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

   1 package OpenILS::Application::Acq::BatchManager;
   2 use OpenSRF::AppSession;
   3 use OpenSRF::EX qw/:try/;
   4 use strict; use warnings;
   5
   6 sub new {
   7     my($class, %args) = @_;
   8     my $self = bless(\%args, $class);
   9     $self->{args} = {
  10         lid => 0,
  11         li => 0,
  12         copies => 0,
  13         bibs => 0,
  14         progress => 0,
  15         debits_accrued => 0,
  16         purchase_order => undef,
  17         picklist => undef,
  18         complete => 0,
  19         indexed => 0,
  20         total => 0
  21     };
  22     $self->{ingest_queue} = [];
  23     $self->{cache} = {};
  24     $self->throttle(5) unless $self->throttle;
  25     return $self;
  26 }
  27
  28 sub conn {
  29     my($self, $val) = @_;
  30     $self->{conn} = $val if $val;
  31     return $self->{conn};
  32 }
  33 sub throttle {
  34     my($self, $val) = @_;
  35     $self->{throttle} = $val if $val;
  36     return $self->{throttle};
  37 }
  38 sub respond {
  39     my($self, %other_args) = @_;
  40     if($self->throttle and not %other_args) {
  41         return unless (
  42             ($self->{args}->{progress} - $self->{last_respond_progress}) >= $self->throttle
  43         );
  44     }
  45     $self->conn->respond({ %{$self->{args}}, %other_args });
  46     $self->{last_respond_progress} = $self->{args}->{progress};
  47 }
  48 sub respond_complete {
  49     my($self, %other_args) = @_;
  50     $self->complete;
  51     $self->conn->respond_complete({ %{$self->{args}}, %other_args });
  52     return undef;
  53 }
  54 sub total {
  55     my($self, $val) = @_;
  56     $self->{args}->{total} = $val if defined $val;
  57     $self->{args}->{maximum} = $self->{args}->{total};
  58     return $self->{args}->{total};
  59 }
  60 sub purchase_order {
  61     my($self, $val) = @_;
  62     $self->{args}->{purchase_order} = $val if $val;
  63     return $self;
  64 }
  65 sub picklist {
  66     my($self, $val) = @_;
  67     $self->{args}->{picklist} = $val if $val;
  68     return $self;
  69 }
  70 sub add_lid {
  71     my $self = shift;
  72     $self->{args}->{lid} += 1;
  73     $self->{args}->{progress} += 1;
  74     return $self;
  75 }
  76 sub add_li {
  77     my $self = shift;
  78     $self->{args}->{li} += 1;
  79     $self->{args}->{progress} += 1;
  80     return $self;
  81 }
  82 sub add_copy {
  83     my $self = shift;
  84     $self->{args}->{copies} += 1;
  85     $self->{args}->{progress} += 1;
  86     return $self;
  87 }
  88 sub add_bib {
  89     my $self = shift;
  90     $self->{args}->{bibs} += 1;
  91     $self->{args}->{progress} += 1;
  92     return $self;
  93 }
  94 sub add_debit {
  95     my($self, $amount) = @_;
  96     $self->{args}->{debits_accrued} += $amount;
  97     $self->{args}->{progress} += 1;
  98     return $self;
  99 }
 100 sub editor {
 101     my($self, $editor) = @_;
 102     $self->{editor} = $editor if defined $editor;
 103     return $self->{editor};
 104 }
 105 sub complete {
 106     my $self = shift;
 107     $self->{args}->{complete} = 1;
 108     return $self;
 109 }
 110
 111 sub ingest_ses {
 112     my($self, $val) = @_;
 113     $self->{ingest_ses} = $val if $val;
 114     return $self->{ingest_ses};
 115 }
 116
 117 sub push_ingest_queue {
 118     my($self, $rec_id) = @_;
 119
 120     $self->ingest_ses(OpenSRF::AppSession->connect('open-ils.ingest'))
 121         unless $self->ingest_ses;
 122
 123     my $req = $self->ingest_ses->request('open-ils.ingest.full.biblio.record', $rec_id);
 124
 125     push(@{$self->{ingest_queue}}, $req);
 126 }
 127
 128 sub process_ingest_records {
 129     my $self = shift;
 130     return unless @{$self->{ingest_queue}};
 131
 132     for my $req (@{$self->{ingest_queue}}) {
 133
 134         try {
 135             $req->gather(1);
 136             $self->{args}->{indexed} += 1;
 137             $self->{args}->{progress} += 1;
 138         } otherwise {};
 139
 140         $self->respond;
 141     }
 142     $self->ingest_ses->disconnect;
 143 }
 144
 145
 146 sub cache {
 147     my($self, $org, $key, $val) = @_;
 148     $self->{cache}->{$org} = {} unless $self->{cache}->{org};
 149     $self->{cache}->{$org}->{$key} = $val if defined $val;
 150     return $self->{cache}->{$org}->{$key};
 151 }
 152
 153
 154 package OpenILS::Application::Acq::Order;
 155 use base qw/OpenILS::Application/;
 156 use strict; use warnings;
 157 # ----------------------------------------------------------------------------
 158 # Break up each component of the order process and pieces into managable
 159 # actions that can be shared across different workflows
 160 # ----------------------------------------------------------------------------
 161 use OpenILS::Event;
 162 use OpenSRF::Utils::Logger qw(:logger);
 163 use OpenSRF::Utils::JSON;
 164 use OpenILS::Utils::Fieldmapper;
 165 use OpenILS::Utils::CStoreEditor q/:funcs/;
 166 use OpenILS::Const qw/:const/;
 167 use OpenSRF::EX q/:try/;
 168 use OpenILS::Application::AppUtils;
 169 use OpenILS::Application::Cat::BibCommon;
 170 use OpenILS::Application::Cat::AssetCommon;
 171 use MARC::Record;
 172 use MARC::Batch;
 173 use MARC::File::XML;
 174 my $U = 'OpenILS::Application::AppUtils';
 175
 176
 177 # ----------------------------------------------------------------------------
 178 # Lineitem
 179 # ----------------------------------------------------------------------------
 180 sub create_lineitem {
 181     my($mgr, %args) = @_;
 182     my $li = Fieldmapper::acq::lineitem->new;
 183     $li->creator($mgr->editor->requestor->id);
 184     $li->selector($li->creator);
 185     $li->editor($li->creator);
 186     $li->create_time('now');
 187     $li->edit_time('now');
 188     $li->state('new');
 189     $li->$_($args{$_}) for keys %args;
 190     $li->clear_id;
 191     $mgr->add_li;
 192     return $mgr->editor->create_acq_lineitem($li);
 193 }
 194
 195 sub update_lineitem {
 196     my($mgr, $li) = @_;
 197     $li->edit_time('now');
 198     $li->editor($mgr->editor->requestor->id);
 199     $mgr->add_li;
 200     return $li if $mgr->editor->update_acq_lineitem($li);
 201     return undef;
 202 }
 203
 204 sub delete_lineitem {
 205     my($mgr, $li) = @_;
 206     $li = $mgr->editor->retrieve_acq_lineitem($li) unless ref $li;
 207
 208     # delete the attached lineitem_details
 209     my $lid_ids = $mgr->editor->search_acq_lineitem_detail({lineitem => $li->id}, {idlist=>1});
 210     for my $lid_id (@$lid_ids) {
 211         return 0 unless delete_lineitem_detail($mgr, $lid_id);
 212     }
 213
 214     $mgr->add_li;
 215     return $mgr->editor->delete_acq_lineitem($li);
 216 }
 217
 218 # begins and commit transactions as it goes
 219 sub create_lineitem_list_assets {
 220     my($mgr, $li_ids) = @_;
 221     return undef if check_import_li_marc_perms($mgr, $li_ids);
 222
 223     # create the bibs/volumes/copies and ingest the records
 224     for my $li_id (@$li_ids) {
 225         $mgr->editor->xact_begin;
 226         my $data = create_lineitem_assets($mgr, $li_id) or return undef;
 227         $mgr->editor->xact_commit;
 228         # XXX ingest is in-db now
 229         #$mgr->push_ingest_queue($data->{li}->eg_bib_id) if $data->{new_bib};
 230         $mgr->respond;
 231     }
 232     $mgr->process_ingest_records;
 233     return 1;
 234 }
 235
 236 # returns event on error, undef on success
 237 sub check_import_li_marc_perms {
 238     my($mgr, $li_ids) = @_;
 239
 240     # if there are any order records that are not linked to
 241     # in-db bib records, verify staff has perms to import order records
 242     my $order_li = $mgr->editor->search_acq_lineitem(
 243         [{id => $li_ids, eg_bib_id => undef}, {limit => 1}], {idlist => 1})->[0];
 244
 245     if($order_li) {
 246         return $mgr->editor->die_event unless
 247             $mgr->editor->allowed('IMPORT_ACQ_LINEITEM_BIB_RECORD');
 248     }
 249
 250     return undef;
 251 }
 252
 253
 254 # ----------------------------------------------------------------------------
 255 # if all of the lineitem details for this lineitem have
 256 # been received, mark the lineitem as received
 257 # returns 1 on non-received, li on received, 0 on error
 258 # ----------------------------------------------------------------------------
 259 sub check_lineitem_received {
 260     my($mgr, $li_id) = @_;
 261
 262     my $non_recv = $mgr->editor->search_acq_lineitem_detail(
 263         {recv_time => undef, lineitem => $li_id}, {idlist=>1});
 264
 265     return 1 if @$non_recv;
 266
 267     my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
 268     $li->state('received');
 269     return update_lineitem($mgr, $li);
 270 }
 271
 272 sub receive_lineitem {
 273     my($mgr, $li_id, $skip_complete_check) = @_;
 274     my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
 275
 276     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
 277         {lineitem => $li_id, recv_time => undef}, {idlist => 1});
 278
 279     for my $lid_id (@$lid_ids) {
 280        receive_lineitem_detail($mgr, $lid_id, 1) or return 0;
 281     }
 282
 283     $mgr->add_li;
 284     $li->state('received');
 285     update_lineitem($mgr, $li) or return 0;
 286     return 1 if $skip_complete_check;
 287
 288     return check_purchase_order_received($mgr, $li->purchase_order);
 289 }
 290
 291 sub rollback_receive_lineitem {
 292     my($mgr, $li_id) = @_;
 293     my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
 294
 295     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
 296         {lineitem => $li_id, recv_time => {'!=' => undef}}, {idlist => 1});
 297
 298     for my $lid_id (@$lid_ids) {
 299        rollback_receive_lineitem_detail($mgr, $lid_id, 1) or return 0;
 300     }
 301
 302     $mgr->add_li;
 303     $li->state('on-order');
 304     return update_lineitem($mgr, $li);
 305 }
 306
 307 # ----------------------------------------------------------------------------
 308 # Lineitem Detail
 309 # ----------------------------------------------------------------------------
 310 sub create_lineitem_detail {
 311     my($mgr, %args) = @_;
 312     my $lid = Fieldmapper::acq::lineitem_detail->new;
 313     $lid->$_($args{$_}) for keys %args;
 314     $lid->clear_id;
 315     $mgr->add_lid;
 316     return $mgr->editor->create_acq_lineitem_detail($lid);
 317 }
 318
 319
 320 # flesh out any required data with default values where appropriate
 321 sub complete_lineitem_detail {
 322     my($mgr, $lid) = @_;
 323     unless($lid->barcode) {
 324         my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_barcode_prefix') || 'ACQ';
 325         $lid->barcode($pfx.$lid->id);
 326     }
 327
 328     unless($lid->cn_label) {
 329         my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_callnumber_prefix') || 'ACQ';
 330         $lid->cn_label($pfx.$lid->id);
 331     }
 332
 333     if(!$lid->location and my $loc = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.default_copy_location')) {
 334         $lid->location($loc);
 335     }
 336
 337     if(!$lid->circ_modifier and my $mod = get_default_circ_modifier($mgr, $lid->owning_lib)) {
 338         $lid->circ_modifier($mod);
 339     }
 340
 341     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
 342     return $lid;
 343 }
 344
 345 sub get_default_circ_modifier {
 346     my($mgr, $org) = @_;
 347     my $mod = $mgr->cache($org, 'def_circ_mod');
 348     return $mod if $mod;
 349     $mod = $U->ou_ancestor_setting_value($org, 'acq.default_circ_modifier');
 350     return $mgr->cache($org, 'def_circ_mod', $mod) if $mod;
 351     return undef;
 352 }
 353
 354 sub delete_lineitem_detail {
 355     my($mgr, $lid) = @_;
 356     $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid) unless ref $lid;
 357     return $mgr->editor->delete_acq_lineitem_detail($lid);
 358 }
 359
 360
 361 sub receive_lineitem_detail {
 362     my($mgr, $lid_id, $skip_complete_check) = @_;
 363     my $e = $mgr->editor;
 364
 365     my $lid = $e->retrieve_acq_lineitem_detail([
 366         $lid_id,
 367         {   flesh => 1,
 368             flesh_fields => {
 369                 acqlid => ['fund_debit']
 370             }
 371         }
 372     ]) or return 0;
 373
 374     return 1 if $lid->recv_time;
 375
 376     $lid->recv_time('now');
 377     $e->update_acq_lineitem_detail($lid) or return 0;
 378
 379     my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
 380     $copy->status(OILS_COPY_STATUS_IN_PROCESS);
 381     $copy->edit_date('now');
 382     $copy->editor($e->requestor->id);
 383     $e->update_asset_copy($copy) or return 0;
 384
 385     if($lid->fund_debit) {
 386         $lid->fund_debit->encumbrance('f');
 387         $e->update_acq_fund_debit($lid->fund_debit) or return 0;
 388     }
 389
 390     $mgr->add_lid;
 391
 392     return 1 if $skip_complete_check;
 393
 394     my $li = check_lineitem_received($mgr, $lid->lineitem) or return 0;
 395     return 1 if $li == 1; # li not received
 396
 397     return check_purchase_order_received($mgr, $li->purchase_order);
 398 }
 399
 400
 401 sub rollback_receive_lineitem_detail {
 402     my($mgr, $lid_id) = @_;
 403     my $e = $mgr->editor;
 404
 405     my $lid = $e->retrieve_acq_lineitem_detail([
 406         $lid_id,
 407         {   flesh => 1,
 408             flesh_fields => {
 409                 acqlid => ['fund_debit']
 410             }
 411         }
 412     ]) or return 0;
 413
 414     return 1 unless $lid->recv_time;
 415
 416     $lid->clear_recv_time;
 417     $e->update_acq_lineitem_detail($lid) or return 0;
 418
 419     my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
 420     $copy->status(OILS_COPY_STATUS_ON_ORDER);
 421     $copy->edit_date('now');
 422     $copy->editor($e->requestor->id);
 423     $e->update_asset_copy($copy) or return 0;
 424
 425     if($lid->fund_debit) {
 426         $lid->fund_debit->encumbrance('t');
 427         $e->update_acq_fund_debit($lid->fund_debit) or return 0;
 428     }
 429
 430     $mgr->add_lid;
 431     return $lid;
 432 }
 433
 434 # ----------------------------------------------------------------------------
 435 # Lineitem Attr
 436 # ----------------------------------------------------------------------------
 437 sub set_lineitem_attr {
 438     my($mgr, %args) = @_;
 439     my $attr_type = $args{attr_type};
 440
 441     # first, see if it's already set.  May just need to overwrite it
 442     my $attr = $mgr->editor->search_acq_lineitem_attr({
 443         lineitem => $args{lineitem},
 444         attr_type => $args{attr_type},
 445         attr_name => $args{attr_name}
 446     })->[0];
 447
 448     if($attr) {
 449         $attr->attr_value($args{attr_value});
 450         return $attr if $mgr->editor->update_acq_lineitem_attr($attr);
 451         return undef;
 452
 453     } else {
 454
 455         $attr = Fieldmapper::acq::lineitem_attr->new;
 456         $attr->$_($args{$_}) for keys %args;
 457
 458         unless($attr->definition) {
 459             my $find = "search_acq_$attr_type";
 460             my $attr_def_id = $mgr->editor->$find({code => $attr->attr_name}, {idlist=>1})->[0] or return 0;
 461             $attr->definition($attr_def_id);
 462         }
 463         return $mgr->editor->create_acq_lineitem_attr($attr);
 464     }
 465 }
 466
 467 sub get_li_price {
 468     my $li = shift;
 469     my $attrs = $li->attributes;
 470     my ($marc_estimated, $local_estimated, $local_actual, $prov_estimated, $prov_actual);
 471
 472     for my $attr (@$attrs) {
 473         if($attr->attr_name eq 'estimated_price') {
 474             $local_estimated = $attr->attr_value
 475                 if $attr->attr_type eq 'lineitem_local_attr_definition';
 476             $prov_estimated = $attr->attr_value
 477                 if $attr->attr_type eq 'lineitem_prov_attr_definition';
 478             $marc_estimated = $attr->attr_value
 479                 if $attr->attr_type eq 'lineitem_marc_attr_definition';
 480
 481         } elsif($attr->attr_name eq 'actual_price') {
 482             $local_actual = $attr->attr_value
 483                 if $attr->attr_type eq 'lineitem_local_attr_definition';
 484             $prov_actual = $attr->attr_value
 485                 if $attr->attr_type eq 'lineitem_prov_attr_definition';
 486         }
 487     }
 488
 489     return ($local_actual, 1) if $local_actual;
 490     return ($prov_actual, 2) if $prov_actual;
 491     return ($local_estimated, 1) if $local_estimated;
 492     return ($prov_estimated, 2) if $prov_estimated;
 493     return ($marc_estimated, 3);
 494 }
 495
 496
 497 # ----------------------------------------------------------------------------
 498 # Lineitem Debits
 499 # ----------------------------------------------------------------------------
 500 sub create_lineitem_debits {
 501     my($mgr, $li, $price, $ptype) = @_;
 502
 503     ($price, $ptype) = get_li_price($li) unless $price;
 504
 505     unless($price) {
 506         $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PRICE', payload => $li->id));
 507         $mgr->editor->rollback;
 508         return 0;
 509     }
 510
 511     unless($li->provider) {
 512         $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PROVIDER', payload => $li->id));
 513         $mgr->editor->rollback;
 514         return 0;
 515     }
 516
 517     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
 518         {lineitem => $li->id},
 519         {idlist=>1}
 520     );
 521
 522     for my $lid_id (@$lid_ids) {
 523
 524         my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
 525             $lid_id,
 526             {   flesh => 1,
 527                 flesh_fields => {acqlid => ['fund']}
 528             }
 529         ]);
 530
 531         create_lineitem_detail_debit($mgr, $li, $lid, $price, $ptype) or return 0;
 532     }
 533
 534     return 1;
 535 }
 536
 537
 538 # flesh li->provider
 539 # flesh lid->fund
 540 # ptype 1=local, 2=provider, 3=marc
 541 sub create_lineitem_detail_debit {
 542     my($mgr, $li, $lid, $price, $ptype) = @_;
 543
 544     unless(ref $li and ref $li->provider) {
 545        $li = $mgr->editor->retrieve_acq_lineitem([
 546             $li,
 547             {   flesh => 1,
 548                 flesh_fields => {jub => ['provider']},
 549             }
 550         ]);
 551     }
 552
 553     unless(ref $lid and ref $lid->fund) {
 554         $lid = $mgr->editor->retrieve_acq_lineitem_detail([
 555             $lid,
 556             {   flesh => 1,
 557                 flesh_fields => {acqlid => ['fund']}
 558             }
 559         ]);
 560     }
 561
 562     my $ctype = $lid->fund->currency_type;
 563     my $amount = $price;
 564
 565     if($ptype == 2) { # price from vendor
 566         $ctype = $li->provider->currency_type;
 567         $amount = currency_conversion($mgr, $ctype, $lid->fund->currency_type, $price);
 568     }
 569
 570     my $debit = create_fund_debit(
 571         $mgr,
 572         fund => $lid->fund->id,
 573         origin_amount => $price,
 574         origin_currency_type => $ctype,
 575         amount => $amount
 576     ) or return 0;
 577
 578     $lid->fund_debit($debit->id);
 579     $lid->fund($lid->fund->id);
 580     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
 581     return $debit;
 582 }
 583
 584
 585 # ----------------------------------------------------------------------------
 586 # Fund Debit
 587 # ----------------------------------------------------------------------------
 588 sub create_fund_debit {
 589     my($mgr, %args) = @_;
 590     my $debit = Fieldmapper::acq::fund_debit->new;
 591     $debit->debit_type('purchase');
 592     $debit->encumbrance('t');
 593     $debit->$_($args{$_}) for keys %args;
 594     $debit->clear_id;
 595     $mgr->add_debit($debit->amount);
 596     return $mgr->editor->create_acq_fund_debit($debit);
 597 }
 598
 599 sub currency_conversion {
 600     my($mgr, $src_currency, $dest_currency, $amount) = @_;
 601     my $result = $mgr->editor->json_query(
 602         {from => ['acq.exchange_ratio', $src_currency, $dest_currency, $amount]});
 603     return $result->[0]->{'acq.exchange_ratio'};
 604 }
 605
 606
 607 # ----------------------------------------------------------------------------
 608 # Picklist
 609 # ----------------------------------------------------------------------------
 610 sub create_picklist {
 611     my($mgr, %args) = @_;
 612     my $picklist = Fieldmapper::acq::picklist->new;
 613     $picklist->creator($mgr->editor->requestor->id);
 614     $picklist->owner($picklist->creator);
 615     $picklist->editor($picklist->creator);
 616     $picklist->create_time('now');
 617     $picklist->edit_time('now');
 618     $picklist->org_unit($mgr->editor->requestor->ws_ou);
 619     $picklist->owner($mgr->editor->requestor->id);
 620     $picklist->$_($args{$_}) for keys %args;
 621     $picklist->clear_id;
 622     $mgr->picklist($picklist);
 623     return $mgr->editor->create_acq_picklist($picklist);
 624 }
 625
 626 sub update_picklist {
 627     my($mgr, $picklist) = @_;
 628     $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
 629     $picklist->edit_time('now');
 630     $picklist->editor($mgr->editor->requestor->id);
 631     $mgr->picklist($picklist);
 632     return $picklist if $mgr->editor->update_acq_picklist($picklist);
 633     return undef;
 634 }
 635
 636 sub delete_picklist {
 637     my($mgr, $picklist) = @_;
 638     $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
 639
 640     # delete all 'new' lineitems
 641     my $li_ids = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => 'new'}, {idlist => 1});
 642     for my $li_id (@$li_ids) {
 643         my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
 644         return 0 unless delete_lineitem($mgr, $li);
 645         $mgr->respond;
 646     }
 647
 648     # detach all non-'new' lineitems
 649     $li_ids = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => {'!=' => 'new'}}, {idlist => 1});
 650     for my $li_id (@$li_ids) {
 651         my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
 652         $li->clear_picklist;
 653         return 0 unless update_lineitem($mgr, $li);
 654         $mgr->respond;
 655     }
 656
 657     # remove any picklist-specific object perms
 658     my $ops = $mgr->editor->search_permission_usr_object_perm_map({object_type => 'acqpl', object_id => ''.$picklist->id});
 659     for my $op (@$ops) {
 660         return 0 unless $mgr->editor->delete_usr_object_perm_map($op);
 661     }
 662
 663     return $mgr->editor->delete_acq_picklist($picklist);
 664 }
 665
 666 # ----------------------------------------------------------------------------
 667 # Purchase Order
 668 # ----------------------------------------------------------------------------
 669 sub update_purchase_order {
 670     my($mgr, $po) = @_;
 671     $po = $mgr->editor->retrieve_acq_purchase_order($po) unless ref $po;
 672     $po->editor($mgr->editor->requestor->id);
 673     $po->edit_time('now');
 674     $mgr->purchase_order($po);
 675     return $po if $mgr->editor->update_acq_purchase_order($po);
 676     return undef;
 677 }
 678
 679 sub create_purchase_order {
 680     my($mgr, %args) = @_;
 681     my $po = Fieldmapper::acq::purchase_order->new;
 682     $po->creator($mgr->editor->requestor->id);
 683     $po->editor($mgr->editor->requestor->id);
 684     $po->owner($mgr->editor->requestor->id);
 685     $po->edit_time('now');
 686     $po->create_time('now');
 687     $po->state('pending');
 688     $po->ordering_agency($mgr->editor->requestor->ws_ou);
 689     $po->$_($args{$_}) for keys %args;
 690     $po->clear_id;
 691     $mgr->purchase_order($po);
 692     return $mgr->editor->create_acq_purchase_order($po);
 693 }
 694
 695 # ----------------------------------------------------------------------------
 696 # if all of the lineitems for this PO are received,
 697 # mark the PO as received
 698 # ----------------------------------------------------------------------------
 699 sub check_purchase_order_received {
 700     my($mgr, $po_id) = @_;
 701
 702     my $non_recv_li = $mgr->editor->search_acq_lineitem(
 703         {   purchase_order => $po_id,
 704             state => {'!=' => 'received'}
 705         }, {idlist=>1});
 706
 707     return 1 if @$non_recv_li;
 708
 709     my $po = $mgr->editor->retrieve_acq_purchase_order($po_id);
 710     $po->state('received');
 711     return update_purchase_order($mgr, $po);
 712 }
 713
 714
 715 # ----------------------------------------------------------------------------
 716 # Bib, Callnumber, and Copy data
 717 # ----------------------------------------------------------------------------
 718
 719 sub create_lineitem_assets {
 720     my($mgr, $li_id) = @_;
 721     my $evt;
 722
 723     my $li = $mgr->editor->retrieve_acq_lineitem([
 724         $li_id,
 725         {   flesh => 1,
 726             flesh_fields => {jub => ['purchase_order', 'attributes']}
 727         }
 728     ]) or return 0;
 729
 730     # -----------------------------------------------------------------
 731     # first, create the bib record if necessary
 732     # -----------------------------------------------------------------
 733     my $new_bib = 0;
 734     unless($li->eg_bib_id) {
 735         create_bib($mgr, $li) or return 0;
 736         $new_bib = 1;
 737     }
 738
 739     my $li_details = $mgr->editor->search_acq_lineitem_detail({lineitem => $li_id}, {idlist=>1});
 740
 741     # -----------------------------------------------------------------
 742     # for each lineitem_detail, create the volume if necessary, create
 743     # a copy, and link them all together.
 744     # -----------------------------------------------------------------
 745     my $first_cn;
 746     for my $lid_id (@{$li_details}) {
 747
 748         my $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid_id) or return 0;
 749         next if $lid->eg_copy_id;
 750
 751         # use the same callnumber label for all items within this lineitem
 752         $lid->cn_label($first_cn) if $first_cn and not $lid->cn_label;
 753
 754         # apply defaults if necessary
 755         return 0 unless complete_lineitem_detail($mgr, $lid);
 756
 757         $first_cn = $lid->cn_label unless $first_cn;
 758
 759         my $org = $lid->owning_lib;
 760         my $label = $lid->cn_label;
 761         my $bibid = $li->eg_bib_id;
 762
 763         my $volume = $mgr->cache($org, "cn.$bibid.$label");
 764         unless($volume) {
 765             $volume = create_volume($mgr, $li, $lid) or return 0;
 766             $mgr->cache($org, "cn.$bibid.$label", $volume);
 767         }
 768         create_copy($mgr, $volume, $lid) or return 0;
 769     }
 770
 771     return { li => $li, new_bib => $new_bib };
 772 }
 773
 774 sub create_bib {
 775     my($mgr, $li) = @_;
 776
 777     my $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
 778         $mgr->editor,
 779         $li->marc,
 780         undef, # bib source
 781         undef,
 782         1, # override tcn collisions
 783     );
 784
 785     if($U->event_code($record)) {
 786         $mgr->editor->event($record);
 787         $mgr->editor->rollback;
 788         return 0;
 789     }
 790
 791     $li->eg_bib_id($record->id);
 792     $mgr->add_bib;
 793     return update_lineitem($mgr, $li);
 794 }
 795
 796 sub create_volume {
 797     my($mgr, $li, $lid) = @_;
 798
 799     my ($volume, $evt) =
 800         OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
 801             $mgr->editor,
 802             $lid->cn_label,
 803             $li->eg_bib_id,
 804             $lid->owning_lib
 805         );
 806
 807     if($evt) {
 808         $mgr->editor->event($evt);
 809         return 0;
 810     }
 811
 812     return $volume;
 813 }
 814
 815 sub create_copy {
 816     my($mgr, $volume, $lid) = @_;
 817     my $copy = Fieldmapper::asset::copy->new;
 818     $copy->isnew(1);
 819     $copy->loan_duration(2);
 820     $copy->fine_level(2);
 821     $copy->status(OILS_COPY_STATUS_ON_ORDER);
 822     $copy->barcode($lid->barcode);
 823     $copy->location($lid->location);
 824     $copy->call_number($volume->id);
 825     $copy->circ_lib($volume->owning_lib);
 826     $copy->circ_modifier($lid->circ_modifier);
 827
 828     my $evt = OpenILS::Application::Cat::AssetCommon->create_copy($mgr->editor, $volume, $copy);
 829     if($evt) {
 830         $mgr->editor->event($evt);
 831         return 0;
 832     }
 833
 834     $mgr->add_copy;
 835     $lid->eg_copy_id($copy->id);
 836     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
 837 }
 838
 839
 840
 841
 842
 843
 844 # ----------------------------------------------------------------------------
 845 # Workflow: Build a selection list from a Z39.50 search
 846 # ----------------------------------------------------------------------------
 847
 848 __PACKAGE__->register_method(
 849         method => 'zsearch',
 850         api_name => 'open-ils.acq.picklist.search.z3950',
 851     stream => 1,
 852         signature => {
 853         desc => 'Performs a z3950 federated search and creates a picklist and associated lineitems',
 854         params => [
 855             {desc => 'Authentication token', type => 'string'},
 856             {desc => 'Search definition', type => 'object'},
 857             {desc => 'Picklist name, optional', type => 'string'},
 858         ]
 859     }
 860 );
 861
 862 sub zsearch {
 863     my($self, $conn, $auth, $search, $name, $options) = @_;
 864     my $e = new_editor(authtoken=>$auth);
 865     return $e->event unless $e->checkauth;
 866     return $e->event unless $e->allowed('CREATE_PICKLIST');
 867
 868     $search->{limit} ||= 10;
 869     $options ||= {};
 870
 871     my $ses = OpenSRF::AppSession->create('open-ils.search');
 872     my $req = $ses->request('open-ils.search.z3950.search_class', $auth, $search);
 873
 874     my $first = 1;
 875     my $picklist;
 876     my $mgr;
 877     while(my $resp = $req->recv(timeout=>60)) {
 878
 879         if($first) {
 880             my $e = new_editor(requestor=>$e->requestor, xact=>1);
 881             $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
 882             $picklist = zsearch_build_pl($mgr, $name);
 883             $first = 0;
 884         }
 885
 886         my $result = $resp->content;
 887         my $count = $result->{count};
 888         $mgr->total( (($count < $search->{limit}) ? $count : $search->{limit})+1 );
 889
 890         for my $rec (@{$result->{records}}) {
 891
 892             my $li = create_lineitem($mgr,
 893                 picklist => $picklist->id,
 894                 source_label => $result->{service},
 895                 marc => $rec->{marcxml},
 896                 eg_bib_id => $rec->{bibid}
 897             );
 898
 899             if($$options{respond_li}) {
 900                 $li->attributes($mgr->editor->search_acq_lineitem_attr({lineitem => $li->id}))
 901                     if $$options{flesh_attrs};
 902                 $li->clear_marc if $$options{clear_marc};
 903                 $mgr->respond(lineitem => $li);
 904             } else {
 905                 $mgr->respond;
 906             }
 907         }
 908     }
 909
 910     $mgr->editor->commit;
 911     return $mgr->respond_complete;
 912 }
 913
 914 sub zsearch_build_pl {
 915     my($mgr, $name) = @_;
 916     $name ||= '';
 917
 918     my $picklist = $mgr->editor->search_acq_picklist({
 919         owner => $mgr->editor->requestor->id,
 920         name => $name
 921     })->[0];
 922
 923     if($name eq '' and $picklist) {
 924         return 0 unless delete_picklist($mgr, $picklist);
 925         $picklist = undef;
 926     }
 927
 928     return update_picklist($mgr, $picklist) if $picklist;
 929     return create_picklist($mgr, name => $name);
 930 }
 931
 932
 933 # ----------------------------------------------------------------------------
 934 # Workflow: Build a selection list / PO by importing a batch of MARC records
 935 # ----------------------------------------------------------------------------
 936
 937 __PACKAGE__->register_method(
 938     method => 'upload_records',
 939     api_name => 'open-ils.acq.process_upload_records',
 940     stream => 1,
 941 );
 942
 943 sub upload_records {
 944     my($self, $conn, $auth, $key) = @_;
 945
 946         my $e = new_editor(authtoken => $auth, xact => 1);
 947     return $e->die_event unless $e->checkauth;
 948     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
 949
 950     my $cache = OpenSRF::Utils::Cache->new;
 951
 952     my $data = $cache->get_cache("vandelay_import_spool_$key");
 953         my $purpose = $data->{purpose};
 954     my $filename = $data->{path};
 955     my $provider = $data->{provider};
 956     my $picklist = $data->{picklist};
 957     my $create_po = $data->{create_po};
 958     my $ordering_agency = $data->{ordering_agency};
 959     my $create_assets = $data->{create_assets};
 960     my $po;
 961     my $evt;
 962
 963     unless(-r $filename) {
 964         $logger->error("unable to read MARC file $filename");
 965         $e->rollback;
 966         return OpenILS::Event->new('FILE_UPLOAD_ERROR', payload => {filename => $filename});
 967     }
 968
 969     $provider = $e->retrieve_acq_provider($provider) or return $e->die_event;
 970
 971     if($picklist) {
 972         $picklist = $e->retrieve_acq_picklist($picklist) or return $e->die_event;
 973         if($picklist->owner != $e->requestor->id) {
 974             return $e->die_event unless
 975                 $e->allowed('CREATE_PICKLIST', $picklist->org_unit, $picklist);
 976         }
 977         $mgr->picklist($picklist);
 978     }
 979
 980     if($create_po) {
 981
 982         # verify the provider is still active
 983         unless($U->is_true($provider->active)) {
 984             $logger->error("provider is not active.  cannot create PO");
 985             $e->rollback;
 986             return OpenILS::Event->new('ACQ_PROVIDER_INACTIVE');
 987         }
 988
 989         $po = create_purchase_order($mgr,
 990             ordering_agency => $ordering_agency,
 991             provider => $provider->id,
 992             state => 'on-order'
 993         ) or return $mgr->editor->die_event;
 994     }
 995
 996     $logger->info("acq processing MARC file=$filename");
 997
 998     my $marctype = 'USMARC'; # ?
 999         my $batch = new MARC::Batch ($marctype, $filename);
1000         $batch->strict_off;
1001
1002         my $count = 0;
1003     my @li_list;
1004
1005         while(1) {
1006
1007             my $err;
1008         my $xml;
1009                 $count++;
1010         my $r;
1011
1012                 try {
1013             $r = $batch->next;
1014         } catch Error with {
1015             $err = shift;
1016                         $logger->warn("Proccessing of record $count in set $key failed with error $err.  Skipping this record");
1017         };
1018
1019         next if $err;
1020         last unless $r;
1021
1022                 try {
1023             ($xml = $r->as_xml_record()) =~ s/\n//sog;
1024             $xml =~ s/^<\?xml.+\?\s*>//go;
1025             $xml =~ s/>\s+</></go;
1026             $xml =~ s/\p{Cc}//go;
1027             $xml = $U->entityize($xml);
1028             $xml =~ s/[\x00-\x1f]//go;
1029
1030                 } catch Error with {
1031                         $err = shift;
1032                         $logger->warn("Proccessing XML of record $count in set $key failed with error $err.  Skipping this record");
1033                 };
1034
1035         next if $err or not $xml;
1036
1037         my %args = (
1038             source_label => $provider->code,
1039             provider => $provider->id,
1040             marc => $xml,
1041         );
1042
1043         $args{picklist} = $picklist->id if $picklist;
1044         if($po) {
1045             $args{purchase_order} = $po->id;
1046             $args{state} = 'on-order';
1047         }
1048
1049         my $li = create_lineitem($mgr, %args) or return $mgr->editor->die_event;
1050         $mgr->respond;
1051         $li->provider($provider); # flesh it, we'll need it later
1052
1053         import_lineitem_details($mgr, $ordering_agency, $li) or return $mgr->editor->die_event;
1054         $mgr->respond;
1055
1056         push(@li_list, $li->id);
1057         $mgr->respond;
1058         }
1059
1060         $e->commit;
1061     unlink($filename);
1062     $cache->delete_cache('vandelay_import_spool_' . $key);
1063
1064     if($create_assets) {
1065         create_lineitem_list_assets($mgr, \@li_list) or return $e->die_event;
1066     }
1067
1068     return $mgr->respond_complete;
1069 }
1070
1071 sub import_lineitem_details {
1072     my($mgr, $ordering_agency, $li) = @_;
1073
1074     my $holdings = $mgr->editor->json_query({from => ['acq.extract_provider_holding_data', $li->id]});
1075     return 1 unless @$holdings;
1076     my $org_path = $U->get_org_ancestors($ordering_agency);
1077     $org_path = [ reverse (@$org_path) ];
1078     my $price;
1079
1080     my $idx = 1;
1081     while(1) {
1082         # create a lineitem detail for each copy in the data
1083
1084         my $compiled = extract_lineitem_detail_data($mgr, $org_path, $holdings, $idx);
1085         last unless defined $compiled;
1086         return 0 unless $compiled;
1087
1088         # this takes the price of the last copy and uses it as the lineitem price
1089         # need to determine if a given record would include different prices for the same item
1090         $price = $$compiled{price};
1091
1092         for(1..$$compiled{quantity}) {
1093             my $lid = create_lineitem_detail($mgr,
1094                 lineitem => $li->id,
1095                 owning_lib => $$compiled{owning_lib},
1096                 cn_label => $$compiled{call_number},
1097                 fund => $$compiled{fund},
1098                 circ_modifier => $$compiled{circ_modifier},
1099                 note => $$compiled{note},
1100                 location => $$compiled{copy_location},
1101                 collection_code => $$compiled{collection_code}
1102             ) or return 0;
1103         }
1104
1105         $mgr->respond;
1106         $idx++;
1107     }
1108
1109     # set the price attr so we'll know the source of the price
1110     set_lineitem_attr(
1111         $mgr,
1112         attr_name => 'estimated_price',
1113         attr_type => 'lineitem_local_attr_definition',
1114         attr_value => $price,
1115         lineitem => $li->id
1116     ) or return 0;
1117
1118     # if we're creating a purchase order, create the debits
1119     if($li->purchase_order) {
1120         create_lineitem_debits($mgr, $li, $price, 2) or return 0;
1121         $mgr->respond;
1122     }
1123
1124     return 1;
1125 }
1126
1127 # return hash on success, 0 on error, undef on no more holdings
1128 sub extract_lineitem_detail_data {
1129     my($mgr, $org_path, $holdings, $index) = @_;
1130
1131     my @data_list = grep { $_->{holding} eq $index } @$holdings;
1132     return undef unless @data_list;
1133
1134     my %compiled = map { $_->{attr} => $_->{data} } @data_list;
1135     my $base_org = $$org_path[0];
1136
1137     my $killme = sub {
1138         my $msg = shift;
1139         $logger->error("Item import extraction error: $msg");
1140         $logger->error('Holdings Data: ' . OpenSRF::Utils::JSON->perl2JSON(\%compiled));
1141         $mgr->editor->rollback;
1142         $mgr->editor->event(OpenILS::Event->new('ACQ_IMPORT_ERROR', payload => $msg));
1143         return 0;
1144     };
1145
1146     $compiled{quantity} ||= 1;
1147
1148     # ---------------------------------------------------------------------
1149     # Fund
1150     my $code = $compiled{fund_code};
1151     return $killme->('no fund code provided') unless $code;
1152
1153     my $fund = $mgr->cache($base_org, "fund.$code");
1154     unless($fund) {
1155         # search up the org tree for the most appropriate fund
1156         for my $org (@$org_path) {
1157             $fund = $mgr->editor->search_acq_fund(
1158                 {org => $org, code => $code, year => DateTime->now->year}, {idlist => 1})->[0];
1159             last if $fund;
1160         }
1161     }
1162     return $killme->("no fund with code $code at orgs [@$org_path]") unless $fund;
1163     $compiled{fund} = $fund;
1164     $mgr->cache($base_org, "fund.$code", $fund);
1165
1166
1167     # ---------------------------------------------------------------------
1168     # Owning lib
1169     my $sn = $compiled{owning_lib};
1170     return $killme->('no owning_lib defined') unless $sn;
1171     my $org_id =
1172         $mgr->cache($base_org, "orgsn.$sn") ||
1173             $mgr->editor->search_actor_org_unit({shortname => $sn}, {idlist => 1})->[0];
1174     return $killme->("invalid owning_lib defined: $sn") unless $org_id;
1175     $compiled{owning_lib} = $org_id;
1176     $mgr->cache($$org_path[0], "orgsn.$sn", $org_id);
1177
1178
1179     # ---------------------------------------------------------------------
1180     # Circ Modifier
1181     my $mod;
1182     $code = $compiled{circ_modifier};
1183
1184     if($code) {
1185
1186         $mod = $mgr->cache($base_org, "mod.$code") ||
1187             $mgr->editor->retrieve_config_circ_modifier($code);
1188         return $killme->("invlalid circ_modifier $code") unless $mod;
1189         $mgr->cache($base_org, "mod.$code", $mod);
1190
1191     } else {
1192         # try the default
1193         $mod = get_default_circ_modifier($mgr, $base_org)
1194             or return $killme->('no circ_modifier defined');
1195     }
1196
1197     $compiled{circ_modifier} = $mod;
1198
1199
1200     # ---------------------------------------------------------------------
1201     # Shelving Location
1202     my $name = $compiled{copy_location};
1203     if($name) {
1204         my $loc = $mgr->cache($base_org, "copy_loc.$name");
1205         unless($loc) {
1206             for my $org (@$org_path) {
1207                 $loc = $mgr->editor->search_asset_copy_location(
1208                     {owning_lib => $org, name => $name}, {idlist => 1})->[0];
1209                 last if $loc;
1210             }
1211         }
1212         return $killme->("Invalid copy location $name") unless $loc;
1213         $compiled{copy_location} = $loc;
1214         $mgr->cache($base_org, "copy_loc.$name", $loc);
1215     }
1216
1217     return \%compiled;
1218 }
1219
1220
1221
1222 # ----------------------------------------------------------------------------
1223 # Workflow: Given an existing purchase order, import/create the bibs,
1224 # callnumber and copy objects
1225 # ----------------------------------------------------------------------------
1226
1227 __PACKAGE__->register_method(
1228         method => 'create_po_assets',
1229         api_name        => 'open-ils.acq.purchase_order.assets.create',
1230         signature => {
1231         desc => q/Creates assets for each lineitem in the purchase order/,
1232         params => [
1233             {desc => 'Authentication token', type => 'string'},
1234             {desc => 'The purchase order id', type => 'number'},
1235         ],
1236         return => {desc => 'Streams a total versus completed counts object, event on error'}
1237     }
1238 );
1239
1240 sub create_po_assets {
1241     my($self, $conn, $auth, $po_id) = @_;
1242
1243     my $e = new_editor(authtoken=>$auth, xact=>1);
1244     return $e->die_event unless $e->checkauth;
1245     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1246
1247     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1248
1249     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1250
1251     # it's ugly, but it's fast.  Get the total count of lineitem detail objects to process
1252     my $lid_total = $e->json_query({
1253         select => { acqlid => [{aggregate => 1, transform => 'count', column => 'id'}] },
1254         from => {
1255             acqlid => {
1256                 jub => {
1257                     fkey => 'lineitem',
1258                     field => 'id',
1259                     join => {acqpo => {fkey => 'purchase_order', field => 'id'}}
1260                 }
1261             }
1262         },
1263         where => {'+acqpo' => {id => $po_id}}
1264     })->[0]->{id};
1265
1266     $mgr->total(scalar(@$li_ids) + $lid_total);
1267
1268     create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1269
1270     $e->xact_begin;
1271     update_purchase_order($mgr, $po) or return $e->die_event;
1272     $e->commit;
1273
1274     return $mgr->respond_complete;
1275 }
1276
1277
1278
1279 __PACKAGE__->register_method(
1280         method => 'create_purchase_order_api',
1281         api_name        => 'open-ils.acq.purchase_order.create',
1282         signature => {
1283         desc => 'Creates a new purchase order',
1284         params => [
1285             {desc => 'Authentication token', type => 'string'},
1286             {desc => 'purchase_order to create', type => 'object'}
1287         ],
1288         return => {desc => 'The purchase order id, Event on failure'}
1289     }
1290 );
1291
1292 sub create_purchase_order_api {
1293     my($self, $conn, $auth, $po, $args) = @_;
1294     $args ||= {};
1295
1296     my $e = new_editor(xact=>1, authtoken=>$auth);
1297     return $e->die_event unless $e->checkauth;
1298     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
1299     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1300
1301     # verify the provider is still active
1302     my $provider = $e->retrieve_acq_provider($po->provider) or return $e->die_event;
1303     unless($U->is_true($provider->active)) {
1304         $logger->error("provider is not active.  cannot create PO");
1305         $e->rollback;
1306         return OpenILS::Event->new('ACQ_PROVIDER_INACTIVE');
1307     }
1308
1309     # create the PO
1310     my %pargs = (ordering_agency => $e->requestor->ws_ou); # default
1311     $pargs{provider} = $po->provider if $po->provider;
1312     $pargs{ordering_agency} = $po->ordering_agency if $po->ordering_agency;
1313     $po = create_purchase_order($mgr, %pargs) or return $e->die_event;
1314
1315     my $li_ids = $$args{lineitems};
1316
1317     if($li_ids) {
1318
1319         for my $li_id (@$li_ids) {
1320
1321             my $li = $e->retrieve_acq_lineitem([
1322                 $li_id,
1323                 {flesh => 1, flesh_fields => {jub => ['attributes']}}
1324             ]) or return $e->die_event;
1325
1326             $li->provider($po->provider);
1327             $li->purchase_order($po->id);
1328             $li->state('pending-order');
1329             update_lineitem($mgr, $li) or return $e->die_event;
1330             $mgr->respond;
1331
1332             create_lineitem_debits($mgr, $li) or return $e->die_event;
1333         }
1334     }
1335
1336     # commit before starting the asset creation
1337     $e->xact_commit;
1338
1339     if($li_ids and $$args{create_assets}) {
1340         create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1341     }
1342
1343     return $mgr->respond_complete;
1344 }
1345
1346
1347 __PACKAGE__->register_method(
1348         method => 'lineitem_detail_CUD_batch',
1349         api_name => 'open-ils.acq.lineitem_detail.cud.batch',
1350     stream => 1,
1351         signature => {
1352         desc => q/Creates a new purchase order line item detail.
1353             Additionally creates the associated fund_debit/,
1354         params => [
1355             {desc => 'Authentication token', type => 'string'},
1356             {desc => 'List of lineitem_details to create', type => 'array'},
1357         ],
1358         return => {desc => 'Streaming response of current position in the array'}
1359     }
1360 );
1361
1362 sub lineitem_detail_CUD_batch {
1363     my($self, $conn, $auth, $li_details) = @_;
1364
1365     my $e = new_editor(xact=>1, authtoken=>$auth);
1366     return $e->die_event unless $e->checkauth;
1367     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1368
1369     # XXX perms
1370
1371     $mgr->total(scalar(@$li_details));
1372
1373     my %li_cache;
1374
1375     for my $lid (@$li_details) {
1376
1377         my $li = $li_cache{$lid->lineitem} || $e->retrieve_acq_lineitem($lid->lineitem);
1378
1379         if($lid->isnew) {
1380             create_lineitem_detail($mgr, %{$lid->to_bare_hash}) or return $e->die_event;
1381
1382         } elsif($lid->ischanged) {
1383             $e->update_acq_lineitem_detail($lid) or return $e->die_event;
1384
1385         } elsif($lid->isdeleted) {
1386             delete_lineitem_detail($mgr, $lid) or return $e->die_event;
1387         }
1388
1389         $mgr->respond(li => $li);
1390         $li_cache{$lid->lineitem} = $li;
1391     }
1392
1393     $e->commit;
1394     return $mgr->respond_complete;
1395 }
1396
1397
1398 __PACKAGE__->register_method(
1399         method => 'receive_po_api',
1400         api_name        => 'open-ils.acq.purchase_order.receive'
1401 );
1402
1403 sub receive_po_api {
1404     my($self, $conn, $auth, $po_id) = @_;
1405     my $e = new_editor(xact => 1, authtoken => $auth);
1406     return $e->die_event unless $e->checkauth;
1407     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1408
1409     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1410     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1411
1412     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1413
1414     for my $li_id (@$li_ids) {
1415         receive_lineitem($mgr, $li_id) or return $e->die_event;
1416         $mgr->respond;
1417     }
1418
1419     $po->state('received');
1420     update_purchase_order($mgr, $po) or return $e->die_event;
1421
1422     $e->commit;
1423     return $mgr->respond_complete;
1424 }
1425
1426
1427 __PACKAGE__->register_method(
1428         method => 'receive_lineitem_detail_api',
1429         api_name        => 'open-ils.acq.lineitem_detail.receive',
1430         signature => {
1431         desc => 'Mark a lineitem_detail as received',
1432         params => [
1433             {desc => 'Authentication token', type => 'string'},
1434             {desc => 'lineitem detail ID', type => 'number'}
1435         ],
1436         return => {desc => '1 on success, Event on error'}
1437     }
1438 );
1439
1440 sub receive_lineitem_detail_api {
1441     my($self, $conn, $auth, $lid_id) = @_;
1442
1443     my $e = new_editor(xact=>1, authtoken=>$auth);
1444     return $e->die_event unless $e->checkauth;
1445     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1446
1447     my $lid = $e->retrieve_acq_lineitem_detail([
1448         $lid_id, {
1449             flesh => 2,
1450             flesh_fields => {
1451                 acqlid => ['lineitem'],
1452                 jub => ['purchase_order']
1453             }
1454         }
1455     ]);
1456
1457     return $e->die_event unless $e->allowed(
1458         'RECEIVE_PURCHASE_ORDER', $lid->lineitem->purchase_order->ordering_agency);
1459
1460     receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1461     $e->commit;
1462     return 1;
1463 }
1464
1465 __PACKAGE__->register_method(
1466         method => 'receive_lineitem_api',
1467         api_name        => 'open-ils.acq.lineitem.receive',
1468         signature => {
1469         desc => 'Mark a lineitem as received',
1470         params => [
1471             {desc => 'Authentication token', type => 'string'},
1472             {desc => 'lineitem detail ID', type => 'number'}
1473         ],
1474         return => {desc => '1 on success, Event on error'}
1475     }
1476 );
1477
1478 sub receive_lineitem_api {
1479     my($self, $conn, $auth, $li_id) = @_;
1480
1481     my $e = new_editor(xact=>1, authtoken=>$auth);
1482     return $e->die_event unless $e->checkauth;
1483     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1484
1485     my $li = $e->retrieve_acq_lineitem([
1486         $li_id, {
1487             flesh => 1,
1488             flesh_fields => {
1489                 jub => ['purchase_order']
1490             }
1491         }
1492     ]) or return $e->die_event;
1493
1494     return $e->die_event unless $e->allowed(
1495         'RECEIVE_PURCHASE_ORDER', $li->purchase_order->ordering_agency);
1496
1497     receive_lineitem($mgr, $li_id) or return $e->die_event;
1498     $e->commit;
1499     return 1;
1500 }
1501
1502
1503 __PACKAGE__->register_method(
1504         method => 'rollback_receive_po_api',
1505         api_name        => 'open-ils.acq.purchase_order.receive.rollback'
1506 );
1507
1508 sub rollback_receive_po_api {
1509     my($self, $conn, $auth, $po_id) = @_;
1510     my $e = new_editor(xact => 1, authtoken => $auth);
1511     return $e->die_event unless $e->checkauth;
1512     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1513
1514     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1515     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1516
1517     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1518
1519     for my $li_id (@$li_ids) {
1520         rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1521         $mgr->respond;
1522     }
1523
1524     $po->state('on-order');
1525     update_purchase_order($mgr, $po) or return $e->die_event;
1526
1527     $e->commit;
1528     return $mgr->respond_complete;
1529 }
1530
1531
1532 __PACKAGE__->register_method(
1533         method => 'rollback_receive_lineitem_detail_api',
1534         api_name        => 'open-ils.acq.lineitem_detail.receive.rollback',
1535         signature => {
1536         desc => 'Mark a lineitem_detail as received',
1537         params => [
1538             {desc => 'Authentication token', type => 'string'},
1539             {desc => 'lineitem detail ID', type => 'number'}
1540         ],
1541         return => {desc => '1 on success, Event on error'}
1542     }
1543 );
1544
1545 sub rollback_receive_lineitem_detail_api {
1546     my($self, $conn, $auth, $lid_id) = @_;
1547
1548     my $e = new_editor(xact=>1, authtoken=>$auth);
1549     return $e->die_event unless $e->checkauth;
1550     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1551
1552     my $lid = $e->retrieve_acq_lineitem_detail([
1553         $lid_id, {
1554             flesh => 2,
1555             flesh_fields => {
1556                 acqlid => ['lineitem'],
1557                 jub => ['purchase_order']
1558             }
1559         }
1560     ]);
1561     my $li = $lid->lineitem;
1562     my $po = $li->purchase_order;
1563
1564     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1565     rollback_receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1566
1567     $li->state('on-order');
1568     $po->state('on-order');
1569     udpate_lineitem($mgr, $li) or return $e->die_event;
1570     udpate_purchase_order($mgr, $po) or return $e->die_event;
1571
1572     $e->commit;
1573     return 1;
1574 }
1575
1576 __PACKAGE__->register_method(
1577         method => 'rollback_receive_lineitem_api',
1578         api_name        => 'open-ils.acq.lineitem.receive.rollback',
1579         signature => {
1580         desc => 'Mark a lineitem as received',
1581         params => [
1582             {desc => 'Authentication token', type => 'string'},
1583             {desc => 'lineitem detail ID', type => 'number'}
1584         ],
1585         return => {desc => '1 on success, Event on error'}
1586     }
1587 );
1588
1589 sub rollback_receive_lineitem_api {
1590     my($self, $conn, $auth, $li_id) = @_;
1591
1592     my $e = new_editor(xact=>1, authtoken=>$auth);
1593     return $e->die_event unless $e->checkauth;
1594     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1595
1596     my $li = $e->retrieve_acq_lineitem_detail([
1597         $li_id, {
1598             flesh => 1,
1599             flesh_fields => {
1600                 jub => ['purchase_order']
1601             }
1602         }
1603     ]);
1604     my $po = $li->purchase_order;
1605
1606     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1607
1608     rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1609
1610     $po->state('on-order');
1611     update_purchase_order($mgr, $po) or return $e->die_event;
1612
1613     $e->commit;
1614     return 1;
1615 }
1616
1617
1618 __PACKAGE__->register_method(
1619         method => 'set_lineitem_price_api',
1620         api_name        => 'open-ils.acq.lineitem.price.set',
1621         signature => {
1622         desc => 'Set lineitem price.  If debits already exist, update them as well',
1623         params => [
1624             {desc => 'Authentication token', type => 'string'},
1625             {desc => 'lineitem ID', type => 'number'}
1626         ],
1627         return => {desc => 'status blob, Event on error'}
1628     }
1629 );
1630
1631 sub set_lineitem_price_api {
1632     my($self, $conn, $auth, $li_id, $price, $currency) = @_;
1633
1634     my $e = new_editor(xact=>1, authtoken=>$auth);
1635     return $e->die_event unless $e->checkauth;
1636     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1637
1638     # XXX perms
1639
1640     my $li = $e->retrieve_acq_lineitem($li_id) or return $e->die_event;
1641
1642     # update the local attr for estimated price
1643     set_lineitem_attr(
1644         $mgr,
1645         attr_name => 'estimated_price',
1646         attr_type => 'lineitem_local_attr_definition',
1647         attr_value => $price,
1648         lineitem => $li_id
1649     ) or return $e->die_event;
1650
1651     my $lid_ids = $e->search_acq_lineitem_detail(
1652         {lineitem => $li_id, fund_debit => {'!=' => undef}},
1653         {idlist => 1}
1654     );
1655
1656     for my $lid_id (@$lid_ids) {
1657
1658         my $lid = $e->retrieve_acq_lineitem_detail([
1659             $lid_id, {
1660             flesh => 1, flesh_fields => {acqlid => ['fund', 'fund_debit']}}
1661         ]);
1662
1663         # onless otherwise specified, assume currency of new price is same as currency type of the fund
1664         $currency ||= $lid->fund->currency_type;
1665         my $amount = $price;
1666
1667         if($lid->fund->currency_type ne $currency) {
1668             $amount = currency_conversion($mgr, $currency, $lid->fund->currency_type, $price);
1669         }
1670
1671         $lid->fund_debit->origin_currency_type($currency);
1672         $lid->fund_debit->origin_amount($price);
1673         $lid->fund_debit->amount($amount);
1674
1675         $e->update_acq_fund_debit($lid->fund_debit) or return $e->die_event;
1676         $mgr->add_lid;
1677         $mgr->respond;
1678     }
1679
1680     $e->commit;
1681     return $mgr->respond_complete;
1682 }
1683
1684
1685 __PACKAGE__->register_method(
1686         method => 'clone_picklist_api',
1687         api_name        => 'open-ils.acq.picklist.clone',
1688         signature => {
1689         desc => 'Clones a picklist, including lineitem and lineitem details',
1690         params => [
1691             {desc => 'Authentication token', type => 'string'},
1692             {desc => 'Picklist ID', type => 'number'},
1693             {desc => 'New Picklist Name', type => 'string'}
1694         ],
1695         return => {desc => 'status blob, Event on error'}
1696     }
1697 );
1698
1699 sub clone_picklist_api {
1700     my($self, $conn, $auth, $pl_id, $name) = @_;
1701
1702     my $e = new_editor(xact=>1, authtoken=>$auth);
1703     return $e->die_event unless $e->checkauth;
1704     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1705
1706     my $old_pl = $e->retrieve_acq_picklist($pl_id);
1707     my $new_pl = create_picklist($mgr, %{$old_pl->to_bare_hash}, name => $name) or return $e->die_event;
1708
1709     my $li_ids = $e->search_acq_lineitem({picklist => $pl_id}, {idlist => 1});
1710
1711     for my $li_id (@$li_ids) {
1712
1713         # copy the lineitems
1714         my $li = $e->retrieve_acq_lineitem($li_id);
1715         my $new_li = create_lineitem($mgr, %{$li->to_bare_hash}, picklist => $new_pl->id) or return $e->die_event;
1716
1717         my $lid_ids = $e->search_acq_lineitem_detail({lineitem => $li_id}, {idlist => 1});
1718         for my $lid_id (@$lid_ids) {
1719
1720             # copy the lineitem details
1721             my $lid = $e->retrieve_acq_lineitem_detail($lid_id);
1722             create_lineitem_detail($mgr, %{$lid->to_bare_hash}, lineitem => $new_li->id) or return $e->die_event;
1723         }
1724
1725         $mgr->respond;
1726     }
1727
1728     $e->commit;
1729     return $mgr->respond_complete;
1730 }
1731
1732
1733 __PACKAGE__->register_method(
1734         method => 'merge_picklist_api',
1735         api_name        => 'open-ils.acq.picklist.merge',
1736         signature => {
1737         desc => 'Merges 2 or more picklists into a single list',
1738         params => [
1739             {desc => 'Authentication token', type => 'string'},
1740             {desc => 'Lead Picklist ID', type => 'number'},
1741             {desc => 'List of subordinate picklist IDs', type => 'array'}
1742         ],
1743         return => {desc => 'status blob, Event on error'}
1744     }
1745 );
1746
1747 sub merge_picklist_api {
1748     my($self, $conn, $auth, $lead_pl, $pl_list) = @_;
1749
1750     my $e = new_editor(xact=>1, authtoken=>$auth);
1751     return $e->die_event unless $e->checkauth;
1752     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1753
1754     # XXX perms on each picklist modified
1755
1756     # point all of the lineitems at the lead picklist
1757     my $li_ids = $e->search_acq_lineitem({picklist => $pl_list}, {idlist => 1});
1758
1759     for my $li_id (@$li_ids) {
1760         my $li = $e->retrieve_acq_lineitem($li_id);
1761         $li->picklist($lead_pl);
1762         update_lineitem($mgr, $li) or return $e->die_event;
1763         $mgr->respond;
1764     }
1765
1766     # now delete the subordinate lists
1767     for my $pl_id (@$pl_list) {
1768         my $pl = $e->retrieve_acq_picklist($pl_id);
1769         $e->delete_acq_picklist($pl) or return $e->die_event;
1770     }
1771
1772     $e->commit;
1773     return $mgr->respond_complete;
1774 }
1775
1776
1777 __PACKAGE__->register_method(
1778         method => 'delete_picklist_api',
1779         api_name        => 'open-ils.acq.picklist.delete',
1780         signature => {
1781         desc => q/Deletes a picklist.  It also deletes any lineitems in the "new" state.
1782             Other attached lineitems are detached'/,
1783         params => [
1784             {desc => 'Authentication token', type => 'string'},
1785             {desc => 'Picklist ID to delete', type => 'number'}
1786         ],
1787         return => {desc => '1 on success, Event on error'}
1788     }
1789 );
1790
1791 sub delete_picklist_api {
1792     my($self, $conn, $auth, $picklist_id) = @_;
1793     my $e = new_editor(xact=>1, authtoken=>$auth);
1794     return $e->die_event unless $e->checkauth;
1795     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1796     my $pl = $e->retrieve_acq_picklist($picklist_id) or return $e->die_event;
1797     delete_picklist($mgr, $pl) or return $e->die_event;
1798     $e->commit;
1799     return $mgr->respond_complete;
1800 }
1801
1802
1803
1804 __PACKAGE__->register_method(
1805         method => 'activate_purchase_order',
1806         api_name        => 'open-ils.acq.purchase_order.activate',
1807         signature => {
1808         desc => q/Activates a purchase order.  This updates the status of the PO
1809             and Lineitems to 'on-order'.  Activated PO's are ready for EDI delivery
1810             if appropriate./,
1811         params => [
1812             {desc => 'Authentication token', type => 'string'},
1813             {desc => 'Purchase ID', type => 'number'}
1814         ],
1815         return => {desc => '1 on success, Event on error'}
1816     }
1817 );
1818
1819 sub activate_purchase_order {
1820     my($self, $conn, $auth, $po_id) = @_;
1821     my $e = new_editor(xact=>1, authtoken=>$auth);
1822     return $e->die_event unless $e->checkauth;
1823     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1824
1825     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1826     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
1827
1828     $po->state('on-order');
1829     update_purchase_order($mgr, $po) or return $e->die_event;
1830
1831     my $query = [
1832         {purchase_order => $po_id, state => 'pending-order'},
1833         {limit => 1}
1834     ];
1835
1836     while( my $li = $e->search_acq_lineitem($query)->[0] ) {
1837         $li->state('on-order');
1838         update_lineitem($mgr, $li) or return $e->die_event;
1839         $mgr->respond;
1840     }
1841
1842     $e->commit;
1843     return 1;
1844 }
1845
1846
1847 __PACKAGE__->register_method(
1848         method => 'split_purchase_order_by_lineitems',
1849         api_name        => 'open-ils.acq.purchase_order.split_by_lineitems',
1850         signature => {
1851         desc => q/Splits a PO into many POs, 1 per lineitem.  Only works for
1852         POs a) with more than one lineitems, and b) in the "pending" state./,
1853         params => [
1854             {desc => 'Authentication token', type => 'string'},
1855             {desc => 'Purchase order ID', type => 'number'}
1856         ],
1857         return => {desc => 'list of new PO IDs on success, Event on error'}
1858     }
1859 );
1860
1861 sub split_purchase_order_by_lineitems {
1862     my ($self, $conn, $auth, $po_id) = @_;
1863
1864     my $e = new_editor("xact" => 1, "authtoken" => $auth);
1865     return $e->die_event unless $e->checkauth;
1866
1867     my $po = $e->retrieve_acq_purchase_order([
1868         $po_id, {
1869             "flesh" => 1,
1870             "flesh_fields" => {"acqpo" => [qw/lineitems notes/]}
1871         }
1872     ]) or return $e->die_event;
1873
1874     return $e->die_event
1875         unless $e->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
1876
1877     unless ($po->state eq "pending") {
1878         $e->rollback;
1879         return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_LATE");
1880     }
1881
1882     unless (@{$po->lineitems} > 1) {
1883         $e->rollback;
1884         return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_SHORT");
1885     }
1886
1887     # To split an existing PO into many, it seems unwise to just delete the
1888     # original PO, so we'll instead detach all of the original POs' lineitems
1889     # but the first, then create new POs for each of the remaining LIs, and
1890     # then attach the LIs to their new POs.
1891
1892     my @po_ids = ($po->id);
1893     my @moving_li = @{$po->lineitems};
1894     shift @moving_li;    # discard first LI
1895
1896     foreach my $li (@moving_li) {
1897         my $new_po = $po->clone;
1898         $new_po->clear_id;
1899         $new_po->clear_name;
1900         $new_po->creator($e->requestor->id);
1901         $new_po->editor($e->requestor->id);
1902         $new_po->owner($e->requestor->id);
1903         $new_po->edit_time("now");
1904         $new_po->create_time("now");
1905
1906         $new_po = $e->create_acq_purchase_order($new_po);
1907
1908         # Clone any notes attached to the old PO and attach to the new one.
1909         foreach my $note (@{$po->notes}) {
1910             my $new_note = $note->clone;
1911             $new_note->clear_id;
1912             $new_note->edit_time("now");
1913             $new_note->purchase_order($new_po->id);
1914             $e->create_acq_po_note($new_note);
1915         }
1916
1917         $li->edit_time("now");
1918         $li->purchase_order($new_po->id);
1919         $e->update_acq_lineitem($li);
1920
1921         push @po_ids, $new_po->id;
1922     }
1923
1924     $po->edit_time("now");
1925     $e->update_acq_purchase_order($po);
1926
1927     return \@po_ids if $e->commit;
1928     return $e->die_event;
1929 }
1930
1931
1932 1;