1 package OpenILS::Application::Acq::BatchManager;
2 use OpenSRF::AppSession;
3 use OpenSRF::EX qw/:try/;
4 use strict; use warnings;
7 my($class, %args) = @_;
8 my $self = bless(\%args, $class);
16 purchase_order => undef,
22 $self->{ingest_queue} = [];
24 $self->throttle(5) unless $self->throttle;
30 $self->{conn} = $val if $val;
35 $self->{throttle} = $val if $val;
36 return $self->{throttle};
39 my($self, %other_args) = @_;
40 if($self->throttle and not %other_args) {
42 ($self->{args}->{progress} - $self->{last_respond_progress}) >= $self->throttle
45 $self->conn->respond({ %{$self->{args}}, %other_args });
46 $self->{last_respond_progress} = $self->{args}->{progress};
48 sub respond_complete {
49 my($self, %other_args) = @_;
51 $self->conn->respond_complete({ %{$self->{args}}, %other_args });
56 $self->{args}->{total} = $val if defined $val;
57 $self->{args}->{maximum} = $self->{args}->{total};
58 return $self->{args}->{total};
62 $self->{args}->{purchase_order} = $val if $val;
67 $self->{args}->{picklist} = $val if $val;
72 $self->{args}->{lid} += 1;
73 $self->{args}->{progress} += 1;
78 $self->{args}->{li} += 1;
79 $self->{args}->{progress} += 1;
84 $self->{args}->{copies} += 1;
85 $self->{args}->{progress} += 1;
90 $self->{args}->{bibs} += 1;
91 $self->{args}->{progress} += 1;
95 my($self, $amount) = @_;
96 $self->{args}->{debits_accrued} += $amount;
97 $self->{args}->{progress} += 1;
101 my($self, $editor) = @_;
102 $self->{editor} = $editor if defined $editor;
103 return $self->{editor};
107 $self->{args}->{complete} = 1;
112 my($self, $val) = @_;
113 $self->{ingest_ses} = $val if $val;
114 return $self->{ingest_ses};
117 sub push_ingest_queue {
118 my($self, $rec_id) = @_;
120 $self->ingest_ses(OpenSRF::AppSession->connect('open-ils.ingest'))
121 unless $self->ingest_ses;
123 my $req = $self->ingest_ses->request('open-ils.ingest.full.biblio.record', $rec_id);
125 push(@{$self->{ingest_queue}}, $req);
128 sub process_ingest_records {
130 return unless @{$self->{ingest_queue}};
132 for my $req (@{$self->{ingest_queue}}) {
136 $self->{args}->{indexed} += 1;
137 $self->{args}->{progress} += 1;
142 $self->ingest_ses->disconnect;
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};
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 # ----------------------------------------------------------------------------
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;
174 my $U = 'OpenILS::Application::AppUtils';
177 # ----------------------------------------------------------------------------
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');
189 $li->$_($args{$_}) for keys %args;
192 return $mgr->editor->create_acq_lineitem($li);
195 sub update_lineitem {
197 $li->edit_time('now');
198 $li->editor($mgr->editor->requestor->id);
200 return $li if $mgr->editor->update_acq_lineitem($li);
204 sub delete_lineitem {
206 $li = $mgr->editor->retrieve_acq_lineitem($li) unless ref $li;
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);
215 return $mgr->editor->delete_acq_lineitem($li);
218 # begins and commit transactions as it goes
219 sub create_lineitem_list_assets {
220 my($mgr, $li_ids) = @_;
221 # create the bibs/volumes/copies and ingest the records
222 for my $li_id (@$li_ids) {
223 $mgr->editor->xact_begin;
224 my $data = create_lineitem_assets($mgr, $li_id) or return undef;
225 $mgr->editor->xact_commit;
226 $mgr->push_ingest_queue($data->{li}->eg_bib_id) if $data->{new_bib};
229 $mgr->process_ingest_records;
233 # ----------------------------------------------------------------------------
234 # if all of the lineitem details for this lineitem have
235 # been received, mark the lineitem as received
236 # returns 1 on non-received, li on received, 0 on error
237 # ----------------------------------------------------------------------------
238 sub check_lineitem_received {
239 my($mgr, $li_id) = @_;
241 my $non_recv = $mgr->editor->search_acq_lineitem_detail(
242 {recv_time => undef, lineitem => $li_id}, {idlist=>1});
244 return 1 if @$non_recv;
246 my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
247 $li->state('received');
248 return update_lineitem($mgr, $li);
251 sub receive_lineitem {
252 my($mgr, $li_id, $skip_complete_check) = @_;
253 my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
255 my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
256 {lineitem => $li_id, recv_time => undef}, {idlist => 1});
258 for my $lid_id (@$lid_ids) {
259 receive_lineitem_detail($mgr, $lid_id, 1) or return 0;
263 $li->state('received');
264 update_lineitem($mgr, $li) or return 0;
265 return 1 if $skip_complete_check;
267 return check_purchase_order_received($mgr, $li->purchase_order);
270 sub rollback_receive_lineitem {
271 my($mgr, $li_id) = @_;
272 my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
274 my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
275 {lineitem => $li_id, recv_time => {'!=' => undef}}, {idlist => 1});
277 for my $lid_id (@$lid_ids) {
278 rollback_receive_lineitem_detail($mgr, $lid_id, 1) or return 0;
282 $li->state('on-order');
283 return update_lineitem($mgr, $li);
286 # ----------------------------------------------------------------------------
288 # ----------------------------------------------------------------------------
289 sub create_lineitem_detail {
290 my($mgr, %args) = @_;
291 my $lid = Fieldmapper::acq::lineitem_detail->new;
292 $lid->$_($args{$_}) for keys %args;
294 $mgr->editor->create_acq_lineitem_detail($lid) or return 0;
297 # create some default values
298 unless($lid->barcode) {
299 my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_barcode_prefix') || 'ACQ';
300 $lid->barcode($pfx.$lid->id);
303 unless($lid->cn_label) {
304 my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_callnumber_prefix') || 'ACQ';
305 $lid->cn_label($pfx.$lid->id);
308 if(!$lid->location and my $loc = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.default_copy_location')) {
309 $lid->location($loc);
312 if(!$lid->circ_modifier and my $mod = get_default_circ_modifier($mgr, $lid->owning_lib)) {
313 $lid->circ_modifier($mod);
316 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
317 my $li = $mgr->editor->retrieve_acq_lineitem($lid->lineitem) or return 0;
318 update_lineitem($mgr, $li) or return 0;
322 sub get_default_circ_modifier {
324 my $mod = $mgr->cache($org, 'def_circ_mod');
326 $mod = $U->ou_ancestor_setting_value($org, 'acq.default_circ_modifier');
327 return $mgr->cache($org, 'def_circ_mod', $mod) if $mod;
331 sub delete_lineitem_detail {
333 $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid) unless ref $lid;
334 return $mgr->editor->delete_acq_lineitem_detail($lid);
338 sub receive_lineitem_detail {
339 my($mgr, $lid_id, $skip_complete_check) = @_;
340 my $e = $mgr->editor;
342 my $lid = $e->retrieve_acq_lineitem_detail([
346 acqlid => ['fund_debit']
351 return 1 if $lid->recv_time;
353 $lid->recv_time('now');
354 $e->update_acq_lineitem_detail($lid) or return 0;
356 my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
357 $copy->status(OILS_COPY_STATUS_IN_PROCESS);
358 $copy->edit_date('now');
359 $copy->editor($e->requestor->id);
360 $e->update_asset_copy($copy) or return 0;
362 if($lid->fund_debit) {
363 $lid->fund_debit->encumbrance('f');
364 $e->update_acq_fund_debit($lid->fund_debit) or return 0;
369 return 1 if $skip_complete_check;
371 my $li = check_lineitem_received($mgr, $lid->lineitem) or return 0;
372 return 1 if $li == 1; # li not received
374 return check_purchase_order_received($mgr, $li->purchase_order);
378 sub rollback_receive_lineitem_detail {
379 my($mgr, $lid_id) = @_;
380 my $e = $mgr->editor;
382 my $lid = $e->retrieve_acq_lineitem_detail([
386 acqlid => ['fund_debit']
391 return 1 unless $lid->recv_time;
393 $lid->clear_recv_time;
394 $e->update_acq_lineitem_detail($lid) or return 0;
396 my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
397 $copy->status(OILS_COPY_STATUS_ON_ORDER);
398 $copy->edit_date('now');
399 $copy->editor($e->requestor->id);
400 $e->update_asset_copy($copy) or return 0;
402 if($lid->fund_debit) {
403 $lid->fund_debit->encumbrance('t');
404 $e->update_acq_fund_debit($lid->fund_debit) or return 0;
411 # ----------------------------------------------------------------------------
413 # ----------------------------------------------------------------------------
414 sub set_lineitem_attr {
415 my($mgr, %args) = @_;
416 my $attr_type = $args{attr_type};
418 # first, see if it's already set. May just need to overwrite it
419 my $attr = $mgr->editor->search_acq_lineitem_attr({
420 lineitem => $args{lineitem},
421 attr_type => $args{attr_type},
422 attr_name => $args{attr_name}
426 $attr->attr_value($args{attr_value});
427 return $attr if $mgr->editor->update_acq_lineitem_attr($attr);
432 $attr = Fieldmapper::acq::lineitem_attr->new;
433 $attr->$_($args{$_}) for keys %args;
435 unless($attr->definition) {
436 my $find = "search_acq_$attr_type";
437 my $attr_def_id = $mgr->editor->$find({code => $attr->attr_name}, {idlist=>1})->[0] or return 0;
438 $attr->definition($attr_def_id);
440 return $mgr->editor->create_acq_lineitem_attr($attr);
446 my $attrs = $li->attributes;
447 my ($marc_estimated, $local_estimated, $local_actual, $prov_estimated, $prov_actual);
449 for my $attr (@$attrs) {
450 if($attr->attr_name eq 'estimated_price') {
451 $local_estimated = $attr->attr_value
452 if $attr->attr_type eq 'lineitem_local_attr_definition';
453 $prov_estimated = $attr->attr_value
454 if $attr->attr_type eq 'lineitem_prov_attr_definition';
455 $marc_estimated = $attr->attr_value
456 if $attr->attr_type eq 'lineitem_marc_attr_definition';
458 } elsif($attr->attr_name eq 'actual_price') {
459 $local_actual = $attr->attr_value
460 if $attr->attr_type eq 'lineitem_local_attr_definition';
461 $prov_actual = $attr->attr_value
462 if $attr->attr_type eq 'lineitem_prov_attr_definition';
466 return ($local_actual, 1) if $local_actual;
467 return ($prov_actual, 2) if $prov_actual;
468 return ($local_estimated, 1) if $local_estimated;
469 return ($prov_estimated, 2) if $prov_estimated;
470 return ($marc_estimated, 3);
474 # ----------------------------------------------------------------------------
476 # ----------------------------------------------------------------------------
477 sub create_lineitem_debits {
478 my($mgr, $li, $price, $ptype) = @_;
480 ($price, $ptype) = get_li_price($li) unless $price;
483 $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PRICE', payload => $li->id));
484 $mgr->editor->rollback;
488 unless($li->provider) {
489 $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PROVIDER', payload => $li->id));
490 $mgr->editor->rollback;
494 my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
495 {lineitem => $li->id},
499 for my $lid_id (@$lid_ids) {
501 my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
504 flesh_fields => {acqlid => ['fund']}
508 create_lineitem_detail_debit($mgr, $li, $lid, $price, $ptype) or return 0;
517 # ptype 1=local, 2=provider, 3=marc
518 sub create_lineitem_detail_debit {
519 my($mgr, $li, $lid, $price, $ptype) = @_;
521 unless(ref $li and ref $li->provider) {
522 $li = $mgr->editor->retrieve_acq_lineitem([
525 flesh_fields => {jub => ['provider']},
530 unless(ref $lid and ref $lid->fund) {
531 $lid = $mgr->editor->retrieve_acq_lineitem_detail([
534 flesh_fields => {acqlid => ['fund']}
539 my $ctype = $lid->fund->currency_type;
542 if($ptype == 2) { # price from vendor
543 $ctype = $li->provider->currency_type;
544 $amount = currency_conversion($mgr, $ctype, $lid->fund->currency_type, $price);
547 my $debit = create_fund_debit(
549 fund => $lid->fund->id,
550 origin_amount => $price,
551 origin_currency_type => $ctype,
555 $lid->fund_debit($debit->id);
556 $lid->fund($lid->fund->id);
557 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
562 # ----------------------------------------------------------------------------
564 # ----------------------------------------------------------------------------
565 sub create_fund_debit {
566 my($mgr, %args) = @_;
567 my $debit = Fieldmapper::acq::fund_debit->new;
568 $debit->debit_type('purchase');
569 $debit->encumbrance('t');
570 $debit->$_($args{$_}) for keys %args;
572 $mgr->add_debit($debit->amount);
573 return $mgr->editor->create_acq_fund_debit($debit);
576 sub currency_conversion {
577 my($mgr, $src_currency, $dest_currency, $amount) = @_;
578 my $result = $mgr->editor->json_query(
579 {from => ['acq.exchange_ratio', $src_currency, $dest_currency, $amount]});
580 return $result->[0]->{'acq.exchange_ratio'};
584 # ----------------------------------------------------------------------------
586 # ----------------------------------------------------------------------------
587 sub create_picklist {
588 my($mgr, %args) = @_;
589 my $picklist = Fieldmapper::acq::picklist->new;
590 $picklist->creator($mgr->editor->requestor->id);
591 $picklist->owner($picklist->creator);
592 $picklist->editor($picklist->creator);
593 $picklist->create_time('now');
594 $picklist->edit_time('now');
595 $picklist->org_unit($mgr->editor->requestor->ws_ou);
596 $picklist->owner($mgr->editor->requestor->id);
597 $picklist->$_($args{$_}) for keys %args;
599 $mgr->picklist($picklist);
600 return $mgr->editor->create_acq_picklist($picklist);
603 sub update_picklist {
604 my($mgr, $picklist) = @_;
605 $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
606 $picklist->edit_time('now');
607 $picklist->editor($mgr->editor->requestor->id);
608 $mgr->picklist($picklist);
609 return $picklist if $mgr->editor->update_acq_picklist($picklist);
613 sub delete_picklist {
614 my($mgr, $picklist) = @_;
615 $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
617 # delete all 'new' lineitems
618 my $lis = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => 'new'});
620 return 0 unless delete_lineitem($mgr, $li);
623 # detach all non-'new' lineitems
624 $lis = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => {'!=' => 'new'}});
627 return 0 unless update_lineitem($mgr, $li);
630 # remove any picklist-specific object perms
631 my $ops = $mgr->editor->search_permission_usr_object_perm_map({object_type => 'acqpl', object_id => ''.$picklist->id});
633 return 0 unless $mgr->editor->delete_usr_object_perm_map($op);
636 return $mgr->editor->delete_acq_picklist($picklist);
639 # ----------------------------------------------------------------------------
641 # ----------------------------------------------------------------------------
642 sub update_purchase_order {
644 $po = $mgr->editor->retrieve_acq_purchase_order($po) unless ref $po;
645 $po->editor($mgr->editor->requestor->id);
646 $po->edit_time('now');
647 $mgr->purchase_order($po);
648 return $po if $mgr->editor->update_acq_purchase_order($po);
652 sub create_purchase_order {
653 my($mgr, %args) = @_;
654 my $po = Fieldmapper::acq::purchase_order->new;
655 $po->creator($mgr->editor->requestor->id);
656 $po->editor($mgr->editor->requestor->id);
657 $po->owner($mgr->editor->requestor->id);
658 $po->edit_time('now');
659 $po->create_time('now');
660 $po->ordering_agency($mgr->editor->requestor->ws_ou);
661 $po->$_($args{$_}) for keys %args;
663 $mgr->purchase_order($po);
664 return $mgr->editor->create_acq_purchase_order($po);
667 # ----------------------------------------------------------------------------
668 # if all of the lineitems for this PO are received,
669 # mark the PO as received
670 # ----------------------------------------------------------------------------
671 sub check_purchase_order_received {
672 my($mgr, $po_id) = @_;
674 my $non_recv_li = $mgr->editor->search_acq_lineitem(
675 { purchase_order => $po_id,
676 state => {'!=' => 'received'}
679 return 1 if @$non_recv_li;
681 my $po = $mgr->editor->retrieve_acq_purchase_order($po_id);
682 $po->state('received');
683 return update_purchase_order($mgr, $po);
687 # ----------------------------------------------------------------------------
688 # Bib, Callnumber, and Copy data
689 # ----------------------------------------------------------------------------
691 sub create_lineitem_assets {
692 my($mgr, $li_id) = @_;
695 my $li = $mgr->editor->retrieve_acq_lineitem([
698 flesh_fields => {jub => ['purchase_order', 'attributes']}
702 # -----------------------------------------------------------------
703 # first, create the bib record if necessary
704 # -----------------------------------------------------------------
706 unless($li->eg_bib_id) {
707 create_bib($mgr, $li) or return 0;
711 my $li_details = $mgr->editor->search_acq_lineitem_detail({lineitem => $li_id}, {idlist=>1});
713 # -----------------------------------------------------------------
714 # for each lineitem_detail, create the volume if necessary, create
715 # a copy, and link them all together.
716 # -----------------------------------------------------------------
717 for my $lid_id (@{$li_details}) {
719 my $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid_id) or return 0;
720 next if $lid->eg_copy_id;
722 my $org = $lid->owning_lib;
723 my $label = $lid->cn_label;
724 my $bibid = $li->eg_bib_id;
726 my $volume = $mgr->cache($org, "cn.$bibid.$label");
728 $volume = create_volume($mgr, $li, $lid) or return 0;
729 $mgr->cache($org, "cn.$bibid.$label", $volume);
731 create_copy($mgr, $volume, $lid) or return 0;
734 return { li => $li, new_bib => $new_bib };
740 my $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
745 1, # override tcn collisions
747 undef # $rec->bib_source
750 if($U->event_code($record)) {
751 $mgr->editor->event($record);
752 $mgr->editor->rollback;
756 $li->eg_bib_id($record->id);
758 return update_lineitem($mgr, $li);
762 my($mgr, $li, $lid) = @_;
765 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
773 $mgr->editor->event($evt);
781 my($mgr, $volume, $lid) = @_;
782 my $copy = Fieldmapper::asset::copy->new;
784 $copy->loan_duration(2);
785 $copy->fine_level(2);
786 $copy->status(OILS_COPY_STATUS_ON_ORDER);
787 $copy->barcode($lid->barcode);
788 $copy->location($lid->location);
789 $copy->call_number($volume->id);
790 $copy->circ_lib($volume->owning_lib);
791 $copy->circ_modifier($lid->circ_modifier);
793 my $evt = OpenILS::Application::Cat::AssetCommon->create_copy($mgr->editor, $volume, $copy);
795 $mgr->editor->event($evt);
800 $lid->eg_copy_id($copy->id);
801 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
809 # ----------------------------------------------------------------------------
810 # Workflow: Build a selection list from a Z39.50 search
811 # ----------------------------------------------------------------------------
813 __PACKAGE__->register_method(
815 api_name => 'open-ils.acq.picklist.search.z3950',
818 desc => 'Performs a z3950 federated search and creates a picklist and associated lineitems',
820 {desc => 'Authentication token', type => 'string'},
821 {desc => 'Search definition', type => 'object'},
822 {desc => 'Picklist name, optional', type => 'string'},
828 my($self, $conn, $auth, $search, $name, $options) = @_;
829 my $e = new_editor(authtoken=>$auth);
830 return $e->event unless $e->checkauth;
831 return $e->event unless $e->allowed('CREATE_PICKLIST');
833 $search->{limit} ||= 10;
836 my $ses = OpenSRF::AppSession->create('open-ils.search');
837 my $req = $ses->request('open-ils.search.z3950.search_class', $auth, $search);
842 while(my $resp = $req->recv(timeout=>60)) {
845 my $e = new_editor(requestor=>$e->requestor, xact=>1);
846 $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
847 $picklist = zsearch_build_pl($mgr, $name);
851 my $result = $resp->content;
852 my $count = $result->{count};
853 $mgr->total( (($count < $search->{limit}) ? $count : $search->{limit})+1 );
855 for my $rec (@{$result->{records}}) {
857 my $li = create_lineitem($mgr,
858 picklist => $picklist->id,
859 source_label => $result->{service},
860 marc => $rec->{marcxml},
861 eg_bib_id => $rec->{bibid}
864 if($$options{respond_li}) {
865 $li->attributes($mgr->editor->search_acq_lineitem_attr({lineitem => $li->id}))
866 if $$options{flesh_attrs};
867 $li->clear_marc if $$options{clear_marc};
868 $mgr->respond(lineitem => $li);
875 $mgr->editor->commit;
876 return $mgr->respond_complete;
879 sub zsearch_build_pl {
880 my($mgr, $name) = @_;
883 my $picklist = $mgr->editor->search_acq_picklist({
884 owner => $mgr->editor->requestor->id,
888 if($name eq '' and $picklist) {
889 return 0 unless delete_picklist($mgr, $picklist);
893 return update_picklist($mgr, $picklist) if $picklist;
894 return create_picklist($mgr, name => $name);
898 # ----------------------------------------------------------------------------
899 # Workflow: Build a selection list / PO by importing a batch of MARC records
900 # ----------------------------------------------------------------------------
902 __PACKAGE__->register_method(
903 method => 'upload_records',
904 api_name => 'open-ils.acq.process_upload_records',
909 my($self, $conn, $auth, $key) = @_;
911 my $e = new_editor(authtoken => $auth, xact => 1);
912 return $e->die_event unless $e->checkauth;
913 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
915 my $cache = OpenSRF::Utils::Cache->new;
917 my $data = $cache->get_cache("vandelay_import_spool_$key");
918 my $purpose = $data->{purpose};
919 my $filename = $data->{path};
920 my $provider = $data->{provider};
921 my $picklist = $data->{picklist};
922 my $create_po = $data->{create_po};
923 my $ordering_agency = $data->{ordering_agency};
924 my $create_assets = $data->{create_assets};
928 unless(-r $filename) {
929 $logger->error("unable to read MARC file $filename");
931 return OpenILS::Event->new('FILE_UPLOAD_ERROR', payload => {filename => $filename});
934 $provider = $e->retrieve_acq_provider($provider) or return $e->die_event;
937 $picklist = $e->retrieve_acq_picklist($picklist) or return $e->die_event;
938 if($picklist->owner != $e->requestor->id) {
939 return $e->die_event unless
940 $e->allowed('CREATE_PICKLIST', $picklist->org_unit, $picklist);
945 $po = create_purchase_order($mgr,
946 ordering_agency => $ordering_agency,
947 provider => $provider->id
948 ) or return $mgr->editor->die_event;
951 $logger->info("acq processing MARC file=$filename");
953 my $marctype = 'USMARC'; # ?
954 my $batch = new MARC::Batch ($marctype, $filename);
971 $logger->warn("Proccessing of record $count in set $key failed with error $err. Skipping this record");
978 ($xml = $r->as_xml_record()) =~ s/\n//sog;
979 $xml =~ s/^<\?xml.+\?\s*>//go;
980 $xml =~ s/>\s+</></go;
981 $xml =~ s/\p{Cc}//go;
982 $xml = $U->entityize($xml);
983 $xml =~ s/[\x00-\x1f]//go;
987 $logger->warn("Proccessing XML of record $count in set $key failed with error $err. Skipping this record");
990 next if $err or not $xml;
993 source_label => $provider->code,
994 provider => $provider->id,
998 $args{picklist} = $picklist->id if $picklist;
1000 $args{purchase_order} = $po->id;
1001 $args{state} = 'on-order';
1004 my $li = create_lineitem($mgr, %args) or return $mgr->editor->die_event;
1006 $li->provider($provider); # flesh it, we'll need it later
1008 import_lineitem_details($mgr, $ordering_agency, $li) or return $mgr->editor->die_event;
1011 push(@li_list, $li->id);
1017 $cache->delete_cache('vandelay_import_spool_' . $key);
1019 if($create_assets) {
1020 create_lineitem_list_assets($mgr, \@li_list) or return $e->die_event;
1023 return $mgr->respond_complete;
1026 sub import_lineitem_details {
1027 my($mgr, $ordering_agency, $li) = @_;
1029 my $holdings = $mgr->editor->json_query({from => ['acq.extract_provider_holding_data', $li->id]});
1030 return 1 unless @$holdings;
1031 my $org_path = $U->get_org_ancestors($ordering_agency);
1032 $org_path = [ reverse (@$org_path) ];
1037 # create a lineitem detail for each copy in the data
1039 my $compiled = extract_lineitem_detail_data($mgr, $org_path, $holdings, $idx);
1040 last unless defined $compiled;
1041 return 0 unless $compiled;
1043 # this takes the price of the last copy and uses it as the lineitem price
1044 # need to determine if a given record would include different prices for the same item
1045 $price = $$compiled{price};
1047 for(1..$$compiled{quantity}) {
1048 my $lid = create_lineitem_detail($mgr,
1049 lineitem => $li->id,
1050 owning_lib => $$compiled{owning_lib},
1051 cn_label => $$compiled{call_number},
1052 fund => $$compiled{fund},
1053 circ_modifier => $$compiled{circ_modifier},
1054 note => $$compiled{note},
1055 location => $$compiled{copy_location}
1063 # set the price attr so we'll know the source of the price
1066 attr_name => 'estimated_price',
1067 attr_type => 'lineitem_local_attr_definition',
1068 attr_value => $price,
1072 # if we're creating a purchase order, create the debits
1073 if($li->purchase_order) {
1074 create_lineitem_debits($mgr, $li, $price, 2) or return 0;
1081 # return hash on success, 0 on error, undef on no more holdings
1082 sub extract_lineitem_detail_data {
1083 my($mgr, $org_path, $holdings, $index) = @_;
1085 my @data_list = grep { $_->{holding} eq $index } @$holdings;
1086 return undef unless @data_list;
1088 my %compiled = map { $_->{attr} => $_->{data} } @data_list;
1089 my $base_org = $$org_path[0];
1093 $logger->error("Item import extraction error: $msg");
1094 $logger->error('Holdings Data: ' . OpenSRF::Utils::JSON->perl2JSON(\%compiled));
1095 $mgr->editor->rollback;
1096 $mgr->editor->event(OpenILS::Event->new('ACQ_IMPORT_ERROR', payload => $msg));
1100 $compiled{quantity} ||= 1;
1102 # ---------------------------------------------------------------------
1104 my $code = $compiled{fund_code};
1105 return $killme->('no fund code provided') unless $code;
1107 my $fund = $mgr->cache($base_org, "fund.$code");
1109 # search up the org tree for the most appropriate fund
1110 for my $org (@$org_path) {
1111 $fund = $mgr->editor->search_acq_fund(
1112 {org => $org, code => $code, year => DateTime->now->year}, {idlist => 1})->[0];
1116 return $killme->("no fund with code $code at orgs [@$org_path]") unless $fund;
1117 $compiled{fund} = $fund;
1118 $mgr->cache($base_org, "fund.$code", $fund);
1121 # ---------------------------------------------------------------------
1123 my $sn = $compiled{owning_lib};
1124 return $killme->('no owning_lib defined') unless $sn;
1126 $mgr->cache($base_org, "orgsn.$sn") ||
1127 $mgr->editor->search_actor_org_unit({shortname => $sn}, {idlist => 1})->[0];
1128 return $killme->("invalid owning_lib defined: $sn") unless $org_id;
1129 $compiled{owning_lib} = $org_id;
1130 $mgr->cache($$org_path[0], "orgsn.$sn", $org_id);
1133 # ---------------------------------------------------------------------
1136 $code = $compiled{circ_modifier};
1140 $mod = $mgr->cache($base_org, "mod.$code") ||
1141 $mgr->editor->retrieve_config_circ_modifier($code);
1142 return $killme->("invlalid circ_modifier $code") unless $mod;
1143 $mgr->cache($base_org, "mod.$code", $mod);
1147 $mod = get_default_circ_modifier($mgr, $base_org)
1148 or return $killme->('no circ_modifier defined');
1151 $compiled{circ_modifier} = $mod;
1154 # ---------------------------------------------------------------------
1156 my $name = $compiled{copy_location};
1157 return $killme->('no copy_location defined') unless $name;
1158 my $loc = $mgr->cache($base_org, "copy_loc.$name");
1160 for my $org (@$org_path) {
1161 $loc = $mgr->editor->search_asset_copy_location(
1162 {owning_lib => $org, name => $name}, {idlist => 1})->[0];
1166 return $killme->("Invalid copy location $name") unless $loc;
1167 $compiled{copy_location} = $loc;
1168 $mgr->cache($base_org, "copy_loc.$name", $loc);
1175 # ----------------------------------------------------------------------------
1176 # Workflow: Given an existing purchase order, import/create the bibs,
1177 # callnumber and copy objects
1178 # ----------------------------------------------------------------------------
1180 __PACKAGE__->register_method(
1181 method => 'create_po_assets',
1182 api_name => 'open-ils.acq.purchase_order.assets.create',
1184 desc => q/Creates assets for each lineitem in the purchase order/,
1186 {desc => 'Authentication token', type => 'string'},
1187 {desc => 'The purchase order id', type => 'number'},
1189 return => {desc => 'Streams a total versus completed counts object, event on error'}
1193 sub create_po_assets {
1194 my($self, $conn, $auth, $po_id) = @_;
1196 my $e = new_editor(authtoken=>$auth, xact=>1);
1197 return $e->die_event unless $e->checkauth;
1198 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1200 my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1201 return $e->die_event unless $e->allowed('IMPORT_PURCHASE_ORDER_ASSETS', $po->ordering_agency);
1203 my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1205 # it's ugly, but it's fast. Get the total count of lineitem detail objects to process
1206 my $lid_total = $e->json_query({
1207 select => { acqlid => [{aggregate => 1, transform => 'count', column => 'id'}] },
1213 join => {acqpo => {fkey => 'purchase_order', field => 'id'}}
1217 where => {'+acqpo' => {id => $po_id}}
1220 $mgr->total(scalar(@$li_ids) + $lid_total);
1222 create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1225 update_purchase_order($mgr, $po) or return $e->die_event;
1228 return $mgr->respond_complete;
1233 __PACKAGE__->register_method(
1234 method => 'create_purchase_order_api',
1235 api_name => 'open-ils.acq.purchase_order.create',
1237 desc => 'Creates a new purchase order',
1239 {desc => 'Authentication token', type => 'string'},
1240 {desc => 'purchase_order to create', type => 'object'}
1242 return => {desc => 'The purchase order id, Event on failure'}
1246 sub create_purchase_order_api {
1247 my($self, $conn, $auth, $po, $args) = @_;
1250 my $e = new_editor(xact=>1, authtoken=>$auth);
1251 return $e->die_event unless $e->checkauth;
1252 return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
1253 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1256 my %pargs = (ordering_agency => $e->requestor->ws_ou);
1257 $pargs{provider} = $po->provider if $po->provider;
1258 $po = create_purchase_order($mgr, %pargs) or return $e->die_event;
1260 my $li_ids = $$args{lineitems};
1264 for my $li_id (@$li_ids) {
1266 my $li = $e->retrieve_acq_lineitem([
1268 {flesh => 1, flesh_fields => {jub => ['attributes']}}
1269 ]) or return $e->die_event;
1271 $li->provider($po->provider);
1272 $li->purchase_order($po->id);
1273 update_lineitem($mgr, $li) or return $e->die_event;
1276 create_lineitem_debits($mgr, $li) or return $e->die_event;
1280 # commit before starting the asset creation
1283 if($li_ids and $$args{create_assets}) {
1284 create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1287 return $mgr->respond_complete;
1291 __PACKAGE__->register_method(
1292 method => 'lineitem_detail_CUD_batch',
1293 api_name => 'open-ils.acq.lineitem_detail.cud.batch',
1296 desc => q/Creates a new purchase order line item detail.
1297 Additionally creates the associated fund_debit/,
1299 {desc => 'Authentication token', type => 'string'},
1300 {desc => 'List of lineitem_details to create', type => 'array'},
1302 return => {desc => 'Streaming response of current position in the array'}
1306 sub lineitem_detail_CUD_batch {
1307 my($self, $conn, $auth, $li_details) = @_;
1309 my $e = new_editor(xact=>1, authtoken=>$auth);
1310 return $e->die_event unless $e->checkauth;
1311 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1315 $mgr->total(scalar(@$li_details));
1319 for my $lid (@$li_details) {
1321 my $li = $li_cache{$lid->lineitem} || $e->retrieve_acq_lineitem($lid->lineitem);
1324 create_lineitem_detail($mgr, %{$lid->to_bare_hash}) or return $e->die_event;
1326 } elsif($lid->ischanged) {
1327 $e->update_acq_lineitem_detail($lid) or return $e->die_event;
1329 } elsif($lid->isdeleted) {
1330 delete_lineitem_detail($mgr, $lid) or return $e->die_event;
1333 $mgr->respond(li => $li);
1334 $li_cache{$lid->lineitem} = $li;
1338 return $mgr->respond_complete;
1342 __PACKAGE__->register_method(
1343 method => 'receive_po_api',
1344 api_name => 'open-ils.acq.purchase_order.receive'
1347 sub receive_po_api {
1348 my($self, $conn, $auth, $po_id) = @_;
1349 my $e = new_editor(xact => 1, authtoken => $auth);
1350 return $e->die_event unless $e->checkauth;
1351 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1353 my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1354 return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1356 my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1358 for my $li_id (@$li_ids) {
1359 receive_lineitem($mgr, $li_id) or return $e->die_event;
1363 $po->state('received');
1364 update_purchase_order($mgr, $po) or return $e->die_event;
1367 return $mgr->respond_complete;
1371 __PACKAGE__->register_method(
1372 method => 'receive_lineitem_detail_api',
1373 api_name => 'open-ils.acq.lineitem_detail.receive',
1375 desc => 'Mark a lineitem_detail as received',
1377 {desc => 'Authentication token', type => 'string'},
1378 {desc => 'lineitem detail ID', type => 'number'}
1380 return => {desc => '1 on success, Event on error'}
1384 sub receive_lineitem_detail_api {
1385 my($self, $conn, $auth, $lid_id) = @_;
1387 my $e = new_editor(xact=>1, authtoken=>$auth);
1388 return $e->die_event unless $e->checkauth;
1389 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1391 my $lid = $e->retrieve_acq_lineitem_detail([
1395 acqlid => ['lineitem'],
1396 jub => ['purchase_order']
1401 return $e->die_event unless $e->allowed(
1402 'RECEIVE_PURCHASE_ORDER', $lid->lineitem->purchase_order->ordering_agency);
1404 receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1409 __PACKAGE__->register_method(
1410 method => 'receive_lineitem_api',
1411 api_name => 'open-ils.acq.lineitem.receive',
1413 desc => 'Mark a lineitem as received',
1415 {desc => 'Authentication token', type => 'string'},
1416 {desc => 'lineitem detail ID', type => 'number'}
1418 return => {desc => '1 on success, Event on error'}
1422 sub receive_lineitem_api {
1423 my($self, $conn, $auth, $li_id) = @_;
1425 my $e = new_editor(xact=>1, authtoken=>$auth);
1426 return $e->die_event unless $e->checkauth;
1427 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1429 my $li = $e->retrieve_acq_lineitem([
1433 jub => ['purchase_order']
1436 ]) or return $e->die_event;
1438 return $e->die_event unless $e->allowed(
1439 'RECEIVE_PURCHASE_ORDER', $li->purchase_order->ordering_agency);
1441 receive_lineitem($mgr, $li_id) or return $e->die_event;
1447 __PACKAGE__->register_method(
1448 method => 'rollback_receive_po_api',
1449 api_name => 'open-ils.acq.purchase_order.receive.rollback'
1452 sub rollback_receive_po_api {
1453 my($self, $conn, $auth, $po_id) = @_;
1454 my $e = new_editor(xact => 1, authtoken => $auth);
1455 return $e->die_event unless $e->checkauth;
1456 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1458 my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1459 return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1461 my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1463 for my $li_id (@$li_ids) {
1464 rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1468 $po->state('on-order');
1469 update_purchase_order($mgr, $po) or return $e->die_event;
1472 return $mgr->respond_complete;
1476 __PACKAGE__->register_method(
1477 method => 'rollback_receive_lineitem_detail_api',
1478 api_name => 'open-ils.acq.lineitem_detail.receive.rollback',
1480 desc => 'Mark a lineitem_detail as received',
1482 {desc => 'Authentication token', type => 'string'},
1483 {desc => 'lineitem detail ID', type => 'number'}
1485 return => {desc => '1 on success, Event on error'}
1489 sub rollback_receive_lineitem_detail_api {
1490 my($self, $conn, $auth, $lid_id) = @_;
1492 my $e = new_editor(xact=>1, authtoken=>$auth);
1493 return $e->die_event unless $e->checkauth;
1494 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1496 my $lid = $e->retrieve_acq_lineitem_detail([
1500 acqlid => ['lineitem'],
1501 jub => ['purchase_order']
1505 my $li = $lid->lineitem;
1506 my $po = $li->purchase_order;
1508 return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1509 rollback_receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1511 $li->state('on-order');
1512 $po->state('on-order');
1513 udpate_lineitem($mgr, $li) or return $e->die_event;
1514 udpate_purchase_order($mgr, $po) or return $e->die_event;
1520 __PACKAGE__->register_method(
1521 method => 'rollback_receive_lineitem_api',
1522 api_name => 'open-ils.acq.lineitem.receive.rollback',
1524 desc => 'Mark a lineitem as received',
1526 {desc => 'Authentication token', type => 'string'},
1527 {desc => 'lineitem detail ID', type => 'number'}
1529 return => {desc => '1 on success, Event on error'}
1533 sub rollback_receive_lineitem_api {
1534 my($self, $conn, $auth, $li_id) = @_;
1536 my $e = new_editor(xact=>1, authtoken=>$auth);
1537 return $e->die_event unless $e->checkauth;
1538 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1540 my $li = $e->retrieve_acq_lineitem_detail([
1544 jub => ['purchase_order']
1548 my $po = $li->purchase_order;
1550 return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1552 rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1554 $po->state('on-order');
1555 update_purchase_order($mgr, $po) or return $e->die_event;
1562 __PACKAGE__->register_method(
1563 method => 'set_lineitem_price_api',
1564 api_name => 'open-ils.acq.lineitem.price.set',
1566 desc => 'Set lineitem price. If debits already exist, update them as well',
1568 {desc => 'Authentication token', type => 'string'},
1569 {desc => 'lineitem ID', type => 'number'}
1571 return => {desc => 'status blob, Event on error'}
1575 sub set_lineitem_price_api {
1576 my($self, $conn, $auth, $li_id, $price, $currency) = @_;
1578 my $e = new_editor(xact=>1, authtoken=>$auth);
1579 return $e->die_event unless $e->checkauth;
1580 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1584 my $li = $e->retrieve_acq_lineitem($li_id) or return $e->die_event;
1586 # update the local attr for estimated price
1589 attr_name => 'estimated_price',
1590 attr_type => 'lineitem_local_attr_definition',
1591 attr_value => $price,
1593 ) or return $e->die_event;
1595 my $lid_ids = $e->search_acq_lineitem_detail(
1596 {lineitem => $li_id, fund_debit => {'!=' => undef}},
1600 for my $lid_id (@$lid_ids) {
1602 my $lid = $e->retrieve_acq_lineitem_detail([
1604 flesh => 1, flesh_fields => {acqlid => ['fund', 'fund_debit']}}
1607 # onless otherwise specified, assume currency of new price is same as currency type of the fund
1608 $currency ||= $lid->fund->currency_type;
1609 my $amount = $price;
1611 if($lid->fund->currency_type ne $currency) {
1612 $amount = currency_conversion($mgr, $currency, $lid->fund->currency_type, $price);
1615 $lid->fund_debit->origin_currency_type($currency);
1616 $lid->fund_debit->origin_amount($price);
1617 $lid->fund_debit->amount($amount);
1619 $e->update_acq_fund_debit($lid->fund_debit) or return $e->die_event;
1625 return $mgr->respond_complete;
1629 __PACKAGE__->register_method(
1630 method => 'clone_picklist_api',
1631 api_name => 'open-ils.acq.picklist.clone',
1633 desc => 'Clones a picklist, including lineitem and lineitem details',
1635 {desc => 'Authentication token', type => 'string'},
1636 {desc => 'Picklist ID', type => 'number'},
1637 {desc => 'New Picklist Name', type => 'string'}
1639 return => {desc => 'status blob, Event on error'}
1643 sub clone_picklist_api {
1644 my($self, $conn, $auth, $pl_id, $name) = @_;
1646 my $e = new_editor(xact=>1, authtoken=>$auth);
1647 return $e->die_event unless $e->checkauth;
1648 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1650 my $old_pl = $e->retrieve_acq_picklist($pl_id);
1651 my $new_pl = create_picklist($mgr, %{$old_pl->to_bare_hash}, name => $name) or return $e->die_event;
1653 my $li_ids = $e->search_acq_lineitem({picklist => $pl_id}, {idlist => 1});
1655 for my $li_id (@$li_ids) {
1657 # copy the lineitems
1658 my $li = $e->retrieve_acq_lineitem($li_id);
1659 my $new_li = create_lineitem($mgr, %{$li->to_bare_hash}, picklist => $new_pl->id) or return $e->die_event;
1661 my $lid_ids = $e->search_acq_lineitem_detail({lineitem => $li_id}, {idlist => 1});
1662 for my $lid_id (@$lid_ids) {
1664 # copy the lineitem details
1665 my $lid = $e->retrieve_acq_lineitem_detail($lid_id);
1666 create_lineitem_detail($mgr, %{$lid->to_bare_hash}, lineitem => $new_li->id) or return $e->die_event;
1672 return $mgr->respond_complete;
1676 __PACKAGE__->register_method(
1677 method => 'merge_picklist_api',
1678 api_name => 'open-ils.acq.picklist.merge',
1680 desc => 'Merges 2 or more picklists into a single list',
1682 {desc => 'Authentication token', type => 'string'},
1683 {desc => 'Lead Picklist ID', type => 'number'},
1684 {desc => 'List of subordinate picklist IDs', type => 'array'}
1686 return => {desc => 'status blob, Event on error'}
1690 sub merge_picklist_api {
1691 my($self, $conn, $auth, $lead_pl, $pl_list) = @_;
1693 my $e = new_editor(xact=>1, authtoken=>$auth);
1694 return $e->die_event unless $e->checkauth;
1695 my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1697 # XXX perms on each picklist modified
1699 # point all of the lineitems at the lead picklist
1700 my $li_ids = $e->search_acq_lineitem({picklist => $pl_list}, {idlist => 1});
1702 for my $li_id (@$li_ids) {
1703 my $li = $e->retrieve_acq_lineitem($li_id);
1704 $li->picklist($lead_pl);
1705 update_lineitem($mgr, $li) or return $e->die_event;
1709 # now delete the subordinate lists
1710 for my $pl_id (@$pl_list) {
1711 my $pl = $e->retrieve_acq_picklist($pl_id);
1712 $e->delete_acq_picklist($pl) or return $e->die_event;
1716 return $mgr->respond_complete;