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;
8 my($class, %args) = @_;
9 my $self = bless(\%args, $class);
17 purchase_order => undef,
23 $self->{ingest_queue} = [];
25 $self->throttle(5) unless $self->throttle;
26 $self->{post_proc_queue} = [];
27 $self->{last_respond_progress} = 0;
33 $self->{conn} = $val if $val;
38 $self->{throttle} = $val if $val;
39 return $self->{throttle};
42 my($self, %other_args) = @_;
43 if($self->throttle and not %other_args) {
45 ($self->{args}->{progress} - $self->{last_respond_progress}) >= $self->throttle
48 $self->conn->respond({ %{$self->{args}}, %other_args });
49 $self->{last_respond_progress} = $self->{args}->{progress};
51 sub respond_complete {
52 my($self, %other_args) = @_;
54 $self->conn->respond_complete({ %{$self->{args}}, %other_args });
55 $self->run_post_response_hooks;
59 # run the post response hook subs, shifting them off as we go
60 sub run_post_response_hooks {
62 (shift @{$self->{post_proc_queue}})->() while @{$self->{post_proc_queue}};
65 # any subs passed to this method will be run after the call to respond_complete
68 push(@{$self->{post_proc_queue}}, $sub);
73 $self->{args}->{total} = $val if defined $val;
74 $self->{args}->{maximum} = $self->{args}->{total};
75 return $self->{args}->{total};
79 $self->{args}->{purchase_order} = $val if $val;
84 $self->{args}->{picklist} = $val if $val;
89 $self->{args}->{lid} += 1;
90 $self->{args}->{progress} += 1;
95 $self->{args}->{li} += 1;
96 $self->{args}->{progress} += 1;
101 $self->{args}->{copies} += 1;
102 $self->{args}->{progress} += 1;
107 $self->{args}->{bibs} += 1;
108 $self->{args}->{progress} += 1;
112 my($self, $amount) = @_;
113 $self->{args}->{debits_accrued} += $amount;
114 $self->{args}->{progress} += 1;
118 my($self, $editor) = @_;
119 $self->{editor} = $editor if defined $editor;
120 return $self->{editor};
124 $self->{args}->{complete} = 1;
129 my($self, $val) = @_;
130 $self->{ingest_ses} = $val if $val;
131 return $self->{ingest_ses};
134 sub push_ingest_queue {
135 my($self, $rec_id) = @_;
137 $self->ingest_ses(OpenSRF::AppSession->connect('open-ils.ingest'))
138 unless $self->ingest_ses;
140 my $req = $self->ingest_ses->request('open-ils.ingest.full.biblio.record', $rec_id);
142 push(@{$self->{ingest_queue}}, $req);
145 sub process_ingest_records {
147 return unless @{$self->{ingest_queue}};
149 for my $req (@{$self->{ingest_queue}}) {
153 $self->{args}->{indexed} += 1;
154 $self->{args}->{progress} += 1;
159 $self->ingest_ses->disconnect;
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};
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 # ----------------------------------------------------------------------------
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;
192 my $U = 'OpenILS::Application::AppUtils';
195 # ----------------------------------------------------------------------------
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');
207 $li->$_($args{$_}) for keys %args;
210 $mgr->editor->create_acq_lineitem($li) or return 0;
212 unless($li->estimated_unit_price) {
213 # extract the price from the MARC data
214 my $price = get_li_price_from_attr($mgr->editor, $li) or return $li;
215 $li->estimated_unit_price($price);
216 return update_lineitem($mgr, $li);
222 sub get_li_price_from_attr {
224 my $attrs = $li->attributes || $e->search_acq_lineitem_attr({lineitem => $li->id});
226 for my $attr_type (qw/
227 lineitem_local_attr_definition
228 lineitem_prov_attr_definition
229 lineitem_marc_attr_definition/) {
232 $_->attr_name eq 'estimated_price' and
233 $_->attr_type eq $attr_type } @$attrs;
235 return $attr->attr_value if $attr;
242 sub update_lineitem {
244 $li->edit_time('now');
245 $li->editor($mgr->editor->requestor->id);
247 return $mgr->editor->retrieve_acq_lineitem($mgr->editor->data) if
248 $mgr->editor->update_acq_lineitem($li);
253 # ----------------------------------------------------------------------------
254 # Create real holds from patron requests for a given lineitem
255 # ----------------------------------------------------------------------------
256 sub promote_lineitem_holds {
259 my $requests = $mgr->editor->search_acq_user_request(
260 { lineitem => $li->id,
262 [ { need_before => {'>' => 'now'} },
263 { need_before => undef }
268 for my $request ( @$requests ) {
270 $request->eg_bib( $li->eg_bib_id );
271 $mgr->editor->update_acq_user_request( $request ) or return 0;
273 next unless ($U->is_true( $request->hold ));
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 );
286 if ($request->holdable_formats) {
287 my $mrm = $mgr->editor->search_metabib_metarecord_source_map( { source => $li->eg_bib_id } )->[0];
289 $hold->hold_type( 'M' );
290 $hold->holdable_formats( $request->holdable_formats );
291 $hold->target( $mrm->metarecord );
295 if (!$hold->target) {
296 $hold->hold_type( 'T' );
297 $hold->target( $li->eg_bib_id );
300 $mgr->editor->create_actor_hold_request( $hold ) or return 0;
306 sub delete_lineitem {
308 $li = $mgr->editor->retrieve_acq_lineitem($li) unless ref $li;
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);
317 return $mgr->editor->delete_acq_lineitem($li);
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);
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};
334 $mgr->process_ingest_records;
338 # returns event on error, undef on success
339 sub check_import_li_marc_perms {
340 my($mgr, $li_ids) = @_;
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];
348 return $mgr->editor->die_event unless
349 $mgr->editor->allowed('IMPORT_ACQ_LINEITEM_BIB_RECORD');
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 # ----------------------------------------------------------------------------
362 sub describe_affected_po {
366 OpenILS::Application::Acq::Financials::build_price_summary(
371 "state" => $po->state,
372 "amount_encumbered" => $enc,
373 "amount_spent" => $spent
378 sub check_lineitem_received {
379 my($mgr, $li_id) = @_;
381 my $non_recv = $mgr->editor->search_acq_lineitem_detail(
382 {recv_time => undef, lineitem => $li_id}, {idlist=>1});
384 return 1 if @$non_recv;
386 my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
387 $li->state('received');
388 return update_lineitem($mgr, $li);
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;
395 my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
396 {lineitem => $li_id, recv_time => undef}, {idlist => 1});
398 for my $lid_id (@$lid_ids) {
399 receive_lineitem_detail($mgr, $lid_id, 1) or return 0;
403 $li->state('received');
405 $li = update_lineitem($mgr, $li) or return 0;
406 $mgr->post_process( sub { create_lineitem_status_events($mgr, $li_id, 'aur.received'); });
410 $skip_complete_check or (
411 $po = check_purchase_order_received($mgr, $li->purchase_order)
414 my $result = {"li" => {$li->id => {"state" => $li->state}}};
415 $result->{"po"} = describe_affected_po($mgr->editor, $po) if ref $po;
419 sub rollback_receive_lineitem {
420 my($mgr, $li_id) = @_;
421 my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
423 my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
424 {lineitem => $li_id, recv_time => {'!=' => undef}}, {idlist => 1});
426 for my $lid_id (@$lid_ids) {
427 rollback_receive_lineitem_detail($mgr, $lid_id, 1) or return 0;
431 $li->state('on-order');
432 return update_lineitem($mgr, $li);
436 sub create_lineitem_status_events {
437 my($mgr, $li_id, $hook) = @_;
439 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
441 my $user_reqs = $mgr->editor->search_acq_user_request([
442 {lineitem => $li_id},
443 {flesh => 1, flesh_fields => {aur => ['usr']}}
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);
455 # ----------------------------------------------------------------------------
457 # ----------------------------------------------------------------------------
458 sub create_lineitem_detail {
459 my($mgr, %args) = @_;
460 my $lid = Fieldmapper::acq::lineitem_detail->new;
461 $lid->$_($args{$_}) for keys %args;
464 return $mgr->editor->create_acq_lineitem_detail($lid);
468 # flesh out any required data with default values where appropriate
469 sub complete_lineitem_detail {
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);
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);
481 if(!$lid->location and my $loc = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.default_copy_location')) {
482 $lid->location($loc);
485 $lid->circ_modifier(get_default_circ_modifier($mgr, $lid->owning_lib))
486 unless defined $lid->circ_modifier;
488 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
492 sub get_default_circ_modifier {
494 my $code = $mgr->cache($org, 'def_circ_mod');
495 $code = $U->ou_ancestor_setting_value($org, 'acq.default_circ_modifier') unless defined $code;
496 return $mgr->cache($org, 'def_circ_mod', $code) if defined $code;
500 sub delete_lineitem_detail {
502 $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid) unless ref $lid;
503 return $mgr->editor->delete_acq_lineitem_detail($lid);
507 sub receive_lineitem_detail {
508 my($mgr, $lid_id, $skip_complete_check) = @_;
509 my $e = $mgr->editor;
511 my $lid = $e->retrieve_acq_lineitem_detail([
515 acqlid => ['fund_debit']
520 return 1 if $lid->recv_time;
522 $lid->recv_time('now');
523 $e->update_acq_lineitem_detail($lid) or return 0;
525 my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
526 $copy->status(OILS_COPY_STATUS_IN_PROCESS);
527 $copy->edit_date('now');
528 $copy->editor($e->requestor->id);
529 $e->update_asset_copy($copy) or return 0;
533 return 1 if $skip_complete_check;
535 my $li = check_lineitem_received($mgr, $lid->lineitem) or return 0;
536 return 1 if $li == 1; # li not received
538 return check_purchase_order_received($mgr, $li->purchase_order) or return 0;
542 sub rollback_receive_lineitem_detail {
543 my($mgr, $lid_id) = @_;
544 my $e = $mgr->editor;
546 my $lid = $e->retrieve_acq_lineitem_detail([
550 acqlid => ['fund_debit']
555 return 1 unless $lid->recv_time;
557 $lid->clear_recv_time;
558 $e->update_acq_lineitem_detail($lid) or return 0;
560 my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
561 $copy->status(OILS_COPY_STATUS_ON_ORDER);
562 $copy->edit_date('now');
563 $copy->editor($e->requestor->id);
564 $e->update_asset_copy($copy) or return 0;
570 # ----------------------------------------------------------------------------
572 # ----------------------------------------------------------------------------
573 sub set_lineitem_attr {
574 my($mgr, %args) = @_;
575 my $attr_type = $args{attr_type};
577 # first, see if it's already set. May just need to overwrite it
578 my $attr = $mgr->editor->search_acq_lineitem_attr({
579 lineitem => $args{lineitem},
580 attr_type => $args{attr_type},
581 attr_name => $args{attr_name}
585 $attr->attr_value($args{attr_value});
586 return $attr if $mgr->editor->update_acq_lineitem_attr($attr);
591 $attr = Fieldmapper::acq::lineitem_attr->new;
592 $attr->$_($args{$_}) for keys %args;
594 unless($attr->definition) {
595 my $find = "search_acq_$attr_type";
596 my $attr_def_id = $mgr->editor->$find({code => $attr->attr_name}, {idlist=>1})->[0] or return 0;
597 $attr->definition($attr_def_id);
599 return $mgr->editor->create_acq_lineitem_attr($attr);
603 # ----------------------------------------------------------------------------
605 # ----------------------------------------------------------------------------
606 sub create_lineitem_debits {
607 my ($mgr, $li, $dry_run) = @_;
609 unless($li->estimated_unit_price) {
610 $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PRICE', payload => $li->id));
611 $mgr->editor->rollback;
615 unless($li->provider) {
616 $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PROVIDER', payload => $li->id));
617 $mgr->editor->rollback;
621 my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
622 {lineitem => $li->id},
626 for my $lid_id (@$lid_ids) {
628 my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
631 flesh_fields => {acqlid => ['fund']}
635 create_lineitem_detail_debit($mgr, $li, $lid, $dry_run) or return 0;
644 sub create_lineitem_detail_debit {
645 my ($mgr, $li, $lid, $dry_run, $no_translate) = @_;
647 # don't create the debit if one already exists
648 return $mgr->editor->retrieve_acq_fund_debit($lid->fund_debit) if $lid->fund_debit;
650 my $li_id = ref($li) ? $li->id : $li;
652 unless(ref $li and ref $li->provider) {
653 $li = $mgr->editor->retrieve_acq_lineitem([
656 flesh_fields => {jub => ['provider']},
662 $lid->fund($mgr->editor->retrieve_acq_fund($lid->fund)) unless(ref $lid->fund);
664 $lid = $mgr->editor->retrieve_acq_lineitem_detail([
667 flesh_fields => {acqlid => ['fund']}
672 unless ($lid->fund) {
674 new OpenILS::Event("ACQ_FUND_NOT_FOUND") # close enough
679 my $amount = $li->estimated_unit_price;
680 if($li->provider->currency_type ne $lid->fund->currency_type and !$no_translate) {
682 # At Fund debit creation time, translate into the currency of the fund
683 # TODO: org setting to disable automatic currency conversion at debit create time?
685 $amount = $mgr->editor->json_query({
687 'acq.exchange_ratio',
688 $li->provider->currency_type, # source currency
689 $lid->fund->currency_type, # destination currency
690 $li->estimated_unit_price # source amount
695 my $debit = create_fund_debit(
698 fund => $lid->fund->id,
699 origin_amount => $li->estimated_unit_price,
700 origin_currency_type => $li->provider->currency_type,
704 $lid->fund_debit($debit->id);
705 $lid->fund($lid->fund->id);
706 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
711 __PACKAGE__->register_method(
712 "method" => "fund_exceeds_balance_percent_api",
713 "api_name" => "open-ils.acq.fund.check_balance_percentages",
715 "desc" => q/Determine whether a given fund exceeds its defined
716 "balance stop and warning percentages"/,
718 {"desc" => "Authentication token", "type" => "string"},
719 {"desc" => "Fund ID", "type" => "number"},
720 {"desc" => "Theoretical debit amount (optional)",
723 "return" => {"desc" => q/An array of two values, for stop and warning,
724 in that order: 1 if fund exceeds that balance percentage, else 0/}
728 sub fund_exceeds_balance_percent_api {
729 my ($self, $conn, $auth, $fund_id, $debit_amount) = @_;
733 my $e = new_editor("authtoken" => $auth);
734 return $e->die_event unless $e->checkauth;
736 my $fund = $e->retrieve_acq_fund($fund_id) or return $e->die_event;
737 return $e->die_event unless $e->allowed("VIEW_FUND", $fund->org);
740 fund_exceeds_balance_percent($fund, $debit_amount, $e, "stop"),
741 fund_exceeds_balance_percent($fund, $debit_amount, $e, "warning")
748 sub fund_exceeds_balance_percent {
749 my ($fund, $debit_amount, $e, $which) = @_;
751 my ($method_name, $event_name) = @{{
753 "balance_warning_percent", "ACQ_FUND_EXCEEDS_WARN_PERCENT"
756 "balance_stop_percent", "ACQ_FUND_EXCEEDS_STOP_PERCENT"
760 if ($fund->$method_name) {
762 $e->search_acq_fund_combined_balance({"fund" => $fund->id})->[0];
764 $e->search_acq_fund_allocation_total({"fund" => $fund->id})->[0];
766 $balance = ($balance) ? $balance->amount : 0;
767 $allocations = ($allocations) ? $allocations->amount : 0;
770 $allocations == 0 || # if no allocations were ever made, assume we have hit the stop percent
771 ((($allocations - $balance + $debit_amount) / $allocations) * 100) > $fund->$method_name
773 $logger->info("fund would hit a limit: " . $fund->id . ", $balance, $debit_amount, $allocations, $method_name");
778 "fund" => $fund, "debit_amount" => $debit_amount
788 # ----------------------------------------------------------------------------
790 # ----------------------------------------------------------------------------
791 sub create_fund_debit {
792 my($mgr, $dry_run, %args) = @_;
794 # Verify the fund is not being spent beyond the hard stop amount
795 my $fund = $mgr->editor->retrieve_acq_fund($args{fund}) or return 0;
798 fund_exceeds_balance_percent(
799 $fund, $args{"amount"}, $mgr->editor, "stop"
802 $dry_run and fund_exceeds_balance_percent(
803 $fund, $args{"amount"}, $mgr->editor, "warning"
806 my $debit = Fieldmapper::acq::fund_debit->new;
807 $debit->debit_type('purchase');
808 $debit->encumbrance('t');
809 $debit->$_($args{$_}) for keys %args;
811 $mgr->add_debit($debit->amount);
812 return $mgr->editor->create_acq_fund_debit($debit);
816 # ----------------------------------------------------------------------------
818 # ----------------------------------------------------------------------------
819 sub create_picklist {
820 my($mgr, %args) = @_;
821 my $picklist = Fieldmapper::acq::picklist->new;
822 $picklist->creator($mgr->editor->requestor->id);
823 $picklist->owner($picklist->creator);
824 $picklist->editor($picklist->creator);
825 $picklist->create_time('now');
826 $picklist->edit_time('now');
827 $picklist->org_unit($mgr->editor->requestor->ws_ou);
828 $picklist->owner($mgr->editor->requestor->id);
829 $picklist->$_($args{$_}) for keys %args;
831 $mgr->picklist($picklist);
832 return $mgr->editor->create_acq_picklist($picklist);
835 sub update_picklist {
836 my($mgr, $picklist) = @_;
837 $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
838 $picklist->edit_time('now');
839 $picklist->editor($mgr->editor->requestor->id);
840 if ($mgr->editor->update_acq_picklist($picklist)) {
841 $picklist = $mgr->editor->retrieve_acq_picklist($mgr->editor->data);
842 $mgr->picklist($picklist);
849 sub delete_picklist {
850 my($mgr, $picklist) = @_;
851 $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
853 # delete all 'new' lineitems
854 my $li_ids = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => 'new'}, {idlist => 1});
855 for my $li_id (@$li_ids) {
856 my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
857 return 0 unless delete_lineitem($mgr, $li);
861 # detach all non-'new' lineitems
862 $li_ids = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => {'!=' => 'new'}}, {idlist => 1});
863 for my $li_id (@$li_ids) {
864 my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
866 return 0 unless update_lineitem($mgr, $li);
870 # remove any picklist-specific object perms
871 my $ops = $mgr->editor->search_permission_usr_object_perm_map({object_type => 'acqpl', object_id => ''.$picklist->id});
873 return 0 unless $mgr->editor->delete_usr_object_perm_map($op);
876 return $mgr->editor->delete_acq_picklist($picklist);
879 # ----------------------------------------------------------------------------
881 # ----------------------------------------------------------------------------
882 sub update_purchase_order {
884 $po = $mgr->editor->retrieve_acq_purchase_order($po) unless ref $po;
885 $po->editor($mgr->editor->requestor->id);
886 $po->edit_time('now');
887 $mgr->purchase_order($po);
888 return $mgr->editor->retrieve_acq_purchase_order($mgr->editor->data)
889 if $mgr->editor->update_acq_purchase_order($po);
893 sub create_purchase_order {
894 my($mgr, %args) = @_;
896 # verify the chosen provider is still active
897 my $provider = $mgr->editor->retrieve_acq_provider($args{provider}) or return 0;
898 unless($U->is_true($provider->active)) {
899 $logger->error("provider is not active. cannot create PO");
900 $mgr->editor->event(OpenILS::Event->new('ACQ_PROVIDER_INACTIVE'));
904 my $po = Fieldmapper::acq::purchase_order->new;
905 $po->creator($mgr->editor->requestor->id);
906 $po->editor($mgr->editor->requestor->id);
907 $po->owner($mgr->editor->requestor->id);
908 $po->edit_time('now');
909 $po->create_time('now');
910 $po->state('pending');
911 $po->ordering_agency($mgr->editor->requestor->ws_ou);
912 $po->$_($args{$_}) for keys %args;
914 $mgr->purchase_order($po);
915 return $mgr->editor->create_acq_purchase_order($po);
918 # ----------------------------------------------------------------------------
919 # if all of the lineitems for this PO are received,
920 # mark the PO as received
921 # ----------------------------------------------------------------------------
922 sub check_purchase_order_received {
923 my($mgr, $po_id) = @_;
925 my $non_recv_li = $mgr->editor->search_acq_lineitem(
926 { purchase_order => $po_id,
927 state => {'!=' => 'received'}
930 my $po = $mgr->editor->retrieve_acq_purchase_order($po_id);
931 return $po if @$non_recv_li;
933 $po->state('received');
934 return update_purchase_order($mgr, $po);
938 # ----------------------------------------------------------------------------
939 # Bib, Callnumber, and Copy data
940 # ----------------------------------------------------------------------------
942 sub create_lineitem_assets {
943 my($mgr, $li_id) = @_;
946 my $li = $mgr->editor->retrieve_acq_lineitem([
949 flesh_fields => {jub => ['purchase_order', 'attributes']}
953 # -----------------------------------------------------------------
954 # first, create the bib record if necessary
955 # -----------------------------------------------------------------
957 unless($li->eg_bib_id) {
958 create_bib($mgr, $li) or return 0;
963 # -----------------------------------------------------------------
964 # The lineitem is going live, promote user request holds to real holds
965 # -----------------------------------------------------------------
966 promote_lineitem_holds($mgr, $li) or return 0;
968 my $li_details = $mgr->editor->search_acq_lineitem_detail({lineitem => $li_id}, {idlist=>1});
970 # -----------------------------------------------------------------
971 # for each lineitem_detail, create the volume if necessary, create
972 # a copy, and link them all together.
973 # -----------------------------------------------------------------
975 for my $lid_id (@{$li_details}) {
977 my $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid_id) or return 0;
978 next if $lid->eg_copy_id;
980 # use the same callnumber label for all items within this lineitem
981 $lid->cn_label($first_cn) if $first_cn and not $lid->cn_label;
983 # apply defaults if necessary
984 return 0 unless complete_lineitem_detail($mgr, $lid);
986 $first_cn = $lid->cn_label unless $first_cn;
988 my $org = $lid->owning_lib;
989 my $label = $lid->cn_label;
990 my $bibid = $li->eg_bib_id;
992 my $volume = $mgr->cache($org, "cn.$bibid.$label");
994 $volume = create_volume($mgr, $li, $lid) or return 0;
995 $mgr->cache($org, "cn.$bibid.$label", $volume);
997 create_copy($mgr, $volume, $lid, $li) or return 0;
1000 return { li => $li, new_bib => $new_bib };
1006 my $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1011 1, # override tcn collisions
1014 if($U->event_code($record)) {
1015 $mgr->editor->event($record);
1016 $mgr->editor->rollback;
1020 $li->eg_bib_id($record->id);
1022 return update_lineitem($mgr, $li);
1026 my($mgr, $li, $lid) = @_;
1028 my ($volume, $evt) =
1029 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1037 $mgr->editor->event($evt);
1045 my($mgr, $volume, $lid, $li) = @_;
1046 my $copy = Fieldmapper::asset::copy->new;
1048 $copy->loan_duration(2);
1049 $copy->fine_level(2);
1050 $copy->status(($lid->recv_time) ? OILS_COPY_STATUS_IN_PROCESS : OILS_COPY_STATUS_ON_ORDER);
1051 $copy->barcode($lid->barcode);
1052 $copy->location($lid->location);
1053 $copy->call_number($volume->id);
1054 $copy->circ_lib($volume->owning_lib);
1055 $copy->circ_modifier($lid->circ_modifier);
1057 # AKA list price. We might need a $li->list_price field since
1058 # estimated price is not necessarily the same as list price
1059 $copy->price($li->estimated_unit_price);
1061 my $evt = OpenILS::Application::Cat::AssetCommon->create_copy($mgr->editor, $volume, $copy);
1063 $mgr->editor->event($evt);
1068 $lid->eg_copy_id($copy->id);
1069 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
1077 # ----------------------------------------------------------------------------
1078 # Workflow: Build a selection list from a Z39.50 search
1079 # ----------------------------------------------------------------------------
1081 __PACKAGE__->register_method(
1082 method => 'zsearch',
1083 api_name => 'open-ils.acq.picklist.search.z3950',
1086 desc => 'Performs a z3950 federated search and creates a picklist and associated lineitems',
1088 {desc => 'Authentication token', type => 'string'},
1089 {desc => 'Search definition', type => 'object'},
1090 {desc => 'Picklist name, optional', type => 'string'},
1096 my($self, $conn, $auth, $search, $name, $options) = @_;
1097 my $e = new_editor(authtoken=>$auth);
1098 return $e->event unless $e->checkauth;
1099 return $e->event unless $e->allowed('CREATE_PICKLIST');
1101 $search->{limit} ||= 10;
1104 my $ses = OpenSRF::AppSession->create('open-ils.search');
1105 my $req = $ses->request('open-ils.search.z3950.search_class', $auth, $search);
1110 while(my $resp = $req->recv(timeout=>60)) {
1113 my $e = new_editor(requestor=>$e->requestor, xact=>1);
1114 $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1115 $picklist = zsearch_build_pl($mgr, $name);
1119 my $result = $resp->content;
1120 my $count = $result->{count} || 0;
1121 $mgr->total( (($count < $search->{limit}) ? $count : $search->{limit})+1 );
1123 for my $rec (@{$result->{records}}) {
1125 my $li = create_lineitem($mgr,
1126 picklist => $picklist->id,
1127 source_label => $result->{service},
1128 marc => $rec->{marcxml},
1129 eg_bib_id => $rec->{bibid}
1132 if($$options{respond_li}) {
1133 $li->attributes($mgr->editor->search_acq_lineitem_attr({lineitem => $li->id}))
1134 if $$options{flesh_attrs};
1135 $li->clear_marc if $$options{clear_marc};
1136 $mgr->respond(lineitem => $li);
1143 $mgr->editor->commit;
1144 return $mgr->respond_complete;
1147 sub zsearch_build_pl {
1148 my($mgr, $name) = @_;
1151 my $picklist = $mgr->editor->search_acq_picklist({
1152 owner => $mgr->editor->requestor->id,
1156 if($name eq '' and $picklist) {
1157 return 0 unless delete_picklist($mgr, $picklist);
1161 return update_picklist($mgr, $picklist) if $picklist;
1162 return create_picklist($mgr, name => $name);
1166 # ----------------------------------------------------------------------------
1167 # Workflow: Build a selection list / PO by importing a batch of MARC records
1168 # ----------------------------------------------------------------------------
1170 __PACKAGE__->register_method(
1171 method => 'upload_records',
1172 api_name => 'open-ils.acq.process_upload_records',
1176 sub upload_records {
1177 my($self, $conn, $auth, $key) = @_;
1179 my $e = new_editor(authtoken => $auth, xact => 1);
1180 return $e->die_event unless $e->checkauth;
1181 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1183 my $cache = OpenSRF::Utils::Cache->new;
1185 my $data = $cache->get_cache("vandelay_import_spool_$key");
1186 my $purpose = $data->{purpose};
1187 my $filename = $data->{path};
1188 my $provider = $data->{provider};
1189 my $picklist = $data->{picklist};
1190 my $create_po = $data->{create_po};
1191 my $activate_po = $data->{activate_po};
1192 my $ordering_agency = $data->{ordering_agency};
1193 my $create_assets = $data->{create_assets};
1197 unless(-r $filename) {
1198 $logger->error("unable to read MARC file $filename");
1200 return OpenILS::Event->new('FILE_UPLOAD_ERROR', payload => {filename => $filename});
1203 $provider = $e->retrieve_acq_provider($provider) or return $e->die_event;
1206 $picklist = $e->retrieve_acq_picklist($picklist) or return $e->die_event;
1207 if($picklist->owner != $e->requestor->id) {
1208 return $e->die_event unless
1209 $e->allowed('CREATE_PICKLIST', $picklist->org_unit, $picklist);
1211 $mgr->picklist($picklist);
1216 $po = create_purchase_order($mgr,
1217 ordering_agency => $ordering_agency,
1218 provider => $provider->id,
1220 ) or return $mgr->editor->die_event;
1223 $logger->info("acq processing MARC file=$filename");
1225 my $batch = new MARC::Batch ('USMARC', $filename);
1233 my ($err, $xml, $r);
1238 } catch Error with {
1240 $logger->warn("Proccessing of record $count in set $key failed with error $err. Skipping this record");
1247 ($xml = $r->as_xml_record()) =~ s/\n//sog;
1248 $xml =~ s/^<\?xml.+\?\s*>//go;
1249 $xml =~ s/>\s+</></go;
1250 $xml =~ s/\p{Cc}//go;
1251 $xml = $U->entityize($xml);
1252 $xml =~ s/[\x00-\x1f]//go;
1254 } catch Error with {
1256 $logger->warn("Proccessing XML of record $count in set $key failed with error $err. Skipping this record");
1259 next if $err or not $xml;
1262 source_label => $provider->code,
1263 provider => $provider->id,
1267 $args{picklist} = $picklist->id if $picklist;
1269 $args{purchase_order} = $po->id;
1270 $args{state} = 'pending-order';
1273 my $li = create_lineitem($mgr, %args) or return $mgr->editor->die_event;
1275 $li->provider($provider); # flesh it, we'll need it later
1277 import_lineitem_details($mgr, $ordering_agency, $li) or return $mgr->editor->die_event;
1280 push(@li_list, $li->id);
1284 my $die_event = activate_purchase_order_impl($mgr, $po->id) if $po and $activate_po;
1285 return $die_event if $die_event;
1289 $cache->delete_cache('vandelay_import_spool_' . $key);
1291 if ($create_assets) {
1292 create_lineitem_list_assets($mgr, \@li_list) or return $e->die_event;
1295 return $mgr->respond_complete;
1298 sub import_lineitem_details {
1299 my($mgr, $ordering_agency, $li) = @_;
1301 my $holdings = $mgr->editor->json_query({from => ['acq.extract_provider_holding_data', $li->id]});
1302 return 1 unless @$holdings;
1303 my $org_path = $U->get_org_ancestors($ordering_agency);
1304 $org_path = [ reverse (@$org_path) ];
1310 # create a lineitem detail for each copy in the data
1312 my $compiled = extract_lineitem_detail_data($mgr, $org_path, $holdings, $idx);
1313 last unless defined $compiled;
1314 return 0 unless $compiled;
1316 # this takes the price of the last copy and uses it as the lineitem price
1317 # need to determine if a given record would include different prices for the same item
1318 $price = $$compiled{estimated_price};
1320 last unless $$compiled{quantity};
1322 for(1..$$compiled{quantity}) {
1323 my $lid = create_lineitem_detail(
1325 lineitem => $li->id,
1326 owning_lib => $$compiled{owning_lib},
1327 cn_label => $$compiled{call_number},
1328 fund => $$compiled{fund},
1329 circ_modifier => $$compiled{circ_modifier},
1330 note => $$compiled{note},
1331 location => $$compiled{copy_location},
1332 collection_code => $$compiled{collection_code}
1340 $li->estimated_unit_price($price);
1341 update_lineitem($mgr, $li) or return 0;
1345 # return hash on success, 0 on error, undef on no more holdings
1346 sub extract_lineitem_detail_data {
1347 my($mgr, $org_path, $holdings, $index) = @_;
1349 my @data_list = grep { $_->{holding} eq $index } @$holdings;
1350 return undef unless @data_list;
1352 my %compiled = map { $_->{attr} => $_->{data} } @data_list;
1353 my $base_org = $$org_path[0];
1357 $logger->error("Item import extraction error: $msg");
1358 $logger->error('Holdings Data: ' . OpenSRF::Utils::JSON->perl2JSON(\%compiled));
1359 $mgr->editor->rollback;
1360 $mgr->editor->event(OpenILS::Event->new('ACQ_IMPORT_ERROR', payload => $msg));
1364 # ---------------------------------------------------------------------
1366 if(my $code = $compiled{fund_code}) {
1368 my $fund = $mgr->cache($base_org, "fund.$code");
1370 # search up the org tree for the most appropriate fund
1371 for my $org (@$org_path) {
1372 $fund = $mgr->editor->search_acq_fund(
1373 {org => $org, code => $code, year => DateTime->now->year}, {idlist => 1})->[0];
1377 return $killme->("no fund with code $code at orgs [@$org_path]") unless $fund;
1378 $compiled{fund} = $fund;
1379 $mgr->cache($base_org, "fund.$code", $fund);
1383 # ---------------------------------------------------------------------
1385 if(my $sn = $compiled{owning_lib}) {
1386 my $org_id = $mgr->cache($base_org, "orgsn.$sn") ||
1387 $mgr->editor->search_actor_org_unit({shortname => $sn}, {idlist => 1})->[0];
1388 return $killme->("invalid owning_lib defined: $sn") unless $org_id;
1389 $compiled{owning_lib} = $org_id;
1390 $mgr->cache($$org_path[0], "orgsn.$sn", $org_id);
1394 # ---------------------------------------------------------------------
1396 my $code = $compiled{circ_modifier};
1400 # verify this is a valid circ modifier
1401 return $killme->("invlalid circ_modifier $code") unless
1402 defined $mgr->cache($base_org, "mod.$code") or
1403 $mgr->editor->retrieve_config_circ_modifier($code);
1405 # if valid, cache for future tests
1406 $mgr->cache($base_org, "mod.$code", $code);
1409 $compiled{circ_modifier} = get_default_circ_modifier($mgr, $base_org);
1413 # ---------------------------------------------------------------------
1415 if( my $name = $compiled{copy_location}) {
1416 my $loc = $mgr->cache($base_org, "copy_loc.$name");
1418 for my $org (@$org_path) {
1419 $loc = $mgr->editor->search_asset_copy_location(
1420 {owning_lib => $org, name => $name}, {idlist => 1})->[0];
1424 return $killme->("Invalid copy location $name") unless $loc;
1425 $compiled{copy_location} = $loc;
1426 $mgr->cache($base_org, "copy_loc.$name", $loc);
1434 # ----------------------------------------------------------------------------
1435 # Workflow: Given an existing purchase order, import/create the bibs,
1436 # callnumber and copy objects
1437 # ----------------------------------------------------------------------------
1439 __PACKAGE__->register_method(
1440 method => 'create_po_assets',
1441 api_name => 'open-ils.acq.purchase_order.assets.create',
1443 desc => q/Creates assets for each lineitem in the purchase order/,
1445 {desc => 'Authentication token', type => 'string'},
1446 {desc => 'The purchase order id', type => 'number'},
1448 return => {desc => 'Streams a total versus completed counts object, event on error'}
1452 sub create_po_assets {
1453 my($self, $conn, $auth, $po_id) = @_;
1455 my $e = new_editor(authtoken=>$auth, xact=>1);
1456 return $e->die_event unless $e->checkauth;
1457 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1459 my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1461 my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1463 # it's ugly, but it's fast. Get the total count of lineitem detail objects to process
1464 my $lid_total = $e->json_query({
1465 select => { acqlid => [{aggregate => 1, transform => 'count', column => 'id'}] },
1471 join => {acqpo => {fkey => 'purchase_order', field => 'id'}}
1475 where => {'+acqpo' => {id => $po_id}}
1478 $mgr->total(scalar(@$li_ids) + $lid_total);
1480 create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1483 update_purchase_order($mgr, $po) or return $e->die_event;
1486 return $mgr->respond_complete;
1491 __PACKAGE__->register_method(
1492 method => 'create_purchase_order_api',
1493 api_name => 'open-ils.acq.purchase_order.create',
1495 desc => 'Creates a new purchase order',
1497 {desc => 'Authentication token', type => 'string'},
1498 {desc => 'purchase_order to create', type => 'object'}
1500 return => {desc => 'The purchase order id, Event on failure'}
1504 sub create_purchase_order_api {
1505 my($self, $conn, $auth, $po, $args) = @_;
1508 my $e = new_editor(xact=>1, authtoken=>$auth);
1509 return $e->die_event unless $e->checkauth;
1510 return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
1511 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1514 my %pargs = (ordering_agency => $e->requestor->ws_ou); # default
1515 $pargs{provider} = $po->provider if $po->provider;
1516 $pargs{ordering_agency} = $po->ordering_agency if $po->ordering_agency;
1517 $pargs{prepayment_required} = $po->prepayment_required if $po->prepayment_required;
1519 $po = create_purchase_order($mgr, %pargs) or return $e->die_event;
1521 my $li_ids = $$args{lineitems};
1525 for my $li_id (@$li_ids) {
1527 my $li = $e->retrieve_acq_lineitem([
1529 {flesh => 1, flesh_fields => {jub => ['attributes']}}
1530 ]) or return $e->die_event;
1532 $li->provider($po->provider);
1533 $li->purchase_order($po->id);
1534 $li->state('pending-order');
1535 update_lineitem($mgr, $li) or return $e->die_event;
1540 # commit before starting the asset creation
1543 if($li_ids and $$args{create_assets}) {
1544 create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1547 return $mgr->respond_complete;
1552 __PACKAGE__->register_method(
1553 method => 'update_lineitem_fund_batch',
1554 api_name => 'open-ils.acq.lineitem.fund.update.batch',
1557 desc => q/Given a set of lineitem IDS, updates the fund for all attached lineitem details/
1561 sub update_lineitem_fund_batch {
1562 my($self, $conn, $auth, $li_ids, $fund_id) = @_;
1563 my $e = new_editor(xact=>1, authtoken=>$auth);
1564 return $e->die_event unless $e->checkauth;
1565 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1566 for my $li_id (@$li_ids) {
1567 my ($li, $evt) = fetch_and_check_li($e, $li_id, 'write');
1568 return $evt if $evt;
1569 my $li_details = $e->search_acq_lineitem_detail({lineitem => $li_id});
1570 $_->fund($fund_id) and $_->ischanged(1) for @$li_details;
1571 $evt = lineitem_detail_CUD_batch($mgr, $li_details);
1572 return $evt if $evt;
1577 return $mgr->respond_complete;
1582 __PACKAGE__->register_method(
1583 method => 'lineitem_detail_CUD_batch_api',
1584 api_name => 'open-ils.acq.lineitem_detail.cud.batch',
1587 desc => q/Creates a new purchase order line item detail. / .
1588 q/Additionally creates the associated fund_debit/,
1590 {desc => 'Authentication token', type => 'string'},
1591 {desc => 'List of lineitem_details to create', type => 'array'},
1592 {desc => 'Create Debits. Used for creating post-po-asset-creation debits', type => 'bool'},
1594 return => {desc => 'Streaming response of current position in the array'}
1598 __PACKAGE__->register_method(
1599 method => 'lineitem_detail_CUD_batch_api',
1600 api_name => 'open-ils.acq.lineitem_detail.cud.batch.dry_run',
1604 Dry run version of open-ils.acq.lineitem_detail.cud.batch.
1605 In dry_run mode, updated fund_debit's the exceed the warning
1606 percent return an event.
1612 sub lineitem_detail_CUD_batch_api {
1613 my($self, $conn, $auth, $li_details, $create_debits) = @_;
1614 my $e = new_editor(xact=>1, authtoken=>$auth);
1615 return $e->die_event unless $e->checkauth;
1616 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1617 my $dry_run = ($self->api_name =~ /dry_run/o);
1618 my $evt = lineitem_detail_CUD_batch($mgr, $li_details, $create_debits, $dry_run);
1619 return $evt if $evt;
1621 return $mgr->respond_complete;
1625 sub lineitem_detail_CUD_batch {
1626 my($mgr, $li_details, $create_debits, $dry_run) = @_;
1628 $mgr->total(scalar(@$li_details));
1629 my $e = $mgr->editor;
1633 my $fund_cache = {};
1636 for my $lid (@$li_details) {
1638 unless($li = $li_cache{$lid->lineitem}) {
1639 ($li, $evt) = fetch_and_check_li($e, $lid->lineitem, 'write');
1640 return $evt if $evt;
1644 $lid = create_lineitem_detail($mgr, %{$lid->to_bare_hash}) or return $e->die_event;
1645 if($create_debits) {
1646 $li->provider($e->retrieve_acq_provider($li->provider)) or return $e->die_event;
1647 $lid->fund($e->retrieve_acq_fund($lid->fund)) or return $e->die_event;
1648 create_lineitem_detail_debit($mgr, $li, $lid, 0, 1) or return $e->die_event;
1651 } elsif($lid->ischanged) {
1652 return $evt if $evt = handle_changed_lid($e, $lid, $dry_run, $fund_cache);
1654 } elsif($lid->isdeleted) {
1655 delete_lineitem_detail($mgr, $lid) or return $e->die_event;
1658 $mgr->respond(li => $li);
1659 $li_cache{$lid->lineitem} = $li;
1665 sub handle_changed_lid {
1666 my($e, $lid, $dry_run, $fund_cache) = @_;
1668 my $orig_lid = $e->retrieve_acq_lineitem_detail($lid->id) or return $e->die_event;
1670 # updating the fund, so update the debit
1671 if($orig_lid->fund_debit and $orig_lid->fund != $lid->fund) {
1673 my $debit = $e->retrieve_acq_fund_debit($orig_lid->fund_debit);
1674 my $new_fund = $$fund_cache{$lid->fund} =
1675 $$fund_cache{$lid->fund} || $e->retrieve_acq_fund($lid->fund);
1677 # check the thresholds
1678 return $e->die_event if
1679 fund_exceeds_balance_percent($new_fund, $debit->amount, $e, "stop");
1680 return $e->die_event if $dry_run and
1681 fund_exceeds_balance_percent($new_fund, $debit->amount, $e, "warning");
1683 $debit->fund($new_fund->id);
1684 $e->update_acq_fund_debit($debit) or return $e->die_event;
1687 $e->update_acq_lineitem_detail($lid) or return $e->die_event;
1692 __PACKAGE__->register_method(
1693 method => 'receive_po_api',
1694 api_name => 'open-ils.acq.purchase_order.receive'
1697 sub receive_po_api {
1698 my($self, $conn, $auth, $po_id) = @_;
1699 my $e = new_editor(xact => 1, authtoken => $auth);
1700 return $e->die_event unless $e->checkauth;
1701 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1703 my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1704 return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1706 my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1708 for my $li_id (@$li_ids) {
1709 receive_lineitem($mgr, $li_id) or return $e->die_event;
1713 $po->state('received');
1714 update_purchase_order($mgr, $po) or return $e->die_event;
1717 return $mgr->respond_complete;
1721 # At the moment there's a lack of parallelism between the receive and unreceive
1722 # API methods for POs and the API methods for LIs and LIDs. The methods for
1723 # POs stream back objects as they act, whereas the methods for LIs and LIDs
1724 # atomically return an object that describes only what changed (in LIs and LIDs
1725 # themselves or in the objects to which to LIs and LIDs belong).
1727 # The methods for LIs and LIDs work the way they do to faciliate the UI's
1728 # maintaining correct information about the state of these things when a user
1729 # wants to receive or unreceive these objects without refreshing their whole
1730 # display. The UI feature for receiving and un-receiving a whole PO just
1731 # refreshes the whole display, so this absence of parallelism in the UI is also
1732 # relected in this module.
1734 # This could be neatened in the future by making POs receive and unreceive in
1735 # the same way the LIs and LIDs do.
1737 __PACKAGE__->register_method(
1738 method => 'receive_lineitem_detail_api',
1739 api_name => 'open-ils.acq.lineitem_detail.receive',
1741 desc => 'Mark a lineitem_detail as received',
1743 {desc => 'Authentication token', type => 'string'},
1744 {desc => 'lineitem detail ID', type => 'number'}
1747 "on success, object describing changes to LID and possibly " .
1748 "to LI and PO; on error, Event"
1753 sub receive_lineitem_detail_api {
1754 my($self, $conn, $auth, $lid_id) = @_;
1756 my $e = new_editor(xact=>1, authtoken=>$auth);
1757 return $e->die_event unless $e->checkauth;
1758 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1761 "flesh" => 2, "flesh_fields" => {
1762 "acqlid" => ["lineitem"], "jub" => ["purchase_order"]
1766 my $lid = $e->retrieve_acq_lineitem_detail([$lid_id, $fleshing]);
1768 return $e->die_event unless $e->allowed(
1769 'RECEIVE_PURCHASE_ORDER', $lid->lineitem->purchase_order->ordering_agency);
1772 my $recvd = receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1774 # .. and re-retrieve
1775 $lid = $e->retrieve_acq_lineitem_detail([$lid_id, $fleshing]);
1777 # Now build result data structure.
1778 my $result = {"lid" => {$lid->id => {"recv_time" => $lid->recv_time}}};
1781 if ($recvd->class_name =~ /::purchase_order/) {
1782 $result->{"po"} = describe_affected_po($e, $recvd);
1784 $lid->lineitem->id => {"state" => $lid->lineitem->state}
1786 } elsif ($recvd->class_name =~ /::lineitem/) {
1787 $result->{"li"} = {$recvd->id => {"state" => $recvd->state}};
1791 describe_affected_po($e, $lid->lineitem->purchase_order);
1797 __PACKAGE__->register_method(
1798 method => 'receive_lineitem_api',
1799 api_name => 'open-ils.acq.lineitem.receive',
1801 desc => 'Mark a lineitem as received',
1803 {desc => 'Authentication token', type => 'string'},
1804 {desc => 'lineitem ID', type => 'number'}
1807 "on success, object describing changes to LI and possibly PO; " .
1813 sub receive_lineitem_api {
1814 my($self, $conn, $auth, $li_id) = @_;
1816 my $e = new_editor(xact=>1, authtoken=>$auth);
1817 return $e->die_event unless $e->checkauth;
1818 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1820 my $li = $e->retrieve_acq_lineitem([
1824 jub => ['purchase_order']
1827 ]) or return $e->die_event;
1829 return $e->die_event unless $e->allowed(
1830 'RECEIVE_PURCHASE_ORDER', $li->purchase_order->ordering_agency);
1832 my $res = receive_lineitem($mgr, $li_id) or return $e->die_event;
1834 $conn->respond_complete($res);
1835 $mgr->run_post_response_hooks;
1839 __PACKAGE__->register_method(
1840 method => 'rollback_receive_po_api',
1841 api_name => 'open-ils.acq.purchase_order.receive.rollback'
1844 sub rollback_receive_po_api {
1845 my($self, $conn, $auth, $po_id) = @_;
1846 my $e = new_editor(xact => 1, authtoken => $auth);
1847 return $e->die_event unless $e->checkauth;
1848 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1850 my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1851 return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1853 my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1855 for my $li_id (@$li_ids) {
1856 rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1860 $po->state('on-order');
1861 update_purchase_order($mgr, $po) or return $e->die_event;
1864 return $mgr->respond_complete;
1868 __PACKAGE__->register_method(
1869 method => 'rollback_receive_lineitem_detail_api',
1870 api_name => 'open-ils.acq.lineitem_detail.receive.rollback',
1872 desc => 'Mark a lineitem_detail as Un-received',
1874 {desc => 'Authentication token', type => 'string'},
1875 {desc => 'lineitem detail ID', type => 'number'}
1878 "on success, object describing changes to LID and possibly " .
1879 "to LI and PO; on error, Event"
1884 sub rollback_receive_lineitem_detail_api {
1885 my($self, $conn, $auth, $lid_id) = @_;
1887 my $e = new_editor(xact=>1, authtoken=>$auth);
1888 return $e->die_event unless $e->checkauth;
1889 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1891 my $lid = $e->retrieve_acq_lineitem_detail([
1895 acqlid => ['lineitem'],
1896 jub => ['purchase_order']
1900 my $li = $lid->lineitem;
1901 my $po = $li->purchase_order;
1903 return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1907 my $recvd = rollback_receive_lineitem_detail($mgr, $lid_id)
1908 or return $e->die_event;
1911 $result->{"lid"} = {$recvd->id => {"recv_time" => $recvd->recv_time}};
1913 $result->{"lid"} = {$lid->id => {"recv_time" => $lid->recv_time}};
1916 if ($li->state eq "received") {
1917 $li->state("on-order");
1918 $li = update_lineitem($mgr, $li) or return $e->die_event;
1919 $result->{"li"} = {$li->id => {"state" => $li->state}};
1922 if ($po->state eq "received") {
1923 $po->state("on-order");
1924 $po = update_purchase_order($mgr, $po) or return $e->die_event;
1926 $result->{"po"} = describe_affected_po($e, $po);
1928 $e->commit and return $result or return $e->die_event;
1931 __PACKAGE__->register_method(
1932 method => 'rollback_receive_lineitem_api',
1933 api_name => 'open-ils.acq.lineitem.receive.rollback',
1935 desc => 'Mark a lineitem as Un-received',
1937 {desc => 'Authentication token', type => 'string'},
1938 {desc => 'lineitem ID', type => 'number'}
1941 "on success, object describing changes to LI and possibly PO; " .
1947 sub rollback_receive_lineitem_api {
1948 my($self, $conn, $auth, $li_id) = @_;
1950 my $e = new_editor(xact=>1, authtoken=>$auth);
1951 return $e->die_event unless $e->checkauth;
1952 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1954 my $li = $e->retrieve_acq_lineitem([
1956 "flesh" => 1, "flesh_fields" => {"jub" => ["purchase_order"]}
1959 my $po = $li->purchase_order;
1961 return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1963 $li = rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1965 my $result = {"li" => {$li->id => {"state" => $li->state}}};
1966 if ($po->state eq "received") {
1967 $po->state("on-order");
1968 $po = update_purchase_order($mgr, $po) or return $e->die_event;
1970 $result->{"po"} = describe_affected_po($e, $po);
1972 $e->commit and return $result or return $e->die_event;
1976 __PACKAGE__->register_method(
1977 method => 'set_lineitem_price_api',
1978 api_name => 'open-ils.acq.lineitem.price.set',
1980 desc => 'Set lineitem price. If debits already exist, update them as well',
1982 {desc => 'Authentication token', type => 'string'},
1983 {desc => 'lineitem ID', type => 'number'}
1985 return => {desc => 'status blob, Event on error'}
1989 sub set_lineitem_price_api {
1990 my($self, $conn, $auth, $li_id, $price) = @_;
1992 my $e = new_editor(xact=>1, authtoken=>$auth);
1993 return $e->die_event unless $e->checkauth;
1994 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1996 my ($li, $evt) = fetch_and_check_li($e, $li_id, 'write');
1997 return $evt if $evt;
1999 $li->estimated_unit_price($price);
2000 update_lineitem($mgr, $li) or return $e->die_event;
2002 my $lid_ids = $e->search_acq_lineitem_detail(
2003 {lineitem => $li_id, fund_debit => {'!=' => undef}},
2007 for my $lid_id (@$lid_ids) {
2009 my $lid = $e->retrieve_acq_lineitem_detail([
2011 flesh => 1, flesh_fields => {acqlid => ['fund', 'fund_debit']}}
2014 $lid->fund_debit->amount($price);
2015 $e->update_acq_fund_debit($lid->fund_debit) or return $e->die_event;
2021 return $mgr->respond_complete;
2025 __PACKAGE__->register_method(
2026 method => 'clone_picklist_api',
2027 api_name => 'open-ils.acq.picklist.clone',
2029 desc => 'Clones a picklist, including lineitem and lineitem details',
2031 {desc => 'Authentication token', type => 'string'},
2032 {desc => 'Picklist ID', type => 'number'},
2033 {desc => 'New Picklist Name', type => 'string'}
2035 return => {desc => 'status blob, Event on error'}
2039 sub clone_picklist_api {
2040 my($self, $conn, $auth, $pl_id, $name) = @_;
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);
2046 my $old_pl = $e->retrieve_acq_picklist($pl_id);
2047 my $new_pl = create_picklist($mgr, %{$old_pl->to_bare_hash}, name => $name) or return $e->die_event;
2049 my $li_ids = $e->search_acq_lineitem({picklist => $pl_id}, {idlist => 1});
2051 for my $li_id (@$li_ids) {
2053 # copy the lineitems
2054 my $li = $e->retrieve_acq_lineitem($li_id);
2055 my $new_li = create_lineitem($mgr, %{$li->to_bare_hash}, picklist => $new_pl->id) or return $e->die_event;
2057 my $lid_ids = $e->search_acq_lineitem_detail({lineitem => $li_id}, {idlist => 1});
2058 for my $lid_id (@$lid_ids) {
2060 # copy the lineitem details
2061 my $lid = $e->retrieve_acq_lineitem_detail($lid_id);
2062 create_lineitem_detail($mgr, %{$lid->to_bare_hash}, lineitem => $new_li->id) or return $e->die_event;
2069 return $mgr->respond_complete;
2073 __PACKAGE__->register_method(
2074 method => 'merge_picklist_api',
2075 api_name => 'open-ils.acq.picklist.merge',
2077 desc => 'Merges 2 or more picklists into a single list',
2079 {desc => 'Authentication token', type => 'string'},
2080 {desc => 'Lead Picklist ID', type => 'number'},
2081 {desc => 'List of subordinate picklist IDs', type => 'array'}
2083 return => {desc => 'status blob, Event on error'}
2087 sub merge_picklist_api {
2088 my($self, $conn, $auth, $lead_pl, $pl_list) = @_;
2090 my $e = new_editor(xact=>1, authtoken=>$auth);
2091 return $e->die_event unless $e->checkauth;
2092 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2094 # XXX perms on each picklist modified
2096 $lead_pl = $e->retrieve_acq_picklist($lead_pl) or return $e->die_event;
2097 # point all of the lineitems at the lead picklist
2098 my $li_ids = $e->search_acq_lineitem({picklist => $pl_list}, {idlist => 1});
2100 for my $li_id (@$li_ids) {
2101 my $li = $e->retrieve_acq_lineitem($li_id);
2102 $li->picklist($lead_pl);
2103 update_lineitem($mgr, $li) or return $e->die_event;
2107 # now delete the subordinate lists
2108 for my $pl_id (@$pl_list) {
2109 my $pl = $e->retrieve_acq_picklist($pl_id);
2110 $e->delete_acq_picklist($pl) or return $e->die_event;
2113 update_picklist($mgr, $lead_pl) or return $e->die_event;
2116 return $mgr->respond_complete;
2120 __PACKAGE__->register_method(
2121 method => 'delete_picklist_api',
2122 api_name => 'open-ils.acq.picklist.delete',
2124 desc => q/Deletes a picklist. It also deletes any lineitems in the "new" state. / .
2125 q/Other attached lineitems are detached/,
2127 {desc => 'Authentication token', type => 'string'},
2128 {desc => 'Picklist ID to delete', type => 'number'}
2130 return => {desc => '1 on success, Event on error'}
2134 sub delete_picklist_api {
2135 my($self, $conn, $auth, $picklist_id) = @_;
2136 my $e = new_editor(xact=>1, authtoken=>$auth);
2137 return $e->die_event unless $e->checkauth;
2138 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2139 my $pl = $e->retrieve_acq_picklist($picklist_id) or return $e->die_event;
2140 delete_picklist($mgr, $pl) or return $e->die_event;
2142 return $mgr->respond_complete;
2147 __PACKAGE__->register_method(
2148 method => 'activate_purchase_order',
2149 api_name => 'open-ils.acq.purchase_order.activate.dry_run'
2152 __PACKAGE__->register_method(
2153 method => 'activate_purchase_order',
2154 api_name => 'open-ils.acq.purchase_order.activate',
2156 desc => q/Activates a purchase order. This updates the status of the PO / .
2157 q/and Lineitems to 'on-order'. Activated PO's are ready for EDI delivery if appropriate./,
2159 {desc => 'Authentication token', type => 'string'},
2160 {desc => 'Purchase ID', type => 'number'}
2162 return => {desc => '1 on success, Event on error'}
2166 sub activate_purchase_order {
2167 my($self, $conn, $auth, $po_id) = @_;
2169 my $dry_run = ($self->api_name =~ /\.dry_run/) ? 1 : 0;
2170 my $e = new_editor(xact=>1, authtoken=>$auth);
2171 return $e->die_event unless $e->checkauth;
2172 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2173 my $die_event = activate_purchase_order_impl($mgr, $po_id, $dry_run);
2174 return $e->die_event if $die_event;
2180 $conn->respond_complete(1);
2181 $mgr->run_post_response_hooks;
2185 sub activate_purchase_order_impl {
2186 my ($mgr, $po_id, $dry_run) = @_;
2187 my $e = $mgr->editor;
2189 my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
2190 return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
2192 my $provider = $e->retrieve_acq_provider($po->provider);
2194 $po->state('on-order');
2195 $po->order_date('now');
2196 update_purchase_order($mgr, $po) or return $e->die_event;
2200 purchase_order => $po_id,
2201 state => [qw/pending-order new order-ready/]
2206 while( my $li_id = $e->search_acq_lineitem($query, {idlist => 1})->[0] ) {
2210 $li = $e->retrieve_acq_lineitem($li_id);
2212 # can't activate a PO w/o assets. Create lineitem assets as necessary
2213 my $data = create_lineitem_assets($mgr, $li_id) or return $e->die_event;
2217 $li->state('on-order');
2218 $li->claim_policy($provider->default_claim_policy)
2219 if $provider->default_claim_policy and !$li->claim_policy;
2220 create_lineitem_debits($mgr, $li, $dry_run) or return $e->die_event;
2221 update_lineitem($mgr, $li) or return $e->die_event;
2222 $mgr->post_process( sub { create_lineitem_status_events($mgr, $li->id, 'aur.ordered'); });
2226 for my $po_item (@{$e->search_acq_po_item({purchase_order => $po_id})}) {
2228 my $debit = create_fund_debit(
2231 debit_type => 'direct_charge', # to match invoicing
2232 origin_amount => $po_item->estimated_cost,
2233 origin_currency_type => $e->retrieve_acq_fund($po_item->fund)->currency_type,
2234 amount => $po_item->estimated_cost,
2235 fund => $po_item->fund
2236 ) or return $e->die_event;
2237 $po_item->fund_debit($debit->id);
2238 $e->update_acq_po_item($po_item) or return $e->die_event;
2242 # tell the world we activated a PO
2243 $U->create_events_for_hook('acqpo.activated', $po, $po->ordering_agency) unless $dry_run;
2249 __PACKAGE__->register_method(
2250 method => 'split_purchase_order_by_lineitems',
2251 api_name => 'open-ils.acq.purchase_order.split_by_lineitems',
2253 desc => q/Splits a PO into many POs, 1 per lineitem. Only works for / .
2254 q/POs a) with more than one lineitems, and b) in the "pending" state./,
2256 {desc => 'Authentication token', type => 'string'},
2257 {desc => 'Purchase order ID', type => 'number'}
2259 return => {desc => 'list of new PO IDs on success, Event on error'}
2263 sub split_purchase_order_by_lineitems {
2264 my ($self, $conn, $auth, $po_id) = @_;
2266 my $e = new_editor("xact" => 1, "authtoken" => $auth);
2267 return $e->die_event unless $e->checkauth;
2269 my $po = $e->retrieve_acq_purchase_order([
2272 "flesh_fields" => {"acqpo" => [qw/lineitems notes/]}
2274 ]) or return $e->die_event;
2276 return $e->die_event
2277 unless $e->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
2279 unless ($po->state eq "pending") {
2281 return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_LATE");
2284 unless (@{$po->lineitems} > 1) {
2286 return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_SHORT");
2289 # To split an existing PO into many, it seems unwise to just delete the
2290 # original PO, so we'll instead detach all of the original POs' lineitems
2291 # but the first, then create new POs for each of the remaining LIs, and
2292 # then attach the LIs to their new POs.
2294 my @po_ids = ($po->id);
2295 my @moving_li = @{$po->lineitems};
2296 shift @moving_li; # discard first LI
2298 foreach my $li (@moving_li) {
2299 my $new_po = $po->clone;
2301 $new_po->clear_name;
2302 $new_po->creator($e->requestor->id);
2303 $new_po->editor($e->requestor->id);
2304 $new_po->owner($e->requestor->id);
2305 $new_po->edit_time("now");
2306 $new_po->create_time("now");
2308 $new_po = $e->create_acq_purchase_order($new_po);
2310 # Clone any notes attached to the old PO and attach to the new one.
2311 foreach my $note (@{$po->notes}) {
2312 my $new_note = $note->clone;
2313 $new_note->clear_id;
2314 $new_note->edit_time("now");
2315 $new_note->purchase_order($new_po->id);
2316 $e->create_acq_po_note($new_note);
2319 $li->edit_time("now");
2320 $li->purchase_order($new_po->id);
2321 $e->update_acq_lineitem($li);
2323 push @po_ids, $new_po->id;
2326 $po->edit_time("now");
2327 $e->update_acq_purchase_order($po);
2329 return \@po_ids if $e->commit;
2330 return $e->die_event;
2334 sub not_cancelable {
2336 (ref $o eq "HASH" and $o->{"textcode"} eq "ACQ_NOT_CANCELABLE");
2339 __PACKAGE__->register_method(
2340 method => "cancel_purchase_order_api",
2341 api_name => "open-ils.acq.purchase_order.cancel",
2343 desc => q/Cancels an on-order purchase order/,
2345 {desc => "Authentication token", type => "string"},
2346 {desc => "PO ID to cancel", type => "number"},
2347 {desc => "Cancel reason ID", type => "number"}
2349 return => {desc => q/Object describing changed POs, LIs and LIDs
2350 on success; Event on error./}
2354 sub cancel_purchase_order_api {
2355 my ($self, $conn, $auth, $po_id, $cancel_reason) = @_;
2357 my $e = new_editor("xact" => 1, "authtoken" => $auth);
2358 return $e->die_event unless $e->checkauth;
2359 my $mgr = new OpenILS::Application::Acq::BatchManager(
2360 "editor" => $e, "conn" => $conn
2363 $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2364 return new OpenILS::Event(
2365 "BAD_PARAMS", "note" => "Provide cancel reason ID"
2368 my $result = cancel_purchase_order($mgr, $po_id, $cancel_reason) or
2369 return $e->die_event;
2370 if (not_cancelable($result)) { # event not from CStoreEditor
2373 } elsif ($result == -1) {
2375 return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2378 $e->commit or return $e->die_event;
2380 # XXX create purchase order status events?
2382 if ($mgr->{post_commit}) {
2383 foreach my $func (@{$mgr->{post_commit}}) {
2391 sub cancel_purchase_order {
2392 my ($mgr, $po_id, $cancel_reason) = @_;
2394 my $po = $mgr->editor->retrieve_acq_purchase_order($po_id) or return 0;
2396 # XXX is "cancelled" a typo? It's not correct US spelling, anyway.
2397 # Depending on context, this may not warrant an event.
2398 return -1 if $po->state eq "cancelled";
2400 # But this always does.
2401 return new OpenILS::Event(
2402 "ACQ_NOT_CANCELABLE", "note" => "purchase_order $po_id"
2403 ) unless ($po->state eq "on-order" or $po->state eq "pending");
2406 $mgr->editor->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
2408 $po->state("cancelled");
2409 $po->cancel_reason($cancel_reason->id);
2411 my $li_ids = $mgr->editor->search_acq_lineitem(
2412 {"purchase_order" => $po_id}, {"idlist" => 1}
2415 my $result = {"li" => {}, "lid" => {}};
2416 foreach my $li_id (@$li_ids) {
2417 my $li_result = cancel_lineitem($mgr, $li_id, $cancel_reason)
2420 next if $li_result == -1; # already canceled:skip.
2421 return $li_result if not_cancelable($li_result); # not cancelable:stop.
2423 # Merge in each LI result (there's only going to be
2424 # one per call to cancel_lineitem).
2425 my ($k, $v) = each %{$li_result->{"li"}};
2426 $result->{"li"}->{$k} = $v;
2428 # Merge in each LID result (there may be many per call to
2430 while (($k, $v) = each %{$li_result->{"lid"}}) {
2431 $result->{"lid"}->{$k} = $v;
2435 # TODO who/what/where/how do we indicate this change for electronic orders?
2436 # TODO return changes to encumbered/spent
2437 # TODO maybe cascade up from smaller object to container object if last
2438 # smaller object in the container has been canceled?
2440 update_purchase_order($mgr, $po) or return 0;
2442 $po_id => {"state" => $po->state, "cancel_reason" => $cancel_reason}
2448 __PACKAGE__->register_method(
2449 method => "cancel_lineitem_api",
2450 api_name => "open-ils.acq.lineitem.cancel",
2452 desc => q/Cancels an on-order lineitem/,
2454 {desc => "Authentication token", type => "string"},
2455 {desc => "Lineitem ID to cancel", type => "number"},
2456 {desc => "Cancel reason ID", type => "number"}
2458 return => {desc => q/Object describing changed LIs and LIDs on success;
2463 __PACKAGE__->register_method(
2464 method => "cancel_lineitem_api",
2465 api_name => "open-ils.acq.lineitem.cancel.batch",
2467 desc => q/Batched version of open-ils.acq.lineitem.cancel/,
2468 return => {desc => q/Object describing changed LIs and LIDs on success;
2473 sub cancel_lineitem_api {
2474 my ($self, $conn, $auth, $li_id, $cancel_reason) = @_;
2476 my $batched = $self->api_name =~ /\.batch/;
2478 my $e = new_editor("xact" => 1, "authtoken" => $auth);
2479 return $e->die_event unless $e->checkauth;
2480 my $mgr = new OpenILS::Application::Acq::BatchManager(
2481 "editor" => $e, "conn" => $conn
2484 $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2485 return new OpenILS::Event(
2486 "BAD_PARAMS", "note" => "Provide cancel reason ID"
2489 my ($result, $maybe_event);
2492 $result = {"li" => {}, "lid" => {}};
2493 foreach my $one_li_id (@$li_id) {
2494 my $one = cancel_lineitem($mgr, $one_li_id, $cancel_reason) or
2495 return $e->die_event;
2496 if (not_cancelable($one)) {
2497 $maybe_event = $one;
2498 } elsif ($result == -1) {
2499 $maybe_event = new OpenILS::Event("ACQ_ALREADY_CANCELED");
2503 while (($k, $v) = each %{$one->{"li"}}) {
2504 $result->{"li"}->{$k} = $v;
2507 if ($one->{"lid"}) {
2508 while (($k, $v) = each %{$one->{"lid"}}) {
2509 $result->{"lid"}->{$k} = $v;
2515 $result = cancel_lineitem($mgr, $li_id, $cancel_reason) or
2516 return $e->die_event;
2518 if (not_cancelable($result)) {
2521 } elsif ($result == -1) {
2523 return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2527 if ($batched and not scalar keys %{$result->{"li"}}) {
2529 return $maybe_event;
2531 $e->commit or return $e->die_event;
2532 # create_lineitem_status_events should handle array li_id ok
2533 create_lineitem_status_events($mgr, $li_id, "aur.cancelled");
2535 if ($mgr->{post_commit}) {
2536 foreach my $func (@{$mgr->{post_commit}}) {
2545 sub cancel_lineitem {
2546 my ($mgr, $li_id, $cancel_reason) = @_;
2547 my $li = $mgr->editor->retrieve_acq_lineitem([
2548 $li_id, {flesh => 1, flesh_fields => {jub => ['purchase_order']}}
2551 return 0 unless $mgr->editor->allowed(
2552 "CREATE_PURCHASE_ORDER", $li->purchase_order->ordering_agency
2555 # Depending on context, this may not warrant an event.
2556 return -1 if $li->state eq "cancelled";
2558 # But this always does.
2559 return new OpenILS::Event(
2560 "ACQ_NOT_CANCELABLE", "note" => "lineitem $li_id"
2562 (! $li->purchase_order) or (
2563 $li->purchase_order and (
2564 $li->state eq "on-order" or $li->state eq "pending-order"
2569 $li->state("cancelled");
2570 $li->cancel_reason($cancel_reason->id);
2572 my $lids = $mgr->editor->search_acq_lineitem_detail([{
2573 "lineitem" => $li_id
2576 flesh_fields => { acqlid => ['eg_copy_id'] }
2579 my $result = {"lid" => {}};
2581 foreach my $lid (@$lids) {
2582 my $lid_result = cancel_lineitem_detail($mgr, $lid->id, $cancel_reason)
2585 # gathering any real copies for deletion
2586 if ($lid->eg_copy_id) {
2587 $lid->eg_copy_id->isdeleted('t');
2588 push @$copies, $lid->eg_copy_id;
2591 next if $lid_result == -1; # already canceled: just skip it.
2592 return $lid_result if not_cancelable($lid_result); # not cxlable: stop.
2594 # Merge in each LID result (there's only going to be one per call to
2595 # cancel_lineitem_detail).
2596 my ($k, $v) = each %{$lid_result->{"lid"}};
2597 $result->{"lid"}->{$k} = $v;
2600 # Attempt to delete the gathered copies (this will also handle volume deletion and bib deletion)
2601 # Delete empty bibs according org unit setting
2602 my $force_delete_empty_bib = $U->ou_ancestor_setting_value(
2603 $mgr->editor->requestor->ws_ou, 'cat.bib.delete_on_no_copy_via_acq_lineitem_cancel', $mgr->editor);
2604 if (scalar(@$copies)>0) {
2606 my $delete_stats = undef;
2607 my $retarget_holds = [];
2608 my $cat_evt = OpenILS::Application::Cat::AssetCommon->update_fleshed_copies(
2609 $mgr->editor, $override, undef, $copies, $delete_stats, $retarget_holds,$force_delete_empty_bib);
2612 $logger->info("fleshed copy update failed with event: ".OpenSRF::Utils::JSON->perl2JSON($cat_evt));
2613 return new OpenILS::Event(
2614 "ACQ_NOT_CANCELABLE", "note" => "lineitem $li_id", "payload" => $cat_evt
2618 # We can't do the following and stay within the same transaction, but that's okay, the hold targeter will pick these up later.
2619 #my $ses = OpenSRF::AppSession->create('open-ils.circ');
2620 #$ses->request('open-ils.circ.hold.reset.batch', $auth, $retarget_holds);
2623 # if we have a bib, check to see whether it has been deleted. if so, cancel any active holds targeting that bib
2624 if ($li->eg_bib_id) {
2625 my $bib = $mgr->editor->retrieve_biblio_record_entry($li->eg_bib_id) or return new OpenILS::Event(
2626 "ACQ_NOT_CANCELABLE", "note" => "Could not retrieve bib " . $li->eg_bib_id . " for lineitem $li_id"
2628 if ($U->is_true($bib->deleted)) {
2629 my $holds = $mgr->editor->search_action_hold_request(
2630 { cancel_time => undef,
2631 fulfillment_time => undef,
2632 target => $li->eg_bib_id
2636 my %cached_usr_home_ou = ();
2638 for my $hold (@$holds) {
2640 $logger->info("Cancelling hold ".$hold->id.
2641 " due to acq lineitem cancellation.");
2643 $hold->cancel_time('now');
2644 $hold->cancel_cause(5); # 'Staff forced'--we may want a new hold cancel cause reason for this
2645 $hold->cancel_note('Corresponding Acquistion Lineitem/Purchase Order was cancelled.');
2646 unless($mgr->editor->update_action_hold_request($hold)) {
2647 my $evt = $mgr->editor->event;
2648 $logger->error("Error updating hold ". $evt->textcode .":". $evt->desc .":". $evt->stacktrace);
2649 return new OpenILS::Event(
2650 "ACQ_NOT_CANCELABLE", "note" => "Could not cancel hold " . $hold->id . " for lineitem $li_id", "payload" => $evt
2653 if (! defined $mgr->{post_commit}) { # we need a mechanism for creating trigger events, but only if the transaction gets committed
2654 $mgr->{post_commit} = [];
2656 push @{ $mgr->{post_commit} }, sub {
2657 my $home_ou = $cached_usr_home_ou{$hold->usr};
2659 my $user = $mgr->editor->retrieve_actor_user($hold->usr); # FIXME: how do we want to handle failures here?
2660 $home_ou = $user->home_ou;
2661 $cached_usr_home_ou{$hold->usr} = $home_ou;
2663 $U->create_events_for_hook('hold_request.cancel.cancelled_order', $hold, $home_ou);
2669 update_lineitem($mgr, $li) or return 0;
2672 "state" => $li->state,
2673 "cancel_reason" => $cancel_reason
2680 __PACKAGE__->register_method(
2681 method => "cancel_lineitem_detail_api",
2682 api_name => "open-ils.acq.lineitem_detail.cancel",
2684 desc => q/Cancels an on-order lineitem detail/,
2686 {desc => "Authentication token", type => "string"},
2687 {desc => "Lineitem detail ID to cancel", type => "number"},
2688 {desc => "Cancel reason ID", type => "number"}
2690 return => {desc => q/Object describing changed LIDs on success;
2695 sub cancel_lineitem_detail_api {
2696 my ($self, $conn, $auth, $lid_id, $cancel_reason) = @_;
2698 my $e = new_editor("xact" => 1, "authtoken" => $auth);
2699 return $e->die_event unless $e->checkauth;
2700 my $mgr = new OpenILS::Application::Acq::BatchManager(
2701 "editor" => $e, "conn" => $conn
2704 $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2705 return new OpenILS::Event(
2706 "BAD_PARAMS", "note" => "Provide cancel reason ID"
2709 my $result = cancel_lineitem_detail($mgr, $lid_id, $cancel_reason) or
2710 return $e->die_event;
2712 if (not_cancelable($result)) {
2715 } elsif ($result == -1) {
2717 return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2720 $e->commit or return $e->die_event;
2722 # XXX create lineitem detail status events?
2726 sub cancel_lineitem_detail {
2727 my ($mgr, $lid_id, $cancel_reason) = @_;
2728 my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
2732 "acqlid" => ["lineitem"], "jub" => ["purchase_order"]
2737 # Depending on context, this may not warrant an event.
2738 return -1 if $lid->cancel_reason;
2740 # But this always does.
2741 return new OpenILS::Event(
2742 "ACQ_NOT_CANCELABLE", "note" => "lineitem_detail $lid_id"
2744 (! $lid->lineitem->purchase_order) or
2746 (not $lid->recv_time) and
2748 $lid->lineitem->purchase_order and (
2749 $lid->lineitem->state eq "on-order" or
2750 $lid->lineitem->state eq "pending-order"
2755 return 0 unless $mgr->editor->allowed(
2756 "CREATE_PURCHASE_ORDER",
2757 $lid->lineitem->purchase_order->ordering_agency
2758 ) or (! $lid->lineitem->purchase_order);
2760 $lid->cancel_reason($cancel_reason->id);
2762 unless($U->is_true($cancel_reason->keep_debits)) {
2763 my $debit_id = $lid->fund_debit;
2764 $lid->clear_fund_debit;
2767 # item is cancelled. Remove the fund debit.
2768 my $debit = $mgr->editor->retrieve_acq_fund_debit($debit_id);
2769 if (!$U->is_true($debit->encumbrance)) {
2770 $mgr->editor->rollback;
2771 return OpenILS::Event->new('ACQ_NOT_CANCELABLE',
2772 note => "Debit is marked as paid: $debit_id");
2774 $mgr->editor->delete_acq_fund_debit($debit) or return $mgr->editor->die_event;
2778 # XXX LIDs don't have either an editor or a edit_time field. Should we
2779 # update these on the LI when we alter an LID?
2780 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
2782 return {"lid" => {$lid_id => {"cancel_reason" => $cancel_reason}}};
2786 __PACKAGE__->register_method(
2787 method => 'user_requests',
2788 api_name => 'open-ils.acq.user_request.retrieve.by_user_id',
2791 desc => 'Retrieve fleshed user requests and related data for a given user.',
2793 { desc => 'Authentication token', type => 'string' },
2794 { desc => 'User ID of the owner, or array of IDs', },
2795 { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)',
2800 desc => 'Fleshed user requests and related data',
2806 __PACKAGE__->register_method(
2807 method => 'user_requests',
2808 api_name => 'open-ils.acq.user_request.retrieve.by_home_ou',
2811 desc => 'Retrieve fleshed user requests and related data for a given org unit or units.',
2813 { desc => 'Authentication token', type => 'string' },
2814 { desc => 'Org unit ID, or array of IDs', },
2815 { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)',
2820 desc => 'Fleshed user requests and related data',
2827 my($self, $conn, $auth, $search_value, $options) = @_;
2828 my $e = new_editor(authtoken => $auth);
2829 return $e->event unless $e->checkauth;
2830 my $rid = $e->requestor->id;
2834 "select"=>{"aur"=>["id"],"au"=>["home_ou", {column => 'id', alias => 'usr_id'} ]},
2835 "from"=>{ "aur" => { "au" => {}, "jub" => { "type" => "left" } } },
2839 {"id"=>undef}, # this with the left-join pulls in requests without lineitems
2840 {"state"=>["new","on-order","pending-order"]} # FIXME - probably needs softcoding
2844 "order_by"=>[{"class"=>"aur", "field"=>"request_date", "direction"=>"desc"}]
2847 foreach (qw/ order_by limit offset /) {
2848 $query->{$_} = $options->{$_} if defined $options->{$_};
2850 if (defined $options->{'state'}) {
2851 $query->{'where'}->{'+jub'}->{'-or'}->[1]->{'state'} = $options->{'state'};
2854 if ($self->api_name =~ /by_user_id/) {
2855 $query->{'where'}->{'usr'} = $search_value;
2857 $query->{'where'}->{'+au'} = { 'home_ou' => $search_value };
2860 my $pertinent_ids = $e->json_query($query);
2863 for my $id_blob (@$pertinent_ids) {
2864 if ($rid != $id_blob->{usr_id}) {
2865 if (!defined $perm_test{ $id_blob->{home_ou} }) {
2866 $perm_test{ $id_blob->{home_ou} } = $e->allowed( ['user_request.view'], $id_blob->{home_ou} );
2868 if (!$perm_test{ $id_blob->{home_ou} }) {
2872 my $aur_obj = $e->retrieve_acq_user_request([
2874 {flesh => 1, flesh_fields => { "aur" => [ 'lineitem' ] } }
2876 if (! $aur_obj) { next; }
2878 if ($aur_obj->lineitem()) {
2879 $aur_obj->lineitem()->clear_marc();
2881 $conn->respond($aur_obj);
2887 __PACKAGE__->register_method (
2888 method => 'update_user_request',
2889 api_name => 'open-ils.acq.user_request.cancel.batch',
2892 desc => 'If given a cancel reason, will update the request with that reason, otherwise, this will delete the request altogether. The ' .
2893 'intention is for staff interfaces or processes to provide cancel reasons, and for patron interfaces to just delete the requests.' ,
2895 { desc => 'Authentication token', type => 'string' },
2896 { desc => 'ID or array of IDs for the user requests to cancel' },
2897 { desc => 'Cancel Reason ID (optional)', type => 'string' }
2900 desc => 'progress object, event on error',
2904 __PACKAGE__->register_method (
2905 method => 'update_user_request',
2906 api_name => 'open-ils.acq.user_request.set_no_hold.batch',
2909 desc => 'Remove the hold from a user request or set of requests',
2911 { desc => 'Authentication token', type => 'string' },
2912 { desc => 'ID or array of IDs for the user requests to modify' }
2915 desc => 'progress object, event on error',
2920 sub update_user_request {
2921 my($self, $conn, $auth, $aur_ids, $cancel_reason) = @_;
2922 my $e = new_editor(xact => 1, authtoken => $auth);
2923 return $e->die_event unless $e->checkauth;
2924 my $rid = $e->requestor->id;
2928 for my $id (@$aur_ids) {
2930 my $aur_obj = $e->retrieve_acq_user_request([
2933 flesh_fields => { "aur" => ['lineitem', 'usr'] }
2935 ]) or return $e->die_event;
2937 my $context_org = $aur_obj->usr()->home_ou();
2938 $aur_obj->usr( $aur_obj->usr()->id() );
2940 if ($rid != $aur_obj->usr) {
2941 if (!defined $perm_test{ $context_org }) {
2942 $perm_test{ $context_org } = $e->allowed( ['user_request.update'], $context_org );
2944 if (!$perm_test{ $context_org }) {
2949 if($self->api_name =~ /set_no_hold/) {
2950 if ($U->is_true($aur_obj->hold)) {
2952 $e->update_acq_user_request($aur_obj) or return $e->die_event;
2956 if($self->api_name =~ /cancel/) {
2957 if ( $cancel_reason ) {
2958 $aur_obj->cancel_reason( $cancel_reason );
2959 $e->update_acq_user_request($aur_obj) or return $e->die_event;
2960 create_user_request_events( $e, [ $aur_obj ], 'aur.rejected' );
2962 $e->delete_acq_user_request($aur_obj);
2966 $conn->respond({maximum => scalar(@$aur_ids), progress => $x++});
2970 return {complete => 1};
2973 __PACKAGE__->register_method (
2974 method => 'new_user_request',
2975 api_name => 'open-ils.acq.user_request.create',
2977 desc => 'Create a new user request object in the DB',
2979 { desc => 'Authentication token', type => 'string' },
2980 { desc => 'User request data hash. Hash keys match the fields for the "aur" object', type => 'object' }
2983 desc => 'The created user request object, or event on error'
2988 sub new_user_request {
2989 my($self, $conn, $auth, $form_data) = @_;
2990 my $e = new_editor(xact => 1, authtoken => $auth);
2991 return $e->die_event unless $e->checkauth;
2992 my $rid = $e->requestor->id;
2993 my $target_user_fleshed;
2994 if (! defined $$form_data{'usr'}) {
2995 $$form_data{'usr'} = $rid;
2997 if ($$form_data{'usr'} != $rid) {
2998 # See if the requestor can place the request on behalf of a different user.
2999 $target_user_fleshed = $e->retrieve_actor_user($$form_data{'usr'}) or return $e->die_event;
3000 $e->allowed('user_request.create', $target_user_fleshed->home_ou) or return $e->die_event;
3002 $target_user_fleshed = $e->requestor;
3003 $e->allowed('CREATE_PURCHASE_REQUEST') or return $e->die_event;
3005 if (! defined $$form_data{'pickup_lib'}) {
3006 if ($target_user_fleshed->ws_ou) {
3007 $$form_data{'pickup_lib'} = $target_user_fleshed->ws_ou;
3009 $$form_data{'pickup_lib'} = $target_user_fleshed->home_ou;
3012 if (! defined $$form_data{'request_type'}) {
3013 $$form_data{'request_type'} = 1; # Books
3015 my $aur_obj = new Fieldmapper::acq::user_request;
3017 $aur_obj->usr( $$form_data{'usr'} );
3018 $aur_obj->request_date( 'now' );
3019 for my $field ( keys %$form_data ) {
3020 if (defined $$form_data{$field} and $field !~ /^(id|lineitem|eg_bib|request_date|cancel_reason)$/) {
3021 $aur_obj->$field( $$form_data{$field} );
3025 $aur_obj = $e->create_acq_user_request($aur_obj) or return $e->die_event;
3027 $e->commit and create_user_request_events( $e, [ $aur_obj ], 'aur.created' );
3032 sub create_user_request_events {
3033 my($e, $user_reqs, $hook) = @_;
3035 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
3038 my %cached_usr_home_ou = ();
3039 for my $user_req (@$user_reqs) {
3040 my $home_ou = $cached_usr_home_ou{$user_req->usr};
3042 my $user = $e->retrieve_actor_user($user_req->usr) or return $e->die_event;
3043 $home_ou = $user->home_ou;
3044 $cached_usr_home_ou{$user_req->usr} = $home_ou;
3046 my $req = $ses->request('open-ils.trigger.event.autocreate', $hook, $user_req, $home_ou);
3055 __PACKAGE__->register_method(
3056 method => "po_note_CUD_batch",
3057 api_name => "open-ils.acq.po_note.cud.batch",
3060 desc => q/Manage purchase order notes/,
3062 {desc => "Authentication token", type => "string"},
3063 {desc => "List of po_notes to manage", type => "array"},
3065 return => {desc => "Stream of successfully managed objects"}
3069 sub po_note_CUD_batch {
3070 my ($self, $conn, $auth, $notes) = @_;
3072 my $e = new_editor("xact"=> 1, "authtoken" => $auth);
3073 return $e->die_event unless $e->checkauth;
3076 my $total = @$notes;
3079 foreach my $note (@$notes) {
3081 $note->editor($e->requestor->id);
3082 $note->edit_time("now");
3085 $note->creator($e->requestor->id);
3086 $note = $e->create_acq_po_note($note) or return $e->die_event;
3087 } elsif ($note->isdeleted) {
3088 $e->delete_acq_po_note($note) or return $e->die_event;
3089 } elsif ($note->ischanged) {
3090 $e->update_acq_po_note($note) or return $e->die_event;
3093 unless ($note->isdeleted) {
3094 $note = $e->retrieve_acq_po_note($note->id) or
3095 return $e->die_event;
3099 {"maximum" => $total, "progress" => ++$count, "note" => $note}
3103 $e->commit and $conn->respond_complete or return $e->die_event;
3107 # retrieves a lineitem, fleshes its PO and PL, checks perms
3108 sub fetch_and_check_li {
3111 my $perm_mode = shift || 'read';
3113 my $li = $e->retrieve_acq_lineitem([
3116 flesh_fields => {jub => ['purchase_order', 'picklist']}
3118 ]) or return $e->die_event;
3120 if(my $po = $li->purchase_order) {
3121 my $perms = ($perm_mode eq 'read') ? 'VIEW_PURCHASE_ORDER' : 'CREATE_PURCHASE_ORDER';
3122 return ($li, $e->die_event) unless $e->allowed($perms, $po->ordering_agency);
3124 } elsif(my $pl = $li->picklist) {
3125 my $perms = ($perm_mode eq 'read') ? 'VIEW_PICKLIST' : 'CREATE_PICKLIST';
3126 return ($li, $e->die_event) unless $e->allowed($perms, $pl->org_unit);
3133 __PACKAGE__->register_method(
3134 method => "clone_distrib_form",
3135 api_name => "open-ils.acq.distribution_formula.clone",
3138 desc => q/Clone a distribution formula/,
3140 {desc => "Authentication token", type => "string"},
3141 {desc => "Original formula ID", type => 'integer'},
3142 {desc => "Name of new formula", type => 'string'},
3144 return => {desc => "ID of newly created formula"}
3148 sub clone_distrib_form {
3149 my($self, $client, $auth, $form_id, $new_name) = @_;
3151 my $e = new_editor("xact"=> 1, "authtoken" => $auth);
3152 return $e->die_event unless $e->checkauth;
3154 my $old_form = $e->retrieve_acq_distribution_formula($form_id) or return $e->die_event;
3155 return $e->die_event unless $e->allowed('ADMIN_ACQ_DISTRIB_FORMULA', $old_form->owner);
3157 my $new_form = Fieldmapper::acq::distribution_formula->new;
3159 $new_form->owner($old_form->owner);
3160 $new_form->name($new_name);
3161 $e->create_acq_distribution_formula($new_form) or return $e->die_event;
3163 my $entries = $e->search_acq_distribution_formula_entry({formula => $form_id});
3164 for my $entry (@$entries) {
3165 my $new_entry = Fieldmapper::acq::distribution_formula_entry->new;
3166 $new_entry->$_($entry->$_()) for $entry->real_fields;
3167 $new_entry->formula($new_form->id);
3168 $new_entry->clear_id;
3169 $e->create_acq_distribution_formula_entry($new_entry) or return $e->die_event;
3173 return $new_form->id;