1 package OpenILS::Application::Acq::BatchManager;
2 use strict; use warnings;
5 my($class, %args) = @_;
6 my $self = bless(\%args, $class);
13 purchase_order => undef,
23 $self->{conn} = $val if $val;
28 $self->{throttle} = $val if $val;
29 return $self->{throttle};
32 my($self, %other_args) = @_;
33 if($self->throttle and not %other_args) {
34 return unless ($self->{args}->{progress} % $self->throttle) == 0;
36 $self->conn->respond({ %{$self->{args}}, %other_args });
38 sub respond_complete {
39 my($self, %other_args) = @_;
41 $self->conn->respond_complete({ %{$self->{args}}, %other_args });
46 $self->{total} = $val if defined $val;
47 return $self->{total};
51 $self->{purchase_order} = $val if $val;
56 $self->{picklist} = $val if $val;
61 $self->{args}->{lid} += 1;
62 $self->{args}->{progress} += 1;
67 $self->{args}->{li} += 1;
68 $self->{args}->{progress} += 1;
73 $self->{args}->{copies} += 1;
74 $self->{args}->{progress} += 1;
78 my($self, $amount) = @_;
79 $self->{args}->{debits_accrued} += $amount;
80 $self->{args}->{progress} += 1;
84 my($self, $editor) = @_;
85 $self->{editor} = $editor if defined $editor;
86 return $self->{editor};
90 $self->{args}->{complete} = 1;
95 my($self, $org, $key, $val) = @_;
96 $self->{cache}->{$org} = {} unless $self->{cache}->{org};
97 $self->{cache}->{$org}->{$key} = $val if defined $val;
98 return $self->{cache}->{$org}->{$key};
102 package OpenILS::Application::Acq::Order;
103 use base qw/OpenILS::Application/;
104 use strict; use warnings;
105 # ----------------------------------------------------------------------------
106 # Break up each component of the order process and pieces into managable
107 # actions that can be shared across different workflows
108 # ----------------------------------------------------------------------------
110 use OpenSRF::Utils::Logger qw(:logger);
111 use OpenSRF::Utils::JSON;
112 use OpenILS::Utils::Fieldmapper;
113 use OpenILS::Utils::CStoreEditor q/:funcs/;
114 use OpenILS::Const qw/:const/;
115 use OpenSRF::EX q/:try/;
116 use OpenILS::Application::AppUtils;
117 use OpenILS::Application::Cat::BibCommon;
118 use OpenILS::Application::Cat::AssetCommon;
122 my $U = 'OpenILS::Application::AppUtils';
125 # ----------------------------------------------------------------------------
127 # ----------------------------------------------------------------------------
128 sub create_lineitem {
129 my($mgr, %args) = @_;
130 my $li = Fieldmapper::acq::lineitem->new;
131 $li->creator($mgr->editor->requestor->id);
132 $li->selector($li->creator);
133 $li->editor($li->creator);
134 $li->create_time('now');
135 $li->edit_time('now');
137 $li->$_($args{$_}) for keys %args;
139 return 0 unless update_picklist($mgr, $li->picklist);
142 return $mgr->editor->create_acq_lineitem($li);
145 sub update_lineitem {
147 $li->edit_time('now');
148 $li->editor($mgr->editor->requestor->id);
149 return $li if $mgr->editor->update_acq_lineitem($li);
153 sub delete_lineitem {
155 $li = $mgr->editor->retrieve_acq_lineitem($li) unless ref $li;
158 return 0 unless update_picklist($mgr, $li->picklist);
161 if($li->purchase_order) {
162 return 0 unless update_purchase_order($mgr, $li->purchase_order);
165 # delete the attached lineitem_details
166 my $lid_ids = $mgr->editor->search_acq_lineitem_detail({lineitem => $li->id}, {idlist=>1});
167 for my $lid_id (@$lid_ids) {
168 return 0 unless delete_lineitem_detail($mgr, undef, $lid_id);
171 return $mgr->editor->delete_acq_lineitem($li);
174 # ----------------------------------------------------------------------------
176 # ----------------------------------------------------------------------------
177 sub create_lineitem_detail {
178 my($mgr, %args) = @_;
179 my $lid = Fieldmapper::acq::lineitem_detail->new;
180 $lid->$_($args{$_}) for keys %args;
181 $mgr->editor->create_acq_lineitem_detail($lid) or return 0;
184 # create some default values
185 unless($lid->barcode) {
186 my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_barcode_prefix') || 'ACQ';
187 $lid->barcode($pfx.$lid->id);
190 unless($lid->cn_label) {
191 my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_callnumber_prefix') || 'ACQ';
192 $lid->cn_label($pfx.$lid->id);
195 if(!$lid->location and my $loc = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.default_copy_location')) {
196 $lid->location($loc);
199 if(!$lid->circ_modifier and my $mod = get_default_circ_modifier($mgr, $lid->owning_lib)) {
200 $lid->circ_modifier($mod);
203 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
204 my $li = $mgr->editor->retrieve_acq_lineitem($lid->lineitem) or return 0;
205 update_lineitem($mgr, $li) or return 0;
209 sub get_default_circ_modifier {
211 my $mod = $mgr->cache($org, "def_circ_mod");
213 $mod = $U->ou_ancestor_setting_value($org, 'acq.default_circ_modifier');
214 return $mgr->cache($org, "def_circ_mod", $mod) if $mod;
218 sub delete_lineitem_detail {
220 $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid) unless ref $lid;
221 return $mgr->editor->delete_acq_lineitem_detail($lid);
225 # ----------------------------------------------------------------------------
227 # ----------------------------------------------------------------------------
228 sub set_lineitem_attr {
229 my($mgr, %args) = @_;
230 my $attr_type = $args{attr_type};
232 # first, see if it's already set. May just need to overwrite it
233 my $attr = $mgr->editor->search_acq_lineitem_attr({
234 lineitem => $args{lineitem},
235 attr_type => $args{attr_type},
236 attr_name => $args{attr_name}
240 $attr->attr_value($args{attr_value});
241 return $attr if $mgr->editor->update_acq_lineitem_attr($attr);
246 $attr = Fieldmapper::acq::lineitem_attr->new;
247 $attr->$_($args{$_}) for keys %args;
249 unless($attr->definition) {
250 my $find = "search_acq_$attr_type";
251 my $attr_def_id = $mgr->editor->$find({code => $attr->attr_name}, {idlist=>1})->[0] or return 0;
252 $attr->definition($attr_def_id);
254 return $mgr->editor->create_acq_lineitem_attr($attr);
258 # ----------------------------------------------------------------------------
260 # ----------------------------------------------------------------------------
261 sub create_picklist {
262 my($mgr, %args) = @_;
263 my $picklist = Fieldmapper::acq::picklist->new;
264 $picklist->creator($mgr->editor->requestor->id);
265 $picklist->owner($picklist->creator);
266 $picklist->editor($picklist->creator);
267 $picklist->create_time('now');
268 $picklist->edit_time('now');
269 $picklist->org_unit($mgr->editor->requestor->ws_ou);
270 $picklist->owner($mgr->editor->requestor->id);
271 $picklist->$_($args{$_}) for keys %args;
272 $mgr->picklist($picklist);
273 return $mgr->editor->create_acq_picklist($picklist);
276 sub update_picklist {
277 my($mgr, $picklist) = @_;
278 $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
279 $picklist->edit_time('now');
280 $picklist->editor($mgr->editor->requestor->id);
281 return $picklist if $mgr->editor->update_acq_picklist($picklist);
285 sub delete_picklist {
286 my($mgr, $picklist) = @_;
287 $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
289 # delete all 'new' lineitems
290 my $lis = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => 'new'});
292 return 0 unless delete_lineitem($mgr, $li);
295 # detach all non-'new' lineitems
296 $lis = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => {'!=' => 'new'}});
299 return 0 unless update_lineitem($li);
302 # remove any picklist-specific object perms
303 my $ops = $mgr->editor->search_permission_usr_object_perm_map({object_type => 'acqpl', object_id => "".$picklist->id});
305 return 0 unless $mgr->editor->delete_usr_object_perm_map($op);
308 return $mgr->editor->delete_acq_picklist($picklist);
311 # ----------------------------------------------------------------------------
313 # ----------------------------------------------------------------------------
314 sub update_purchase_order {
316 $po = $mgr->editor->retrieve_acq_purchase_order($po) unless ref $po;
317 $po->editor($mgr->editor->requestor->id);
318 $po->edit_date('now');
319 return $po if $mgr->editor->update_acq_purchase_order($po);
323 sub create_purchase_order {
324 my($mgr, %args) = @_;
325 my $po = Fieldmapper::acq::purchase_order->new;
326 $po->creator($mgr->editor->requestor->id);
327 $po->editor($mgr->editor->requestor->id);
328 $po->owner($mgr->editor->requestor->id);
329 $po->edit_time('now');
330 $po->create_time('now');
331 $po->ordering_agency($mgr->editor->requestor->ws_ou);
332 $po->$_($args{$_}) for keys %args;
333 $mgr->purchase_order($po);
334 return $mgr->editor->create_acq_purchase_order($po);
338 # ----------------------------------------------------------------------------
339 # Bib, Callnumber, and Copy data
340 # ----------------------------------------------------------------------------
342 sub create_lineitem_assets {
343 my($mgr, $li_id) = @_;
346 my $li = $mgr->editor->retrieve_acq_lineitem([
349 flesh_fields => {jub => ['purchase_order', 'attributes']}
353 # -----------------------------------------------------------------
354 # first, create the bib record if necessary
355 # -----------------------------------------------------------------
356 unless($li->eg_bib_id) {
357 create_bib($mgr, $li) or return 0;
360 my $li_details = $mgr->editor->search_acq_lineitem_detail({lineitem => $li_id}, {idlist=>1});
362 # -----------------------------------------------------------------
363 # for each lineitem_detail, create the volume if necessary, create
364 # a copy, and link them all together.
365 # -----------------------------------------------------------------
366 for my $lid_id (@{$li_details}) {
368 my $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid_id) or return 0;
369 my $org = $lid->owning_lib;
370 my $label = $lid->cn_label;
372 my $volume = $mgr->cache($org, "cn.$label");
374 $volume = create_volume($mgr, $li, $lid) or return 0;
375 $mgr->cache($org, "cn.$label", $volume);
377 create_copy($mgr, $volume, $lid) or return 0;
386 my $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
387 $mgr->editor, $li->marc, undef, undef, 1); #$rec->bib_source
389 if($U->event_code($record)) {
390 $mgr->editor->event($record);
391 $mgr->editor->rollback;
395 $li->eg_bib_id($record->id);
396 return update_lineitem($mgr, $li);
400 my($mgr, $li, $lid) = @_;
403 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
411 $mgr->editor->event($evt);
419 my($mgr, $volume, $lid) = @_;
420 my $copy = Fieldmapper::asset::copy->new;
422 $copy->loan_duration(2);
423 $copy->fine_level(2);
424 $copy->status(OILS_COPY_STATUS_ON_ORDER);
425 $copy->barcode($lid->barcode);
426 $copy->location($lid->location);
427 $copy->call_number($volume->id);
428 $copy->circ_lib($volume->owning_lib);
429 $copy->circ_modifier($lid->circ_modifier);
431 my $evt = OpenILS::Application::Cat::AssetCommon->create_copy($mgr->editor, $volume, $copy);
433 $mgr->editor->event($evt);
438 $lid->eg_copy_id($copy->id);
439 $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
447 # ----------------------------------------------------------------------------
448 # Workflow: Build a selection list from a Z39.50 search
449 # ----------------------------------------------------------------------------
451 __PACKAGE__->register_method(
453 api_name => 'open-ils.acq.picklist.search.z3950',
456 desc => 'Performs a z3950 federated search and creates a picklist and associated lineitems',
458 {desc => 'Authentication token', type => 'string'},
459 {desc => 'Search definition', type => 'object'},
460 {desc => 'Picklist name, optional', type => 'string'},
466 my($self, $conn, $auth, $search, $name, $options) = @_;
467 my $e = new_editor(authtoken=>$auth);
468 return $e->event unless $e->checkauth;
469 return $e->event unless $e->allowed('CREATE_PICKLIST');
471 $search->{limit} ||= 10;
474 my $ses = OpenSRF::AppSession->create('open-ils.search');
475 my $req = $ses->request('open-ils.search.z3950.search_class', $auth, $search);
480 while(my $resp = $req->recv(timeout=>60)) {
483 my $e = new_editor(requestor=>$e->requestor, xact=>1);
484 $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
485 $picklist = zsearch_build_pl($mgr, $name);
489 my $result = $resp->content;
490 my $count = $result->{count};
491 $mgr->total( (($count < $search->{limit}) ? $count : $search->{limit})+1 );
493 for my $rec (@{$result->{records}}) {
495 my $li = create_lineitem($mgr,
496 picklist => $picklist->id,
497 source_label => $result->{service},
498 marc => $rec->{marcxml},
499 eg_bib_id => $rec->{bibid}
502 if($$options{respond_li}) {
503 $li->attributes($mgr->editor->search_acq_lineitem_attr({lineitem => $li->id}))
504 if $$options{flesh_attrs};
505 $li->clear_marc if $$options{clear_marc};
506 $mgr->respond(lineitem => $li);
513 $mgr->editor->commit;
514 return $mgr->respond_complete;
517 sub zsearch_build_pl {
518 my($mgr, $name) = @_;
521 my $picklist = $mgr->editor->search_acq_picklist({
522 owner => $mgr->editor->requestor->id,
526 if($name eq '' and $picklist) {
527 return 0 unless delete_picklist($mgr, $picklist);
531 return update_picklist($mgr, $picklist) if $picklist;
532 return create_picklist($mgr, name => $name);
536 # ----------------------------------------------------------------------------
537 # Workflow: Build a selection list / PO by importing a batch of MARC records
538 # ----------------------------------------------------------------------------
540 __PACKAGE__->register_method(
541 method => 'upload_records',
542 api_name => 'open-ils.acq.process_upload_records',
547 my($self, $conn, $auth, $key) = @_;
549 my $e = new_editor(authtoken => $auth, xact => 1);
550 return $e->die_event unless $e->checkauth;
551 my $mgr = OpenILS::Application::Acq::BatchManager->new(
552 editor => $e, conn => $conn, throttle => 5);
554 my $cache = OpenSRF::Utils::Cache->new;
557 my $data = $cache->get_cache("vandelay_import_spool_$key");
558 my $purpose = $data->{purpose};
559 my $filename = $data->{path};
560 my $provider = $data->{provider};
561 my $picklist = $data->{picklist};
562 my $create_po = $data->{create_po};
563 my $ordering_agency = $data->{ordering_agency};
566 unless(-r $filename) {
567 $logger->error("unable to read MARC file $filename");
569 return OpenILS::Event->new('FILE_UPLOAD_ERROR', payload => {filename => $filename});
572 $provider = $e->retrieve_acq_provider($provider) or return $e->die_event;
575 $picklist = $e->retrieve_acq_picklist($picklist) or return $e->die_event;
576 if($picklist->owner != $e->requestor->id) {
577 return $e->die_event unless
578 $e->allowed('CREATE_PICKLIST', $picklist->org_unit, $picklist);
583 $po = create_purchase_order($mgr,
584 ordering_agency => $ordering_agency,
585 provider => $provider->id
586 ) or return $mgr->editor->die_event;
589 $logger->info("acq processing MARC file=$filename");
591 my $marctype = 'USMARC'; # ?
592 my $batch = new MARC::Batch ($marctype, $filename);
608 $logger->warn("Proccessing of record $count in set $key failed with error $err. Skipping this record");
615 ($xml = $r->as_xml_record()) =~ s/\n//sog;
616 $xml =~ s/^<\?xml.+\?\s*>//go;
617 $xml =~ s/>\s+</></go;
618 $xml =~ s/\p{Cc}//go;
619 $xml = $U->entityize($xml);
620 $xml =~ s/[\x00-\x1f]//go;
624 $logger->warn("Proccessing XML of record $count in set $key failed with error $err. Skipping this record");
627 next if $err or not $xml;
630 source_label => $provider->code,
631 provider => $provider->id,
635 $args{picklist} = $picklist->id if $picklist;
637 $args{purchase_order} = $po->id;
638 $args{state} = 'on-order';
641 my $li = create_lineitem($mgr, %args) or return $mgr->editor->die_event;
644 import_lineitem_details($mgr, $ordering_agency, $li) or return $mgr->editor->die_event;
647 if($li->purchase_order) {
648 create_lineitem_assets($mgr, $li->id) or return 0;
655 $cache->delete_cache('vandelay_import_spool_' . $key);
657 return $mgr->respond_complete;
660 sub import_lineitem_details {
661 my($mgr, $ordering_agency, $li) = @_;
663 my $holdings = $mgr->editor->json_query({from => ['acq.extract_provider_holding_data', $li->id]});
664 return 1 unless @$holdings;
665 my $org_path = $U->get_org_ancestors($ordering_agency);
666 $org_path = [ reverse (@$org_path) ];
671 my $compiled = extract_lineitem_detail_data($mgr, $org_path, $holdings, $idx);
672 last unless defined $compiled;
673 return 0 unless $compiled;
675 for(1..$$compiled{quantity}) {
676 create_lineitem_detail($mgr,
678 owning_lib => $$compiled{owning_lib},
679 cn_label => $$compiled{call_number},
680 fund => $$compiled{fund},
681 circ_modifier => $$compiled{circ_modifier},
682 note => $$compiled{note}
692 attr_name => 'estimated_price',
693 attr_type => 'lineitem_provider_attr_definition',
694 attr_value => $price,
701 # return hash on success, 0 on error, undef on no more holdings
702 sub extract_lineitem_detail_data {
703 my($mgr, $org_path, $holdings, $index) = @_;
705 my @data_list = grep { $_->{holding} eq $index } @$holdings;
706 return undef unless @data_list;
708 my %compiled = map { $_->{attr} => $_->{data} } @data_list;
709 my $base_org = $$org_path[0];
713 $logger->error("Item import extraction error: $msg");
714 $logger->error("Holdings Data: " . OpenSRF::Utils::JSON->perl2JSON(\%compiled));
715 $mgr->editor->rollback;
716 $mgr->editor->event(OpenILS::Event->new('ACQ_IMPORT_ERROR', payload => $msg));
720 $compiled{quantity} ||= 1;
722 # ---------------------------------------------------------------------
724 my $code = $compiled{fund_code};
725 return $killme->("no fund code provided") unless $code;
727 my $fund = $mgr->cache($base_org, "fund.$code");
729 # search up the org tree for the most appropriate fund
730 for my $org (@$org_path) {
731 $fund = $mgr->editor->search_acq_fund(
732 {org => $org, code => $code, year => DateTime->now->year}, {idlist => 1})->[0];
736 return $killme->("no fund with code $code at orgs [@$org_path]") unless $fund;
737 $compiled{fund} = $fund;
738 $mgr->cache($base_org, "fund.$code", $fund);
741 # ---------------------------------------------------------------------
743 my $sn = $compiled{owning_lib};
744 return $killme->("no owning_lib defined") unless $sn;
746 $mgr->cache($base_org, "orgsn.$sn") ||
747 $mgr->editor->search_actor_org_unit({shortname => $sn}, {idlist => 1})->[0];
748 return $killme->("invalid owning_lib defined: $sn") unless $org_id;
749 $compiled{owning_lib} = $org_id;
750 $mgr->cache($$org_path[0], "orgsn.$sn", $org_id);
753 # ---------------------------------------------------------------------
756 $code = $compiled{circ_modifier};
760 $mod = $mgr->cache($base_org, "mod.$code") ||
761 $mgr->editor->retrieve_config_circ_modifier($code);
762 return $killme->("invlalid circ_modifier $code") unless $mod;
763 $mgr->cache($base_org, "mod.$code", $mod);
767 $mod = get_default_circ_modifier($mgr, $base_org)
768 or return $killme->("no circ_modifier defined");
771 $compiled{circ_modifier} = $mod;
774 # ---------------------------------------------------------------------
776 my $name = $compiled{copy_location};
777 return $killme->("no copy_location defined") unless $name;
778 my $loc = $mgr->cache($base_org, "copy_loc.$name");
780 for my $org (@$org_path) {
781 $loc = $mgr->editor->search_asset_copy_location(
782 {owning_lib => $org, name => $name}, {idlist => 1})->[0];
786 return $killme->("Invalid copy location $name") unless $loc;
787 $compiled{copy_location} = $loc;
788 $mgr->cache($base_org, "copy_loc.$name", $loc);