]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Acq/Order.pm
don't require a copy location in import records since we allow for the configuration...
[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_asset_create_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_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->ordering_agency($mgr->editor->requestor->ws_ou);
687     $po->$_($args{$_}) for keys %args;
688     $po->clear_id;
689     $mgr->purchase_order($po);
690     return $mgr->editor->create_acq_purchase_order($po);
691 }
692
693 # ----------------------------------------------------------------------------
694 # if all of the lineitems for this PO are received,
695 # mark the PO as received
696 # ----------------------------------------------------------------------------
697 sub check_purchase_order_received {
698     my($mgr, $po_id) = @_;
699
700     my $non_recv_li = $mgr->editor->search_acq_lineitem(
701         {   purchase_order => $po_id,
702             state => {'!=' => 'received'}
703         }, {idlist=>1});
704
705     return 1 if @$non_recv_li;
706
707     my $po = $mgr->editor->retrieve_acq_purchase_order($po_id);
708     $po->state('received');
709     return update_purchase_order($mgr, $po);
710 }
711
712
713 # ----------------------------------------------------------------------------
714 # Bib, Callnumber, and Copy data
715 # ----------------------------------------------------------------------------
716
717 sub create_lineitem_assets {
718     my($mgr, $li_id) = @_;
719     my $evt;
720
721     my $li = $mgr->editor->retrieve_acq_lineitem([
722         $li_id,
723         {   flesh => 1,
724             flesh_fields => {jub => ['purchase_order', 'attributes']}
725         }
726     ]) or return 0;
727
728     # -----------------------------------------------------------------
729     # first, create the bib record if necessary
730     # -----------------------------------------------------------------
731     my $new_bib = 0;
732     unless($li->eg_bib_id) {
733         create_bib($mgr, $li) or return 0;
734         $new_bib = 1;
735     }
736
737     my $li_details = $mgr->editor->search_acq_lineitem_detail({lineitem => $li_id}, {idlist=>1});
738
739     # -----------------------------------------------------------------
740     # for each lineitem_detail, create the volume if necessary, create 
741     # a copy, and link them all together.
742     # -----------------------------------------------------------------
743     my $first_cn;
744     for my $lid_id (@{$li_details}) {
745
746         my $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid_id) or return 0;
747         next if $lid->eg_copy_id;
748
749         # use the same callnumber label for all items within this lineitem
750         $lid->cn_label($first_cn) if $first_cn and not $lid->cn_label;
751
752         # apply defaults if necessary
753         return 0 unless complete_lineitem_detail($mgr, $lid);
754
755         $first_cn = $lid->cn_label unless $first_cn;
756
757         my $org = $lid->owning_lib;
758         my $label = $lid->cn_label;
759         my $bibid = $li->eg_bib_id;
760
761         my $volume = $mgr->cache($org, "cn.$bibid.$label");
762         unless($volume) {
763             $volume = create_volume($mgr, $li, $lid) or return 0;
764             $mgr->cache($org, "cn.$bibid.$label", $volume);
765         }
766         create_copy($mgr, $volume, $lid) or return 0;
767     }
768
769     return { li => $li, new_bib => $new_bib };
770 }
771
772 sub create_bib {
773     my($mgr, $li) = @_;
774
775     my $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
776         $mgr->editor, 
777         $li->marc, 
778         undef, 
779         undef, 
780         1, # override tcn collisions
781         1, # no-ingest
782         undef # $rec->bib_source
783     ); 
784
785     if($U->event_code($record)) {
786         $mgr->editor->event($record);
787         $mgr->editor->rollback;
788         return 0;
789     }
790
791     $li->eg_bib_id($record->id);
792     $mgr->add_bib;
793     return update_lineitem($mgr, $li);
794 }
795
796 sub create_volume {
797     my($mgr, $li, $lid) = @_;
798
799     my ($volume, $evt) = 
800         OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
801             $mgr->editor, 
802             $lid->cn_label, 
803             $li->eg_bib_id, 
804             $lid->owning_lib
805         );
806
807     if($evt) {
808         $mgr->editor->event($evt);
809         return 0;
810     }
811
812     return $volume;
813 }
814
815 sub create_copy {
816     my($mgr, $volume, $lid) = @_;
817     my $copy = Fieldmapper::asset::copy->new;
818     $copy->isnew(1);
819     $copy->loan_duration(2);
820     $copy->fine_level(2);
821     $copy->status(OILS_COPY_STATUS_ON_ORDER);
822     $copy->barcode($lid->barcode);
823     $copy->location($lid->location);
824     $copy->call_number($volume->id);
825     $copy->circ_lib($volume->owning_lib);
826     $copy->circ_modifier($lid->circ_modifier);
827
828     my $evt = OpenILS::Application::Cat::AssetCommon->create_copy($mgr->editor, $volume, $copy);
829     if($evt) {
830         $mgr->editor->event($evt);
831         return 0;
832     }
833
834     $mgr->add_copy;
835     $lid->eg_copy_id($copy->id);
836     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
837 }
838
839
840
841
842
843
844 # ----------------------------------------------------------------------------
845 # Workflow: Build a selection list from a Z39.50 search
846 # ----------------------------------------------------------------------------
847
848 __PACKAGE__->register_method(
849         method => 'zsearch',
850         api_name => 'open-ils.acq.picklist.search.z3950',
851     stream => 1,
852         signature => {
853         desc => 'Performs a z3950 federated search and creates a picklist and associated lineitems',
854         params => [
855             {desc => 'Authentication token', type => 'string'},
856             {desc => 'Search definition', type => 'object'},
857             {desc => 'Picklist name, optional', type => 'string'},
858         ]
859     }
860 );
861
862 sub zsearch {
863     my($self, $conn, $auth, $search, $name, $options) = @_;
864     my $e = new_editor(authtoken=>$auth);
865     return $e->event unless $e->checkauth;
866     return $e->event unless $e->allowed('CREATE_PICKLIST');
867
868     $search->{limit} ||= 10;
869     $options ||= {};
870
871     my $ses = OpenSRF::AppSession->create('open-ils.search');
872     my $req = $ses->request('open-ils.search.z3950.search_class', $auth, $search);
873
874     my $first = 1;
875     my $picklist;
876     my $mgr;
877     while(my $resp = $req->recv(timeout=>60)) {
878
879         if($first) {
880             my $e = new_editor(requestor=>$e->requestor, xact=>1);
881             $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
882             $picklist = zsearch_build_pl($mgr, $name);
883             $first = 0;
884         }
885
886         my $result = $resp->content;
887         my $count = $result->{count};
888         $mgr->total( (($count < $search->{limit}) ? $count : $search->{limit})+1 );
889
890         for my $rec (@{$result->{records}}) {
891
892             my $li = create_lineitem($mgr, 
893                 picklist => $picklist->id,
894                 source_label => $result->{service},
895                 marc => $rec->{marcxml},
896                 eg_bib_id => $rec->{bibid}
897             );
898
899             if($$options{respond_li}) {
900                 $li->attributes($mgr->editor->search_acq_lineitem_attr({lineitem => $li->id}))
901                     if $$options{flesh_attrs};
902                 $li->clear_marc if $$options{clear_marc};
903                 $mgr->respond(lineitem => $li);
904             } else {
905                 $mgr->respond;
906             }
907         }
908     }
909
910     $mgr->editor->commit;
911     return $mgr->respond_complete;
912 }
913
914 sub zsearch_build_pl {
915     my($mgr, $name) = @_;
916     $name ||= '';
917
918     my $picklist = $mgr->editor->search_acq_picklist({
919         owner => $mgr->editor->requestor->id, 
920         name => $name
921     })->[0];
922
923     if($name eq '' and $picklist) {
924         return 0 unless delete_picklist($mgr, $picklist);
925         $picklist = undef;
926     }
927
928     return update_picklist($mgr, $picklist) if $picklist;
929     return create_picklist($mgr, name => $name);
930 }
931
932
933 # ----------------------------------------------------------------------------
934 # Workflow: Build a selection list / PO by importing a batch of MARC records
935 # ----------------------------------------------------------------------------
936
937 __PACKAGE__->register_method(
938     method => 'upload_records',
939     api_name => 'open-ils.acq.process_upload_records',
940     stream => 1,
941 );
942
943 sub upload_records {
944     my($self, $conn, $auth, $key) = @_;
945
946         my $e = new_editor(authtoken => $auth, xact => 1);
947     return $e->die_event unless $e->checkauth;
948     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
949
950     my $cache = OpenSRF::Utils::Cache->new;
951
952     my $data = $cache->get_cache("vandelay_import_spool_$key");
953         my $purpose = $data->{purpose};
954     my $filename = $data->{path};
955     my $provider = $data->{provider};
956     my $picklist = $data->{picklist};
957     my $create_po = $data->{create_po};
958     my $ordering_agency = $data->{ordering_agency};
959     my $create_assets = $data->{create_assets};
960     my $po;
961     my $evt;
962
963     unless(-r $filename) {
964         $logger->error("unable to read MARC file $filename");
965         $e->rollback;
966         return OpenILS::Event->new('FILE_UPLOAD_ERROR', payload => {filename => $filename});
967     }
968
969     $provider = $e->retrieve_acq_provider($provider) or return $e->die_event;
970
971     if($picklist) {
972         $picklist = $e->retrieve_acq_picklist($picklist) or return $e->die_event;
973         if($picklist->owner != $e->requestor->id) {
974             return $e->die_event unless 
975                 $e->allowed('CREATE_PICKLIST', $picklist->org_unit, $picklist);
976         }
977     }
978
979     if($create_po) {
980         $po = create_purchase_order($mgr, 
981             ordering_agency => $ordering_agency,
982             provider => $provider->id
983         ) or return $mgr->editor->die_event;
984     }
985
986     $logger->info("acq processing MARC file=$filename");
987
988     my $marctype = 'USMARC'; # ?
989         my $batch = new MARC::Batch ($marctype, $filename);
990         $batch->strict_off;
991
992         my $count = 0;
993     my @li_list;
994
995         while(1) {
996
997             my $err;
998         my $xml;
999                 $count++;
1000         my $r;
1001
1002                 try {
1003             $r = $batch->next;
1004         } catch Error with {
1005             $err = shift;
1006                         $logger->warn("Proccessing of record $count in set $key failed with error $err.  Skipping this record");
1007         };
1008
1009         next if $err;
1010         last unless $r;
1011
1012                 try {
1013             ($xml = $r->as_xml_record()) =~ s/\n//sog;
1014             $xml =~ s/^<\?xml.+\?\s*>//go;
1015             $xml =~ s/>\s+</></go;
1016             $xml =~ s/\p{Cc}//go;
1017             $xml = $U->entityize($xml);
1018             $xml =~ s/[\x00-\x1f]//go;
1019
1020                 } catch Error with {
1021                         $err = shift;
1022                         $logger->warn("Proccessing XML of record $count in set $key failed with error $err.  Skipping this record");
1023                 };
1024
1025         next if $err or not $xml;
1026
1027         my %args = (
1028             source_label => $provider->code,
1029             provider => $provider->id,
1030             marc => $xml,
1031         );
1032
1033         $args{picklist} = $picklist->id if $picklist;
1034         if($po) {
1035             $args{purchase_order} = $po->id;
1036             $args{state} = 'on-order';
1037         }
1038
1039         my $li = create_lineitem($mgr, %args) or return $mgr->editor->die_event;
1040         $mgr->respond;
1041         $li->provider($provider); # flesh it, we'll need it later
1042
1043         import_lineitem_details($mgr, $ordering_agency, $li) or return $mgr->editor->die_event;
1044         $mgr->respond;
1045
1046         push(@li_list, $li->id);
1047         $mgr->respond;
1048         }
1049
1050         $e->commit;
1051     unlink($filename);
1052     $cache->delete_cache('vandelay_import_spool_' . $key);
1053
1054     if($create_assets) {
1055         create_lineitem_list_assets($mgr, \@li_list) or return $e->die_event;
1056     }
1057
1058     return $mgr->respond_complete;
1059 }
1060
1061 sub import_lineitem_details {
1062     my($mgr, $ordering_agency, $li) = @_;
1063
1064     my $holdings = $mgr->editor->json_query({from => ['acq.extract_provider_holding_data', $li->id]});
1065     return 1 unless @$holdings;
1066     my $org_path = $U->get_org_ancestors($ordering_agency);
1067     $org_path = [ reverse (@$org_path) ];
1068     my $price;
1069
1070     my $idx = 1;
1071     while(1) {
1072         # create a lineitem detail for each copy in the data
1073
1074         my $compiled = extract_lineitem_detail_data($mgr, $org_path, $holdings, $idx);
1075         last unless defined $compiled;
1076         return 0 unless $compiled;
1077
1078         # this takes the price of the last copy and uses it as the lineitem price
1079         # need to determine if a given record would include different prices for the same item
1080         $price = $$compiled{price};
1081
1082         for(1..$$compiled{quantity}) {
1083             my $lid = create_lineitem_detail($mgr, 
1084                 lineitem => $li->id,
1085                 owning_lib => $$compiled{owning_lib},
1086                 cn_label => $$compiled{call_number},
1087                 fund => $$compiled{fund},
1088                 circ_modifier => $$compiled{circ_modifier},
1089                 note => $$compiled{note},
1090                 location => $$compiled{copy_location},
1091                 collection_code => $$compiled{collection_code}
1092             ) or return 0;
1093         }
1094
1095         $mgr->respond;
1096         $idx++;
1097     }
1098
1099     # set the price attr so we'll know the source of the price
1100     set_lineitem_attr(
1101         $mgr, 
1102         attr_name => 'estimated_price',
1103         attr_type => 'lineitem_local_attr_definition',
1104         attr_value => $price,
1105         lineitem => $li->id
1106     ) or return 0;
1107
1108     # if we're creating a purchase order, create the debits
1109     if($li->purchase_order) {
1110         create_lineitem_debits($mgr, $li, $price, 2) or return 0;
1111         $mgr->respond;
1112     }
1113
1114     return 1;
1115 }
1116
1117 # return hash on success, 0 on error, undef on no more holdings
1118 sub extract_lineitem_detail_data {
1119     my($mgr, $org_path, $holdings, $index) = @_;
1120
1121     my @data_list = grep { $_->{holding} eq $index } @$holdings;
1122     return undef unless @data_list;
1123
1124     my %compiled = map { $_->{attr} => $_->{data} } @data_list;
1125     my $base_org = $$org_path[0];
1126
1127     my $killme = sub {
1128         my $msg = shift;
1129         $logger->error("Item import extraction error: $msg");
1130         $logger->error('Holdings Data: ' . OpenSRF::Utils::JSON->perl2JSON(\%compiled));
1131         $mgr->editor->rollback;
1132         $mgr->editor->event(OpenILS::Event->new('ACQ_IMPORT_ERROR', payload => $msg));
1133         return 0;
1134     };
1135
1136     $compiled{quantity} ||= 1;
1137
1138     # ---------------------------------------------------------------------
1139     # Fund
1140     my $code = $compiled{fund_code};
1141     return $killme->('no fund code provided') unless $code;
1142
1143     my $fund = $mgr->cache($base_org, "fund.$code");
1144     unless($fund) {
1145         # search up the org tree for the most appropriate fund
1146         for my $org (@$org_path) {
1147             $fund = $mgr->editor->search_acq_fund(
1148                 {org => $org, code => $code, year => DateTime->now->year}, {idlist => 1})->[0];
1149             last if $fund;
1150         }
1151     }
1152     return $killme->("no fund with code $code at orgs [@$org_path]") unless $fund;
1153     $compiled{fund} = $fund;
1154     $mgr->cache($base_org, "fund.$code", $fund);
1155
1156
1157     # ---------------------------------------------------------------------
1158     # Owning lib
1159     my $sn = $compiled{owning_lib};
1160     return $killme->('no owning_lib defined') unless $sn;
1161     my $org_id = 
1162         $mgr->cache($base_org, "orgsn.$sn") ||
1163             $mgr->editor->search_actor_org_unit({shortname => $sn}, {idlist => 1})->[0];
1164     return $killme->("invalid owning_lib defined: $sn") unless $org_id;
1165     $compiled{owning_lib} = $org_id;
1166     $mgr->cache($$org_path[0], "orgsn.$sn", $org_id);
1167
1168
1169     # ---------------------------------------------------------------------
1170     # Circ Modifier
1171     my $mod;
1172     $code = $compiled{circ_modifier};
1173
1174     if($code) {
1175
1176         $mod = $mgr->cache($base_org, "mod.$code") ||
1177             $mgr->editor->retrieve_config_circ_modifier($code);
1178         return $killme->("invlalid circ_modifier $code") unless $mod;
1179         $mgr->cache($base_org, "mod.$code", $mod);
1180
1181     } else {
1182         # try the default
1183         $mod = get_default_circ_modifier($mgr, $base_org)
1184             or return $killme->('no circ_modifier defined');
1185     }
1186
1187     $compiled{circ_modifier} = $mod;
1188
1189
1190     # ---------------------------------------------------------------------
1191     # Shelving Location
1192     my $name = $compiled{copy_location};
1193     if($name) {
1194         my $loc = $mgr->cache($base_org, "copy_loc.$name");
1195         unless($loc) {
1196             for my $org (@$org_path) {
1197                 $loc = $mgr->editor->search_asset_copy_location(
1198                     {owning_lib => $org, name => $name}, {idlist => 1})->[0];
1199                 last if $loc;
1200             }
1201         }
1202         return $killme->("Invalid copy location $name") unless $loc;
1203         $compiled{copy_location} = $loc;
1204         $mgr->cache($base_org, "copy_loc.$name", $loc);
1205     }
1206
1207     return \%compiled;
1208 }
1209
1210
1211
1212 # ----------------------------------------------------------------------------
1213 # Workflow: Given an existing purchase order, import/create the bibs, 
1214 # callnumber and copy objects
1215 # ----------------------------------------------------------------------------
1216
1217 __PACKAGE__->register_method(
1218         method => 'create_po_assets',
1219         api_name        => 'open-ils.acq.purchase_order.assets.create',
1220         signature => {
1221         desc => q/Creates assets for each lineitem in the purchase order/,
1222         params => [
1223             {desc => 'Authentication token', type => 'string'},
1224             {desc => 'The purchase order id', type => 'number'},
1225         ],
1226         return => {desc => 'Streams a total versus completed counts object, event on error'}
1227     }
1228 );
1229
1230 sub create_po_assets {
1231     my($self, $conn, $auth, $po_id) = @_;
1232
1233     my $e = new_editor(authtoken=>$auth, xact=>1);
1234     return $e->die_event unless $e->checkauth;
1235     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1236
1237     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1238
1239     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1240
1241     # it's ugly, but it's fast.  Get the total count of lineitem detail objects to process
1242     my $lid_total = $e->json_query({
1243         select => { acqlid => [{aggregate => 1, transform => 'count', column => 'id'}] }, 
1244         from => {
1245             acqlid => {
1246                 jub => {
1247                     fkey => 'lineitem', 
1248                     field => 'id', 
1249                     join => {acqpo => {fkey => 'purchase_order', field => 'id'}}
1250                 }
1251             }
1252         }, 
1253         where => {'+acqpo' => {id => $po_id}}
1254     })->[0]->{id};
1255
1256     $mgr->total(scalar(@$li_ids) + $lid_total);
1257
1258     create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1259
1260     $e->xact_begin;
1261     update_purchase_order($mgr, $po) or return $e->die_event;
1262     $e->commit;
1263
1264     return $mgr->respond_complete;
1265 }
1266
1267
1268
1269 __PACKAGE__->register_method(
1270         method => 'create_purchase_order_api',
1271         api_name        => 'open-ils.acq.purchase_order.create',
1272         signature => {
1273         desc => 'Creates a new purchase order',
1274         params => [
1275             {desc => 'Authentication token', type => 'string'},
1276             {desc => 'purchase_order to create', type => 'object'}
1277         ],
1278         return => {desc => 'The purchase order id, Event on failure'}
1279     }
1280 );
1281
1282 sub create_purchase_order_api {
1283     my($self, $conn, $auth, $po, $args) = @_;
1284     $args ||= {};
1285
1286     my $e = new_editor(xact=>1, authtoken=>$auth);
1287     return $e->die_event unless $e->checkauth;
1288     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
1289     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1290
1291     # create the PO
1292     my %pargs = (ordering_agency => $e->requestor->ws_ou);
1293     $pargs{provider} = $po->provider if $po->provider;
1294     $po = create_purchase_order($mgr, %pargs) or return $e->die_event;
1295
1296     my $li_ids = $$args{lineitems};
1297
1298     if($li_ids) {
1299
1300         for my $li_id (@$li_ids) { 
1301
1302             my $li = $e->retrieve_acq_lineitem([
1303                 $li_id,
1304                 {flesh => 1, flesh_fields => {jub => ['attributes']}}
1305             ]) or return $e->die_event;
1306
1307             $li->provider($po->provider);
1308             $li->purchase_order($po->id);
1309             update_lineitem($mgr, $li) or return $e->die_event;
1310             $mgr->respond;
1311
1312             create_lineitem_debits($mgr, $li) or return $e->die_event;
1313         }
1314     }
1315
1316     # commit before starting the asset creation
1317     $e->xact_commit;
1318
1319     if($li_ids and $$args{create_assets}) {
1320         create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1321     }
1322
1323     return $mgr->respond_complete;
1324 }
1325
1326
1327 __PACKAGE__->register_method(
1328         method => 'lineitem_detail_CUD_batch',
1329         api_name => 'open-ils.acq.lineitem_detail.cud.batch',
1330     stream => 1,
1331         signature => {
1332         desc => q/Creates a new purchase order line item detail.  
1333             Additionally creates the associated fund_debit/,
1334         params => [
1335             {desc => 'Authentication token', type => 'string'},
1336             {desc => 'List of lineitem_details to create', type => 'array'},
1337         ],
1338         return => {desc => 'Streaming response of current position in the array'}
1339     }
1340 );
1341
1342 sub lineitem_detail_CUD_batch {
1343     my($self, $conn, $auth, $li_details) = @_;
1344
1345     my $e = new_editor(xact=>1, authtoken=>$auth);
1346     return $e->die_event unless $e->checkauth;
1347     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1348
1349     # XXX perms
1350
1351     $mgr->total(scalar(@$li_details));
1352     
1353     my %li_cache;
1354
1355     for my $lid (@$li_details) {
1356
1357         my $li = $li_cache{$lid->lineitem} || $e->retrieve_acq_lineitem($lid->lineitem);
1358
1359         if($lid->isnew) {
1360             create_lineitem_detail($mgr, %{$lid->to_bare_hash}) or return $e->die_event;
1361
1362         } elsif($lid->ischanged) {
1363             $e->update_acq_lineitem_detail($lid) or return $e->die_event;
1364
1365         } elsif($lid->isdeleted) {
1366             delete_lineitem_detail($mgr, $lid) or return $e->die_event;
1367         }
1368
1369         $mgr->respond(li => $li);
1370         $li_cache{$lid->lineitem} = $li;
1371     }
1372
1373     $e->commit;
1374     return $mgr->respond_complete;
1375 }
1376
1377
1378 __PACKAGE__->register_method(
1379         method => 'receive_po_api',
1380         api_name        => 'open-ils.acq.purchase_order.receive'
1381 );
1382
1383 sub receive_po_api {
1384     my($self, $conn, $auth, $po_id) = @_;
1385     my $e = new_editor(xact => 1, authtoken => $auth);
1386     return $e->die_event unless $e->checkauth;
1387     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1388
1389     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1390     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1391
1392     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1393
1394     for my $li_id (@$li_ids) {
1395         receive_lineitem($mgr, $li_id) or return $e->die_event;
1396         $mgr->respond;
1397     }
1398
1399     $po->state('received');
1400     update_purchase_order($mgr, $po) or return $e->die_event;
1401
1402     $e->commit;
1403     return $mgr->respond_complete;
1404 }
1405
1406
1407 __PACKAGE__->register_method(
1408         method => 'receive_lineitem_detail_api',
1409         api_name        => 'open-ils.acq.lineitem_detail.receive',
1410         signature => {
1411         desc => 'Mark a lineitem_detail as received',
1412         params => [
1413             {desc => 'Authentication token', type => 'string'},
1414             {desc => 'lineitem detail ID', type => 'number'}
1415         ],
1416         return => {desc => '1 on success, Event on error'}
1417     }
1418 );
1419
1420 sub receive_lineitem_detail_api {
1421     my($self, $conn, $auth, $lid_id) = @_;
1422
1423     my $e = new_editor(xact=>1, authtoken=>$auth);
1424     return $e->die_event unless $e->checkauth;
1425     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1426
1427     my $lid = $e->retrieve_acq_lineitem_detail([
1428         $lid_id, {
1429             flesh => 2,
1430             flesh_fields => {
1431                 acqlid => ['lineitem'],
1432                 jub => ['purchase_order']
1433             }
1434         }
1435     ]);
1436
1437     return $e->die_event unless $e->allowed(
1438         'RECEIVE_PURCHASE_ORDER', $lid->lineitem->purchase_order->ordering_agency);
1439
1440     receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1441     $e->commit;
1442     return 1;
1443 }
1444
1445 __PACKAGE__->register_method(
1446         method => 'receive_lineitem_api',
1447         api_name        => 'open-ils.acq.lineitem.receive',
1448         signature => {
1449         desc => 'Mark a lineitem as received',
1450         params => [
1451             {desc => 'Authentication token', type => 'string'},
1452             {desc => 'lineitem detail ID', type => 'number'}
1453         ],
1454         return => {desc => '1 on success, Event on error'}
1455     }
1456 );
1457
1458 sub receive_lineitem_api {
1459     my($self, $conn, $auth, $li_id) = @_;
1460
1461     my $e = new_editor(xact=>1, authtoken=>$auth);
1462     return $e->die_event unless $e->checkauth;
1463     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1464
1465     my $li = $e->retrieve_acq_lineitem([
1466         $li_id, {
1467             flesh => 1,
1468             flesh_fields => {
1469                 jub => ['purchase_order']
1470             }
1471         }
1472     ]) or return $e->die_event;
1473
1474     return $e->die_event unless $e->allowed(
1475         'RECEIVE_PURCHASE_ORDER', $li->purchase_order->ordering_agency);
1476
1477     receive_lineitem($mgr, $li_id) or return $e->die_event;
1478     $e->commit;
1479     return 1;
1480 }
1481
1482
1483 __PACKAGE__->register_method(
1484         method => 'rollback_receive_po_api',
1485         api_name        => 'open-ils.acq.purchase_order.receive.rollback'
1486 );
1487
1488 sub rollback_receive_po_api {
1489     my($self, $conn, $auth, $po_id) = @_;
1490     my $e = new_editor(xact => 1, authtoken => $auth);
1491     return $e->die_event unless $e->checkauth;
1492     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1493
1494     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1495     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1496
1497     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1498
1499     for my $li_id (@$li_ids) {
1500         rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1501         $mgr->respond;
1502     }
1503
1504     $po->state('on-order');
1505     update_purchase_order($mgr, $po) or return $e->die_event;
1506
1507     $e->commit;
1508     return $mgr->respond_complete;
1509 }
1510
1511
1512 __PACKAGE__->register_method(
1513         method => 'rollback_receive_lineitem_detail_api',
1514         api_name        => 'open-ils.acq.lineitem_detail.receive.rollback',
1515         signature => {
1516         desc => 'Mark a lineitem_detail as received',
1517         params => [
1518             {desc => 'Authentication token', type => 'string'},
1519             {desc => 'lineitem detail ID', type => 'number'}
1520         ],
1521         return => {desc => '1 on success, Event on error'}
1522     }
1523 );
1524
1525 sub rollback_receive_lineitem_detail_api {
1526     my($self, $conn, $auth, $lid_id) = @_;
1527
1528     my $e = new_editor(xact=>1, authtoken=>$auth);
1529     return $e->die_event unless $e->checkauth;
1530     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1531
1532     my $lid = $e->retrieve_acq_lineitem_detail([
1533         $lid_id, {
1534             flesh => 2,
1535             flesh_fields => {
1536                 acqlid => ['lineitem'],
1537                 jub => ['purchase_order']
1538             }
1539         }
1540     ]);
1541     my $li = $lid->lineitem;
1542     my $po = $li->purchase_order;
1543
1544     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1545     rollback_receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1546
1547     $li->state('on-order');
1548     $po->state('on-order');
1549     udpate_lineitem($mgr, $li) or return $e->die_event;
1550     udpate_purchase_order($mgr, $po) or return $e->die_event;
1551
1552     $e->commit;
1553     return 1;
1554 }
1555
1556 __PACKAGE__->register_method(
1557         method => 'rollback_receive_lineitem_api',
1558         api_name        => 'open-ils.acq.lineitem.receive.rollback',
1559         signature => {
1560         desc => 'Mark a lineitem as received',
1561         params => [
1562             {desc => 'Authentication token', type => 'string'},
1563             {desc => 'lineitem detail ID', type => 'number'}
1564         ],
1565         return => {desc => '1 on success, Event on error'}
1566     }
1567 );
1568
1569 sub rollback_receive_lineitem_api {
1570     my($self, $conn, $auth, $li_id) = @_;
1571
1572     my $e = new_editor(xact=>1, authtoken=>$auth);
1573     return $e->die_event unless $e->checkauth;
1574     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1575
1576     my $li = $e->retrieve_acq_lineitem_detail([
1577         $li_id, {
1578             flesh => 1,
1579             flesh_fields => {
1580                 jub => ['purchase_order']
1581             }
1582         }
1583     ]);
1584     my $po = $li->purchase_order;
1585
1586     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1587
1588     rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1589
1590     $po->state('on-order');
1591     update_purchase_order($mgr, $po) or return $e->die_event;
1592
1593     $e->commit;
1594     return 1;
1595 }
1596
1597
1598 __PACKAGE__->register_method(
1599         method => 'set_lineitem_price_api',
1600         api_name        => 'open-ils.acq.lineitem.price.set',
1601         signature => {
1602         desc => 'Set lineitem price.  If debits already exist, update them as well',
1603         params => [
1604             {desc => 'Authentication token', type => 'string'},
1605             {desc => 'lineitem ID', type => 'number'}
1606         ],
1607         return => {desc => 'status blob, Event on error'}
1608     }
1609 );
1610
1611 sub set_lineitem_price_api {
1612     my($self, $conn, $auth, $li_id, $price, $currency) = @_;
1613
1614     my $e = new_editor(xact=>1, authtoken=>$auth);
1615     return $e->die_event unless $e->checkauth;
1616     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1617
1618     # XXX perms
1619
1620     my $li = $e->retrieve_acq_lineitem($li_id) or return $e->die_event;
1621
1622     # update the local attr for estimated price
1623     set_lineitem_attr(
1624         $mgr, 
1625         attr_name => 'estimated_price',
1626         attr_type => 'lineitem_local_attr_definition',
1627         attr_value => $price,
1628         lineitem => $li_id
1629     ) or return $e->die_event;
1630
1631     my $lid_ids = $e->search_acq_lineitem_detail(
1632         {lineitem => $li_id, fund_debit => {'!=' => undef}}, 
1633         {idlist => 1}
1634     );
1635
1636     for my $lid_id (@$lid_ids) {
1637
1638         my $lid = $e->retrieve_acq_lineitem_detail([
1639             $lid_id, {
1640             flesh => 1, flesh_fields => {acqlid => ['fund', 'fund_debit']}}
1641         ]);
1642
1643         # onless otherwise specified, assume currency of new price is same as currency type of the fund
1644         $currency ||= $lid->fund->currency_type;
1645         my $amount = $price;
1646
1647         if($lid->fund->currency_type ne $currency) {
1648             $amount = currency_conversion($mgr, $currency, $lid->fund->currency_type, $price);
1649         }
1650         
1651         $lid->fund_debit->origin_currency_type($currency);
1652         $lid->fund_debit->origin_amount($price);
1653         $lid->fund_debit->amount($amount);
1654
1655         $e->update_acq_fund_debit($lid->fund_debit) or return $e->die_event;
1656         $mgr->add_lid;
1657         $mgr->respond;
1658     }
1659
1660     $e->commit;
1661     return $mgr->respond_complete;
1662 }
1663
1664
1665 __PACKAGE__->register_method(
1666         method => 'clone_picklist_api',
1667         api_name        => 'open-ils.acq.picklist.clone',
1668         signature => {
1669         desc => 'Clones a picklist, including lineitem and lineitem details',
1670         params => [
1671             {desc => 'Authentication token', type => 'string'},
1672             {desc => 'Picklist ID', type => 'number'},
1673             {desc => 'New Picklist Name', type => 'string'}
1674         ],
1675         return => {desc => 'status blob, Event on error'}
1676     }
1677 );
1678
1679 sub clone_picklist_api {
1680     my($self, $conn, $auth, $pl_id, $name) = @_;
1681
1682     my $e = new_editor(xact=>1, authtoken=>$auth);
1683     return $e->die_event unless $e->checkauth;
1684     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1685
1686     my $old_pl = $e->retrieve_acq_picklist($pl_id);
1687     my $new_pl = create_picklist($mgr, %{$old_pl->to_bare_hash}, name => $name) or return $e->die_event;
1688
1689     my $li_ids = $e->search_acq_lineitem({picklist => $pl_id}, {idlist => 1});
1690
1691     for my $li_id (@$li_ids) {
1692
1693         # copy the lineitems
1694         my $li = $e->retrieve_acq_lineitem($li_id);
1695         my $new_li = create_lineitem($mgr, %{$li->to_bare_hash}, picklist => $new_pl->id) or return $e->die_event;
1696
1697         my $lid_ids = $e->search_acq_lineitem_detail({lineitem => $li_id}, {idlist => 1});
1698         for my $lid_id (@$lid_ids) {
1699
1700             # copy the lineitem details
1701             my $lid = $e->retrieve_acq_lineitem_detail($lid_id);
1702             create_lineitem_detail($mgr, %{$lid->to_bare_hash}, lineitem => $new_li->id) or return $e->die_event;
1703         }
1704
1705         $mgr->respond;
1706     }
1707
1708     $e->commit;
1709     return $mgr->respond_complete;
1710 }
1711
1712
1713 __PACKAGE__->register_method(
1714         method => 'merge_picklist_api',
1715         api_name        => 'open-ils.acq.picklist.merge',
1716         signature => {
1717         desc => 'Merges 2 or more picklists into a single list',
1718         params => [
1719             {desc => 'Authentication token', type => 'string'},
1720             {desc => 'Lead Picklist ID', type => 'number'},
1721             {desc => 'List of subordinate picklist IDs', type => 'array'}
1722         ],
1723         return => {desc => 'status blob, Event on error'}
1724     }
1725 );
1726
1727 sub merge_picklist_api {
1728     my($self, $conn, $auth, $lead_pl, $pl_list) = @_;
1729
1730     my $e = new_editor(xact=>1, authtoken=>$auth);
1731     return $e->die_event unless $e->checkauth;
1732     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1733
1734     # XXX perms on each picklist modified
1735
1736     # point all of the lineitems at the lead picklist
1737     my $li_ids = $e->search_acq_lineitem({picklist => $pl_list}, {idlist => 1});
1738
1739     for my $li_id (@$li_ids) {
1740         my $li = $e->retrieve_acq_lineitem($li_id);
1741         $li->picklist($lead_pl);
1742         update_lineitem($mgr, $li) or return $e->die_event;
1743         $mgr->respond;
1744     }
1745
1746     # now delete the subordinate lists
1747     for my $pl_id (@$pl_list) {
1748         my $pl = $e->retrieve_acq_picklist($pl_id);
1749         $e->delete_acq_picklist($pl) or return $e->die_event;
1750     }
1751
1752     $e->commit;
1753     return $mgr->respond_complete;
1754 }
1755
1756
1757 __PACKAGE__->register_method(
1758         method => 'delete_picklist_api',
1759         api_name        => 'open-ils.acq.picklist.delete',
1760         signature => {
1761         desc => q/Deletes a picklist.  It also deletes any lineitems in the "new" state.  
1762             Other attached lineitems are detached'/,
1763         params => [
1764             {desc => 'Authentication token', type => 'string'},
1765             {desc => 'Picklist ID to delete', type => 'number'}
1766         ],
1767         return => {desc => '1 on success, Event on error'}
1768     }
1769 );
1770
1771 sub delete_picklist_api {
1772     my($self, $conn, $auth, $picklist_id) = @_;
1773     my $e = new_editor(xact=>1, authtoken=>$auth);
1774     return $e->die_event unless $e->checkauth;
1775     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1776     my $pl = $e->retrieve_acq_picklist($picklist_id) or return $e->die_event;
1777     delete_picklist($mgr, $pl) or return $e->die_event;
1778     $e->commit;
1779     return $mgr->respond_complete;
1780 }
1781
1782
1783
1784 1;