Make Evergreen Perl modules installable via Module::Build to match OpenSRF
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / AppUtils.pm
1 package OpenILS::Application::AppUtils;
2 # vim:noet:ts=4
3 use strict; use warnings;
4 use OpenILS::Application;
5 use base qw/OpenILS::Application/;
6 use OpenSRF::Utils::Cache;
7 use OpenSRF::Utils::Logger qw/$logger/;
8 use OpenILS::Utils::ModsParser;
9 use OpenSRF::EX qw(:try);
10 use OpenILS::Event;
11 use Data::Dumper;
12 use OpenILS::Utils::CStoreEditor;
13 use OpenILS::Const qw/:const/;
14 use Unicode::Normalize;
15 use OpenSRF::Utils::SettingsClient;
16 use UUID::Tiny;
17 use Encode;
18
19 # ---------------------------------------------------------------------------
20 # Pile of utilty methods used accross applications.
21 # ---------------------------------------------------------------------------
22 my $cache_client = "OpenSRF::Utils::Cache";
23
24
25 # ---------------------------------------------------------------------------
26 # on sucess, returns the created session, on failure throws ERROR exception
27 # ---------------------------------------------------------------------------
28 sub start_db_session {
29
30         my $self = shift;
31         my $session = OpenSRF::AppSession->connect( "open-ils.storage" );
32         my $trans_req = $session->request( "open-ils.storage.transaction.begin" );
33
34         my $trans_resp = $trans_req->recv();
35         if(ref($trans_resp) and UNIVERSAL::isa($trans_resp,"Error")) { throw $trans_resp; }
36         if( ! $trans_resp->content() ) {
37                 throw OpenSRF::ERROR 
38                         ("Unable to Begin Transaction with database" );
39         }
40         $trans_req->finish();
41
42         $logger->debug("Setting global storage session to ".
43                 "session: " . $session->session_id . " : " . $session->app );
44
45         return $session;
46 }
47
48 my $PERM_QUERY = {
49     select => {
50         au => [ {
51             transform => 'permission.usr_has_perm',
52             alias => 'has_perm',
53             column => 'id',
54             params => []
55         } ]
56     },
57     from => 'au',
58     where => {},
59 };
60
61
62 # returns undef if user has all of the perms provided
63 # returns the first failed perm on failure
64 sub check_user_perms {
65         my($self, $user_id, $org_id, @perm_types ) = @_;
66         $logger->debug("Checking perms with user : $user_id , org: $org_id, @perm_types");
67
68         for my $type (@perm_types) {
69             $PERM_QUERY->{select}->{au}->[0]->{params} = [$type, $org_id];
70                 $PERM_QUERY->{where}->{id} = $user_id;
71                 return $type unless $self->is_true(OpenILS::Utils::CStoreEditor->new->json_query($PERM_QUERY)->[0]->{has_perm});
72         }
73         return undef;
74 }
75
76 # checks the list of user perms.  The first one that fails returns a new
77 sub check_perms {
78         my( $self, $user_id, $org_id, @perm_types ) = @_;
79         my $t = $self->check_user_perms( $user_id, $org_id, @perm_types );
80         return OpenILS::Event->new('PERM_FAILURE', ilsperm => $t, ilspermloc => $org_id ) if $t;
81         return undef;
82 }
83
84
85
86 # ---------------------------------------------------------------------------
87 # commits and destroys the session
88 # ---------------------------------------------------------------------------
89 sub commit_db_session {
90         my( $self, $session ) = @_;
91
92         my $req = $session->request( "open-ils.storage.transaction.commit" );
93         my $resp = $req->recv();
94
95         if(!$resp) {
96                 throw OpenSRF::EX::ERROR ("Unable to commit db session");
97         }
98
99         if(UNIVERSAL::isa($resp,"Error")) { 
100                 throw $resp ($resp->stringify); 
101         }
102
103         if(!$resp->content) {
104                 throw OpenSRF::EX::ERROR ("Unable to commit db session");
105         }
106
107         $session->finish();
108         $session->disconnect();
109         $session->kill_me();
110 }
111
112 sub rollback_db_session {
113         my( $self, $session ) = @_;
114
115         my $req = $session->request("open-ils.storage.transaction.rollback");
116         my $resp = $req->recv();
117         if(UNIVERSAL::isa($resp,"Error")) { throw $resp;  }
118
119         $session->finish();
120         $session->disconnect();
121         $session->kill_me();
122 }
123
124
125 # returns undef it the event is not an ILS event
126 # returns the event code otherwise
127 sub event_code {
128         my( $self, $evt ) = @_;
129         return $evt->{ilsevent} if( ref($evt) eq 'HASH' and defined($evt->{ilsevent})) ;
130         return undef;
131 }
132
133 # ---------------------------------------------------------------------------
134 # Checks to see if a user is logged in.  Returns the user record on success,
135 # throws an exception on error.
136 # ---------------------------------------------------------------------------
137 sub check_user_session {
138         my( $self, $user_session ) = @_;
139
140         my $content = $self->simplereq( 
141                 'open-ils.auth', 
142                 'open-ils.auth.session.retrieve', $user_session);
143
144     return undef if (!$content) or $self->event_code($content);
145         return $content;
146 }
147
148 # generic simple request returning a scalar value
149 sub simplereq {
150         my($self, $service, $method, @params) = @_;
151         return $self->simple_scalar_request($service, $method, @params);
152 }
153
154
155 sub simple_scalar_request {
156         my($self, $service, $method, @params) = @_;
157
158         my $session = OpenSRF::AppSession->create( $service );
159
160         my $request = $session->request( $method, @params );
161
162         my $val;
163         my $err;
164         try  {
165
166                 $val = $request->gather(1);     
167
168         } catch Error with {
169                 $err = shift;
170         };
171
172         if( $err ) {
173                 warn "received error : service=$service : method=$method : params=".Dumper(\@params) . "\n $err";
174                 throw $err ("Call to $service for method $method \n failed with exception: $err : " );
175         }
176
177         return $val;
178 }
179
180
181
182
183
184 my $tree                                                = undef;
185 my $orglist                                     = undef;
186 my $org_typelist                        = undef;
187 my $org_typelist_hash   = {};
188
189 sub __get_org_tree {
190         
191         # can we throw this version away??
192
193         my $self = shift;
194         if($tree) { return $tree; }
195
196         # see if it's in the cache
197         $tree = $cache_client->new()->get_cache('_orgtree');
198         if($tree) { return $tree; }
199
200         if(!$orglist) {
201                 warn "Retrieving Org Tree\n";
202                 $orglist = $self->simple_scalar_request( 
203                         "open-ils.cstore", 
204                         "open-ils.cstore.direct.actor.org_unit.search.atomic",
205                         { id => { '!=' => undef } }
206                 );
207         }
208
209         if( ! $org_typelist ) {
210                 warn "Retrieving org types\n";
211                 $org_typelist = $self->simple_scalar_request( 
212                         "open-ils.cstore", 
213                         "open-ils.cstore.direct.actor.org_unit_type.search.atomic",
214                         { id => { '!=' => undef } }
215                 );
216                 $self->build_org_type($org_typelist);
217         }
218
219         $tree = $self->build_org_tree($orglist,1);
220         $cache_client->new()->put_cache('_orgtree', $tree);
221         return $tree;
222
223 }
224
225 my $slimtree = undef;
226 sub get_slim_org_tree {
227
228         my $self = shift;
229         if($slimtree) { return $slimtree; }
230
231         # see if it's in the cache
232         $slimtree = $cache_client->new()->get_cache('slimorgtree');
233         if($slimtree) { return $slimtree; }
234
235         if(!$orglist) {
236                 warn "Retrieving Org Tree\n";
237                 $orglist = $self->simple_scalar_request( 
238                         "open-ils.cstore", 
239                         "open-ils.cstore.direct.actor.org_unit.search.atomic",
240                         { id => { '!=' => undef } }
241                 );
242         }
243
244         $slimtree = $self->build_org_tree($orglist);
245         $cache_client->new->put_cache('slimorgtree', $slimtree);
246         return $slimtree;
247
248 }
249
250
251 sub build_org_type { 
252         my($self, $org_typelist)  = @_;
253         for my $type (@$org_typelist) {
254                 $org_typelist_hash->{$type->id()} = $type;
255         }
256 }
257
258
259
260 sub build_org_tree {
261
262         my( $self, $orglist, $add_types ) = @_;
263
264         return $orglist unless ref $orglist; 
265     return $$orglist[0] if @$orglist == 1;
266
267         my @list = sort { 
268                 $a->ou_type <=> $b->ou_type ||
269                 $a->name cmp $b->name } @$orglist;
270
271         for my $org (@list) {
272
273                 next unless ($org);
274
275                 if(!ref($org->ou_type()) and $add_types) {
276                         $org->ou_type( $org_typelist_hash->{$org->ou_type()});
277                 }
278
279         next if (!defined($org->parent_ou) || $org->parent_ou eq "");
280
281                 my ($parent) = grep { $_->id == $org->parent_ou } @list;
282                 next unless $parent;
283                 $parent->children([]) unless defined($parent->children); 
284                 push( @{$parent->children}, $org );
285         }
286
287         return $list[0];
288 }
289
290 sub fetch_closed_date {
291         my( $self, $cd ) = @_;
292         my $evt;
293         
294         $logger->debug("Fetching closed_date $cd from cstore");
295
296         my $cd_obj = $self->simplereq(
297                 'open-ils.cstore',
298                 'open-ils.cstore.direct.actor.org_unit.closed_date.retrieve', $cd );
299
300         if(!$cd_obj) {
301                 $logger->info("closed_date $cd not found in the db");
302                 $evt = OpenILS::Event->new('ACTOR_USER_NOT_FOUND');
303         }
304
305         return ($cd_obj, $evt);
306 }
307
308 sub fetch_user {
309         my( $self, $userid ) = @_;
310         my( $user, $evt );
311         
312         $logger->debug("Fetching user $userid from cstore");
313
314         $user = $self->simplereq(
315                 'open-ils.cstore',
316                 'open-ils.cstore.direct.actor.user.retrieve', $userid );
317
318         if(!$user) {
319                 $logger->info("User $userid not found in the db");
320                 $evt = OpenILS::Event->new('ACTOR_USER_NOT_FOUND');
321         }
322
323         return ($user, $evt);
324 }
325
326 sub checkses {
327         my( $self, $session ) = @_;
328         my $user = $self->check_user_session($session) or 
329         return (undef, OpenILS::Event->new('NO_SESSION'));
330     return ($user);
331 }
332
333
334 # verifiese the session and checks the permissions agains the
335 # session user and the user's home_ou as the org id
336 sub checksesperm {
337         my( $self, $session, @perms ) = @_;
338         my $user; my $evt; my $e; 
339         $logger->debug("Checking user session $session and perms @perms");
340         ($user, $evt) = $self->checkses($session);
341         return (undef, $evt) if $evt;
342         $evt = $self->check_perms($user->id, $user->home_ou, @perms);
343         return ($user, $evt);
344 }
345
346
347 sub checkrequestor {
348         my( $self, $staffobj, $userid, @perms ) = @_;
349         my $user; my $evt;
350         $userid = $staffobj->id unless defined $userid;
351
352         $logger->debug("checkrequestor(): requestor => " . $staffobj->id . ", target => $userid");
353
354         if( $userid ne $staffobj->id ) {
355                 ($user, $evt) = $self->fetch_user($userid);
356                 return (undef, $evt) if $evt;
357                 $evt = $self->check_perms( $staffobj->id, $user->home_ou, @perms );
358
359         } else {
360                 $user = $staffobj;
361         }
362
363         return ($user, $evt);
364 }
365
366 sub checkses_requestor {
367         my( $self, $authtoken, $targetid, @perms ) = @_;
368         my( $requestor, $target, $evt );
369
370         ($requestor, $evt) = $self->checkses($authtoken);
371         return (undef, undef, $evt) if $evt;
372
373         ($target, $evt) = $self->checkrequestor( $requestor, $targetid, @perms );
374         return( $requestor, $target, $evt);
375 }
376
377 sub fetch_copy {
378         my( $self, $copyid ) = @_;
379         my( $copy, $evt );
380
381         $logger->debug("Fetching copy $copyid from cstore");
382
383         $copy = $self->simplereq(
384                 'open-ils.cstore',
385                 'open-ils.cstore.direct.asset.copy.retrieve', $copyid );
386
387         if(!$copy) { $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND'); }
388
389         return( $copy, $evt );
390 }
391
392
393 # retrieves a circ object by id
394 sub fetch_circulation {
395         my( $self, $circid ) = @_;
396         my $circ; my $evt;
397         
398         $logger->debug("Fetching circ $circid from cstore");
399
400         $circ = $self->simplereq(
401                 'open-ils.cstore',
402                 "open-ils.cstore.direct.action.circulation.retrieve", $circid );
403
404         if(!$circ) {
405                 $evt = OpenILS::Event->new('ACTION_CIRCULATION_NOT_FOUND', circid => $circid );
406         }
407
408         return ( $circ, $evt );
409 }
410
411 sub fetch_record_by_copy {
412         my( $self, $copyid ) = @_;
413         my( $record, $evt );
414
415         $logger->debug("Fetching record by copy $copyid from cstore");
416
417         $record = $self->simplereq(
418                 'open-ils.cstore',
419                 'open-ils.cstore.direct.asset.copy.retrieve', $copyid,
420                 { flesh => 3,
421                   flesh_fields => {     bre => [ 'fixed_fields' ],
422                                         acn => [ 'record' ],
423                                         acp => [ 'call_number' ],
424                                   }
425                 }
426         );
427
428         if(!$record) {
429                 $evt = OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND');
430         } else {
431                 $record = $record->call_number->record;
432         }
433
434         return ($record, $evt);
435 }
436
437 # turns a record object into an mvr (mods) object
438 sub record_to_mvr {
439         my( $self, $record ) = @_;
440         return undef unless $record and $record->marc;
441         my $u = OpenILS::Utils::ModsParser->new();
442         $u->start_mods_batch( $record->marc );
443         my $mods = $u->finish_mods_batch();
444         $mods->doc_id($record->id);
445    $mods->tcn($record->tcn_value);
446         return $mods;
447 }
448
449 sub fetch_hold {
450         my( $self, $holdid ) = @_;
451         my( $hold, $evt );
452
453         $logger->debug("Fetching hold $holdid from cstore");
454
455         $hold = $self->simplereq(
456                 'open-ils.cstore',
457                 'open-ils.cstore.direct.action.hold_request.retrieve', $holdid);
458
459         $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND', holdid => $holdid) unless $hold;
460
461         return ($hold, $evt);
462 }
463
464
465 sub fetch_hold_transit_by_hold {
466         my( $self, $holdid ) = @_;
467         my( $transit, $evt );
468
469         $logger->debug("Fetching transit by hold $holdid from cstore");
470
471         $transit = $self->simplereq(
472                 'open-ils.cstore',
473                 'open-ils.cstore.direct.action.hold_transit_copy.search', { hold => $holdid } );
474
475         $evt = OpenILS::Event->new('ACTION_HOLD_TRANSIT_COPY_NOT_FOUND', holdid => $holdid) unless $transit;
476
477         return ($transit, $evt );
478 }
479
480 # fetches the captured, but not fulfilled hold attached to a given copy
481 sub fetch_open_hold_by_copy {
482         my( $self, $copyid ) = @_;
483         $logger->debug("Searching for active hold for copy $copyid");
484         my( $hold, $evt );
485
486         $hold = $self->cstorereq(
487                 'open-ils.cstore.direct.action.hold_request.search',
488                 { 
489                         current_copy            => $copyid , 
490                         capture_time            => { "!=" => undef }, 
491                         fulfillment_time        => undef,
492                         cancel_time                     => undef,
493                 } );
494
495         $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND', copyid => $copyid) unless $hold;
496         return ($hold, $evt);
497 }
498
499 sub fetch_hold_transit {
500         my( $self, $transid ) = @_;
501         my( $htransit, $evt );
502         $logger->debug("Fetching hold transit with hold id $transid");
503         $htransit = $self->cstorereq(
504                 'open-ils.cstore.direct.action.hold_transit_copy.retrieve', $transid );
505         $evt = OpenILS::Event->new('ACTION_HOLD_TRANSIT_COPY_NOT_FOUND', id => $transid) unless $htransit;
506         return ($htransit, $evt);
507 }
508
509 sub fetch_copy_by_barcode {
510         my( $self, $barcode ) = @_;
511         my( $copy, $evt );
512
513         $logger->debug("Fetching copy by barcode $barcode from cstore");
514
515         $copy = $self->simplereq( 'open-ils.cstore',
516                 'open-ils.cstore.direct.asset.copy.search', { barcode => $barcode, deleted => 'f'} );
517                 #'open-ils.storage.direct.asset.copy.search.barcode', $barcode );
518
519         $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', barcode => $barcode) unless $copy;
520
521         return ($copy, $evt);
522 }
523
524 sub fetch_open_billable_transaction {
525         my( $self, $transid ) = @_;
526         my( $transaction, $evt );
527
528         $logger->debug("Fetching open billable transaction $transid from cstore");
529
530         $transaction = $self->simplereq(
531                 'open-ils.cstore',
532                 'open-ils.cstore.direct.money.open_billable_transaction_summary.retrieve',  $transid);
533
534         $evt = OpenILS::Event->new(
535                 'MONEY_OPEN_BILLABLE_TRANSACTION_SUMMARY_NOT_FOUND', transid => $transid ) unless $transaction;
536
537         return ($transaction, $evt);
538 }
539
540
541
542 my %buckets;
543 $buckets{'biblio'} = 'biblio_record_entry_bucket';
544 $buckets{'callnumber'} = 'call_number_bucket';
545 $buckets{'copy'} = 'copy_bucket';
546 $buckets{'user'} = 'user_bucket';
547
548 sub fetch_container {
549         my( $self, $id, $type ) = @_;
550         my( $bucket, $evt );
551
552         $logger->debug("Fetching container $id with type $type");
553
554         my $e = 'CONTAINER_CALL_NUMBER_BUCKET_NOT_FOUND';
555         $e = 'CONTAINER_BIBLIO_RECORD_ENTRY_BUCKET_NOT_FOUND' if $type eq 'biblio';
556         $e = 'CONTAINER_USER_BUCKET_NOT_FOUND' if $type eq 'user';
557         $e = 'CONTAINER_COPY_BUCKET_NOT_FOUND' if $type eq 'copy';
558
559         my $meth = $buckets{$type};
560         $bucket = $self->simplereq(
561                 'open-ils.cstore',
562                 "open-ils.cstore.direct.container.$meth.retrieve", $id );
563
564         $evt = OpenILS::Event->new(
565                 $e, container => $id, container_type => $type ) unless $bucket;
566
567         return ($bucket, $evt);
568 }
569
570
571 sub fetch_container_e {
572         my( $self, $editor, $id, $type ) = @_;
573
574         my( $bucket, $evt );
575         $bucket = $editor->retrieve_container_copy_bucket($id) if $type eq 'copy';
576         $bucket = $editor->retrieve_container_call_number_bucket($id) if $type eq 'callnumber';
577         $bucket = $editor->retrieve_container_biblio_record_entry_bucket($id) if $type eq 'biblio';
578         $bucket = $editor->retrieve_container_user_bucket($id) if $type eq 'user';
579
580         $evt = $editor->event unless $bucket;
581         return ($bucket, $evt);
582 }
583
584 sub fetch_container_item_e {
585         my( $self, $editor, $id, $type ) = @_;
586
587         my( $bucket, $evt );
588         $bucket = $editor->retrieve_container_copy_bucket_item($id) if $type eq 'copy';
589         $bucket = $editor->retrieve_container_call_number_bucket_item($id) if $type eq 'callnumber';
590         $bucket = $editor->retrieve_container_biblio_record_entry_bucket_item($id) if $type eq 'biblio';
591         $bucket = $editor->retrieve_container_user_bucket_item($id) if $type eq 'user';
592
593         $evt = $editor->event unless $bucket;
594         return ($bucket, $evt);
595 }
596
597
598
599
600
601 sub fetch_container_item {
602         my( $self, $id, $type ) = @_;
603         my( $bucket, $evt );
604
605         $logger->debug("Fetching container item $id with type $type");
606
607         my $meth = $buckets{$type} . "_item";
608
609         $bucket = $self->simplereq(
610                 'open-ils.cstore',
611                 "open-ils.cstore.direct.container.$meth.retrieve", $id );
612
613
614         my $e = 'CONTAINER_CALL_NUMBER_BUCKET_ITEM_NOT_FOUND';
615         $e = 'CONTAINER_BIBLIO_RECORD_ENTRY_BUCKET_ITEM_NOT_FOUND' if $type eq 'biblio';
616         $e = 'CONTAINER_USER_BUCKET_ITEM_NOT_FOUND' if $type eq 'user';
617         $e = 'CONTAINER_COPY_BUCKET_ITEM_NOT_FOUND' if $type eq 'copy';
618
619         $evt = OpenILS::Event->new(
620                 $e, itemid => $id, container_type => $type ) unless $bucket;
621
622         return ($bucket, $evt);
623 }
624
625
626 sub fetch_patron_standings {
627         my $self = shift;
628         $logger->debug("Fetching patron standings");    
629         return $self->simplereq(
630                 'open-ils.cstore', 
631                 'open-ils.cstore.direct.config.standing.search.atomic', { id => { '!=' => undef } });
632 }
633
634
635 sub fetch_permission_group_tree {
636         my $self = shift;
637         $logger->debug("Fetching patron profiles");     
638         return $self->simplereq(
639                 'open-ils.actor', 
640                 'open-ils.actor.groups.tree.retrieve' );
641 }
642
643 sub fetch_permission_group_descendants {
644     my( $self, $profile ) = @_;
645     my $group_tree = $self->fetch_permission_group_tree();
646     my $start_here;
647     my @groups;
648
649     # FIXME: okay, so it's not an org tree, but it is compatible
650     $self->walk_org_tree($group_tree, sub {
651         my $g = shift;
652         if ($g->id == $profile) {
653             $start_here = $g;
654         }
655     });
656
657     $self->walk_org_tree($start_here, sub {
658         my $g = shift;
659         push(@groups,$g->id);
660     });
661
662     return \@groups;
663 }
664
665 sub fetch_patron_circ_summary {
666         my( $self, $userid ) = @_;
667         $logger->debug("Fetching patron summary for $userid");
668         my $summary = $self->simplereq(
669                 'open-ils.storage', 
670                 "open-ils.storage.action.circulation.patron_summary", $userid );
671
672         if( $summary ) {
673                 $summary->[0] ||= 0;
674                 $summary->[1] ||= 0.0;
675                 return $summary;
676         }
677         return undef;
678 }
679
680
681 sub fetch_copy_statuses {
682         my( $self ) = @_;
683         $logger->debug("Fetching copy statuses");
684         return $self->simplereq(
685                 'open-ils.cstore', 
686                 'open-ils.cstore.direct.config.copy_status.search.atomic', { id => { '!=' => undef } });
687 }
688
689 sub fetch_copy_location {
690         my( $self, $id ) = @_;
691         my $evt;
692         my $cl = $self->cstorereq(
693                 'open-ils.cstore.direct.asset.copy_location.retrieve', $id );
694         $evt = OpenILS::Event->new('ASSET_COPY_LOCATION_NOT_FOUND') unless $cl;
695         return ($cl, $evt);
696 }
697
698 sub fetch_copy_locations {
699         my $self = shift; 
700         return $self->simplereq(
701                 'open-ils.cstore', 
702                 'open-ils.cstore.direct.asset.copy_location.search.atomic', { id => { '!=' => undef } });
703 }
704
705 sub fetch_copy_location_by_name {
706         my( $self, $name, $org ) = @_;
707         my $evt;
708         my $cl = $self->cstorereq(
709                 'open-ils.cstore.direct.asset.copy_location.search',
710                         { name => $name, owning_lib => $org } );
711         $evt = OpenILS::Event->new('ASSET_COPY_LOCATION_NOT_FOUND') unless $cl;
712         return ($cl, $evt);
713 }
714
715 sub fetch_callnumber {
716         my( $self, $id ) = @_;
717         my $evt = undef;
718
719         my $e = OpenILS::Event->new( 'ASSET_CALL_NUMBER_NOT_FOUND', id => $id );
720         return( undef, $e ) unless $id;
721
722         $logger->debug("Fetching callnumber $id");
723
724         my $cn = $self->simplereq(
725                 'open-ils.cstore',
726                 'open-ils.cstore.direct.asset.call_number.retrieve', $id );
727         $evt = $e  unless $cn;
728
729         return ( $cn, $evt );
730 }
731
732 my %ORG_CACHE; # - these rarely change, so cache them..
733 sub fetch_org_unit {
734         my( $self, $id ) = @_;
735         return undef unless $id;
736         return $id if( ref($id) eq 'Fieldmapper::actor::org_unit' );
737         return $ORG_CACHE{$id} if $ORG_CACHE{$id};
738         $logger->debug("Fetching org unit $id");
739         my $evt = undef;
740
741         my $org = $self->simplereq(
742                 'open-ils.cstore', 
743                 'open-ils.cstore.direct.actor.org_unit.retrieve', $id );
744         $evt = OpenILS::Event->new( 'ACTOR_ORG_UNIT_NOT_FOUND', id => $id ) unless $org;
745         $ORG_CACHE{$id}  = $org;
746
747         return ($org, $evt);
748 }
749
750 sub fetch_stat_cat {
751         my( $self, $type, $id ) = @_;
752         my( $cat, $evt );
753         $logger->debug("Fetching $type stat cat: $id");
754         $cat = $self->simplereq(
755                 'open-ils.cstore', 
756                 "open-ils.cstore.direct.$type.stat_cat.retrieve", $id );
757
758         my $e = 'ASSET_STAT_CAT_NOT_FOUND';
759         $e = 'ACTOR_STAT_CAT_NOT_FOUND' if $type eq 'actor';
760
761         $evt = OpenILS::Event->new( $e, id => $id ) unless $cat;
762         return ( $cat, $evt );
763 }
764
765 sub fetch_stat_cat_entry {
766         my( $self, $type, $id ) = @_;
767         my( $entry, $evt );
768         $logger->debug("Fetching $type stat cat entry: $id");
769         $entry = $self->simplereq(
770                 'open-ils.cstore', 
771                 "open-ils.cstore.direct.$type.stat_cat_entry.retrieve", $id );
772
773         my $e = 'ASSET_STAT_CAT_ENTRY_NOT_FOUND';
774         $e = 'ACTOR_STAT_CAT_ENTRY_NOT_FOUND' if $type eq 'actor';
775
776         $evt = OpenILS::Event->new( $e, id => $id ) unless $entry;
777         return ( $entry, $evt );
778 }
779
780
781 sub find_org {
782         my( $self, $org_tree, $orgid )  = @_;
783     return undef unless $org_tree and defined $orgid;
784         return $org_tree if ( $org_tree->id eq $orgid );
785         return undef unless ref($org_tree->children);
786         for my $c (@{$org_tree->children}) {
787                 my $o = $self->find_org($c, $orgid);
788                 return $o if $o;
789         }
790         return undef;
791 }
792
793 sub fetch_non_cat_type_by_name_and_org {
794         my( $self, $name, $orgId ) = @_;
795         $logger->debug("Fetching non cat type $name at org $orgId");
796         my $types = $self->simplereq(
797                 'open-ils.cstore',
798                 'open-ils.cstore.direct.config.non_cataloged_type.search.atomic',
799                 { name => $name, owning_lib => $orgId } );
800         return ($types->[0], undef) if($types and @$types);
801         return (undef, OpenILS::Event->new('CONFIG_NON_CATALOGED_TYPE_NOT_FOUND') );
802 }
803
804 sub fetch_non_cat_type {
805         my( $self, $id ) = @_;
806         $logger->debug("Fetching non cat type $id");
807         my( $type, $evt );
808         $type = $self->simplereq(
809                 'open-ils.cstore', 
810                 'open-ils.cstore.direct.config.non_cataloged_type.retrieve', $id );
811         $evt = OpenILS::Event->new('CONFIG_NON_CATALOGED_TYPE_NOT_FOUND') unless $type;
812         return ($type, $evt);
813 }
814
815 sub DB_UPDATE_FAILED { 
816         my( $self, $payload ) = @_;
817         return OpenILS::Event->new('DATABASE_UPDATE_FAILED', 
818                 payload => ($payload) ? $payload : undef ); 
819 }
820
821 sub fetch_booking_reservation {
822         my( $self, $id ) = @_;
823         my( $res, $evt );
824
825         $res = $self->simplereq(
826                 'open-ils.cstore', 
827                 'open-ils.cstore.direct.booking.reservation.retrieve', $id
828         );
829
830         # simplereq doesn't know how to flesh so ...
831         if ($res) {
832                 $res->usr(
833                         $self->simplereq(
834                                 'open-ils.cstore', 
835                                 'open-ils.cstore.direct.actor.user.retrieve', $res->usr
836                         )
837                 );
838
839                 $res->target_resource_type(
840                         $self->simplereq(
841                                 'open-ils.cstore', 
842                                 'open-ils.cstore.direct.booking.resource_type.retrieve', $res->target_resource_type
843                         )
844                 );
845
846                 if ($res->current_resource) {
847                         $res->current_resource(
848                                 $self->simplereq(
849                                         'open-ils.cstore', 
850                                         'open-ils.cstore.direct.booking.resource.retrieve', $res->current_resource
851                                 )
852                         );
853
854                         if ($self->is_true( $res->target_resource_type->catalog_item )) {
855                                 $res->current_resource->catalog_item( $self->fetch_copy_by_barcode( $res->current_resource->barcode ) );
856                         }
857                 }
858
859                 if ($res->target_resource) {
860                         $res->target_resource(
861                                 $self->simplereq(
862                                         'open-ils.cstore', 
863                                         'open-ils.cstore.direct.booking.resource.retrieve', $res->target_resource
864                                 )
865                         );
866
867                         if ($self->is_true( $res->target_resource_type->catalog_item )) {
868                                 $res->target_resource->catalog_item( $self->fetch_copy_by_barcode( $res->target_resource->barcode ) );
869                         }
870                 }
871
872         } else {
873                 $evt = OpenILS::Event->new('RESERVATION_NOT_FOUND');
874         }
875
876         return ($res, $evt);
877 }
878
879 sub fetch_circ_duration_by_name {
880         my( $self, $name ) = @_;
881         my( $dur, $evt );
882         $dur = $self->simplereq(
883                 'open-ils.cstore', 
884                 'open-ils.cstore.direct.config.rules.circ_duration.search.atomic', { name => $name } );
885         $dur = $dur->[0];
886         $evt = OpenILS::Event->new('CONFIG_RULES_CIRC_DURATION_NOT_FOUND') unless $dur;
887         return ($dur, $evt);
888 }
889
890 sub fetch_recurring_fine_by_name {
891         my( $self, $name ) = @_;
892         my( $obj, $evt );
893         $obj = $self->simplereq(
894                 'open-ils.cstore', 
895                 'open-ils.cstore.direct.config.rules.recurring_fine.search.atomic', { name => $name } );
896         $obj = $obj->[0];
897         $evt = OpenILS::Event->new('CONFIG_RULES_RECURRING_FINE_NOT_FOUND') unless $obj;
898         return ($obj, $evt);
899 }
900
901 sub fetch_max_fine_by_name {
902         my( $self, $name ) = @_;
903         my( $obj, $evt );
904         $obj = $self->simplereq(
905                 'open-ils.cstore', 
906                 'open-ils.cstore.direct.config.rules.max_fine.search.atomic', { name => $name } );
907         $obj = $obj->[0];
908         $evt = OpenILS::Event->new('CONFIG_RULES_MAX_FINE_NOT_FOUND') unless $obj;
909         return ($obj, $evt);
910 }
911
912 sub fetch_hard_due_date_by_name {
913         my( $self, $name ) = @_;
914         my( $obj, $evt );
915         $obj = $self->simplereq(
916                 'open-ils.cstore', 
917                 'open-ils.cstore.direct.config.hard_due_date.search.atomic', { name => $name } );
918         $obj = $obj->[0];
919         $evt = OpenILS::Event->new('CONFIG_RULES_HARD_DUE_DATE_NOT_FOUND') unless $obj;
920         return ($obj, $evt);
921 }
922
923 sub storagereq {
924         my( $self, $method, @params ) = @_;
925         return $self->simplereq(
926                 'open-ils.storage', $method, @params );
927 }
928
929 sub storagereq_xact {
930         my($self, $method, @params) = @_;
931         my $ses = $self->start_db_session();
932         my $val = $ses->request($method, @params)->gather(1);
933         $self->rollback_db_session($ses);
934     return $val;
935 }
936
937 sub cstorereq {
938         my( $self, $method, @params ) = @_;
939         return $self->simplereq(
940                 'open-ils.cstore', $method, @params );
941 }
942
943 sub event_equals {
944         my( $self, $e, $name ) =  @_;
945         if( $e and ref($e) eq 'HASH' and 
946                 defined($e->{textcode}) and $e->{textcode} eq $name ) {
947                 return 1 ;
948         }
949         return 0;
950 }
951
952 sub logmark {
953         my( undef, $f, $l ) = caller(0);
954         my( undef, undef, undef, $s ) = caller(1);
955         $s =~ s/.*:://g;
956         $f =~ s/.*\///g;
957         $logger->debug("LOGMARK: $f:$l:$s");
958 }
959
960 # takes a copy id 
961 sub fetch_open_circulation {
962         my( $self, $cid ) = @_;
963         $self->logmark;
964
965         my $e = OpenILS::Utils::CStoreEditor->new;
966     my $circ = $e->search_action_circulation({
967         target_copy => $cid, 
968         stop_fines_time => undef, 
969         checkin_time => undef
970     })->[0];
971     
972     return ($circ, $e->event);
973 }
974
975 my $copy_statuses;
976 sub copy_status_from_name {
977         my( $self, $name ) = @_;
978         $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
979         for my $status (@$copy_statuses) { 
980                 return $status if( $status->name =~ /$name/i );
981         }
982         return undef;
983 }
984
985 sub copy_status_to_name {
986         my( $self, $sid ) = @_;
987         $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
988         for my $status (@$copy_statuses) { 
989                 return $status->name if( $status->id == $sid );
990         }
991         return undef;
992 }
993
994
995 sub copy_status {
996         my( $self, $arg ) = @_;
997         return $arg if ref $arg;
998         $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
999         my ($stat) = grep { $_->id == $arg } @$copy_statuses;
1000         return $stat;
1001 }
1002
1003 sub fetch_open_transit_by_copy {
1004         my( $self, $copyid ) = @_;
1005         my($transit, $evt);
1006         $transit = $self->cstorereq(
1007                 'open-ils.cstore.direct.action.transit_copy.search',
1008                 { target_copy => $copyid, dest_recv_time => undef });
1009         $evt = OpenILS::Event->new('ACTION_TRANSIT_COPY_NOT_FOUND') unless $transit;
1010         return ($transit, $evt);
1011 }
1012
1013 sub unflesh_copy {
1014         my( $self, $copy ) = @_;
1015         return undef unless $copy;
1016         $copy->status( $copy->status->id ) if ref($copy->status);
1017         $copy->location( $copy->location->id ) if ref($copy->location);
1018         $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
1019         return $copy;
1020 }
1021
1022 sub unflesh_reservation {
1023         my( $self, $reservation ) = @_;
1024         return undef unless $reservation;
1025         $reservation->usr( $reservation->usr->id ) if ref($reservation->usr);
1026         $reservation->target_resource_type( $reservation->target_resource_type->id ) if ref($reservation->target_resource_type);
1027         $reservation->target_resource( $reservation->target_resource->id ) if ref($reservation->target_resource);
1028         $reservation->current_resource( $reservation->current_resource->id ) if ref($reservation->current_resource);
1029         return $reservation;
1030 }
1031
1032 # un-fleshes a copy and updates it in the DB
1033 # returns a DB_UPDATE_FAILED event on error
1034 # returns undef on success
1035 sub update_copy {
1036         my( $self, %params ) = @_;
1037
1038         my $copy                = $params{copy} || die "update_copy(): copy required";
1039         my $editor      = $params{editor} || die "update_copy(): copy editor required";
1040         my $session = $params{session};
1041
1042         $logger->debug("Updating copy in the database: " . $copy->id);
1043
1044         $self->unflesh_copy($copy);
1045         $copy->editor( $editor );
1046         $copy->edit_date( 'now' );
1047
1048         my $s;
1049         my $meth = 'open-ils.storage.direct.asset.copy.update';
1050
1051         $s = $session->request( $meth, $copy )->gather(1) if $session;
1052         $s = $self->storagereq( $meth, $copy ) unless $session;
1053
1054         $logger->debug("Update of copy ".$copy->id." returned: $s");
1055
1056         return $self->DB_UPDATE_FAILED($copy) unless $s;
1057         return undef;
1058 }
1059
1060 sub update_reservation {
1061         my( $self, %params ) = @_;
1062
1063         my $reservation = $params{reservation}  || die "update_reservation(): reservation required";
1064         my $editor              = $params{editor} || die "update_reservation(): copy editor required";
1065         my $session             = $params{session};
1066
1067         $logger->debug("Updating copy in the database: " . $reservation->id);
1068
1069         $self->unflesh_reservation($reservation);
1070
1071         my $s;
1072         my $meth = 'open-ils.cstore.direct.booking.reservation.update';
1073
1074         $s = $session->request( $meth, $reservation )->gather(1) if $session;
1075         $s = $self->cstorereq( $meth, $reservation ) unless $session;
1076
1077         $logger->debug("Update of copy ".$reservation->id." returned: $s");
1078
1079         return $self->DB_UPDATE_FAILED($reservation) unless $s;
1080         return undef;
1081 }
1082
1083 sub fetch_billable_xact {
1084         my( $self, $id ) = @_;
1085         my($xact, $evt);
1086         $logger->debug("Fetching billable transaction %id");
1087         $xact = $self->cstorereq(
1088                 'open-ils.cstore.direct.money.billable_transaction.retrieve', $id );
1089         $evt = OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_NOT_FOUND') unless $xact;
1090         return ($xact, $evt);
1091 }
1092
1093 sub fetch_billable_xact_summary {
1094         my( $self, $id ) = @_;
1095         my($xact, $evt);
1096         $logger->debug("Fetching billable transaction summary %id");
1097         $xact = $self->cstorereq(
1098                 'open-ils.cstore.direct.money.billable_transaction_summary.retrieve', $id );
1099         $evt = OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_NOT_FOUND') unless $xact;
1100         return ($xact, $evt);
1101 }
1102
1103 sub fetch_fleshed_copy {
1104         my( $self, $id ) = @_;
1105         my( $copy, $evt );
1106         $logger->info("Fetching fleshed copy $id");
1107         $copy = $self->cstorereq(
1108                 "open-ils.cstore.direct.asset.copy.retrieve", $id,
1109                 { flesh => 1,
1110                   flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
1111                 }
1112         );
1113         $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', id => $id) unless $copy;
1114         return ($copy, $evt);
1115 }
1116
1117
1118 # returns the org that owns the callnumber that the copy
1119 # is attached to
1120 sub fetch_copy_owner {
1121         my( $self, $copyid ) = @_;
1122         my( $copy, $cn, $evt );
1123         $logger->debug("Fetching copy owner $copyid");
1124         ($copy, $evt) = $self->fetch_copy($copyid);
1125         return (undef,$evt) if $evt;
1126         ($cn, $evt) = $self->fetch_callnumber($copy->call_number);
1127         return (undef,$evt) if $evt;
1128         return ($cn->owning_lib);
1129 }
1130
1131 sub fetch_copy_note {
1132         my( $self, $id ) = @_;
1133         my( $note, $evt );
1134         $logger->debug("Fetching copy note $id");
1135         $note = $self->cstorereq(
1136                 'open-ils.cstore.direct.asset.copy_note.retrieve', $id );
1137         $evt = OpenILS::Event->new('ASSET_COPY_NOTE_NOT_FOUND', id => $id ) unless $note;
1138         return ($note, $evt);
1139 }
1140
1141 sub fetch_call_numbers_by_title {
1142         my( $self, $titleid ) = @_;
1143         $logger->info("Fetching call numbers by title $titleid");
1144         return $self->cstorereq(
1145                 'open-ils.cstore.direct.asset.call_number.search.atomic', 
1146                 { record => $titleid, deleted => 'f' });
1147                 #'open-ils.storage.direct.asset.call_number.search.record.atomic', $titleid);
1148 }
1149
1150 sub fetch_copies_by_call_number {
1151         my( $self, $cnid ) = @_;
1152         $logger->info("Fetching copies by call number $cnid");
1153         return $self->cstorereq(
1154                 'open-ils.cstore.direct.asset.copy.search.atomic', { call_number => $cnid, deleted => 'f' } );
1155                 #'open-ils.storage.direct.asset.copy.search.call_number.atomic', $cnid );
1156 }
1157
1158 sub fetch_user_by_barcode {
1159         my( $self, $bc ) = @_;
1160         my $cardid = $self->cstorereq(
1161                 'open-ils.cstore.direct.actor.card.id_list', { barcode => $bc } );
1162         return (undef, OpenILS::Event->new('ACTOR_CARD_NOT_FOUND', barcode => $bc)) unless $cardid;
1163         my $user = $self->cstorereq(
1164                 'open-ils.cstore.direct.actor.user.search', { card => $cardid } );
1165         return (undef, OpenILS::Event->new('ACTOR_USER_NOT_FOUND', card => $cardid)) unless $user;
1166         return ($user);
1167         
1168 }
1169
1170 sub fetch_bill {
1171         my( $self, $billid ) = @_;
1172         $logger->debug("Fetching billing $billid");
1173         my $bill = $self->cstorereq(
1174                 'open-ils.cstore.direct.money.billing.retrieve', $billid );
1175         my $evt = OpenILS::Event->new('MONEY_BILLING_NOT_FOUND') unless $bill;
1176         return($bill, $evt);
1177 }
1178
1179 my $ORG_TREE;
1180 sub fetch_org_tree {
1181         my $self = shift;
1182         return $ORG_TREE if $ORG_TREE;
1183         return $ORG_TREE = OpenILS::Utils::CStoreEditor->new->search_actor_org_unit( 
1184                 [
1185                         {"parent_ou" => undef },
1186                         {
1187                                 flesh                           => -1,
1188                                 flesh_fields    => { aou =>  ['children'] },
1189                                 order_by       => { aou => 'name'}
1190                         }
1191                 ]
1192         )->[0];
1193 }
1194
1195 sub walk_org_tree {
1196         my( $self, $node, $callback ) = @_;
1197         return unless $node;
1198         $callback->($node);
1199         if( $node->children ) {
1200                 $self->walk_org_tree($_, $callback) for @{$node->children};
1201         }
1202 }
1203
1204 sub is_true {
1205         my( $self, $item ) = @_;
1206         return 1 if $item and $item !~ /^f$/i;
1207         return 0;
1208 }
1209
1210
1211 sub patientreq {
1212     my ($self, $client, $service, $method, @params) = @_;
1213     my ($response, $err);
1214
1215     my $session = create OpenSRF::AppSession($service);
1216     my $request = $session->request($method, @params);
1217
1218     my $spurt = 10;
1219     my $give_up = time + 1000;
1220
1221     try {
1222         while (time < $give_up) {
1223             $response = $request->recv("timeout" => $spurt);
1224             last if $request->complete;
1225
1226             $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1227         }
1228     } catch Error with {
1229         $err = shift;
1230     };
1231
1232     if ($err) {
1233         warn "received error : service=$service : method=$method : params=".Dumper(\@params) . "\n $err";
1234         throw $err ("Call to $service for method $method \n failed with exception: $err : " );
1235     }
1236
1237     return $response->content;
1238 }
1239
1240 # This logic now lives in storage
1241 sub __patron_money_owed {
1242         my( $self, $patronid ) = @_;
1243         my $ses = OpenSRF::AppSession->create('open-ils.storage');
1244         my $req = $ses->request(
1245                 'open-ils.storage.money.billable_transaction.summary.search',
1246                 { usr => $patronid, xact_finish => undef } );
1247
1248         my $total = 0;
1249         my $data;
1250         while( $data = $req->recv ) {
1251                 $data = $data->content;
1252                 $total += $data->balance_owed;
1253         }
1254         return $total;
1255 }
1256
1257 sub patron_money_owed {
1258         my( $self, $userid ) = @_;
1259         my $ses = $self->start_db_session();
1260         my $val = $ses->request(
1261                 'open-ils.storage.actor.user.total_owed', $userid)->gather(1);
1262         $self->rollback_db_session($ses);
1263         return $val;
1264 }
1265
1266 sub patron_total_items_out {
1267         my( $self, $userid ) = @_;
1268         my $ses = $self->start_db_session();
1269         my $val = $ses->request(
1270                 'open-ils.storage.actor.user.total_out', $userid)->gather(1);
1271         $self->rollback_db_session($ses);
1272         return $val;
1273 }
1274
1275
1276
1277
1278 #---------------------------------------------------------------------
1279 # Returns  ($summary, $event) 
1280 #---------------------------------------------------------------------
1281 sub fetch_mbts {
1282         my $self = shift;
1283         my $id  = shift;
1284         my $e = shift || OpenILS::Utils::CStoreEditor->new;
1285         $id = $id->id if ref($id);
1286     
1287     my $xact = $e->retrieve_money_billable_transaction_summary($id)
1288             or return (undef, $e->event);
1289
1290     return ($xact);
1291 }
1292
1293
1294 #---------------------------------------------------------------------
1295 # Given a list of money.billable_transaction objects, this creates
1296 # transaction summary objects for each
1297 #--------------------------------------------------------------------
1298 sub make_mbts {
1299         my $self = shift;
1300     my $e = shift;
1301         my @xacts = @_;
1302         return () if (!@xacts);
1303     return @{$e->search_money_billable_transaction_summary({id => [ map { $_->id } @xacts ]})};
1304 }
1305                 
1306                 
1307 sub ou_ancestor_setting_value {
1308     my($self, $org_id, $name, $e) = @_;
1309     $e = $e || OpenILS::Utils::CStoreEditor->new;
1310     my $set = $self->ou_ancestor_setting($org_id, $name, $e);
1311     return $set->{value} if $set;
1312     return undef;
1313 }
1314
1315
1316 # If an authentication token is provided AND this org unit setting has a
1317 # view_perm, then make sure the user referenced by the auth token has
1318 # that permission.  This means that if you call this method without an
1319 # authtoken param, you can get whatever org unit setting values you want.
1320 # API users beware.
1321 #
1322 # NOTE: If you supply an editor ($e) arg AND an auth token arg, the editor's
1323 # authtoken is checked, but the $auth arg is NOT checked.  To say that another
1324 # way, be sure NOT to pass an editor argument if you want your token checked.
1325 # Otherwise the auth arg is just a flag saying "check the editor".  
1326
1327 sub ou_ancestor_setting {
1328     my( $self, $orgid, $name, $e, $auth ) = @_;
1329     $e = $e || OpenILS::Utils::CStoreEditor->new(
1330         (defined $auth) ? (authtoken => $auth) : ()
1331     );
1332     my $coust = $e->retrieve_config_org_unit_setting_type([
1333         $name, {flesh => 1, flesh_fields => {coust => ['view_perm']}}
1334     ]);
1335
1336     if ($auth && $coust && $coust->view_perm) {
1337         # And you can't have permission if you don't have a valid session.
1338         return undef if not $e->checkauth;
1339         # And now that we know you MIGHT have permission, we check it.
1340         return undef if not $e->allowed($coust->view_perm->code, $orgid);
1341     }
1342
1343     my $query = {from => ['actor.org_unit_ancestor_setting', $name, $orgid]};
1344     my $setting = $e->json_query($query)->[0];
1345     return undef unless $setting;
1346     return {org => $setting->{org_unit}, value => OpenSRF::Utils::JSON->JSON2perl($setting->{value})};
1347 }       
1348                 
1349
1350 # returns the ISO8601 string representation of the requested epoch in GMT
1351 sub epoch2ISO8601 {
1352     my( $self, $epoch ) = @_;
1353     my ($sec,$min,$hour,$mday,$mon,$year) = gmtime($epoch);
1354     $year += 1900; $mon += 1;
1355     my $date = sprintf(
1356         '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1357         $year, $mon, $mday, $hour, $min, $sec);
1358     return $date;
1359 }
1360                         
1361 sub find_highest_perm_org {
1362         my ( $self, $perm, $userid, $start_org, $org_tree ) = @_;
1363         my $org = $self->find_org($org_tree, $start_org );
1364
1365         my $lastid = -1;
1366         while( $org ) {
1367                 last if ($self->check_perms( $userid, $org->id, $perm )); # perm failed
1368                 $lastid = $org->id;
1369                 $org = $self->find_org( $org_tree, $org->parent_ou() );
1370         }
1371
1372         return $lastid;
1373 }
1374
1375
1376 # returns the org_unit ID's 
1377 sub user_has_work_perm_at {
1378     my($self, $e, $perm, $options, $user_id) = @_;
1379     $options ||= {};
1380     $user_id = (defined $user_id) ? $user_id : $e->requestor->id;
1381
1382     my $func = 'permission.usr_has_perm_at';
1383     $func = $func.'_all' if $$options{descendants};
1384
1385     my $orgs = $e->json_query({from => [$func, $user_id, $perm]});
1386     $orgs = [map { $_->{ (keys %$_)[0] } } @$orgs];
1387
1388     return $orgs unless $$options{objects};
1389
1390     return $e->search_actor_org_unit({id => $orgs});
1391 }
1392
1393 sub get_user_work_ou_ids {
1394     my($self, $e, $userid) = @_;
1395     my $work_orgs = $e->json_query({
1396         select => {puwoum => ['work_ou']},
1397         from => 'puwoum',
1398         where => {usr => $e->requestor->id}});
1399
1400     return [] unless @$work_orgs;
1401     my @work_orgs;
1402     push(@work_orgs, $_->{work_ou}) for @$work_orgs;
1403
1404     return \@work_orgs;
1405 }
1406
1407
1408 my $org_types;
1409 sub get_org_types {
1410         my($self, $client) = @_;
1411         return $org_types if $org_types;
1412         return $org_types = OpenILS::Utils::CStoreEditor->new->retrieve_all_actor_org_unit_type();
1413 }
1414
1415 sub get_org_tree {
1416         my $self = shift;
1417         my $locale = shift || '';
1418         my $cache = OpenSRF::Utils::Cache->new("global", 0);
1419         my $tree = $cache->get_cache("orgtree.$locale");
1420         return $tree if $tree;
1421
1422         my $ses = OpenILS::Utils::CStoreEditor->new;
1423         $ses->session->session_locale($locale);
1424         $tree = $ses->search_actor_org_unit( 
1425                 [
1426                         {"parent_ou" => undef },
1427                         {
1428                                 flesh                           => -1,
1429                                 flesh_fields    => { aou =>  ['children'] },
1430                                 order_by                        => { aou => 'name'}
1431                         }
1432                 ]
1433         )->[0];
1434
1435         $cache->put_cache("orgtree.$locale", $tree);
1436         return $tree;
1437 }
1438
1439 sub get_org_descendants {
1440         my($self, $org_id, $depth) = @_;
1441
1442         my $select = {
1443                 transform => 'actor.org_unit_descendants',
1444                 column => 'id',
1445                 result_field => 'id',
1446         };
1447         $select->{params} = [$depth] if defined $depth;
1448
1449         my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1450                 select => {aou => [$select]},
1451         from => 'aou',
1452                 where => {id => $org_id}
1453         });
1454         my @orgs;
1455         push(@orgs, $_->{id}) for @$org_list;
1456         return \@orgs;
1457 }
1458
1459 sub get_org_ancestors {
1460         my($self, $org_id) = @_;
1461
1462         my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1463                 select => {
1464                         aou => [{
1465                                 transform => 'actor.org_unit_ancestors',
1466                                 column => 'id',
1467                                 result_field => 'id',
1468                                 params => []
1469                         }],
1470                 },
1471                 from => 'aou',
1472                 where => {id => $org_id}
1473         });
1474
1475         my @orgs;
1476         push(@orgs, $_->{id}) for @$org_list;
1477         return \@orgs;
1478 }
1479
1480 sub get_org_full_path {
1481         my($self, $org_id, $depth) = @_;
1482
1483     my $query = {
1484         select => {
1485                         aou => [{
1486                                 transform => 'actor.org_unit_full_path',
1487                                 column => 'id',
1488                                 result_field => 'id',
1489                         }],
1490                 },
1491                 from => 'aou',
1492                 where => {id => $org_id}
1493         };
1494
1495     $query->{select}->{aou}->[0]->{params} = [$depth] if defined $depth;
1496         my $org_list = OpenILS::Utils::CStoreEditor->new->json_query($query);
1497     return [ map {$_->{id}} @$org_list ];
1498 }
1499
1500 # returns the ID of the org unit ancestor at the specified depth
1501 sub org_unit_ancestor_at_depth {
1502     my($class, $org_id, $depth) = @_;
1503     my $resp = OpenILS::Utils::CStoreEditor->new->json_query(
1504         {from => ['actor.org_unit_ancestor_at_depth', $org_id, $depth]})->[0];
1505     return ($resp) ? $resp->{id} : undef;
1506 }
1507
1508 # returns the user's configured locale as a string.  Defaults to en-US if none is configured.
1509 sub get_user_locale {
1510         my($self, $user_id, $e) = @_;
1511         $e ||= OpenILS::Utils::CStoreEditor->new;
1512
1513         # first, see if the user has an explicit locale set
1514         my $setting = $e->search_actor_user_setting(
1515                 {usr => $user_id, name => 'global.locale'})->[0];
1516         return OpenSRF::Utils::JSON->JSON2perl($setting->value) if $setting;
1517
1518         my $user = $e->retrieve_actor_user($user_id) or return $e->event;
1519         return $self->get_org_locale($user->home_ou, $e);
1520 }
1521
1522 # returns org locale setting
1523 sub get_org_locale {
1524         my($self, $org_id, $e) = @_;
1525         $e ||= OpenILS::Utils::CStoreEditor->new;
1526
1527         my $locale;
1528         if(defined $org_id) {
1529                 $locale = $self->ou_ancestor_setting_value($org_id, 'global.default_locale', $e);
1530                 return $locale if $locale;
1531         }
1532
1533         # system-wide default
1534         my $sclient = OpenSRF::Utils::SettingsClient->new;
1535         $locale = $sclient->config_value('default_locale');
1536     return $locale if $locale;
1537
1538         # if nothing else, fallback to locale=cowboy
1539         return 'en-US';
1540 }
1541
1542
1543 # xml-escape non-ascii characters
1544 sub entityize { 
1545     my($self, $string, $form) = @_;
1546         $form ||= "";
1547
1548         # If we're going to convert non-ASCII characters to XML entities,
1549         # we had better be dealing with a UTF8 string to begin with
1550         $string = decode_utf8($string);
1551
1552         if ($form eq 'D') {
1553                 $string = NFD($string);
1554         } else {
1555                 $string = NFC($string);
1556         }
1557
1558         # Convert raw ampersands to entities
1559         $string =~ s/&(?!\S+;)/&amp;/gso;
1560
1561         # Convert Unicode characters to entities
1562         $string =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
1563
1564         return $string;
1565 }
1566
1567 # x0000-x0008 isn't legal in XML documents
1568 # XXX Perhaps this should just go into our standard entityize method
1569 sub strip_ctrl_chars {
1570         my ($self, $string) = @_;
1571
1572         $string =~ s/([\x{0000}-\x{0008}])//sgoe; 
1573         return $string;
1574 }
1575
1576 sub get_copy_price {
1577         my($self, $e, $copy, $volume) = @_;
1578
1579         $copy->price(0) if $copy->price and $copy->price < 0;
1580
1581         return $copy->price if $copy->price and $copy->price > 0;
1582
1583
1584         my $owner;
1585         if(ref $volume) {
1586                 if($volume->id == OILS_PRECAT_CALL_NUMBER) {
1587                         $owner = $copy->circ_lib;
1588                 } else {
1589                         $owner = $volume->owning_lib;
1590                 }
1591         } else {
1592                 if($copy->call_number == OILS_PRECAT_CALL_NUMBER) {
1593                         $owner = $copy->circ_lib;
1594                 } else {
1595                         $owner = $e->retrieve_asset_call_number($copy->call_number)->owning_lib;
1596                 }
1597         }
1598
1599         my $default_price = $self->ou_ancestor_setting_value(
1600                 $owner, OILS_SETTING_DEF_ITEM_PRICE, $e) || 0;
1601
1602         return $default_price unless defined $copy->price;
1603
1604         # price is 0.  Use the default?
1605     my $charge_on_0 = $self->ou_ancestor_setting_value(
1606         $owner, OILS_SETTING_CHARGE_LOST_ON_ZERO, $e) || 0;
1607
1608         return $default_price if $charge_on_0;
1609         return 0;
1610 }
1611
1612 # given a transaction ID, this returns the context org_unit for the transaction
1613 sub xact_org {
1614     my($self, $xact_id, $e) = @_;
1615     $e ||= OpenILS::Utils::CStoreEditor->new;
1616     
1617     my $loc = $e->json_query({
1618         "select" => {circ => ["circ_lib"]},
1619         from     => "circ",
1620         "where"  => {id => $xact_id},
1621     });
1622
1623     return $loc->[0]->{circ_lib} if @$loc;
1624
1625     $loc = $e->json_query({
1626         "select" => {bresv => ["request_lib"]},
1627         from     => "bresv",
1628         "where"  => {id => $xact_id},
1629     });
1630
1631     return $loc->[0]->{request_lib} if @$loc;
1632
1633     $loc = $e->json_query({
1634         "select" => {mg => ["billing_location"]},
1635         from     => "mg",
1636         "where"  => {id => $xact_id},
1637     });
1638
1639     return $loc->[0]->{billing_location};
1640 }
1641
1642
1643 sub find_event_def_by_hook {
1644     my($self, $hook, $context_org, $e) = @_;
1645
1646     $e ||= OpenILS::Utils::CStoreEditor->new;
1647
1648     my $orgs = $self->get_org_ancestors($context_org);
1649
1650     # search from the context org up
1651     for my $org_id (reverse @$orgs) {
1652
1653         my $def = $e->search_action_trigger_event_definition(
1654             {hook => $hook, owner => $org_id})->[0];
1655
1656         return $def if $def;
1657     }
1658
1659     return undef;
1660 }
1661
1662
1663
1664 # If an event_def ID is not provided, use the hook and context org to find the 
1665 # most appropriate event.  create the event, fire it, then return the resulting
1666 # event with fleshed template_output and error_output
1667 sub fire_object_event {
1668     my($self, $event_def, $hook, $object, $context_org, $granularity, $user_data, $client) = @_;
1669
1670     my $e = OpenILS::Utils::CStoreEditor->new;
1671     my $def;
1672
1673     my $auto_method = "open-ils.trigger.event.autocreate.by_definition";
1674
1675     if($event_def) {
1676         $def = $e->retrieve_action_trigger_event_definition($event_def)
1677             or return $e->event;
1678
1679         $auto_method .= '.include_inactive';
1680
1681     } else {
1682
1683         # find the most appropriate event def depending on context org
1684         $def = $self->find_event_def_by_hook($hook, $context_org, $e) 
1685             or return $e->event;
1686     }
1687
1688     my $final_resp;
1689
1690     if($def->group_field) {
1691         # we have a list of objects
1692         $object = [$object] unless ref $object eq 'ARRAY';
1693
1694         my @event_ids;
1695         $user_data ||= [];
1696         for my $i (0..$#$object) {
1697             my $obj = $$object[$i];
1698             my $udata = $$user_data[$i];
1699             my $event_id = $self->simplereq(
1700                 'open-ils.trigger', $auto_method, $def->id, $obj, $context_org, $udata);
1701             push(@event_ids, $event_id);
1702         }
1703
1704         $logger->info("EVENTS = " . OpenSRF::Utils::JSON->perl2JSON(\@event_ids));
1705
1706         my $resp;
1707         if (not defined $client) {
1708             $resp = $self->simplereq(
1709                 'open-ils.trigger',
1710                 'open-ils.trigger.event_group.fire',
1711                 \@event_ids);
1712         } else {
1713             $resp = $self->patientreq(
1714                 $client,
1715                 "open-ils.trigger", "open-ils.trigger.event_group.fire",
1716                 \@event_ids
1717             );
1718         }
1719
1720         if($resp and $resp->{events} and @{$resp->{events}}) {
1721
1722             $e->xact_begin;
1723             $final_resp = $e->retrieve_action_trigger_event([
1724                 $resp->{events}->[0]->id,
1725                 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1726             ]);
1727             $e->rollback;
1728         }
1729
1730     } else {
1731
1732         $object = $$object[0] if ref $object eq 'ARRAY';
1733
1734         my $event_id;
1735         my $resp;
1736
1737         if (not defined $client) {
1738             $event_id = $self->simplereq(
1739                 'open-ils.trigger',
1740                 $auto_method, $def->id, $object, $context_org, $user_data
1741             );
1742
1743             $resp = $self->simplereq(
1744                 'open-ils.trigger',
1745                 'open-ils.trigger.event.fire',
1746                 $event_id
1747             );
1748         } else {
1749             $event_id = $self->patientreq(
1750                 $client,
1751                 'open-ils.trigger',
1752                 $auto_method, $def->id, $object, $context_org, $user_data
1753             );
1754
1755             $resp = $self->patientreq(
1756                 $client,
1757                 'open-ils.trigger',
1758                 'open-ils.trigger.event.fire',
1759                 $event_id
1760             );
1761         }
1762         
1763         if($resp and $resp->{event}) {
1764             $e->xact_begin;
1765             $final_resp = $e->retrieve_action_trigger_event([
1766                 $resp->{event}->id,
1767                 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1768             ]);
1769             $e->rollback;
1770         }
1771     }
1772
1773     return $final_resp;
1774 }
1775
1776
1777 sub create_events_for_hook {
1778     my($self, $hook, $obj, $org_id, $granularity, $user_data, $wait) = @_;
1779     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1780     my $req = $ses->request('open-ils.trigger.event.autocreate', 
1781         $hook, $obj, $org_id, $granularity, $user_data);
1782     return undef unless $wait;
1783     my $resp = $req->recv;
1784     return $resp->content if $resp;
1785 }
1786
1787 sub create_uuid_string {
1788     return create_UUID_as_string();
1789 }
1790
1791 sub create_circ_chain_summary {
1792     my($class, $e, $circ_id) = @_;
1793     my $sum = $e->json_query({from => ['action.summarize_circ_chain', $circ_id]})->[0];
1794     return undef unless $sum;
1795     my $obj = Fieldmapper::action::circ_chain_summary->new;
1796     $obj->$_($sum->{$_}) for keys %$sum;
1797     return $obj;
1798 }
1799
1800 1;
1801