8e478cad88467ed80067f59d303033fe2df78f19
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Acq / Order.pm
1 package OpenILS::Application::Acq::BatchManager;
2 use OpenILS::Application::Acq::Financials;
3 use OpenSRF::AppSession;
4 use OpenSRF::EX qw/:try/;
5 use strict; use warnings;
6
7 sub new {
8     my($class, %args) = @_;
9     my $self = bless(\%args, $class);
10     $self->{args} = {
11         lid => 0,
12         li => 0,
13         copies => 0,
14         bibs => 0,
15         progress => 0,
16         debits_accrued => 0,
17         purchase_order => undef,
18         picklist => undef,
19         complete => 0,
20         indexed => 0,
21         total => 0
22     };
23     $self->{ingest_queue} = [];
24     $self->{cache} = {};
25     $self->throttle(5) unless $self->throttle;
26     $self->{post_proc_queue} = [];
27     $self->{last_respond_progress} = 0;
28     return $self;
29 }
30
31 sub conn {
32     my($self, $val) = @_;
33     $self->{conn} = $val if $val;
34     return $self->{conn};
35 }
36 sub throttle {
37     my($self, $val) = @_;
38     $self->{throttle} = $val if $val;
39     return $self->{throttle};
40 }
41 sub respond {
42     my($self, %other_args) = @_;
43     if($self->throttle and not %other_args) {
44         return unless (
45             ($self->{args}->{progress} - $self->{last_respond_progress}) >= $self->throttle
46         );
47     }
48     $self->conn->respond({ %{$self->{args}}, %other_args });
49     $self->{last_respond_progress} = $self->{args}->{progress};
50 }
51 sub respond_complete {
52     my($self, %other_args) = @_;
53     $self->complete;
54     $self->conn->respond_complete({ %{$self->{args}}, %other_args });
55     $self->run_post_response_hooks;
56     return undef;
57 }
58
59 # run the post response hook subs, shifting them off as we go
60 sub run_post_response_hooks {
61     my($self) = @_;
62     (shift @{$self->{post_proc_queue}})->() while @{$self->{post_proc_queue}};
63 }
64
65 # any subs passed to this method will be run after the call to respond_complete
66 sub post_process {
67     my($self, $sub) = @_;
68     push(@{$self->{post_proc_queue}}, $sub);
69 }
70
71 sub total {
72     my($self, $val) = @_;
73     $self->{args}->{total} = $val if defined $val;
74     $self->{args}->{maximum} = $self->{args}->{total};
75     return $self->{args}->{total};
76 }
77 sub purchase_order {
78     my($self, $val) = @_;
79     $self->{args}->{purchase_order} = $val if $val;
80     return $self;
81 }
82 sub picklist {
83     my($self, $val) = @_;
84     $self->{args}->{picklist} = $val if $val;
85     return $self;
86 }
87 sub add_lid {
88     my $self = shift;
89     $self->{args}->{lid} += 1;
90     $self->{args}->{progress} += 1;
91     return $self;
92 }
93 sub add_li {
94     my $self = shift;
95     $self->{args}->{li} += 1;
96     $self->{args}->{progress} += 1;
97     return $self;
98 }
99 sub add_copy {
100     my $self = shift;
101     $self->{args}->{copies} += 1;
102     $self->{args}->{progress} += 1;
103     return $self;
104 }
105 sub add_bib {
106     my $self = shift;
107     $self->{args}->{bibs} += 1;
108     $self->{args}->{progress} += 1;
109     return $self;
110 }
111 sub add_debit {
112     my($self, $amount) = @_;
113     $self->{args}->{debits_accrued} += $amount;
114     $self->{args}->{progress} += 1;
115     return $self;
116 }
117 sub editor {
118     my($self, $editor) = @_;
119     $self->{editor} = $editor if defined $editor;
120     return $self->{editor};
121 }
122 sub complete {
123     my $self = shift;
124     $self->{args}->{complete} = 1;
125     return $self;
126 }
127
128 sub ingest_ses {
129     my($self, $val) = @_;
130     $self->{ingest_ses} = $val if $val;
131     return $self->{ingest_ses};
132 }
133
134 sub push_ingest_queue {
135     my($self, $rec_id) = @_;
136
137     $self->ingest_ses(OpenSRF::AppSession->connect('open-ils.ingest'))
138         unless $self->ingest_ses;
139
140     my $req = $self->ingest_ses->request('open-ils.ingest.full.biblio.record', $rec_id);
141
142     push(@{$self->{ingest_queue}}, $req);
143 }
144
145 sub process_ingest_records {
146     my $self = shift;
147     return unless @{$self->{ingest_queue}};
148
149     for my $req (@{$self->{ingest_queue}}) {
150
151         try { 
152             $req->gather(1); 
153             $self->{args}->{indexed} += 1;
154             $self->{args}->{progress} += 1;
155         } otherwise {};
156
157         $self->respond;
158     }
159     $self->ingest_ses->disconnect;
160 }
161
162
163 sub cache {
164     my($self, $org, $key, $val) = @_;
165     $self->{cache}->{$org} = {} unless $self->{cache}->{org};
166     $self->{cache}->{$org}->{$key} = $val if defined $val;
167     return $self->{cache}->{$org}->{$key};
168 }
169
170
171 package OpenILS::Application::Acq::Order;
172 use base qw/OpenILS::Application/;
173 use strict; use warnings;
174 # ----------------------------------------------------------------------------
175 # Break up each component of the order process and pieces into managable
176 # actions that can be shared across different workflows
177 # ----------------------------------------------------------------------------
178 use OpenILS::Event;
179 use OpenSRF::Utils::Logger qw(:logger);
180 use OpenSRF::Utils::JSON;
181 use OpenSRF::AppSession;
182 use OpenILS::Utils::Fieldmapper;
183 use OpenILS::Utils::CStoreEditor q/:funcs/;
184 use OpenILS::Const qw/:const/;
185 use OpenSRF::EX q/:try/;
186 use OpenILS::Application::AppUtils;
187 use OpenILS::Application::Cat::BibCommon;
188 use OpenILS::Application::Cat::AssetCommon;
189 use MARC::Record;
190 use MARC::Batch;
191 use MARC::File::XML (BinaryEncoding => 'UTF-8');
192 my $U = 'OpenILS::Application::AppUtils';
193
194
195 # ----------------------------------------------------------------------------
196 # Lineitem
197 # ----------------------------------------------------------------------------
198 sub create_lineitem {
199     my($mgr, %args) = @_;
200     my $li = Fieldmapper::acq::lineitem->new;
201     $li->creator($mgr->editor->requestor->id);
202     $li->selector($li->creator);
203     $li->editor($li->creator);
204     $li->create_time('now');
205     $li->edit_time('now');
206     $li->state('new');
207     $li->$_($args{$_}) for keys %args;
208     $li->clear_id;
209     $mgr->add_li;
210     $mgr->editor->create_acq_lineitem($li) or return 0;
211     
212     unless($li->estimated_unit_price) {
213         # extract the price from the MARC data
214         my $price = get_li_price_from_attr($mgr->editor, $li) or return $li;
215         $li->estimated_unit_price($price);
216         return update_lineitem($mgr, $li);
217     }
218
219     return $li;
220 }
221
222 sub get_li_price_from_attr {
223     my($e, $li) = @_;
224     my $attrs = $li->attributes || $e->search_acq_lineitem_attr({lineitem => $li->id});
225
226     for my $attr_type (qw/    
227             lineitem_local_attr_definition 
228             lineitem_prov_attr_definition 
229             lineitem_marc_attr_definition/) {
230
231         my ($attr) = grep {
232             $_->attr_name eq 'estimated_price' and 
233             $_->attr_type eq $attr_type } @$attrs;
234
235         return $attr->attr_value if $attr;
236     }
237
238     return undef;
239 }
240
241
242 sub update_lineitem {
243     my($mgr, $li) = @_;
244     $li->edit_time('now');
245     $li->editor($mgr->editor->requestor->id);
246     $mgr->add_li;
247     return $mgr->editor->retrieve_acq_lineitem($mgr->editor->data) if
248         $mgr->editor->update_acq_lineitem($li);
249     return undef;
250 }
251
252
253 # ----------------------------------------------------------------------------
254 # Create real holds from patron requests for a given lineitem
255 # ----------------------------------------------------------------------------
256 sub promote_lineitem_holds {
257     my($mgr, $li) = @_;
258
259     my $requests = $mgr->editor->search_acq_user_request(
260         { lineitem => $li->id,
261           '-or' =>
262             [ { need_before => {'>' => 'now'} },
263               { need_before => undef }
264             ]
265         }
266     );
267
268     for my $request ( @$requests ) {
269
270         $request->eg_bib( $li->eg_bib_id );
271         $mgr->editor->update_acq_user_request( $request ) or return 0;
272
273         next unless ($U->is_true( $request->hold ));
274
275         my $hold = Fieldmapper::action::hold_request->new;
276         $hold->usr( $request->usr );
277         $hold->requestor( $request->usr );
278         $hold->request_time( $request->request_date );
279         $hold->pickup_lib( $request->pickup_lib );
280         $hold->request_lib( $request->pickup_lib );
281         $hold->selection_ou( $request->pickup_lib );
282         $hold->phone_notify( $request->phone_notify );
283         $hold->email_notify( $request->email_notify );
284         $hold->expire_time( $request->need_before );
285
286         if ($request->holdable_formats) {
287             my $mrm = $mgr->editor->search_metabib_metarecord_source_map( { source => $li->eg_bib_id } )->[0];
288             if ($mrm) {
289                 $hold->hold_type( 'M' );
290                 $hold->holdable_formats( $request->holdable_formats );
291                 $hold->target( $mrm->metarecord );
292             }
293         }
294
295         if (!$hold->target) {
296             $hold->hold_type( 'T' );
297             $hold->target( $li->eg_bib_id );
298         }
299
300         $mgr->editor->create_actor_hold_request( $hold ) or return 0;
301     }
302
303     return $li;
304 }
305
306 sub delete_lineitem {
307     my($mgr, $li) = @_;
308     $li = $mgr->editor->retrieve_acq_lineitem($li) unless ref $li;
309
310     # delete the attached lineitem_details
311     my $lid_ids = $mgr->editor->search_acq_lineitem_detail({lineitem => $li->id}, {idlist=>1});
312     for my $lid_id (@$lid_ids) {
313         return 0 unless delete_lineitem_detail($mgr, $lid_id);
314     }
315
316     $mgr->add_li;
317     return $mgr->editor->delete_acq_lineitem($li);
318 }
319
320 # begins and commit transactions as it goes
321 sub create_lineitem_list_assets {
322     my($mgr, $li_ids) = @_;
323     return undef if check_import_li_marc_perms($mgr, $li_ids);
324
325     # create the bibs/volumes/copies and ingest the records
326     for my $li_id (@$li_ids) {
327         $mgr->editor->xact_begin;
328         my $data = create_lineitem_assets($mgr, $li_id) or return undef;
329         $mgr->editor->xact_commit;
330         # XXX ingest is in-db now
331         #$mgr->push_ingest_queue($data->{li}->eg_bib_id) if $data->{new_bib};
332         $mgr->respond;
333     }
334     $mgr->process_ingest_records;
335     return 1;
336 }
337
338 # returns event on error, undef on success
339 sub check_import_li_marc_perms {
340     my($mgr, $li_ids) = @_;
341
342     # if there are any order records that are not linked to 
343     # in-db bib records, verify staff has perms to import order records
344     my $order_li = $mgr->editor->search_acq_lineitem(
345         [{id => $li_ids, eg_bib_id => undef}, {limit => 1}], {idlist => 1})->[0];
346
347     if($order_li) {
348         return $mgr->editor->die_event unless 
349             $mgr->editor->allowed('IMPORT_ACQ_LINEITEM_BIB_RECORD');
350     }
351
352     return undef;
353 }
354
355
356 # ----------------------------------------------------------------------------
357 # if all of the lineitem details for this lineitem have 
358 # been received, mark the lineitem as received
359 # returns 1 on non-received, li on received, 0 on error
360 # ----------------------------------------------------------------------------
361
362 sub describe_affected_po {
363     my ($e, $po) = @_;
364
365     my ($enc, $spent) =
366         OpenILS::Application::Acq::Financials::build_price_summary(
367             $e, $po->id
368         );
369
370     +{$po->id => {
371             "state" => $po->state,
372             "amount_encumbered" => $enc,
373             "amount_spent" => $spent
374         }
375     };
376 }
377
378 sub check_lineitem_received {
379     my($mgr, $li_id) = @_;
380
381     my $non_recv = $mgr->editor->search_acq_lineitem_detail(
382         {recv_time => undef, lineitem => $li_id}, {idlist=>1});
383
384     return 1 if @$non_recv;
385
386     my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
387     $li->state('received');
388     return update_lineitem($mgr, $li);
389 }
390
391 sub receive_lineitem {
392     my($mgr, $li_id, $skip_complete_check) = @_;
393     my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
394
395     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
396         {lineitem => $li_id, recv_time => undef}, {idlist => 1});
397
398     for my $lid_id (@$lid_ids) {
399        receive_lineitem_detail($mgr, $lid_id, 1) or return 0; 
400     }
401
402     $mgr->add_li;
403     $li->state('received');
404
405     $li = update_lineitem($mgr, $li) or return 0;
406     $mgr->post_process( sub { create_lineitem_status_events($mgr, $li_id, 'aur.received'); });
407
408     my $po;
409     return 0 unless
410         $skip_complete_check or (
411             $po = check_purchase_order_received($mgr, $li->purchase_order)
412         );
413
414     my $result = {"li" => {$li->id => {"state" => $li->state}}};
415     $result->{"po"} = describe_affected_po($mgr->editor, $po) if ref $po;
416     return $result;
417 }
418
419 sub rollback_receive_lineitem {
420     my($mgr, $li_id) = @_;
421     my $li = $mgr->editor->retrieve_acq_lineitem($li_id) or return 0;
422
423     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
424         {lineitem => $li_id, recv_time => {'!=' => undef}}, {idlist => 1});
425
426     for my $lid_id (@$lid_ids) {
427        rollback_receive_lineitem_detail($mgr, $lid_id, 1) or return 0; 
428     }
429
430     $mgr->add_li;
431     $li->state('on-order');
432     return update_lineitem($mgr, $li);
433 }
434
435
436 sub create_lineitem_status_events {
437     my($mgr, $li_id, $hook) = @_;
438
439     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
440     $ses->connect;
441     my $user_reqs = $mgr->editor->search_acq_user_request([
442         {lineitem => $li_id}, 
443         {flesh => 1, flesh_fields => {aur => ['usr']}}
444     ]);
445
446     for my $user_req (@$user_reqs) {
447         my $req = $ses->request('open-ils.trigger.event.autocreate', $hook, $user_req, $user_req->usr->home_ou);
448         $req->recv; 
449     }
450
451     $ses->disconnect;
452     return undef;
453 }
454
455 # ----------------------------------------------------------------------------
456 # Lineitem Detail
457 # ----------------------------------------------------------------------------
458 sub create_lineitem_detail {
459     my($mgr, %args) = @_;
460     my $lid = Fieldmapper::acq::lineitem_detail->new;
461     $lid->$_($args{$_}) for keys %args;
462     $lid->clear_id;
463     $mgr->add_lid;
464     return $mgr->editor->create_acq_lineitem_detail($lid);
465 }
466
467
468 # flesh out any required data with default values where appropriate
469 sub complete_lineitem_detail {
470     my($mgr, $lid) = @_;
471     unless($lid->barcode) {
472         my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_barcode_prefix') || 'ACQ';
473         $lid->barcode($pfx.$lid->id);
474     }
475
476     unless($lid->cn_label) {
477         my $pfx = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.tmp_callnumber_prefix') || 'ACQ';
478         $lid->cn_label($pfx.$lid->id);
479     }
480
481     if(!$lid->location and my $loc = $U->ou_ancestor_setting_value($lid->owning_lib, 'acq.default_copy_location')) {
482         $lid->location($loc);
483     }
484
485     $lid->circ_modifier(get_default_circ_modifier($mgr, $lid->owning_lib))
486         unless defined $lid->circ_modifier;
487
488     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
489     return $lid;
490 }
491
492 sub get_default_circ_modifier {
493     my($mgr, $org) = @_;
494     my $code = $mgr->cache($org, 'def_circ_mod');
495     $code = $U->ou_ancestor_setting_value($org, 'acq.default_circ_modifier') unless defined $code;
496     return $mgr->cache($org, 'def_circ_mod', $code) if defined $code;
497     return undef;
498 }
499
500 sub delete_lineitem_detail {
501     my($mgr, $lid) = @_;
502     $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid) unless ref $lid;
503     return $mgr->editor->delete_acq_lineitem_detail($lid);
504 }
505
506
507 sub receive_lineitem_detail {
508     my($mgr, $lid_id, $skip_complete_check) = @_;
509     my $e = $mgr->editor;
510
511     my $lid = $e->retrieve_acq_lineitem_detail([
512         $lid_id,
513         {   flesh => 1,
514             flesh_fields => {
515                 acqlid => ['fund_debit']
516             }
517         }
518     ]) or return 0;
519
520     return 1 if $lid->recv_time;
521
522     $lid->receiver($e->requestor->id);
523     $lid->recv_time('now');
524     $e->update_acq_lineitem_detail($lid) or return 0;
525
526     my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
527     $copy->status(OILS_COPY_STATUS_IN_PROCESS);
528     $copy->edit_date('now');
529     $copy->editor($e->requestor->id);
530     $copy->creator($e->requestor->id) if $U->ou_ancestor_setting_value(
531         $e->requestor->ws_ou, 'acq.copy_creator_uses_receiver', $e);
532     $e->update_asset_copy($copy) or return 0;
533
534     $mgr->add_lid;
535
536     return 1 if $skip_complete_check;
537
538     my $li = check_lineitem_received($mgr, $lid->lineitem) or return 0;
539     return 1 if $li == 1; # li not received
540
541     return check_purchase_order_received($mgr, $li->purchase_order) or return 0;
542 }
543
544
545 sub rollback_receive_lineitem_detail {
546     my($mgr, $lid_id) = @_;
547     my $e = $mgr->editor;
548
549     my $lid = $e->retrieve_acq_lineitem_detail([
550         $lid_id,
551         {   flesh => 1,
552             flesh_fields => {
553                 acqlid => ['fund_debit']
554             }
555         }
556     ]) or return 0;
557
558     return 1 unless $lid->recv_time;
559
560     $lid->clear_receiver;
561     $lid->clear_recv_time;
562     $e->update_acq_lineitem_detail($lid) or return 0;
563
564     my $copy = $e->retrieve_asset_copy($lid->eg_copy_id) or return 0;
565     $copy->status(OILS_COPY_STATUS_ON_ORDER);
566     $copy->edit_date('now');
567     $copy->editor($e->requestor->id);
568     $e->update_asset_copy($copy) or return 0;
569
570     $mgr->add_lid;
571     return $lid;
572 }
573
574 # ----------------------------------------------------------------------------
575 # Lineitem Attr
576 # ----------------------------------------------------------------------------
577 sub set_lineitem_attr {
578     my($mgr, %args) = @_;
579     my $attr_type = $args{attr_type};
580
581     # first, see if it's already set.  May just need to overwrite it
582     my $attr = $mgr->editor->search_acq_lineitem_attr({
583         lineitem => $args{lineitem},
584         attr_type => $args{attr_type},
585         attr_name => $args{attr_name}
586     })->[0];
587
588     if($attr) {
589         $attr->attr_value($args{attr_value});
590         return $attr if $mgr->editor->update_acq_lineitem_attr($attr);
591         return undef;
592
593     } else {
594
595         $attr = Fieldmapper::acq::lineitem_attr->new;
596         $attr->$_($args{$_}) for keys %args;
597         
598         unless($attr->definition) {
599             my $find = "search_acq_$attr_type";
600             my $attr_def_id = $mgr->editor->$find({code => $attr->attr_name}, {idlist=>1})->[0] or return 0;
601             $attr->definition($attr_def_id);
602         }
603         return $mgr->editor->create_acq_lineitem_attr($attr);
604     }
605 }
606
607 # ----------------------------------------------------------------------------
608 # Lineitem Debits
609 # ----------------------------------------------------------------------------
610 sub create_lineitem_debits {
611     my ($mgr, $li, $dry_run) = @_; 
612
613     unless($li->estimated_unit_price) {
614         $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PRICE', payload => $li->id));
615         $mgr->editor->rollback;
616         return 0;
617     }
618
619     unless($li->provider) {
620         $mgr->editor->event(OpenILS::Event->new('ACQ_LINEITEM_NO_PROVIDER', payload => $li->id));
621         $mgr->editor->rollback;
622         return 0;
623     }
624
625     my $lid_ids = $mgr->editor->search_acq_lineitem_detail(
626         {lineitem => $li->id}, 
627         {idlist=>1}
628     );
629
630     for my $lid_id (@$lid_ids) {
631
632         my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
633             $lid_id,
634             {   flesh => 1, 
635                 flesh_fields => {acqlid => ['fund']}
636             }
637         ]);
638
639         create_lineitem_detail_debit($mgr, $li, $lid, $dry_run) or return 0;
640     }
641
642     return 1;
643 }
644
645
646 # flesh li->provider
647 # flesh lid->fund
648 sub create_lineitem_detail_debit {
649     my ($mgr, $li, $lid, $dry_run, $no_translate) = @_;
650
651     # don't create the debit if one already exists
652     return $mgr->editor->retrieve_acq_fund_debit($lid->fund_debit) if $lid->fund_debit;
653
654     my $li_id = ref($li) ? $li->id : $li;
655
656     unless(ref $li and ref $li->provider) {
657        $li = $mgr->editor->retrieve_acq_lineitem([
658             $li_id,
659             {   flesh => 1,
660                 flesh_fields => {jub => ['provider']},
661             }
662         ]);
663     }
664
665     if(ref $lid) {
666         $lid->fund($mgr->editor->retrieve_acq_fund($lid->fund)) unless(ref $lid->fund);
667     } else {
668         $lid = $mgr->editor->retrieve_acq_lineitem_detail([
669             $lid,
670             {   flesh => 1, 
671                 flesh_fields => {acqlid => ['fund']}
672             }
673         ]);
674     }
675
676     unless ($lid->fund) {
677         $mgr->editor->event(
678             new OpenILS::Event("ACQ_FUND_NOT_FOUND") # close enough
679         );
680         return 0;
681     }
682
683     my $amount = $li->estimated_unit_price;
684     if($li->provider->currency_type ne $lid->fund->currency_type and !$no_translate) {
685
686         # At Fund debit creation time, translate into the currency of the fund
687         # TODO: org setting to disable automatic currency conversion at debit create time?
688
689         $amount = $mgr->editor->json_query({
690             from => [
691                 'acq.exchange_ratio', 
692                 $li->provider->currency_type, # source currency
693                 $lid->fund->currency_type, # destination currency
694                 $li->estimated_unit_price # source amount
695             ]
696         })->[0]->{'acq.exchange_ratio'};
697     }
698
699     my $debit = create_fund_debit(
700         $mgr, 
701         $dry_run,
702         fund => $lid->fund->id,
703         origin_amount => $li->estimated_unit_price,
704         origin_currency_type => $li->provider->currency_type,
705         amount => $amount
706     ) or return 0;
707
708     $lid->fund_debit($debit->id);
709     $lid->fund($lid->fund->id);
710     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
711     return $debit;
712 }
713
714
715 __PACKAGE__->register_method(
716         "method" => "fund_exceeds_balance_percent_api",
717         "api_name" => "open-ils.acq.fund.check_balance_percentages",
718         "signature" => {
719         "desc" => q/Determine whether a given fund exceeds its defined
720             "balance stop and warning percentages"/,
721         "params" => [
722             {"desc" => "Authentication token", "type" => "string"},
723             {"desc" => "Fund ID", "type" => "number"},
724             {"desc" => "Theoretical debit amount (optional)",
725                 "type" => "number"}
726         ],
727         "return" => {"desc" => q/An array of two values, for stop and warning,
728             in that order: 1 if fund exceeds that balance percentage, else 0/}
729     }
730 );
731
732 sub fund_exceeds_balance_percent_api {
733     my ($self, $conn, $auth, $fund_id, $debit_amount) = @_;
734
735     $debit_amount ||= 0;
736
737     my $e = new_editor("authtoken" => $auth);
738     return $e->die_event unless $e->checkauth;
739
740     my $fund = $e->retrieve_acq_fund($fund_id) or return $e->die_event;
741     return $e->die_event unless $e->allowed("VIEW_FUND", $fund->org);
742
743     my $result = [
744         fund_exceeds_balance_percent($fund, $debit_amount, $e, "stop"),
745         fund_exceeds_balance_percent($fund, $debit_amount, $e, "warning")
746     ];
747
748     $e->disconnect;
749     return $result;
750 }
751
752 sub fund_exceeds_balance_percent {
753     my ($fund, $debit_amount, $e, $which) = @_;
754
755     my ($method_name, $event_name) = @{{
756         "warning" => [
757             "balance_warning_percent", "ACQ_FUND_EXCEEDS_WARN_PERCENT"
758         ],
759         "stop" => [
760             "balance_stop_percent", "ACQ_FUND_EXCEEDS_STOP_PERCENT"
761         ]
762     }->{$which}};
763
764     if ($fund->$method_name) {
765         my $balance =
766             $e->search_acq_fund_combined_balance({"fund" => $fund->id})->[0];
767         my $allocations =
768             $e->search_acq_fund_allocation_total({"fund" => $fund->id})->[0];
769
770         $balance = ($balance) ? $balance->amount : 0;
771         $allocations = ($allocations) ? $allocations->amount : 0;
772
773         if ( 
774             $allocations == 0 || # if no allocations were ever made, assume we have hit the stop percent
775             ((($allocations - $balance + $debit_amount) / $allocations) * 100) > $fund->$method_name
776         ) {
777             $logger->info("fund would hit a limit: " . $fund->id . ", $balance, $debit_amount, $allocations, $method_name");
778             $e->event(
779                 new OpenILS::Event(
780                     $event_name,
781                     "payload" => {
782                         "fund" => $fund, "debit_amount" => $debit_amount
783                     }
784                 )
785             );
786             return 1;
787         }
788     }
789     return 0;
790 }
791
792 # ----------------------------------------------------------------------------
793 # Fund Debit
794 # ----------------------------------------------------------------------------
795 sub create_fund_debit {
796     my($mgr, $dry_run, %args) = @_;
797
798     # Verify the fund is not being spent beyond the hard stop amount
799     my $fund = $mgr->editor->retrieve_acq_fund($args{fund}) or return 0;
800
801     return 0 if
802         fund_exceeds_balance_percent(
803             $fund, $args{"amount"}, $mgr->editor, "stop"
804         );
805     return 0 if
806         $dry_run and fund_exceeds_balance_percent(
807             $fund, $args{"amount"}, $mgr->editor, "warning"
808         );
809
810     my $debit = Fieldmapper::acq::fund_debit->new;
811     $debit->debit_type('purchase');
812     $debit->encumbrance('t');
813     $debit->$_($args{$_}) for keys %args;
814     $debit->clear_id;
815     $mgr->add_debit($debit->amount);
816     return $mgr->editor->create_acq_fund_debit($debit);
817 }
818
819
820 # ----------------------------------------------------------------------------
821 # Picklist
822 # ----------------------------------------------------------------------------
823 sub create_picklist {
824     my($mgr, %args) = @_;
825     my $picklist = Fieldmapper::acq::picklist->new;
826     $picklist->creator($mgr->editor->requestor->id);
827     $picklist->owner($picklist->creator);
828     $picklist->editor($picklist->creator);
829     $picklist->create_time('now');
830     $picklist->edit_time('now');
831     $picklist->org_unit($mgr->editor->requestor->ws_ou);
832     $picklist->owner($mgr->editor->requestor->id);
833     $picklist->$_($args{$_}) for keys %args;
834     $picklist->clear_id;
835     $mgr->picklist($picklist);
836     return $mgr->editor->create_acq_picklist($picklist);
837 }
838
839 sub update_picklist {
840     my($mgr, $picklist) = @_;
841     $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
842     $picklist->edit_time('now');
843     $picklist->editor($mgr->editor->requestor->id);
844     if ($mgr->editor->update_acq_picklist($picklist)) {
845         $picklist = $mgr->editor->retrieve_acq_picklist($mgr->editor->data);
846         $mgr->picklist($picklist);
847         return $picklist;
848     } else {
849         return undef;
850     }
851 }
852
853 sub delete_picklist {
854     my($mgr, $picklist) = @_;
855     $picklist = $mgr->editor->retrieve_acq_picklist($picklist) unless ref $picklist;
856
857     # delete all 'new' lineitems
858     my $li_ids = $mgr->editor->search_acq_lineitem(
859         {
860             picklist => $picklist->id,
861             "-or" => {state => "new", purchase_order => undef}
862         },
863         {idlist => 1}
864     );
865     for my $li_id (@$li_ids) {
866         my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
867         return 0 unless delete_lineitem($mgr, $li);
868         $mgr->respond;
869     }
870
871     # detach all non-'new' lineitems
872     $li_ids = $mgr->editor->search_acq_lineitem({picklist => $picklist->id, state => {'!=' => 'new'}}, {idlist => 1});
873     for my $li_id (@$li_ids) {
874         my $li = $mgr->editor->retrieve_acq_lineitem($li_id);
875         $li->clear_picklist;
876         return 0 unless update_lineitem($mgr, $li);
877         $mgr->respond;
878     }
879
880     # remove any picklist-specific object perms
881     my $ops = $mgr->editor->search_permission_usr_object_perm_map({object_type => 'acqpl', object_id => ''.$picklist->id});
882     for my $op (@$ops) {
883         return 0 unless $mgr->editor->delete_usr_object_perm_map($op);
884     }
885
886     return $mgr->editor->delete_acq_picklist($picklist);
887 }
888
889 # ----------------------------------------------------------------------------
890 # Purchase Order
891 # ----------------------------------------------------------------------------
892 sub update_purchase_order {
893     my($mgr, $po) = @_;
894     $po = $mgr->editor->retrieve_acq_purchase_order($po) unless ref $po;
895     $po->editor($mgr->editor->requestor->id);
896     $po->edit_time('now');
897     $mgr->purchase_order($po);
898     return $mgr->editor->retrieve_acq_purchase_order($mgr->editor->data)
899         if $mgr->editor->update_acq_purchase_order($po);
900     return undef;
901 }
902
903 sub create_purchase_order {
904     my($mgr, %args) = @_;
905
906     # verify the chosen provider is still active
907     my $provider = $mgr->editor->retrieve_acq_provider($args{provider}) or return 0;
908     unless($U->is_true($provider->active)) {
909         $logger->error("provider is not active.  cannot create PO");
910         $mgr->editor->event(OpenILS::Event->new('ACQ_PROVIDER_INACTIVE'));
911         return 0;
912     }
913
914     my $po = Fieldmapper::acq::purchase_order->new;
915     $po->creator($mgr->editor->requestor->id);
916     $po->editor($mgr->editor->requestor->id);
917     $po->owner($mgr->editor->requestor->id);
918     $po->edit_time('now');
919     $po->create_time('now');
920     $po->state('pending');
921     $po->ordering_agency($mgr->editor->requestor->ws_ou);
922     $po->$_($args{$_}) for keys %args;
923     $po->clear_id;
924     $mgr->purchase_order($po);
925     return $mgr->editor->create_acq_purchase_order($po);
926 }
927
928 # ----------------------------------------------------------------------------
929 # if all of the lineitems for this PO are received,
930 # mark the PO as received
931 # ----------------------------------------------------------------------------
932 sub check_purchase_order_received {
933     my($mgr, $po_id) = @_;
934
935     my $non_recv_li = $mgr->editor->search_acq_lineitem(
936         {   purchase_order => $po_id,
937             state => {'!=' => 'received'}
938         }, {idlist=>1});
939
940     my $po = $mgr->editor->retrieve_acq_purchase_order($po_id);
941     return $po if @$non_recv_li;
942
943     $po->state('received');
944     return update_purchase_order($mgr, $po);
945 }
946
947
948 # ----------------------------------------------------------------------------
949 # Bib, Callnumber, and Copy data
950 # ----------------------------------------------------------------------------
951
952 sub create_lineitem_assets {
953     my($mgr, $li_id) = @_;
954     my $evt;
955
956     my $li = $mgr->editor->retrieve_acq_lineitem([
957         $li_id,
958         {   flesh => 1,
959             flesh_fields => {jub => ['purchase_order', 'attributes']}
960         }
961     ]) or return 0;
962
963     # -----------------------------------------------------------------
964     # first, create the bib record if necessary
965     # -----------------------------------------------------------------
966     my $new_bib = 0;
967     unless($li->eg_bib_id) {
968         create_bib($mgr, $li) or return 0;
969         $new_bib = 1;
970     }
971
972
973     # -----------------------------------------------------------------
974     # The lineitem is going live, promote user request holds to real holds
975     # -----------------------------------------------------------------
976     promote_lineitem_holds($mgr, $li) or return 0;
977
978     my $li_details = $mgr->editor->search_acq_lineitem_detail({lineitem => $li_id}, {idlist=>1});
979
980     # -----------------------------------------------------------------
981     # for each lineitem_detail, create the volume if necessary, create 
982     # a copy, and link them all together.
983     # -----------------------------------------------------------------
984     my $first_cn;
985     for my $lid_id (@{$li_details}) {
986
987         my $lid = $mgr->editor->retrieve_acq_lineitem_detail($lid_id) or return 0;
988         next if $lid->eg_copy_id;
989
990         # use the same callnumber label for all items within this lineitem
991         $lid->cn_label($first_cn) if $first_cn and not $lid->cn_label;
992
993         # apply defaults if necessary
994         return 0 unless complete_lineitem_detail($mgr, $lid);
995
996         $first_cn = $lid->cn_label unless $first_cn;
997
998         my $org = $lid->owning_lib;
999         my $label = $lid->cn_label;
1000         my $bibid = $li->eg_bib_id;
1001
1002         my $volume = $mgr->cache($org, "cn.$bibid.$label");
1003         unless($volume) {
1004             $volume = create_volume($mgr, $li, $lid) or return 0;
1005             $mgr->cache($org, "cn.$bibid.$label", $volume);
1006         }
1007         create_copy($mgr, $volume, $lid, $li) or return 0;
1008     }
1009
1010     return { li => $li, new_bib => $new_bib };
1011 }
1012
1013 sub create_bib {
1014     my($mgr, $li) = @_;
1015
1016     my $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1017         $mgr->editor, 
1018         $li->marc, 
1019         undef, # bib source
1020         undef, 
1021         1, # override tcn collisions
1022     ); 
1023
1024     if($U->event_code($record)) {
1025         $mgr->editor->event($record);
1026         $mgr->editor->rollback;
1027         return 0;
1028     }
1029
1030     $li->eg_bib_id($record->id);
1031     $mgr->add_bib;
1032     return update_lineitem($mgr, $li);
1033 }
1034
1035 sub create_volume {
1036     my($mgr, $li, $lid) = @_;
1037
1038     my ($volume, $evt) = 
1039         OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1040             $mgr->editor, 
1041             $lid->cn_label, 
1042             $li->eg_bib_id, 
1043             $lid->owning_lib
1044         );
1045
1046     if($evt) {
1047         $mgr->editor->event($evt);
1048         return 0;
1049     }
1050
1051     return $volume;
1052 }
1053
1054 sub create_copy {
1055     my($mgr, $volume, $lid, $li) = @_;
1056     my $copy = Fieldmapper::asset::copy->new;
1057     $copy->isnew(1);
1058     $copy->loan_duration(2);
1059     $copy->fine_level(2);
1060     $copy->status(($lid->recv_time) ? OILS_COPY_STATUS_IN_PROCESS : OILS_COPY_STATUS_ON_ORDER);
1061     $copy->barcode($lid->barcode);
1062     $copy->location($lid->location);
1063     $copy->call_number($volume->id);
1064     $copy->circ_lib($volume->owning_lib);
1065     $copy->circ_modifier($lid->circ_modifier);
1066
1067     # AKA list price.  We might need a $li->list_price field since 
1068     # estimated price is not necessarily the same as list price
1069     $copy->price($li->estimated_unit_price); 
1070
1071     my $evt = OpenILS::Application::Cat::AssetCommon->create_copy($mgr->editor, $volume, $copy);
1072     if($evt) {
1073         $mgr->editor->event($evt);
1074         return 0;
1075     }
1076
1077     $mgr->add_copy;
1078     $lid->eg_copy_id($copy->id);
1079     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
1080 }
1081
1082
1083
1084
1085
1086
1087 # ----------------------------------------------------------------------------
1088 # Workflow: Build a selection list from a Z39.50 search
1089 # ----------------------------------------------------------------------------
1090
1091 __PACKAGE__->register_method(
1092         method => 'zsearch',
1093         api_name => 'open-ils.acq.picklist.search.z3950',
1094     stream => 1,
1095         signature => {
1096         desc => 'Performs a z3950 federated search and creates a picklist and associated lineitems',
1097         params => [
1098             {desc => 'Authentication token', type => 'string'},
1099             {desc => 'Search definition', type => 'object'},
1100             {desc => 'Picklist name, optional', type => 'string'},
1101         ]
1102     }
1103 );
1104
1105 sub zsearch {
1106     my($self, $conn, $auth, $search, $name, $options) = @_;
1107     my $e = new_editor(authtoken=>$auth);
1108     return $e->event unless $e->checkauth;
1109     return $e->event unless $e->allowed('CREATE_PICKLIST');
1110
1111     $search->{limit} ||= 10;
1112     $options ||= {};
1113
1114     my $ses = OpenSRF::AppSession->create('open-ils.search');
1115     my $req = $ses->request('open-ils.search.z3950.search_class', $auth, $search);
1116
1117     my $first = 1;
1118     my $picklist;
1119     my $mgr;
1120     while(my $resp = $req->recv(timeout=>60)) {
1121
1122         if($first) {
1123             my $e = new_editor(requestor=>$e->requestor, xact=>1);
1124             $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1125             $picklist = zsearch_build_pl($mgr, $name);
1126             $first = 0;
1127         }
1128
1129         my $result = $resp->content;
1130         my $count = $result->{count} || 0;
1131         $mgr->total( (($count < $search->{limit}) ? $count : $search->{limit})+1 );
1132
1133         for my $rec (@{$result->{records}}) {
1134
1135             my $li = create_lineitem($mgr, 
1136                 picklist => $picklist->id,
1137                 source_label => $result->{service},
1138                 marc => $rec->{marcxml},
1139                 eg_bib_id => $rec->{bibid}
1140             );
1141
1142             if($$options{respond_li}) {
1143                 $li->attributes($mgr->editor->search_acq_lineitem_attr({lineitem => $li->id}))
1144                     if $$options{flesh_attrs};
1145                 $li->clear_marc if $$options{clear_marc};
1146                 $mgr->respond(lineitem => $li);
1147             } else {
1148                 $mgr->respond;
1149             }
1150         }
1151     }
1152
1153     $mgr->editor->commit;
1154     return $mgr->respond_complete;
1155 }
1156
1157 sub zsearch_build_pl {
1158     my($mgr, $name) = @_;
1159     $name ||= '';
1160
1161     my $picklist = $mgr->editor->search_acq_picklist({
1162         owner => $mgr->editor->requestor->id, 
1163         name => $name
1164     })->[0];
1165
1166     if($name eq '' and $picklist) {
1167         return 0 unless delete_picklist($mgr, $picklist);
1168         $picklist = undef;
1169     }
1170
1171     return update_picklist($mgr, $picklist) if $picklist;
1172     return create_picklist($mgr, name => $name);
1173 }
1174
1175
1176 # ----------------------------------------------------------------------------
1177 # Workflow: Build a selection list / PO by importing a batch of MARC records
1178 # ----------------------------------------------------------------------------
1179
1180 __PACKAGE__->register_method(
1181     method   => 'upload_records',
1182     api_name => 'open-ils.acq.process_upload_records',
1183     stream   => 1,
1184 );
1185
1186 sub upload_records {
1187     my($self, $conn, $auth, $key) = @_;
1188
1189         my $e = new_editor(authtoken => $auth, xact => 1);
1190     return $e->die_event unless $e->checkauth;
1191     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1192
1193     my $cache = OpenSRF::Utils::Cache->new;
1194
1195     my $data = $cache->get_cache("vandelay_import_spool_$key");
1196     my $purpose         = $data->{purpose};
1197     my $filename        = $data->{path};
1198     my $provider        = $data->{provider};
1199     my $picklist        = $data->{picklist};
1200     my $create_po       = $data->{create_po};
1201     my $activate_po     = $data->{activate_po};
1202     my $ordering_agency = $data->{ordering_agency};
1203     my $create_assets   = $data->{create_assets};
1204     my $po;
1205     my $evt;
1206
1207     unless(-r $filename) {
1208         $logger->error("unable to read MARC file $filename");
1209         $e->rollback;
1210         return OpenILS::Event->new('FILE_UPLOAD_ERROR', payload => {filename => $filename});
1211     }
1212
1213     $provider = $e->retrieve_acq_provider($provider) or return $e->die_event;
1214
1215     if($picklist) {
1216         $picklist = $e->retrieve_acq_picklist($picklist) or return $e->die_event;
1217         if($picklist->owner != $e->requestor->id) {
1218             return $e->die_event unless 
1219                 $e->allowed('CREATE_PICKLIST', $picklist->org_unit, $picklist);
1220         }
1221         $mgr->picklist($picklist);
1222     }
1223
1224     if($create_po) {
1225
1226         $po = create_purchase_order($mgr, 
1227             ordering_agency => $ordering_agency,
1228             provider => $provider->id,
1229             state => 'on-order'
1230         ) or return $mgr->editor->die_event;
1231     }
1232
1233     $logger->info("acq processing MARC file=$filename");
1234
1235         my $batch = new MARC::Batch ('USMARC', $filename);
1236         $batch->strict_off;
1237
1238         my $count = 0;
1239     my @li_list;
1240
1241         while(1) {
1242
1243             my ($err, $xml, $r);
1244                 $count++;
1245
1246                 try {
1247             $r = $batch->next;
1248         } catch Error with {
1249             $err = shift;
1250                         $logger->warn("Proccessing of record $count in set $key failed with error $err.  Skipping this record");
1251         };
1252
1253         next if $err;
1254         last unless $r;
1255
1256                 try {
1257             ($xml = $r->as_xml_record()) =~ s/\n//sog;
1258             $xml =~ s/^<\?xml.+\?\s*>//go;
1259             $xml =~ s/>\s+</></go;
1260             $xml =~ s/\p{Cc}//go;
1261             $xml = $U->entityize($xml);
1262             $xml =~ s/[\x00-\x1f]//go;
1263
1264                 } catch Error with {
1265                         $err = shift;
1266                         $logger->warn("Proccessing XML of record $count in set $key failed with error $err.  Skipping this record");
1267                 };
1268
1269         next if $err or not $xml;
1270
1271         my %args = (
1272             source_label => $provider->code,
1273             provider => $provider->id,
1274             marc => $xml,
1275         );
1276
1277         $args{picklist} = $picklist->id if $picklist;
1278         if($po) {
1279             $args{purchase_order} = $po->id;
1280             $args{state} = 'pending-order';
1281         }
1282
1283         my $li = create_lineitem($mgr, %args) or return $mgr->editor->die_event;
1284         $mgr->respond;
1285         $li->provider($provider); # flesh it, we'll need it later
1286
1287         import_lineitem_details($mgr, $ordering_agency, $li) or return $mgr->editor->die_event;
1288         $mgr->respond;
1289
1290         push(@li_list, $li->id);
1291         $mgr->respond;
1292         }
1293
1294     my $die_event = activate_purchase_order_impl($mgr, $po->id) if $po and $activate_po;
1295     return $die_event if $die_event;
1296
1297         $e->commit;
1298     unlink($filename);
1299     $cache->delete_cache('vandelay_import_spool_' . $key);
1300
1301     if ($create_assets) {
1302         create_lineitem_list_assets($mgr, \@li_list) or return $e->die_event;
1303     }
1304
1305     return $mgr->respond_complete;
1306 }
1307
1308 sub import_lineitem_details {
1309     my($mgr, $ordering_agency, $li) = @_;
1310
1311     my $holdings = $mgr->editor->json_query({from => ['acq.extract_provider_holding_data', $li->id]});
1312     return 1 unless @$holdings;
1313     my $org_path = $U->get_org_ancestors($ordering_agency);
1314     $org_path = [ reverse (@$org_path) ];
1315     my $price;
1316
1317
1318     my $idx = 1;
1319     while(1) {
1320         # create a lineitem detail for each copy in the data
1321
1322         my $compiled = extract_lineitem_detail_data($mgr, $org_path, $holdings, $idx);
1323         last unless defined $compiled;
1324         return 0 unless $compiled;
1325
1326         # this takes the price of the last copy and uses it as the lineitem price
1327         # need to determine if a given record would include different prices for the same item
1328         $price = $$compiled{estimated_price};
1329
1330         last unless $$compiled{quantity};
1331
1332         for(1..$$compiled{quantity}) {
1333             my $lid = create_lineitem_detail(
1334                 $mgr, 
1335                 lineitem        => $li->id,
1336                 owning_lib      => $$compiled{owning_lib},
1337                 cn_label        => $$compiled{call_number},
1338                 fund            => $$compiled{fund},
1339                 circ_modifier   => $$compiled{circ_modifier},
1340                 note            => $$compiled{note},
1341                 location        => $$compiled{copy_location},
1342                 collection_code => $$compiled{collection_code}
1343             ) or return 0;
1344         }
1345
1346         $mgr->respond;
1347         $idx++;
1348     }
1349
1350     $li->estimated_unit_price($price);
1351     update_lineitem($mgr, $li) or return 0;
1352     return 1;
1353 }
1354
1355 # return hash on success, 0 on error, undef on no more holdings
1356 sub extract_lineitem_detail_data {
1357     my($mgr, $org_path, $holdings, $index) = @_;
1358
1359     my @data_list = grep { $_->{holding} eq $index } @$holdings;
1360     return undef unless @data_list;
1361
1362     my %compiled = map { $_->{attr} => $_->{data} } @data_list;
1363     my $base_org = $$org_path[0];
1364
1365     my $killme = sub {
1366         my $msg = shift;
1367         $logger->error("Item import extraction error: $msg");
1368         $logger->error('Holdings Data: ' . OpenSRF::Utils::JSON->perl2JSON(\%compiled));
1369         $mgr->editor->rollback;
1370         $mgr->editor->event(OpenILS::Event->new('ACQ_IMPORT_ERROR', payload => $msg));
1371         return 0;
1372     };
1373
1374     # ---------------------------------------------------------------------
1375     # Fund
1376     if(my $code = $compiled{fund_code}) {
1377
1378         my $fund = $mgr->cache($base_org, "fund.$code");
1379         unless($fund) {
1380             # search up the org tree for the most appropriate fund
1381             for my $org (@$org_path) {
1382                 $fund = $mgr->editor->search_acq_fund(
1383                     {org => $org, code => $code, year => DateTime->now->year}, {idlist => 1})->[0];
1384                 last if $fund;
1385             }
1386         }
1387         return $killme->("no fund with code $code at orgs [@$org_path]") unless $fund;
1388         $compiled{fund} = $fund;
1389         $mgr->cache($base_org, "fund.$code", $fund);
1390     }
1391
1392
1393     # ---------------------------------------------------------------------
1394     # Owning lib
1395     if(my $sn = $compiled{owning_lib}) {
1396         my $org_id = $mgr->cache($base_org, "orgsn.$sn") ||
1397             $mgr->editor->search_actor_org_unit({shortname => $sn}, {idlist => 1})->[0];
1398         return $killme->("invalid owning_lib defined: $sn") unless $org_id;
1399         $compiled{owning_lib} = $org_id;
1400         $mgr->cache($$org_path[0], "orgsn.$sn", $org_id);
1401     }
1402
1403
1404     # ---------------------------------------------------------------------
1405     # Circ Modifier
1406     my $code = $compiled{circ_modifier};
1407
1408     if(defined $code) {
1409
1410         # verify this is a valid circ modifier
1411         return $killme->("invlalid circ_modifier $code") unless 
1412             defined $mgr->cache($base_org, "mod.$code") or 
1413             $mgr->editor->retrieve_config_circ_modifier($code);
1414
1415             # if valid, cache for future tests
1416             $mgr->cache($base_org, "mod.$code", $code);
1417
1418     } else {
1419         $compiled{circ_modifier} = get_default_circ_modifier($mgr, $base_org);
1420     }
1421
1422
1423     # ---------------------------------------------------------------------
1424     # Shelving Location
1425     if( my $name = $compiled{copy_location}) {
1426         my $loc = $mgr->cache($base_org, "copy_loc.$name");
1427         unless($loc) {
1428             for my $org (@$org_path) {
1429                 $loc = $mgr->editor->search_asset_copy_location(
1430                     {owning_lib => $org, name => $name}, {idlist => 1})->[0];
1431                 last if $loc;
1432             }
1433         }
1434         return $killme->("Invalid copy location $name") unless $loc;
1435         $compiled{copy_location} = $loc;
1436         $mgr->cache($base_org, "copy_loc.$name", $loc);
1437     }
1438
1439     return \%compiled;
1440 }
1441
1442
1443
1444 # ----------------------------------------------------------------------------
1445 # Workflow: Given an existing purchase order, import/create the bibs, 
1446 # callnumber and copy objects
1447 # ----------------------------------------------------------------------------
1448
1449 __PACKAGE__->register_method(
1450         method => 'create_po_assets',
1451         api_name        => 'open-ils.acq.purchase_order.assets.create',
1452         signature => {
1453         desc => q/Creates assets for each lineitem in the purchase order/,
1454         params => [
1455             {desc => 'Authentication token', type => 'string'},
1456             {desc => 'The purchase order id', type => 'number'},
1457         ],
1458         return => {desc => 'Streams a total versus completed counts object, event on error'}
1459     }
1460 );
1461
1462 sub create_po_assets {
1463     my($self, $conn, $auth, $po_id) = @_;
1464
1465     my $e = new_editor(authtoken=>$auth, xact=>1);
1466     return $e->die_event unless $e->checkauth;
1467     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1468
1469     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1470
1471     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1472
1473     # it's ugly, but it's fast.  Get the total count of lineitem detail objects to process
1474     my $lid_total = $e->json_query({
1475         select => { acqlid => [{aggregate => 1, transform => 'count', column => 'id'}] }, 
1476         from => {
1477             acqlid => {
1478                 jub => {
1479                     fkey => 'lineitem', 
1480                     field => 'id', 
1481                     join => {acqpo => {fkey => 'purchase_order', field => 'id'}}
1482                 }
1483             }
1484         }, 
1485         where => {'+acqpo' => {id => $po_id}}
1486     })->[0]->{id};
1487
1488     $mgr->total(scalar(@$li_ids) + $lid_total);
1489
1490     create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1491
1492     $e->xact_begin;
1493     update_purchase_order($mgr, $po) or return $e->die_event;
1494     $e->commit;
1495
1496     return $mgr->respond_complete;
1497 }
1498
1499
1500
1501 __PACKAGE__->register_method(
1502     method    => 'create_purchase_order_api',
1503     api_name  => 'open-ils.acq.purchase_order.create',
1504     signature => {
1505         desc   => 'Creates a new purchase order',
1506         params => [
1507             {desc => 'Authentication token', type => 'string'},
1508             {desc => 'purchase_order to create', type => 'object'}
1509         ],
1510         return => {desc => 'The purchase order id, Event on failure'}
1511     }
1512 );
1513
1514 sub create_purchase_order_api {
1515     my($self, $conn, $auth, $po, $args) = @_;
1516     $args ||= {};
1517
1518     my $e = new_editor(xact=>1, authtoken=>$auth);
1519     return $e->die_event unless $e->checkauth;
1520     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
1521     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1522
1523     # create the PO
1524     my %pargs = (ordering_agency => $e->requestor->ws_ou); # default
1525     $pargs{provider}            = $po->provider            if $po->provider;
1526     $pargs{ordering_agency}     = $po->ordering_agency     if $po->ordering_agency;
1527     $pargs{prepayment_required} = $po->prepayment_required if $po->prepayment_required;
1528         
1529     $po = create_purchase_order($mgr, %pargs) or return $e->die_event;
1530
1531     my $li_ids = $$args{lineitems};
1532
1533     if($li_ids) {
1534
1535         for my $li_id (@$li_ids) { 
1536
1537             my $li = $e->retrieve_acq_lineitem([
1538                 $li_id,
1539                 {flesh => 1, flesh_fields => {jub => ['attributes']}}
1540             ]) or return $e->die_event;
1541
1542             $li->provider($po->provider);
1543             $li->purchase_order($po->id);
1544             $li->state('pending-order');
1545             update_lineitem($mgr, $li) or return $e->die_event;
1546             $mgr->respond;
1547         }
1548     }
1549
1550     # commit before starting the asset creation
1551     $e->xact_commit;
1552
1553     if($li_ids and $$args{create_assets}) {
1554         create_lineitem_list_assets($mgr, $li_ids) or return $e->die_event;
1555     }
1556
1557     return $mgr->respond_complete;
1558 }
1559
1560
1561
1562 __PACKAGE__->register_method(
1563     method   => 'update_lineitem_fund_batch',
1564     api_name => 'open-ils.acq.lineitem.fund.update.batch',
1565     stream   => 1,
1566     signature => { 
1567         desc => q/Given a set of lineitem IDS, updates the fund for all attached lineitem details/
1568     }
1569 );
1570
1571 sub update_lineitem_fund_batch {
1572     my($self, $conn, $auth, $li_ids, $fund_id) = @_;
1573     my $e = new_editor(xact=>1, authtoken=>$auth);
1574     return $e->die_event unless $e->checkauth;
1575     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1576     for my $li_id (@$li_ids) {
1577         my ($li, $evt) = fetch_and_check_li($e, $li_id, 'write');
1578         return $evt if $evt;
1579         my $li_details = $e->search_acq_lineitem_detail({lineitem => $li_id});
1580         $_->fund($fund_id) and $_->ischanged(1) for @$li_details;
1581         $evt = lineitem_detail_CUD_batch($mgr, $li_details);
1582         return $evt if $evt;
1583         $mgr->add_li;
1584         $mgr->respond;
1585     }
1586     $e->commit;
1587     return $mgr->respond_complete;
1588 }
1589
1590
1591
1592 __PACKAGE__->register_method(
1593     method    => 'lineitem_detail_CUD_batch_api',
1594     api_name  => 'open-ils.acq.lineitem_detail.cud.batch',
1595     stream    => 1,
1596     signature => {
1597         desc   => q/Creates a new purchase order line item detail. / .
1598                   q/Additionally creates the associated fund_debit/,
1599         params => [
1600             {desc => 'Authentication token', type => 'string'},
1601             {desc => 'List of lineitem_details to create', type => 'array'},
1602             {desc => 'Create Debits.  Used for creating post-po-asset-creation debits', type => 'bool'},
1603         ],
1604         return => {desc => 'Streaming response of current position in the array'}
1605     }
1606 );
1607
1608 __PACKAGE__->register_method(
1609     method    => 'lineitem_detail_CUD_batch_api',
1610     api_name  => 'open-ils.acq.lineitem_detail.cud.batch.dry_run',
1611     stream    => 1,
1612     signature => { 
1613         desc => q/
1614             Dry run version of open-ils.acq.lineitem_detail.cud.batch.
1615             In dry_run mode, updated fund_debit's the exceed the warning
1616             percent return an event.  
1617         /
1618     }
1619 );
1620
1621
1622 sub lineitem_detail_CUD_batch_api {
1623     my($self, $conn, $auth, $li_details, $create_debits) = @_;
1624     my $e = new_editor(xact=>1, authtoken=>$auth);
1625     return $e->die_event unless $e->checkauth;
1626     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1627     my $dry_run = ($self->api_name =~ /dry_run/o);
1628     my $evt = lineitem_detail_CUD_batch($mgr, $li_details, $create_debits, $dry_run);
1629     return $evt if $evt;
1630     $e->commit;
1631     return $mgr->respond_complete;
1632 }
1633
1634
1635 sub lineitem_detail_CUD_batch {
1636     my($mgr, $li_details, $create_debits, $dry_run) = @_;
1637
1638     $mgr->total(scalar(@$li_details));
1639     my $e = $mgr->editor;
1640     
1641     my $li;
1642     my %li_cache;
1643     my $fund_cache = {};
1644     my $evt;
1645
1646     for my $lid (@$li_details) {
1647
1648         unless($li = $li_cache{$lid->lineitem}) {
1649             ($li, $evt) = fetch_and_check_li($e, $lid->lineitem, 'write');
1650             return $evt if $evt;
1651         }
1652
1653         if($lid->isnew) {
1654             $lid = create_lineitem_detail($mgr, %{$lid->to_bare_hash}) or return $e->die_event;
1655             if($create_debits) {
1656                 $li->provider($e->retrieve_acq_provider($li->provider)) or return $e->die_event;
1657                 $lid->fund($e->retrieve_acq_fund($lid->fund)) or return $e->die_event;
1658                 create_lineitem_detail_debit($mgr, $li, $lid, 0, 1) or return $e->die_event;
1659             }
1660
1661         } elsif($lid->ischanged) {
1662             return $evt if $evt = handle_changed_lid($e, $lid, $dry_run, $fund_cache);
1663
1664         } elsif($lid->isdeleted) {
1665             delete_lineitem_detail($mgr, $lid) or return $e->die_event;
1666         }
1667
1668         $mgr->respond(li => $li);
1669         $li_cache{$lid->lineitem} = $li;
1670     }
1671
1672     return undef;
1673 }
1674
1675 sub handle_changed_lid {
1676     my($e, $lid, $dry_run, $fund_cache) = @_;
1677
1678     my $orig_lid = $e->retrieve_acq_lineitem_detail($lid->id) or return $e->die_event;
1679
1680     # updating the fund, so update the debit
1681     if($orig_lid->fund_debit and $orig_lid->fund != $lid->fund) {
1682
1683         my $debit = $e->retrieve_acq_fund_debit($orig_lid->fund_debit);
1684         my $new_fund = $$fund_cache{$lid->fund} = 
1685             $$fund_cache{$lid->fund} || $e->retrieve_acq_fund($lid->fund);
1686
1687         # check the thresholds
1688         return $e->die_event if
1689             fund_exceeds_balance_percent($new_fund, $debit->amount, $e, "stop");
1690         return $e->die_event if $dry_run and 
1691             fund_exceeds_balance_percent($new_fund, $debit->amount, $e, "warning");
1692
1693         $debit->fund($new_fund->id);
1694         $e->update_acq_fund_debit($debit) or return $e->die_event;
1695     }
1696
1697     $e->update_acq_lineitem_detail($lid) or return $e->die_event;
1698     return undef;
1699 }
1700
1701
1702 __PACKAGE__->register_method(
1703     method   => 'receive_po_api',
1704     api_name => 'open-ils.acq.purchase_order.receive'
1705 );
1706
1707 sub receive_po_api {
1708     my($self, $conn, $auth, $po_id) = @_;
1709     my $e = new_editor(xact => 1, authtoken => $auth);
1710     return $e->die_event unless $e->checkauth;
1711     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1712
1713     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1714     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1715
1716     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1717
1718     for my $li_id (@$li_ids) {
1719         receive_lineitem($mgr, $li_id) or return $e->die_event;
1720         $mgr->respond;
1721     }
1722
1723     $po->state('received');
1724     update_purchase_order($mgr, $po) or return $e->die_event;
1725
1726     $e->commit;
1727     return $mgr->respond_complete;
1728 }
1729
1730
1731 # At the moment there's a lack of parallelism between the receive and unreceive
1732 # API methods for POs and the API methods for LIs and LIDs.  The methods for
1733 # POs stream back objects as they act, whereas the methods for LIs and LIDs
1734 # atomically return an object that describes only what changed (in LIs and LIDs
1735 # themselves or in the objects to which to LIs and LIDs belong).
1736 #
1737 # The methods for LIs and LIDs work the way they do to faciliate the UI's
1738 # maintaining correct information about the state of these things when a user
1739 # wants to receive or unreceive these objects without refreshing their whole
1740 # display.  The UI feature for receiving and un-receiving a whole PO just
1741 # refreshes the whole display, so this absence of parallelism in the UI is also
1742 # relected in this module.
1743 #
1744 # This could be neatened in the future by making POs receive and unreceive in
1745 # the same way the LIs and LIDs do.
1746
1747 __PACKAGE__->register_method(
1748         method => 'receive_lineitem_detail_api',
1749         api_name        => 'open-ils.acq.lineitem_detail.receive',
1750         signature => {
1751         desc => 'Mark a lineitem_detail as received',
1752         params => [
1753             {desc => 'Authentication token', type => 'string'},
1754             {desc => 'lineitem detail ID', type => 'number'}
1755         ],
1756         return => {desc =>
1757             "on success, object describing changes to LID and possibly " .
1758             "to LI and PO; on error, Event"
1759         }
1760     }
1761 );
1762
1763 sub receive_lineitem_detail_api {
1764     my($self, $conn, $auth, $lid_id) = @_;
1765
1766     my $e = new_editor(xact=>1, authtoken=>$auth);
1767     return $e->die_event unless $e->checkauth;
1768     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1769
1770     my $fleshing = {
1771         "flesh" => 2, "flesh_fields" => {
1772             "acqlid" => ["lineitem"], "jub" => ["purchase_order"]
1773         }
1774     };
1775
1776     my $lid = $e->retrieve_acq_lineitem_detail([$lid_id, $fleshing]);
1777
1778     return $e->die_event unless $e->allowed(
1779         'RECEIVE_PURCHASE_ORDER', $lid->lineitem->purchase_order->ordering_agency);
1780
1781     # update ...
1782     my $recvd = receive_lineitem_detail($mgr, $lid_id) or return $e->die_event;
1783
1784     # .. and re-retrieve
1785     $lid = $e->retrieve_acq_lineitem_detail([$lid_id, $fleshing]);
1786
1787     # Now build result data structure.
1788     my $result = {"lid" => {$lid->id => {"recv_time" => $lid->recv_time}}};
1789
1790     if (ref $recvd) {
1791         if ($recvd->class_name =~ /::purchase_order/) {
1792             $result->{"po"} = describe_affected_po($e, $recvd);
1793             $result->{"li"} = {
1794                 $lid->lineitem->id => {"state" => $lid->lineitem->state}
1795             };
1796         } elsif ($recvd->class_name =~ /::lineitem/) {
1797             $result->{"li"} = {$recvd->id => {"state" => $recvd->state}};
1798         }
1799     }
1800     $result->{"po"} ||=
1801         describe_affected_po($e, $lid->lineitem->purchase_order);
1802
1803     $e->commit;
1804     return $result;
1805 }
1806
1807 __PACKAGE__->register_method(
1808         method => 'receive_lineitem_api',
1809         api_name        => 'open-ils.acq.lineitem.receive',
1810         signature => {
1811         desc => 'Mark a lineitem as received',
1812         params => [
1813             {desc => 'Authentication token', type => 'string'},
1814             {desc => 'lineitem ID', type => 'number'}
1815         ],
1816         return => {desc =>
1817             "on success, object describing changes to LI and possibly PO; " .
1818             "on error, Event"
1819         }
1820     }
1821 );
1822
1823 sub receive_lineitem_api {
1824     my($self, $conn, $auth, $li_id) = @_;
1825
1826     my $e = new_editor(xact=>1, authtoken=>$auth);
1827     return $e->die_event unless $e->checkauth;
1828     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1829
1830     my $li = $e->retrieve_acq_lineitem([
1831         $li_id, {
1832             flesh => 1,
1833             flesh_fields => {
1834                 jub => ['purchase_order']
1835             }
1836         }
1837     ]) or return $e->die_event;
1838
1839     return $e->die_event unless $e->allowed(
1840         'RECEIVE_PURCHASE_ORDER', $li->purchase_order->ordering_agency);
1841
1842     my $res = receive_lineitem($mgr, $li_id) or return $e->die_event;
1843     $e->commit;
1844     $conn->respond_complete($res);
1845     $mgr->run_post_response_hooks;
1846 }
1847
1848
1849 __PACKAGE__->register_method(
1850     method   => 'rollback_receive_po_api',
1851     api_name => 'open-ils.acq.purchase_order.receive.rollback'
1852 );
1853
1854 sub rollback_receive_po_api {
1855     my($self, $conn, $auth, $po_id) = @_;
1856     my $e = new_editor(xact => 1, authtoken => $auth);
1857     return $e->die_event unless $e->checkauth;
1858     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1859
1860     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
1861     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1862
1863     my $li_ids = $e->search_acq_lineitem({purchase_order => $po_id}, {idlist => 1});
1864
1865     for my $li_id (@$li_ids) {
1866         rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1867         $mgr->respond;
1868     }
1869
1870     $po->state('on-order');
1871     update_purchase_order($mgr, $po) or return $e->die_event;
1872
1873     $e->commit;
1874     return $mgr->respond_complete;
1875 }
1876
1877
1878 __PACKAGE__->register_method(
1879     method    => 'rollback_receive_lineitem_detail_api',
1880     api_name  => 'open-ils.acq.lineitem_detail.receive.rollback',
1881     signature => {
1882         desc   => 'Mark a lineitem_detail as Un-received',
1883         params => [
1884             {desc => 'Authentication token', type => 'string'},
1885             {desc => 'lineitem detail ID', type => 'number'}
1886         ],
1887         return => {desc =>
1888             "on success, object describing changes to LID and possibly " .
1889             "to LI and PO; on error, Event"
1890         }
1891     }
1892 );
1893
1894 sub rollback_receive_lineitem_detail_api {
1895     my($self, $conn, $auth, $lid_id) = @_;
1896
1897     my $e = new_editor(xact=>1, authtoken=>$auth);
1898     return $e->die_event unless $e->checkauth;
1899     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1900
1901     my $lid = $e->retrieve_acq_lineitem_detail([
1902         $lid_id, {
1903             flesh => 2,
1904             flesh_fields => {
1905                 acqlid => ['lineitem'],
1906                 jub => ['purchase_order']
1907             }
1908         }
1909     ]);
1910     my $li = $lid->lineitem;
1911     my $po = $li->purchase_order;
1912
1913     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1914
1915     my $result = {};
1916
1917     my $recvd = rollback_receive_lineitem_detail($mgr, $lid_id)
1918         or return $e->die_event;
1919
1920     if (ref $recvd) {
1921         $result->{"lid"} = {$recvd->id => {"recv_time" => $recvd->recv_time}};
1922     } else {
1923         $result->{"lid"} = {$lid->id => {"recv_time" => $lid->recv_time}};
1924     }
1925
1926     if ($li->state eq "received") {
1927         $li->state("on-order");
1928         $li = update_lineitem($mgr, $li) or return $e->die_event;
1929         $result->{"li"} = {$li->id => {"state" => $li->state}};
1930     }
1931
1932     if ($po->state eq "received") {
1933         $po->state("on-order");
1934         $po = update_purchase_order($mgr, $po) or return $e->die_event;
1935     }
1936     $result->{"po"} = describe_affected_po($e, $po);
1937
1938     $e->commit and return $result or return $e->die_event;
1939 }
1940
1941 __PACKAGE__->register_method(
1942     method    => 'rollback_receive_lineitem_api',
1943     api_name  => 'open-ils.acq.lineitem.receive.rollback',
1944     signature => {
1945         desc   => 'Mark a lineitem as Un-received',
1946         params => [
1947             {desc => 'Authentication token', type => 'string'},
1948             {desc => 'lineitem ID',          type => 'number'}
1949         ],
1950         return => {desc =>
1951             "on success, object describing changes to LI and possibly PO; " .
1952             "on error, Event"
1953         }
1954     }
1955 );
1956
1957 sub rollback_receive_lineitem_api {
1958     my($self, $conn, $auth, $li_id) = @_;
1959
1960     my $e = new_editor(xact=>1, authtoken=>$auth);
1961     return $e->die_event unless $e->checkauth;
1962     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
1963
1964     my $li = $e->retrieve_acq_lineitem([
1965         $li_id, {
1966             "flesh" => 1, "flesh_fields" => {"jub" => ["purchase_order"]}
1967         }
1968     ]);
1969     my $po = $li->purchase_order;
1970
1971     return $e->die_event unless $e->allowed('RECEIVE_PURCHASE_ORDER', $po->ordering_agency);
1972
1973     $li = rollback_receive_lineitem($mgr, $li_id) or return $e->die_event;
1974
1975     my $result = {"li" => {$li->id => {"state" => $li->state}}};
1976     if ($po->state eq "received") {
1977         $po->state("on-order");
1978         $po = update_purchase_order($mgr, $po) or return $e->die_event;
1979     }
1980     $result->{"po"} = describe_affected_po($e, $po);
1981
1982     $e->commit and return $result or return $e->die_event;
1983 }
1984
1985
1986 __PACKAGE__->register_method(
1987     method    => 'set_lineitem_price_api',
1988     api_name  => 'open-ils.acq.lineitem.price.set',
1989     signature => {
1990         desc   => 'Set lineitem price.  If debits already exist, update them as well',
1991         params => [
1992             {desc => 'Authentication token', type => 'string'},
1993             {desc => 'lineitem ID',          type => 'number'}
1994         ],
1995         return => {desc => 'status blob, Event on error'}
1996     }
1997 );
1998
1999 sub set_lineitem_price_api {
2000     my($self, $conn, $auth, $li_id, $price) = @_;
2001
2002     my $e = new_editor(xact=>1, authtoken=>$auth);
2003     return $e->die_event unless $e->checkauth;
2004     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2005
2006     my ($li, $evt) = fetch_and_check_li($e, $li_id, 'write');
2007     return $evt if $evt;
2008
2009     $li->estimated_unit_price($price);
2010     update_lineitem($mgr, $li) or return $e->die_event;
2011
2012     my $lid_ids = $e->search_acq_lineitem_detail(
2013         {lineitem => $li_id, fund_debit => {'!=' => undef}}, 
2014         {idlist => 1}
2015     );
2016
2017     for my $lid_id (@$lid_ids) {
2018
2019         my $lid = $e->retrieve_acq_lineitem_detail([
2020             $lid_id, {
2021             flesh => 1, flesh_fields => {acqlid => ['fund', 'fund_debit']}}
2022         ]);
2023
2024         $lid->fund_debit->amount($price);
2025         $e->update_acq_fund_debit($lid->fund_debit) or return $e->die_event;
2026         $mgr->add_lid;
2027         $mgr->respond;
2028     }
2029
2030     $e->commit;
2031     return $mgr->respond_complete;
2032 }
2033
2034
2035 __PACKAGE__->register_method(
2036     method    => 'clone_picklist_api',
2037     api_name  => 'open-ils.acq.picklist.clone',
2038     signature => {
2039         desc   => 'Clones a picklist, including lineitem and lineitem details',
2040         params => [
2041             {desc => 'Authentication token', type => 'string'},
2042             {desc => 'Picklist ID', type => 'number'},
2043             {desc => 'New Picklist Name', type => 'string'}
2044         ],
2045         return => {desc => 'status blob, Event on error'}
2046     }
2047 );
2048
2049 sub clone_picklist_api {
2050     my($self, $conn, $auth, $pl_id, $name) = @_;
2051
2052     my $e = new_editor(xact=>1, authtoken=>$auth);
2053     return $e->die_event unless $e->checkauth;
2054     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2055
2056     my $old_pl = $e->retrieve_acq_picklist($pl_id);
2057     my $new_pl = create_picklist($mgr, %{$old_pl->to_bare_hash}, name => $name) or return $e->die_event;
2058
2059     my $li_ids = $e->search_acq_lineitem({picklist => $pl_id}, {idlist => 1});
2060
2061     for my $li_id (@$li_ids) {
2062
2063         # copy the lineitems
2064         my $li = $e->retrieve_acq_lineitem($li_id);
2065         my $new_li = create_lineitem($mgr, %{$li->to_bare_hash}, picklist => $new_pl->id) or return $e->die_event;
2066
2067         my $lid_ids = $e->search_acq_lineitem_detail({lineitem => $li_id}, {idlist => 1});
2068         for my $lid_id (@$lid_ids) {
2069
2070             # copy the lineitem details
2071             my $lid = $e->retrieve_acq_lineitem_detail($lid_id);
2072             create_lineitem_detail($mgr, %{$lid->to_bare_hash}, lineitem => $new_li->id) or return $e->die_event;
2073         }
2074
2075         $mgr->respond;
2076     }
2077
2078     $e->commit;
2079     return $mgr->respond_complete;
2080 }
2081
2082
2083 __PACKAGE__->register_method(
2084     method    => 'merge_picklist_api',
2085     api_name  => 'open-ils.acq.picklist.merge',
2086     signature => {
2087         desc   => 'Merges 2 or more picklists into a single list',
2088         params => [
2089             {desc => 'Authentication token', type => 'string'},
2090             {desc => 'Lead Picklist ID', type => 'number'},
2091             {desc => 'List of subordinate picklist IDs', type => 'array'}
2092         ],
2093         return => {desc => 'status blob, Event on error'}
2094     }
2095 );
2096
2097 sub merge_picklist_api {
2098     my($self, $conn, $auth, $lead_pl, $pl_list) = @_;
2099
2100     my $e = new_editor(xact=>1, authtoken=>$auth);
2101     return $e->die_event unless $e->checkauth;
2102     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2103
2104     # XXX perms on each picklist modified
2105
2106     $lead_pl = $e->retrieve_acq_picklist($lead_pl) or return $e->die_event;
2107     # point all of the lineitems at the lead picklist
2108     my $li_ids = $e->search_acq_lineitem({picklist => $pl_list}, {idlist => 1});
2109
2110     for my $li_id (@$li_ids) {
2111         my $li = $e->retrieve_acq_lineitem($li_id);
2112         $li->picklist($lead_pl);
2113         update_lineitem($mgr, $li) or return $e->die_event;
2114         $mgr->respond;
2115     }
2116
2117     # now delete the subordinate lists
2118     for my $pl_id (@$pl_list) {
2119         my $pl = $e->retrieve_acq_picklist($pl_id);
2120         $e->delete_acq_picklist($pl) or return $e->die_event;
2121     }
2122
2123     update_picklist($mgr, $lead_pl) or return $e->die_event;
2124
2125     $e->commit;
2126     return $mgr->respond_complete;
2127 }
2128
2129
2130 __PACKAGE__->register_method(
2131     method    => 'delete_picklist_api',
2132     api_name  => 'open-ils.acq.picklist.delete',
2133     signature => {
2134         desc   => q/Deletes a picklist.  It also deletes any lineitems in the "new" state. / .
2135                   q/Other attached lineitems are detached/,
2136         params => [
2137             {desc => 'Authentication token',  type => 'string'},
2138             {desc => 'Picklist ID to delete', type => 'number'}
2139         ],
2140         return => {desc => '1 on success, Event on error'}
2141     }
2142 );
2143
2144 sub delete_picklist_api {
2145     my($self, $conn, $auth, $picklist_id) = @_;
2146     my $e = new_editor(xact=>1, authtoken=>$auth);
2147     return $e->die_event unless $e->checkauth;
2148     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2149     my $pl = $e->retrieve_acq_picklist($picklist_id) or return $e->die_event;
2150     delete_picklist($mgr, $pl) or return $e->die_event;
2151     $e->commit;
2152     return $mgr->respond_complete;
2153 }
2154
2155
2156
2157 __PACKAGE__->register_method(
2158     method   => 'activate_purchase_order',
2159     api_name => 'open-ils.acq.purchase_order.activate.dry_run'
2160 );
2161
2162 __PACKAGE__->register_method(
2163     method    => 'activate_purchase_order',
2164     api_name  => 'open-ils.acq.purchase_order.activate',
2165     signature => {
2166         desc => q/Activates a purchase order.  This updates the status of the PO / .
2167                 q/and Lineitems to 'on-order'.  Activated PO's are ready for EDI delivery if appropriate./,
2168         params => [
2169             {desc => 'Authentication token', type => 'string'},
2170             {desc => 'Purchase ID', type => 'number'}
2171         ],
2172         return => {desc => '1 on success, Event on error'}
2173     }
2174 );
2175
2176 sub activate_purchase_order {
2177     my($self, $conn, $auth, $po_id) = @_;
2178
2179     my $dry_run = ($self->api_name =~ /\.dry_run/) ? 1 : 0;
2180     my $e = new_editor(xact=>1, authtoken=>$auth);
2181     return $e->die_event unless $e->checkauth;
2182     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
2183     my $die_event = activate_purchase_order_impl($mgr, $po_id, $dry_run);
2184     return $e->die_event if $die_event;
2185     if ($dry_run) {
2186         $e->rollback;
2187     } else {
2188         $e->commit;
2189     }
2190     $conn->respond_complete(1);
2191     $mgr->run_post_response_hooks;
2192     return undef;
2193 }
2194
2195 sub activate_purchase_order_impl {
2196     my ($mgr, $po_id, $dry_run) = @_;
2197     my $e = $mgr->editor;
2198
2199     my $po = $e->retrieve_acq_purchase_order($po_id) or return $e->die_event;
2200     return $e->die_event unless $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
2201
2202     my $provider = $e->retrieve_acq_provider($po->provider);
2203
2204     $po->state('on-order');
2205     $po->order_date('now');
2206     update_purchase_order($mgr, $po) or return $e->die_event;
2207
2208     my $query = [
2209         {
2210             purchase_order => $po_id, 
2211             state => [qw/pending-order new order-ready/]
2212         },
2213         {limit => 1}
2214     ];
2215
2216     while( my $li_id = $e->search_acq_lineitem($query, {idlist => 1})->[0] ) {
2217
2218         my $li;
2219         if($dry_run) {
2220             $li = $e->retrieve_acq_lineitem($li_id);
2221         } else {
2222             # can't activate a PO w/o assets.  Create lineitem assets as necessary
2223             my $data = create_lineitem_assets($mgr, $li_id) or return $e->die_event;
2224             $li = $data->{li};
2225         }
2226
2227         $li->state('on-order');
2228         $li->claim_policy($provider->default_claim_policy)
2229             if $provider->default_claim_policy and !$li->claim_policy;
2230         create_lineitem_debits($mgr, $li, $dry_run) or return $e->die_event;
2231         update_lineitem($mgr, $li) or return $e->die_event;
2232         $mgr->post_process( sub { create_lineitem_status_events($mgr, $li->id, 'aur.ordered'); });
2233         $mgr->respond;
2234     }
2235
2236     for my $po_item (@{$e->search_acq_po_item({purchase_order => $po_id})}) {
2237
2238         my $debit = create_fund_debit(
2239             $mgr, 
2240             $dry_run, 
2241             debit_type => 'direct_charge', # to match invoicing
2242             origin_amount => $po_item->estimated_cost,
2243             origin_currency_type => $e->retrieve_acq_fund($po_item->fund)->currency_type,
2244             amount => $po_item->estimated_cost,
2245             fund => $po_item->fund
2246         ) or return $e->die_event;
2247         $po_item->fund_debit($debit->id);
2248         $e->update_acq_po_item($po_item) or return $e->die_event;
2249         $mgr->respond;
2250     }
2251
2252     # tell the world we activated a PO
2253     $U->create_events_for_hook('acqpo.activated', $po, $po->ordering_agency) unless $dry_run;
2254
2255     return undef;
2256 }
2257
2258
2259 __PACKAGE__->register_method(
2260     method    => 'split_purchase_order_by_lineitems',
2261     api_name  => 'open-ils.acq.purchase_order.split_by_lineitems',
2262     signature => {
2263         desc   => q/Splits a PO into many POs, 1 per lineitem.  Only works for / .
2264                   q/POs a) with more than one lineitems, and b) in the "pending" state./,
2265         params => [
2266             {desc => 'Authentication token', type => 'string'},
2267             {desc => 'Purchase order ID',    type => 'number'}
2268         ],
2269         return => {desc => 'list of new PO IDs on success, Event on error'}
2270     }
2271 );
2272
2273 sub split_purchase_order_by_lineitems {
2274     my ($self, $conn, $auth, $po_id) = @_;
2275
2276     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2277     return $e->die_event unless $e->checkauth;
2278
2279     my $po = $e->retrieve_acq_purchase_order([
2280         $po_id, {
2281             "flesh" => 1,
2282             "flesh_fields" => {"acqpo" => [qw/lineitems notes/]}
2283         }
2284     ]) or return $e->die_event;
2285
2286     return $e->die_event
2287         unless $e->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
2288
2289     unless ($po->state eq "pending") {
2290         $e->rollback;
2291         return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_LATE");
2292     }
2293
2294     unless (@{$po->lineitems} > 1) {
2295         $e->rollback;
2296         return new OpenILS::Event("ACQ_PURCHASE_ORDER_TOO_SHORT");
2297     }
2298
2299     # To split an existing PO into many, it seems unwise to just delete the
2300     # original PO, so we'll instead detach all of the original POs' lineitems
2301     # but the first, then create new POs for each of the remaining LIs, and
2302     # then attach the LIs to their new POs.
2303
2304     my @po_ids = ($po->id);
2305     my @moving_li = @{$po->lineitems};
2306     shift @moving_li;    # discard first LI
2307
2308     foreach my $li (@moving_li) {
2309         my $new_po = $po->clone;
2310         $new_po->clear_id;
2311         $new_po->clear_name;
2312         $new_po->creator($e->requestor->id);
2313         $new_po->editor($e->requestor->id);
2314         $new_po->owner($e->requestor->id);
2315         $new_po->edit_time("now");
2316         $new_po->create_time("now");
2317
2318         $new_po = $e->create_acq_purchase_order($new_po);
2319
2320         # Clone any notes attached to the old PO and attach to the new one.
2321         foreach my $note (@{$po->notes}) {
2322             my $new_note = $note->clone;
2323             $new_note->clear_id;
2324             $new_note->edit_time("now");
2325             $new_note->purchase_order($new_po->id);
2326             $e->create_acq_po_note($new_note);
2327         }
2328
2329         $li->edit_time("now");
2330         $li->purchase_order($new_po->id);
2331         $e->update_acq_lineitem($li);
2332
2333         push @po_ids, $new_po->id;
2334     }
2335
2336     $po->edit_time("now");
2337     $e->update_acq_purchase_order($po);
2338
2339     return \@po_ids if $e->commit;
2340     return $e->die_event;
2341 }
2342
2343
2344 sub not_cancelable {
2345     my $o = shift;
2346     (ref $o eq "HASH" and $o->{"textcode"} eq "ACQ_NOT_CANCELABLE");
2347 }
2348
2349 __PACKAGE__->register_method(
2350         method => "cancel_purchase_order_api",
2351         api_name        => "open-ils.acq.purchase_order.cancel",
2352         signature => {
2353         desc => q/Cancels an on-order purchase order/,
2354         params => [
2355             {desc => "Authentication token", type => "string"},
2356             {desc => "PO ID to cancel", type => "number"},
2357             {desc => "Cancel reason ID", type => "number"}
2358         ],
2359         return => {desc => q/Object describing changed POs, LIs and LIDs
2360             on success; Event on error./}
2361     }
2362 );
2363
2364 sub cancel_purchase_order_api {
2365     my ($self, $conn, $auth, $po_id, $cancel_reason) = @_;
2366
2367     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2368     return $e->die_event unless $e->checkauth;
2369     my $mgr = new OpenILS::Application::Acq::BatchManager(
2370         "editor" => $e, "conn" => $conn
2371     );
2372
2373     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2374         return new OpenILS::Event(
2375             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2376         );
2377
2378     my $result = cancel_purchase_order($mgr, $po_id, $cancel_reason) or
2379         return $e->die_event;
2380     if (not_cancelable($result)) { # event not from CStoreEditor
2381         $e->rollback;
2382         return $result;
2383     } elsif ($result == -1) {
2384         $e->rollback;
2385         return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2386     }
2387
2388     $e->commit or return $e->die_event;
2389
2390     # XXX create purchase order status events?
2391
2392     if ($mgr->{post_commit}) {
2393         foreach my $func (@{$mgr->{post_commit}}) {
2394             $func->();
2395         }
2396     }
2397
2398     return $result;
2399 }
2400
2401 sub cancel_purchase_order {
2402     my ($mgr, $po_id, $cancel_reason) = @_;
2403
2404     my $po = $mgr->editor->retrieve_acq_purchase_order($po_id) or return 0;
2405
2406     # XXX is "cancelled" a typo?  It's not correct US spelling, anyway.
2407     # Depending on context, this may not warrant an event.
2408     return -1 if $po->state eq "cancelled";
2409
2410     # But this always does.
2411     return new OpenILS::Event(
2412         "ACQ_NOT_CANCELABLE", "note" => "purchase_order $po_id"
2413     ) unless ($po->state eq "on-order" or $po->state eq "pending");
2414
2415     return 0 unless
2416         $mgr->editor->allowed("CREATE_PURCHASE_ORDER", $po->ordering_agency);
2417
2418     $po->state("cancelled");
2419     $po->cancel_reason($cancel_reason->id);
2420
2421     my $li_ids = $mgr->editor->search_acq_lineitem(
2422         {"purchase_order" => $po_id}, {"idlist" => 1}
2423     );
2424
2425     my $result = {"li" => {}, "lid" => {}};
2426     foreach my $li_id (@$li_ids) {
2427         my $li_result = cancel_lineitem($mgr, $li_id, $cancel_reason)
2428             or return 0;
2429
2430         next if $li_result == -1; # already canceled:skip.
2431         return $li_result if not_cancelable($li_result); # not cancelable:stop.
2432
2433         # Merge in each LI result (there's only going to be
2434         # one per call to cancel_lineitem).
2435         my ($k, $v) = each %{$li_result->{"li"}};
2436         $result->{"li"}->{$k} = $v;
2437
2438         # Merge in each LID result (there may be many per call to
2439         # cancel_lineitem).
2440         while (($k, $v) = each %{$li_result->{"lid"}}) {
2441             $result->{"lid"}->{$k} = $v;
2442         }
2443     }
2444
2445     # TODO who/what/where/how do we indicate this change for electronic orders?
2446     # TODO return changes to encumbered/spent
2447     # TODO maybe cascade up from smaller object to container object if last
2448     # smaller object in the container has been canceled?
2449
2450     update_purchase_order($mgr, $po) or return 0;
2451     $result->{"po"} = {
2452         $po_id => {"state" => $po->state, "cancel_reason" => $cancel_reason}
2453     };
2454     return $result;
2455 }
2456
2457
2458 __PACKAGE__->register_method(
2459         method => "cancel_lineitem_api",
2460         api_name        => "open-ils.acq.lineitem.cancel",
2461         signature => {
2462         desc => q/Cancels an on-order lineitem/,
2463         params => [
2464             {desc => "Authentication token", type => "string"},
2465             {desc => "Lineitem ID to cancel", type => "number"},
2466             {desc => "Cancel reason ID", type => "number"}
2467         ],
2468         return => {desc => q/Object describing changed LIs and LIDs on success;
2469             Event on error./}
2470     }
2471 );
2472
2473 __PACKAGE__->register_method(
2474         method => "cancel_lineitem_api",
2475         api_name        => "open-ils.acq.lineitem.cancel.batch",
2476         signature => {
2477         desc => q/Batched version of open-ils.acq.lineitem.cancel/,
2478         return => {desc => q/Object describing changed LIs and LIDs on success;
2479             Event on error./}
2480     }
2481 );
2482
2483 sub cancel_lineitem_api {
2484     my ($self, $conn, $auth, $li_id, $cancel_reason) = @_;
2485
2486     my $batched = $self->api_name =~ /\.batch/;
2487
2488     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2489     return $e->die_event unless $e->checkauth;
2490     my $mgr = new OpenILS::Application::Acq::BatchManager(
2491         "editor" => $e, "conn" => $conn
2492     );
2493
2494     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2495         return new OpenILS::Event(
2496             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2497         );
2498
2499     my ($result, $maybe_event);
2500
2501     if ($batched) {
2502         $result = {"li" => {}, "lid" => {}};
2503         foreach my $one_li_id (@$li_id) {
2504             my $one = cancel_lineitem($mgr, $one_li_id, $cancel_reason) or
2505                 return $e->die_event;
2506             if (not_cancelable($one)) {
2507                 $maybe_event = $one;
2508             } elsif ($result == -1) {
2509                 $maybe_event = new OpenILS::Event("ACQ_ALREADY_CANCELED");
2510             } else {
2511                 my ($k, $v);
2512                 if ($one->{"li"}) {
2513                     while (($k, $v) = each %{$one->{"li"}}) {
2514                         $result->{"li"}->{$k} = $v;
2515                     }
2516                 }
2517                 if ($one->{"lid"}) {
2518                     while (($k, $v) = each %{$one->{"lid"}}) {
2519                         $result->{"lid"}->{$k} = $v;
2520                     }
2521                 }
2522             }
2523         }
2524     } else {
2525         $result = cancel_lineitem($mgr, $li_id, $cancel_reason) or
2526             return $e->die_event;
2527
2528         if (not_cancelable($result)) {
2529             $e->rollback;
2530             return $result;
2531         } elsif ($result == -1) {
2532             $e->rollback;
2533             return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2534         }
2535     }
2536
2537     if ($batched and not scalar keys %{$result->{"li"}}) {
2538         $e->rollback;
2539         return $maybe_event;
2540     } else {
2541         $e->commit or return $e->die_event;
2542         # create_lineitem_status_events should handle array li_id ok
2543         create_lineitem_status_events($mgr, $li_id, "aur.cancelled");
2544
2545         if ($mgr->{post_commit}) {
2546             foreach my $func (@{$mgr->{post_commit}}) {
2547                 $func->();
2548             }
2549         }
2550
2551         return $result;
2552     }
2553 }
2554
2555 sub cancel_lineitem {
2556     my ($mgr, $li_id, $cancel_reason) = @_;
2557     my $li = $mgr->editor->retrieve_acq_lineitem([
2558         $li_id, {flesh => 1, flesh_fields => {jub => ['purchase_order']}}
2559     ]) or return 0;
2560
2561     return 0 unless $mgr->editor->allowed(
2562         "CREATE_PURCHASE_ORDER", $li->purchase_order->ordering_agency
2563     );
2564
2565     # Depending on context, this may not warrant an event.
2566     return -1 if $li->state eq "cancelled";
2567
2568     # But this always does.
2569     return new OpenILS::Event(
2570         "ACQ_NOT_CANCELABLE", "note" => "lineitem $li_id"
2571     ) unless (
2572         (! $li->purchase_order) or (
2573             $li->purchase_order and (
2574                 $li->state eq "on-order" or $li->state eq "pending-order"
2575             )
2576         )
2577     );
2578
2579     $li->state("cancelled");
2580     $li->cancel_reason($cancel_reason->id);
2581
2582     my $lids = $mgr->editor->search_acq_lineitem_detail([{
2583         "lineitem" => $li_id
2584     }, {
2585         flesh => 1,
2586         flesh_fields => { acqlid => ['eg_copy_id'] }
2587     }]);
2588
2589     my $result = {"lid" => {}};
2590     my $copies = [];
2591     foreach my $lid (@$lids) {
2592         my $lid_result = cancel_lineitem_detail($mgr, $lid->id, $cancel_reason)
2593             or return 0;
2594
2595         # gathering any real copies for deletion
2596         if ($lid->eg_copy_id) {
2597             $lid->eg_copy_id->isdeleted('t');
2598             push @$copies, $lid->eg_copy_id;
2599         }
2600
2601         next if $lid_result == -1; # already canceled: just skip it.
2602         return $lid_result if not_cancelable($lid_result); # not cxlable: stop.
2603
2604         # Merge in each LID result (there's only going to be one per call to
2605         # cancel_lineitem_detail).
2606         my ($k, $v) = each %{$lid_result->{"lid"}};
2607         $result->{"lid"}->{$k} = $v;
2608     }
2609
2610     # Attempt to delete the gathered copies (this will also handle volume deletion and bib deletion)
2611     # Delete empty bibs according org unit setting
2612     my $force_delete_empty_bib = $U->ou_ancestor_setting_value(
2613         $mgr->editor->requestor->ws_ou, 'cat.bib.delete_on_no_copy_via_acq_lineitem_cancel', $mgr->editor);
2614     if (scalar(@$copies)>0) {
2615         my $override = 1;
2616         my $delete_stats = undef;
2617         my $retarget_holds = [];
2618         my $cat_evt = OpenILS::Application::Cat::AssetCommon->update_fleshed_copies(
2619             $mgr->editor, $override, undef, $copies, $delete_stats, $retarget_holds,$force_delete_empty_bib);
2620
2621         if( $cat_evt ) {
2622             $logger->info("fleshed copy update failed with event: ".OpenSRF::Utils::JSON->perl2JSON($cat_evt));
2623             return new OpenILS::Event(
2624                 "ACQ_NOT_CANCELABLE", "note" => "lineitem $li_id", "payload" => $cat_evt
2625             );
2626         }
2627
2628         # We can't do the following and stay within the same transaction, but that's okay, the hold targeter will pick these up later.
2629         #my $ses = OpenSRF::AppSession->create('open-ils.circ');
2630         #$ses->request('open-ils.circ.hold.reset.batch', $auth, $retarget_holds);
2631     }
2632
2633     # if we have a bib, check to see whether it has been deleted.  if so, cancel any active holds targeting that bib
2634     if ($li->eg_bib_id) {
2635         my $bib = $mgr->editor->retrieve_biblio_record_entry($li->eg_bib_id) or return new OpenILS::Event(
2636             "ACQ_NOT_CANCELABLE", "note" => "Could not retrieve bib " . $li->eg_bib_id . " for lineitem $li_id"
2637         );
2638         if ($U->is_true($bib->deleted)) {
2639             my $holds = $mgr->editor->search_action_hold_request(
2640                 {   cancel_time => undef,
2641                     fulfillment_time => undef,
2642                     target => $li->eg_bib_id
2643                 }
2644             );
2645
2646             my %cached_usr_home_ou = ();
2647
2648             for my $hold (@$holds) {
2649
2650                 $logger->info("Cancelling hold ".$hold->id.
2651                     " due to acq lineitem cancellation.");
2652
2653                 $hold->cancel_time('now');
2654                 $hold->cancel_cause(5); # 'Staff forced'--we may want a new hold cancel cause reason for this
2655                 $hold->cancel_note('Corresponding Acquistion Lineitem/Purchase Order was cancelled.');
2656                 unless($mgr->editor->update_action_hold_request($hold)) {
2657                     my $evt = $mgr->editor->event;
2658                     $logger->error("Error updating hold ". $evt->textcode .":". $evt->desc .":". $evt->stacktrace);
2659                     return new OpenILS::Event(
2660                         "ACQ_NOT_CANCELABLE", "note" => "Could not cancel hold " . $hold->id . " for lineitem $li_id", "payload" => $evt
2661                     );
2662                 }
2663                 if (! defined $mgr->{post_commit}) { # we need a mechanism for creating trigger events, but only if the transaction gets committed
2664                     $mgr->{post_commit} = [];
2665                 }
2666                 push @{ $mgr->{post_commit} }, sub {
2667                     my $home_ou = $cached_usr_home_ou{$hold->usr};
2668                     if (! $home_ou) {
2669                         my $user = $mgr->editor->retrieve_actor_user($hold->usr); # FIXME: how do we want to handle failures here?
2670                         $home_ou = $user->home_ou;
2671                         $cached_usr_home_ou{$hold->usr} = $home_ou;
2672                     }
2673                     $U->create_events_for_hook('hold_request.cancel.cancelled_order', $hold, $home_ou);
2674                 };
2675             }
2676         }
2677     }
2678
2679     update_lineitem($mgr, $li) or return 0;
2680     $result->{"li"} = {
2681         $li_id => {
2682             "state" => $li->state,
2683             "cancel_reason" => $cancel_reason
2684         }
2685     };
2686     return $result;
2687 }
2688
2689
2690 __PACKAGE__->register_method(
2691         method => "cancel_lineitem_detail_api",
2692         api_name        => "open-ils.acq.lineitem_detail.cancel",
2693         signature => {
2694         desc => q/Cancels an on-order lineitem detail/,
2695         params => [
2696             {desc => "Authentication token", type => "string"},
2697             {desc => "Lineitem detail ID to cancel", type => "number"},
2698             {desc => "Cancel reason ID", type => "number"}
2699         ],
2700         return => {desc => q/Object describing changed LIDs on success;
2701             Event on error./}
2702     }
2703 );
2704
2705 sub cancel_lineitem_detail_api {
2706     my ($self, $conn, $auth, $lid_id, $cancel_reason) = @_;
2707
2708     my $e = new_editor("xact" => 1, "authtoken" => $auth);
2709     return $e->die_event unless $e->checkauth;
2710     my $mgr = new OpenILS::Application::Acq::BatchManager(
2711         "editor" => $e, "conn" => $conn
2712     );
2713
2714     $cancel_reason = $mgr->editor->retrieve_acq_cancel_reason($cancel_reason) or
2715         return new OpenILS::Event(
2716             "BAD_PARAMS", "note" => "Provide cancel reason ID"
2717         );
2718
2719     my $result = cancel_lineitem_detail($mgr, $lid_id, $cancel_reason) or
2720         return $e->die_event;
2721
2722     if (not_cancelable($result)) {
2723         $e->rollback;
2724         return $result;
2725     } elsif ($result == -1) {
2726         $e->rollback;
2727         return new OpenILS::Event("ACQ_ALREADY_CANCELED");
2728     }
2729
2730     $e->commit or return $e->die_event;
2731
2732     # XXX create lineitem detail status events?
2733     return $result;
2734 }
2735
2736 sub cancel_lineitem_detail {
2737     my ($mgr, $lid_id, $cancel_reason) = @_;
2738     my $lid = $mgr->editor->retrieve_acq_lineitem_detail([
2739         $lid_id, {
2740             "flesh" => 2,
2741             "flesh_fields" => {
2742                 "acqlid" => ["lineitem"], "jub" => ["purchase_order"]
2743             }
2744         }
2745     ]) or return 0;
2746
2747     # Depending on context, this may not warrant an event.
2748     return -1 if $lid->cancel_reason;
2749
2750     # But this always does.
2751     return new OpenILS::Event(
2752         "ACQ_NOT_CANCELABLE", "note" => "lineitem_detail $lid_id"
2753     ) unless (
2754         (! $lid->lineitem->purchase_order) or
2755         (
2756             (not $lid->recv_time) and
2757             $lid->lineitem and
2758             $lid->lineitem->purchase_order and (
2759                 $lid->lineitem->state eq "on-order" or
2760                 $lid->lineitem->state eq "pending-order"
2761             )
2762         )
2763     );
2764
2765     return 0 unless $mgr->editor->allowed(
2766         "CREATE_PURCHASE_ORDER",
2767         $lid->lineitem->purchase_order->ordering_agency
2768     ) or (! $lid->lineitem->purchase_order);
2769
2770     $lid->cancel_reason($cancel_reason->id);
2771
2772     unless($U->is_true($cancel_reason->keep_debits)) {
2773         my $debit_id = $lid->fund_debit;
2774         $lid->clear_fund_debit;
2775
2776         if($debit_id) {
2777             # item is cancelled.  Remove the fund debit.
2778             my $debit = $mgr->editor->retrieve_acq_fund_debit($debit_id);
2779             if (!$U->is_true($debit->encumbrance)) {
2780                 $mgr->editor->rollback;
2781                 return OpenILS::Event->new('ACQ_NOT_CANCELABLE', 
2782                     note => "Debit is marked as paid: $debit_id");
2783             }
2784             $mgr->editor->delete_acq_fund_debit($debit) or return $mgr->editor->die_event;
2785         }
2786     }
2787
2788     # XXX LIDs don't have either an editor or a edit_time field. Should we
2789     # update these on the LI when we alter an LID?
2790     $mgr->editor->update_acq_lineitem_detail($lid) or return 0;
2791
2792     return {"lid" => {$lid_id => {"cancel_reason" => $cancel_reason}}};
2793 }
2794
2795
2796 __PACKAGE__->register_method(
2797     method    => 'user_requests',
2798     api_name  => 'open-ils.acq.user_request.retrieve.by_user_id',
2799     stream    => 1,
2800     signature => {
2801         desc   => 'Retrieve fleshed user requests and related data for a given user.',
2802         params => [
2803             { desc => 'Authentication token',      type => 'string' },
2804             { desc => 'User ID of the owner, or array of IDs',      },
2805             { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)',
2806               type => 'object'
2807             }
2808         ],
2809         return => {
2810             desc => 'Fleshed user requests and related data',
2811             type => 'object'
2812         }
2813     }
2814 );
2815
2816 __PACKAGE__->register_method(
2817     method    => 'user_requests',
2818     api_name  => 'open-ils.acq.user_request.retrieve.by_home_ou',
2819     stream    => 1,
2820     signature => {
2821         desc   => 'Retrieve fleshed user requests and related data for a given org unit or units.',
2822         params => [
2823             { desc => 'Authentication token',      type => 'string' },
2824             { desc => 'Org unit ID, or array of IDs',               },
2825             { desc => 'Options hash (optional) with any of the keys: order_by, limit, offset, state (of the lineitem)',
2826               type => 'object'
2827             }
2828         ],
2829         return => {
2830             desc => 'Fleshed user requests and related data',
2831             type => 'object'
2832         }
2833     }
2834 );
2835
2836 sub user_requests {
2837     my($self, $conn, $auth, $search_value, $options) = @_;
2838     my $e = new_editor(authtoken => $auth);
2839     return $e->event unless $e->checkauth;
2840     my $rid = $e->requestor->id;
2841     $options ||= {};
2842
2843     my $query = {
2844         "select"=>{"aur"=>["id"],"au"=>["home_ou", {column => 'id', alias => 'usr_id'} ]},
2845         "from"=>{ "aur" => { "au" => {}, "jub" => { "type" => "left" } } },
2846         "where"=>{
2847             "+jub"=> {
2848                 "-or" => [
2849                     {"id"=>undef}, # this with the left-join pulls in requests without lineitems
2850                     {"state"=>["new","on-order","pending-order"]} # FIXME - probably needs softcoding
2851                 ]
2852             }
2853         },
2854         "order_by"=>[{"class"=>"aur", "field"=>"request_date", "direction"=>"desc"}]
2855     };
2856
2857     foreach (qw/ order_by limit offset /) {
2858         $query->{$_} = $options->{$_} if defined $options->{$_};
2859     }
2860     if (defined $options->{'state'}) {
2861         $query->{'where'}->{'+jub'}->{'-or'}->[1]->{'state'} = $options->{'state'};        
2862     }
2863
2864     if ($self->api_name =~ /by_user_id/) {
2865         $query->{'where'}->{'usr'} = $search_value;
2866     } else {
2867         $query->{'where'}->{'+au'} = { 'home_ou' => $search_value };
2868     }
2869
2870     my $pertinent_ids = $e->json_query($query);
2871
2872     my %perm_test = ();
2873     for my $id_blob (@$pertinent_ids) {
2874         if ($rid != $id_blob->{usr_id}) {
2875             if (!defined $perm_test{ $id_blob->{home_ou} }) {
2876                 $perm_test{ $id_blob->{home_ou} } = $e->allowed( ['user_request.view'], $id_blob->{home_ou} );
2877             }
2878             if (!$perm_test{ $id_blob->{home_ou} }) {
2879                 next; # failed test
2880             }
2881         }
2882         my $aur_obj = $e->retrieve_acq_user_request([
2883             $id_blob->{id},
2884             {flesh => 1, flesh_fields => { "aur" => [ 'lineitem' ] } }
2885         ]);
2886         if (! $aur_obj) { next; }
2887
2888         if ($aur_obj->lineitem()) {
2889             $aur_obj->lineitem()->clear_marc();
2890         }
2891         $conn->respond($aur_obj);
2892     }
2893
2894     return undef;
2895 }
2896
2897 __PACKAGE__->register_method (
2898     method    => 'update_user_request',
2899     api_name  => 'open-ils.acq.user_request.cancel.batch',
2900     stream    => 1,
2901     signature => {
2902         desc   => 'If given a cancel reason, will update the request with that reason, otherwise, this will delete the request altogether.  The '    .
2903                   'intention is for staff interfaces or processes to provide cancel reasons, and for patron interfaces to just delete the requests.' ,
2904         params => [
2905             { desc => 'Authentication token',              type => 'string' },
2906             { desc => 'ID or array of IDs for the user requests to cancel'  },
2907             { desc => 'Cancel Reason ID (optional)',       type => 'string' }
2908         ],
2909         return => {
2910             desc => 'progress object, event on error',
2911         }
2912     }
2913 );
2914 __PACKAGE__->register_method (
2915     method    => 'update_user_request',
2916     api_name  => 'open-ils.acq.user_request.set_no_hold.batch',
2917     stream    => 1,
2918     signature => {
2919         desc   => 'Remove the hold from a user request or set of requests',
2920         params => [
2921             { desc => 'Authentication token',              type => 'string' },
2922             { desc => 'ID or array of IDs for the user requests to modify'  }
2923         ],
2924         return => {
2925             desc => 'progress object, event on error',
2926         }
2927     }
2928 );
2929
2930 sub update_user_request {
2931     my($self, $conn, $auth, $aur_ids, $cancel_reason) = @_;
2932     my $e = new_editor(xact => 1, authtoken => $auth);
2933     return $e->die_event unless $e->checkauth;
2934     my $rid = $e->requestor->id;
2935
2936     my $x = 1;
2937     my %perm_test = ();
2938     for my $id (@$aur_ids) {
2939
2940         my $aur_obj = $e->retrieve_acq_user_request([
2941             $id,
2942             {   flesh => 1,
2943                 flesh_fields => { "aur" => ['lineitem', 'usr'] }
2944             }
2945         ]) or return $e->die_event;
2946
2947         my $context_org = $aur_obj->usr()->home_ou();
2948         $aur_obj->usr( $aur_obj->usr()->id() );
2949
2950         if ($rid != $aur_obj->usr) {
2951             if (!defined $perm_test{ $context_org }) {
2952                 $perm_test{ $context_org } = $e->allowed( ['user_request.update'], $context_org );
2953             }
2954             if (!$perm_test{ $context_org }) {
2955                 next; # failed test
2956             }
2957         }
2958
2959         if($self->api_name =~ /set_no_hold/) {
2960             if ($U->is_true($aur_obj->hold)) { 
2961                 $aur_obj->hold(0); 
2962                 $e->update_acq_user_request($aur_obj) or return $e->die_event;
2963             }
2964         }
2965
2966         if($self->api_name =~ /cancel/) {
2967             if ( $cancel_reason ) {
2968                 $aur_obj->cancel_reason( $cancel_reason );
2969                 $e->update_acq_user_request($aur_obj) or return $e->die_event;
2970                 create_user_request_events( $e, [ $aur_obj ], 'aur.rejected' );
2971             } else {
2972                 $e->delete_acq_user_request($aur_obj);
2973             }
2974         }
2975
2976         $conn->respond({maximum => scalar(@$aur_ids), progress => $x++});
2977     }
2978
2979     $e->commit;
2980     return {complete => 1};
2981 }
2982
2983 __PACKAGE__->register_method (
2984     method    => 'new_user_request',
2985     api_name  => 'open-ils.acq.user_request.create',
2986     signature => {
2987         desc   => 'Create a new user request object in the DB',
2988         param  => [
2989             { desc => 'Authentication token',   type => 'string' },
2990             { desc => 'User request data hash.  Hash keys match the fields for the "aur" object', type => 'object' }
2991         ],
2992         return => {
2993             desc => 'The created user request object, or event on error'
2994         }
2995     }
2996 );
2997
2998 sub new_user_request {
2999     my($self, $conn, $auth, $form_data) = @_;
3000     my $e = new_editor(xact => 1, authtoken => $auth);
3001     return $e->die_event unless $e->checkauth;
3002     my $rid = $e->requestor->id;
3003     my $target_user_fleshed;
3004     if (! defined $$form_data{'usr'}) {
3005         $$form_data{'usr'} = $rid;
3006     }
3007     if ($$form_data{'usr'} != $rid) {
3008         # See if the requestor can place the request on behalf of a different user.
3009         $target_user_fleshed = $e->retrieve_actor_user($$form_data{'usr'}) or return $e->die_event;
3010         $e->allowed('user_request.create', $target_user_fleshed->home_ou) or return $e->die_event;
3011     } else {
3012         $target_user_fleshed = $e->requestor;
3013         $e->allowed('CREATE_PURCHASE_REQUEST') or return $e->die_event;
3014     }
3015     if (! defined $$form_data{'pickup_lib'}) {
3016         if ($target_user_fleshed->ws_ou) {
3017             $$form_data{'pickup_lib'} = $target_user_fleshed->ws_ou;
3018         } else {
3019             $$form_data{'pickup_lib'} = $target_user_fleshed->home_ou;
3020         }
3021     }
3022     if (! defined $$form_data{'request_type'}) {
3023         $$form_data{'request_type'} = 1; # Books
3024     }
3025     my $aur_obj = new Fieldmapper::acq::user_request; 
3026     $aur_obj->isnew(1);
3027     $aur_obj->usr( $$form_data{'usr'} );
3028     $aur_obj->request_date( 'now' );
3029     for my $field ( keys %$form_data ) {
3030         if (defined $$form_data{$field} and $field !~ /^(id|lineitem|eg_bib|request_date|cancel_reason)$/) {
3031             $aur_obj->$field( $$form_data{$field} );
3032         }
3033     }
3034
3035     $aur_obj = $e->create_acq_user_request($aur_obj) or return $e->die_event;
3036
3037     $e->commit and create_user_request_events( $e, [ $aur_obj ], 'aur.created' );
3038
3039     return $aur_obj;
3040 }
3041
3042 sub create_user_request_events {
3043     my($e, $user_reqs, $hook) = @_;
3044
3045     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
3046     $ses->connect;
3047
3048     my %cached_usr_home_ou = ();
3049     for my $user_req (@$user_reqs) {
3050         my $home_ou = $cached_usr_home_ou{$user_req->usr};
3051         if (! $home_ou) {
3052             my $user = $e->retrieve_actor_user($user_req->usr) or return $e->die_event;
3053             $home_ou = $user->home_ou;
3054             $cached_usr_home_ou{$user_req->usr} = $home_ou;
3055         }
3056         my $req = $ses->request('open-ils.trigger.event.autocreate', $hook, $user_req, $home_ou);
3057         $req->recv;
3058     }
3059
3060     $ses->disconnect;
3061     return undef;
3062 }
3063
3064
3065 __PACKAGE__->register_method(
3066         method => "po_note_CUD_batch",
3067         api_name => "open-ils.acq.po_note.cud.batch",
3068     stream => 1,
3069         signature => {
3070         desc => q/Manage purchase order notes/,
3071         params => [
3072             {desc => "Authentication token", type => "string"},
3073             {desc => "List of po_notes to manage", type => "array"},
3074         ],
3075         return => {desc => "Stream of successfully managed objects"}
3076     }
3077 );
3078
3079 sub po_note_CUD_batch {
3080     my ($self, $conn, $auth, $notes) = @_;
3081
3082     my $e = new_editor("xact"=> 1, "authtoken" => $auth);
3083     return $e->die_event unless $e->checkauth;
3084     # XXX perms
3085
3086     my $total = @$notes;
3087     my $count = 0;
3088
3089     foreach my $note (@$notes) {
3090
3091         $note->editor($e->requestor->id);
3092         $note->edit_time("now");
3093
3094         if ($note->isnew) {
3095             $note->creator($e->requestor->id);
3096             $note = $e->create_acq_po_note($note) or return $e->die_event;
3097         } elsif ($note->isdeleted) {
3098             $e->delete_acq_po_note($note) or return $e->die_event;
3099         } elsif ($note->ischanged) {
3100             $e->update_acq_po_note($note) or return $e->die_event;
3101         }
3102
3103         unless ($note->isdeleted) {
3104             $note = $e->retrieve_acq_po_note($note->id) or
3105                 return $e->die_event;
3106         }
3107
3108         $conn->respond(
3109             {"maximum" => $total, "progress" => ++$count, "note" => $note}
3110         );
3111     }
3112
3113     $e->commit and $conn->respond_complete or return $e->die_event;
3114 }
3115
3116
3117 # retrieves a lineitem, fleshes its PO and PL, checks perms
3118 sub fetch_and_check_li {
3119     my $e = shift;
3120     my $li_id = shift;
3121     my $perm_mode = shift || 'read';
3122
3123     my $li = $e->retrieve_acq_lineitem([
3124         $li_id,
3125         {   flesh => 1,
3126             flesh_fields => {jub => ['purchase_order', 'picklist']}
3127         }
3128     ]) or return $e->die_event;
3129
3130     if(my $po = $li->purchase_order) {
3131         my $perms = ($perm_mode eq 'read') ? 'VIEW_PURCHASE_ORDER' : 'CREATE_PURCHASE_ORDER';
3132         return ($li, $e->die_event) unless $e->allowed($perms, $po->ordering_agency);
3133
3134     } elsif(my $pl = $li->picklist) {
3135         my $perms = ($perm_mode eq 'read') ? 'VIEW_PICKLIST' : 'CREATE_PICKLIST';
3136         return ($li, $e->die_event) unless $e->allowed($perms, $pl->org_unit);
3137     }
3138
3139     return ($li);
3140 }
3141
3142
3143 __PACKAGE__->register_method(
3144         method => "clone_distrib_form",
3145         api_name => "open-ils.acq.distribution_formula.clone",
3146     stream => 1,
3147         signature => {
3148         desc => q/Clone a distribution formula/,
3149         params => [
3150             {desc => "Authentication token", type => "string"},
3151             {desc => "Original formula ID", type => 'integer'},
3152             {desc => "Name of new formula", type => 'string'},
3153         ],
3154         return => {desc => "ID of newly created formula"}
3155     }
3156 );
3157
3158 sub clone_distrib_form {
3159     my($self, $client, $auth, $form_id, $new_name) = @_;
3160
3161     my $e = new_editor("xact"=> 1, "authtoken" => $auth);
3162     return $e->die_event unless $e->checkauth;
3163
3164     my $old_form = $e->retrieve_acq_distribution_formula($form_id) or return $e->die_event;
3165     return $e->die_event unless $e->allowed('ADMIN_ACQ_DISTRIB_FORMULA', $old_form->owner);
3166
3167     my $new_form = Fieldmapper::acq::distribution_formula->new;
3168
3169     $new_form->owner($old_form->owner);
3170     $new_form->name($new_name);
3171     $e->create_acq_distribution_formula($new_form) or return $e->die_event;
3172
3173     my $entries = $e->search_acq_distribution_formula_entry({formula => $form_id});
3174     for my $entry (@$entries) {
3175        my $new_entry = Fieldmapper::acq::distribution_formula_entry->new;
3176        $new_entry->$_($entry->$_()) for $entry->real_fields;
3177        $new_entry->formula($new_form->id);
3178        $new_entry->clear_id;
3179        $e->create_acq_distribution_formula_entry($new_entry) or return $e->die_event;
3180     }
3181
3182     $e->commit;
3183     return $new_form->id;
3184 }
3185
3186 __PACKAGE__->register_method(
3187         method => 'add_li_to_po',
3188         api_name        => 'open-ils.acq.purchase_order.add_lineitem',
3189         signature => {
3190         desc => q/Adds a lineitem to an existing purchase order/,
3191         params => [
3192             {desc => 'Authentication token', type => 'string'},
3193             {desc => 'The purchase order id', type => 'number'},
3194             {desc => 'The lineitem ID', type => 'number'},
3195         ],
3196         return => {desc => 'Streams a total versus completed counts object, event on error'}
3197     }
3198 );
3199
3200 sub add_li_to_po {
3201     my($self, $conn, $auth, $po_id, $li_id) = @_;
3202
3203     my $e = new_editor(authtoken => $auth, xact => 1);
3204     return $e->die_event unless $e->checkauth;
3205
3206     my $mgr = OpenILS::Application::Acq::BatchManager->new(editor => $e, conn => $conn);
3207
3208     my $po = $e->retrieve_acq_purchase_order($po_id)
3209         or return $e->die_event;
3210
3211     my $li = $e->retrieve_acq_lineitem($li_id)
3212         or return $e->die_event;
3213
3214     return $e->die_event unless 
3215         $e->allowed('CREATE_PURCHASE_ORDER', $po->ordering_agency);
3216
3217     unless ($po->state =~ /new|pending/) {
3218         $e->rollback;
3219         return {success => 0, po => $po, error => 'bad-po-state'};
3220     }
3221
3222     unless ($li->state =~ /new|order-ready|pending-order/) {
3223         $e->rollback;
3224         return {success => 0, li => $li, error => 'bad-li-state'};
3225     }
3226
3227     $li->purchase_order($po_id);
3228     $li->state('pending-order');
3229     update_lineitem($mgr, $li) or return $e->die_event;
3230     
3231     $e->commit;
3232     return {success => 1};
3233 }
3234
3235 1;
3236