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