added some utility methods, cleaned up the search code some
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / AppUtils.pm
1 package OpenILS::Application::AppUtils;
2 use strict; use warnings;
3 use base qw/OpenSRF::Application/;
4 use OpenSRF::Utils::Cache;
5 use OpenSRF::EX qw(:try);
6 use OpenILS::Perm;
7 use OpenSRF::Utils::Logger;
8 use OpenILS::Utils::ModsParser;
9 use OpenILS::Event;
10 my $logger = "OpenSRF::Utils::Logger";
11
12
13 my $cache_client = "OpenSRF::Utils::Cache";
14
15 my $storage_session = undef;
16
17 # ---------------------------------------------------------------------------
18 # Pile of utilty methods used accross applications.
19 # ---------------------------------------------------------------------------
20
21
22 # ---------------------------------------------------------------------------
23 # on sucess, returns the created session, on failure throws ERROR exception
24 # ---------------------------------------------------------------------------
25 sub start_db_session {
26
27         my $self = shift;
28         my $session = OpenSRF::AppSession->connect( "open-ils.storage" );
29         my $trans_req = $session->request( "open-ils.storage.transaction.begin" );
30
31         my $trans_resp = $trans_req->recv();
32         if(ref($trans_resp) and UNIVERSAL::isa($trans_resp,"Error")) { throw $trans_resp; }
33         if( ! $trans_resp->content() ) {
34                 throw OpenSRF::ERROR 
35                         ("Unable to Begin Transaction with database" );
36         }
37         $trans_req->finish();
38
39         $logger->debug("Setting global storage session to ".
40                 "session: " . $session->session_id . " : " . $session->app );
41
42         $storage_session = $session;
43         return $session;
44 }
45
46
47 # returns undef if user has all of the perms provided
48 # returns the first failed perm on failure
49 sub check_user_perms {
50         my($self, $user_id, $org_id, @perm_types ) = @_;
51         $logger->debug("Checking perms with user : $user_id , org: $org_id, @perm_types");
52         for my $type (@perm_types) {
53                 return $type unless ($self->storagereq(
54                         "open-ils.storage.permission.user_has_perm", 
55                         $user_id, $type, $org_id ));
56         }
57         return undef;
58 }
59
60 # checks the list of user perms.  The first one that fails returns a new
61 # OpenILS::Perm object of that type.  Returns undef if all perms are allowed
62 sub check_perms {
63         my( $self, $user_id, $org_id, @perm_types ) = @_;
64         my $t = $self->check_user_perms( $user_id, $org_id, @perm_types );
65         return OpenILS::Event->new('PERM_FAILURE', ilsperm => $t, ilspermloc => $org_id ) if $t;
66         return undef;
67 }
68
69
70
71 # ---------------------------------------------------------------------------
72 # commits and destroys the session
73 # ---------------------------------------------------------------------------
74 sub commit_db_session {
75         my( $self, $session ) = @_;
76
77         my $req = $session->request( "open-ils.storage.transaction.commit" );
78         my $resp = $req->recv();
79
80         if(!$resp) {
81                 throw OpenSRF::EX::ERROR ("Unable to commit db session");
82         }
83
84         if(UNIVERSAL::isa($resp,"Error")) { 
85                 throw $resp ($resp->stringify); 
86         }
87
88         if(!$resp->content) {
89                 throw OpenSRF::EX::ERROR ("Unable to commit db session");
90         }
91
92         $session->finish();
93         $session->disconnect();
94         $session->kill_me();
95         $storage_session = undef;
96 }
97
98 sub rollback_db_session {
99         my( $self, $session ) = @_;
100
101         my $req = $session->request("open-ils.storage.transaction.rollback");
102         my $resp = $req->recv();
103         if(UNIVERSAL::isa($resp,"Error")) { throw $resp;  }
104
105         $session->finish();
106         $session->disconnect();
107         $session->kill_me();
108         $storage_session = undef;
109 }
110
111
112 # returns undef it the event is not an ILS event
113 # returns the event code otherwise
114 sub event_code {
115         my( $self, $evt ) = @_;
116         return $evt->{ilsevent} if( ref($evt) eq 'HASH' and defined($evt->{ilsevent})) ;
117         return undef;
118 }
119
120 # ---------------------------------------------------------------------------
121 # Checks to see if a user is logged in.  Returns the user record on success,
122 # throws an exception on error.
123 # ---------------------------------------------------------------------------
124 sub check_user_session {
125
126         my( $self, $user_session ) = @_;
127
128         my $content = $self->simplereq( 
129                 'open-ils.auth', 
130                 'open-ils.auth.session.retrieve', $user_session );
131
132
133         if(! $content or $self->event_code($content)) {
134                 throw OpenSRF::EX::ERROR 
135                         ("Session [$user_session] cannot be authenticated" );
136         }
137
138         $logger->debug("Fetch user session $user_session found user " . $content->id );
139
140         return $content;
141 }
142
143 # generic simple request returning a scalar value
144 sub simplereq {
145         my($self, $service, $method, @params) = @_;
146         return $self->simple_scalar_request($service, $method, @params);
147 }
148
149 sub get_storage_session {
150
151         if(     $storage_session and 
152                         $storage_session->connected and
153                         $storage_session->transport_connected and
154                         $storage_session->app eq 'open-ils.storage' ) {
155
156                 $logger->debug("get_storage_session(): returning existing session");
157                 return $storage_session;
158         }
159         $logger->debug("get_storage_session(): returning undef");
160         $storage_session = undef;
161         return undef;
162 }
163
164
165 sub simple_scalar_request {
166         my($self, $service, $method, @params) = @_;
167
168         my $session = undef;
169         if( $service eq 'open-ils.storage' ) {
170                 if( $session = get_storage_session() ) {
171                         $logger->debug("simple request using existing storage session ".$session->session_id);
172                 } else { $session = undef; }
173         }
174
175         if(!$session) {
176                 $session = OpenSRF::AppSession->create( $service );
177         }
178
179         $logger->debug("simple request for service $service using session " .$session->app);
180
181         my $request = $session->request( $method, @params );
182         my $response = $request->recv(30);
183
184         $request->wait_complete;
185
186         if(!$request->complete) {
187                 throw OpenSRF::EX::ERROR ("Call to $service for method $method with params @params" . 
188                                 "\n did not complete successfully");
189         }
190
191         if(!$response) {
192                 warn "No response from $service for method $method with params @params";
193         }
194
195         if(UNIVERSAL::isa($response,"Error")) {
196                 throw $response ("Call to $service for method $method with params @params" . 
197                                 "\n failed with exception: " . $response->stringify );
198         }
199
200
201         $request->finish();
202
203         if($service ne 'open-ils.storage' or !get_storage_session() ) {
204                 $session->finish();
205                 $session->disconnect();
206         }
207
208         my $value;
209
210         if($response) { $value = $response->content; }
211         else { $value = undef; }
212
213         return $value;
214 }
215
216
217
218
219
220 my $tree                                                = undef;
221 my $orglist                                     = undef;
222 my $org_typelist                        = undef;
223 my $org_typelist_hash   = {};
224
225 sub get_org_tree {
226
227         my $self = shift;
228         if($tree) { return $tree; }
229
230         # see if it's in the cache
231         $tree = $cache_client->new()->get_cache('_orgtree');
232         if($tree) { return $tree; }
233
234         if(!$orglist) {
235                 warn "Retrieving Org Tree\n";
236                 $orglist = $self->simple_scalar_request( 
237                         "open-ils.storage", 
238                         "open-ils.storage.direct.actor.org_unit.retrieve.all.atomic" );
239         }
240
241         if( ! $org_typelist ) {
242                 warn "Retrieving org types\n";
243                 $org_typelist = $self->simple_scalar_request( 
244                         "open-ils.storage", 
245                         "open-ils.storage.direct.actor.org_unit_type.retrieve.all.atomic" );
246                 $self->build_org_type($org_typelist);
247         }
248
249         $tree = $self->build_org_tree($orglist,1);
250         $cache_client->new()->put_cache('_orgtree', $tree);
251         return $tree;
252
253 }
254
255 my $slimtree = undef;
256 sub get_slim_org_tree {
257
258         my $self = shift;
259         if($slimtree) { return $slimtree; }
260
261         # see if it's in the cache
262         $slimtree = $cache_client->new()->get_cache('slimorgtree');
263         if($slimtree) { return $slimtree; }
264
265         if(!$orglist) {
266                 warn "Retrieving Org Tree\n";
267                 $orglist = $self->simple_scalar_request( 
268                         "open-ils.storage", 
269                         "open-ils.storage.direct.actor.org_unit.retrieve.all.atomic" );
270         }
271
272         $slimtree = $self->build_org_tree($orglist);
273         $cache_client->new->put_cache('slimorgtree', $slimtree);
274         return $slimtree;
275
276 }
277
278
279 sub build_org_type { 
280         my($self, $org_typelist)  = @_;
281         for my $type (@$org_typelist) {
282                 $org_typelist_hash->{$type->id()} = $type;
283         }
284 }
285
286
287
288 sub build_org_tree {
289
290         my( $self, $orglist, $add_types ) = @_;
291
292         return $orglist unless ( 
293                         ref($orglist) and @$orglist > 1 );
294
295         my @list = sort { 
296                 $a->ou_type <=> $b->ou_type ||
297                 $a->name cmp $b->name } @$orglist;
298
299         for my $org (@list) {
300
301                 next unless ($org);
302
303                 if(!ref($org->ou_type()) and $add_types) {
304                         $org->ou_type( $org_typelist_hash->{$org->ou_type()});
305                 }
306
307                 next unless (defined($org->parent_ou));
308
309                 my ($parent) = grep { $_->id == $org->parent_ou } @list;
310                 next unless $parent;
311                 $parent->children([]) unless defined($parent->children); 
312                 push( @{$parent->children}, $org );
313         }
314
315         return $list[0];
316
317 }
318
319 sub fetch_user {
320         my( $self, $userid ) = @_;
321         my( $user, $evt );
322
323         $logger->debug("Fetching user $userid from storage");
324
325         $user = $self->simplereq(
326                 'open-ils.storage',
327                 'open-ils.storage.direct.actor.user.retrieve', $userid );
328
329         if(!$user) {
330                 $logger->info("User $userid not found in the db");
331                 $evt = OpenILS::Event->new('USER_NOT_FOUND');
332         }
333
334         return ($user, $evt);
335 }
336
337 sub checkses {
338         my( $self, $session ) = @_;
339         my $user; my $evt; my $e; 
340
341         $logger->debug("Checking user session $session");
342
343         try {
344                 $user = $self->check_user_session($session);
345         } catch Error with { $e = 1; };
346
347         if( $e or !$user ) { $evt = OpenILS::Event->new('NO_SESSION'); }
348         return ( $user, $evt );
349 }
350
351
352 # verifiese the session and checks the permissions agains the
353 # session user and the user's home_ou as the org id
354 sub checksesperm {
355         my( $self, $session, @perms ) = @_;
356         my $user; my $evt; my $e; 
357         $logger->debug("Checking user session $session and perms @perms");
358         ($user, $evt) = $self->checkses($session);
359         return (undef, $evt) if $evt;
360         $evt = $self->check_perms($user->id, $user->home_ou, @perms);
361         return ($user, $evt);
362 }
363
364
365 sub checkrequestor {
366         my( $self, $staffobj, $userid, @perms ) = @_;
367         my $user; my $evt;
368         $userid = $staffobj->id unless defined $userid;
369
370         $logger->debug("checkrequestor(): requestor => " . $staffobj->id . ", target => $userid");
371
372         if( $userid ne $staffobj->id ) {
373                 ($user, $evt) = $self->fetch_user($userid);
374                 return (undef, $evt) if $evt;
375                 $evt = $self->check_perms( $staffobj->id, $user->home_ou, @perms );
376
377         } else {
378                 $user = $staffobj;
379         }
380
381         return ($user, $evt);
382 }
383
384 sub checkses_requestor {
385         my( $self, $authtoken, $targetid, @perms ) = @_;
386         my( $requestor, $target, $evt );
387
388         ($requestor, $evt) = $self->checkses($authtoken);
389         return (undef, undef, $evt) if $evt;
390
391         ($target, $evt) = $self->checkrequestor( $requestor, $targetid, @perms );
392         return( $requestor, $target, $evt);
393 }
394
395 sub fetch_copy {
396         my( $self, $copyid ) = @_;
397         my( $copy, $evt );
398
399         $logger->debug("Fetching copy $copyid from storage");
400
401         $copy = $self->simplereq(
402                 'open-ils.storage',
403                 'open-ils.storage.direct.asset.copy.retrieve', $copyid );
404
405         if(!$copy) { $evt = OpenILS::Event->new('COPY_NOT_FOUND'); }
406
407         return( $copy, $evt );
408 }
409
410
411 # retrieves a circ object by id
412 sub fetch_circulation {
413         my( $self, $circid ) = @_;
414         my $circ; my $evt;
415         
416         $logger->debug("Fetching circ $circid from storage");
417
418         $circ = $self->simplereq(
419                 'open-ils.storage',
420                 "open-ils.storage.direct.action.circulation.retrieve", $circid );
421
422         if(!$circ) {
423                 $evt = OpenILS::Event->new('CIRCULATION_NOT_FOUND', circid => $circid );
424         }
425
426         return ( $circ, $evt );
427 }
428
429 sub fetch_record_by_copy {
430         my( $self, $copyid ) = @_;
431         my( $record, $evt );
432
433         $logger->debug("Fetching record by copy $copyid from storage");
434
435         $record = $self->simplereq(
436                 'open-ils.storage',
437                 'open-ils.storage.fleshed.biblio.record_entry.retrieve_by_copy', $copyid );
438
439         if(!$record) {
440                 $evt = OpenILS::Event->new('BIBLIO_RECORD_NOT_FOUND');
441         }
442
443         return ($record, $evt);
444 }
445
446 # turns a record object into an mvr (mods) object
447 sub record_to_mvr {
448         my( $self, $record ) = @_;
449         my $u = OpenILS::Utils::ModsParser->new();
450         $u->start_mods_batch( $record->marc );
451         my $mods = $u->finish_mods_batch();
452         $mods->doc_id($record->id);
453         return $mods;
454 }
455
456 sub fetch_hold {
457         my( $self, $holdid ) = @_;
458         my( $hold, $evt );
459
460         $logger->debug("Fetching hold $holdid from storage");
461
462         $hold = $self->simplereq(
463                 'open-ils.storage',
464                 'open-ils.storage.direct.action.hold_request.retrieve', $holdid);
465
466         $evt = OpenILS::Event->new('HOLD_NOT_FOUND', holdid => $holdid) unless $hold;
467
468         return ($hold, $evt);
469 }
470
471
472 sub fetch_hold_transit_by_hold {
473         my( $self, $holdid ) = @_;
474         my( $transit, $evt );
475
476         $logger->debug("Fetching transit by hold $holdid from storage");
477
478         $transit = $self->simplereq(
479                 'open-ils.storage',
480                 'open-ils.storage.direct.action.hold_transit_copy.search.hold', $holdid );
481
482         $evt = OpenILS::Event->new('HOLD_TRANSIT_NOT_FOUND', holdid => $holdid) unless $transit;
483
484         return ($transit, $evt );
485 }
486
487 # fetches the captured, but not fulfilled hold attached to a given copy
488 sub fetch_open_hold_by_copy {
489         my( $self, $copyid ) = @_;
490         $logger->debug("Searching for active hold for copy $copyid");
491         my( $hold, $evt );
492
493         $hold = $self->storagereq(
494                 'open-ils.storage.direct.action.hold_request.search_where',
495                 { 
496                         current_copy            => $copyid , 
497                         capture_time            => { "!=" => undef }, 
498                         fulfillment_time        => undef 
499                 } );
500
501         $evt = OpenILS::Event->new('HOLD_NOT_FOUND', copyid => $copyid) unless $hold;
502         return ($hold, $evt);
503 }
504
505 sub fetch_hold_transit {
506         my( $self, $transid ) = @_;
507         my( $htransit, $evt );
508         $logger->debug("Fetching hold transit with hold id $transid");
509         $htransit = $self->storagereq(
510                 'open-ils.storage.direct.action.hold_transit_copy.retrieve', $transid );
511         $evt = OpenILS::Event->new('HOLD_TRANSIT_NOT_FOUND', id => $transid) unless $htransit;
512         return ($htransit, $evt);
513 }
514
515 sub fetch_copy_by_barcode {
516         my( $self, $barcode ) = @_;
517         my( $copy, $evt );
518
519         $logger->debug("Fetching copy by barcode $barcode from storage");
520
521         $copy = $self->simplereq( 'open-ils.storage',
522                 'open-ils.storage.direct.asset.copy.search.barcode', $barcode );
523
524         $evt = OpenILS::Event->new('COPY_NOT_FOUND', barcode => $barcode) unless $copy;
525
526         return ($copy, $evt);
527 }
528
529 sub fetch_open_billable_transaction {
530         my( $self, $transid ) = @_;
531         my( $transaction, $evt );
532
533         $logger->debug("Fetching open billable transaction $transid from storage");
534
535         $transaction = $self->simplereq(
536                 'open-ils.storage',
537                 'open-ils.storage.direct.money.open_billable_transaction_summary.retrieve',  $transid);
538
539         $evt = OpenILS::Event->new(
540                 'TRANSACTION_NOT_FOUND', transid => $transid ) unless $transaction;
541
542         return ($transaction, $evt);
543 }
544
545
546
547 my %buckets;
548 $buckets{'biblio'} = 'biblio_record_entry_bucket';
549 $buckets{'callnumber'} = 'call_number_bucket';
550 $buckets{'copy'} = 'copy_bucket';
551 $buckets{'user'} = 'user_bucket';
552
553 sub fetch_container {
554         my( $self, $id, $type ) = @_;
555         my( $bucket, $evt );
556
557         $logger->debug("Fetching container $id with type $type");
558
559         my $meth = $buckets{$type};
560         $bucket = $self->simplereq(
561                 'open-ils.storage',
562                 "open-ils.storage.direct.container.$meth.retrieve", $id );
563
564         $evt = OpenILS::Event->new(
565                 'CONTAINER_NOT_FOUND', container => $id, 
566                         container_type => $type ) unless $bucket;
567
568         return ($bucket, $evt);
569 }
570
571
572 sub fetch_container_item {
573         my( $self, $id, $type ) = @_;
574         my( $bucket, $evt );
575
576         $logger->debug("Fetching container item $id with type $type");
577
578         my $meth = $buckets{$type} . "_item";
579
580         $bucket = $self->simplereq(
581                 'open-ils.storage',
582                 "open-ils.storage.direct.container.$meth.retrieve", $id );
583
584         $evt = OpenILS::Event->new(
585                 'CONTAINER_ITEM_NOT_FOUND', itemid => $id, 
586                         container_type => $type ) unless $bucket;
587
588         return ($bucket, $evt);
589 }
590
591
592 sub fetch_patron_standings {
593         my $self = shift;
594         $logger->debug("Fetching patron standings");    
595         return $self->simplereq(
596                 'open-ils.storage', 
597                 'open-ils.storage.direct.config.standing.retrieve.all.atomic');
598 }
599
600
601 sub fetch_permission_group_tree {
602         my $self = shift;
603         $logger->debug("Fetching patron profiles");     
604         return $self->simplereq(
605                 'open-ils.actor', 
606                 'open-ils.actor.groups.tree.retrieve' );
607 }
608
609
610 sub fetch_patron_circ_summary {
611         my( $self, $userid ) = @_;
612         $logger->debug("Fetching patron summary for $userid");
613         my $summary = $self->simplereq(
614                 'open-ils.storage', 
615                 "open-ils.storage.action.circulation.patron_summary", $userid );
616
617         if( $summary ) {
618                 $summary->[0] ||= 0;
619                 $summary->[1] ||= 0.0;
620                 return $summary;
621         }
622         return undef;
623 }
624
625
626 sub fetch_copy_statuses {
627         my( $self ) = @_;
628         $logger->debug("Fetching copy statuses");
629         return $self->simplereq(
630                 'open-ils.storage', 
631                 'open-ils.storage.direct.config.copy_status.retrieve.all.atomic' );
632 }
633
634 sub fetch_copy_location {
635         my( $self, $id ) = @_;
636         my $evt;
637         my $cl = $self->storagereq(
638                 'open-ils.storage.direct.asset.copy_location.retrieve', $id );
639         $evt = OpenILS::Event->new('COPY_LOCATION_NOT_FOUND') unless $cl;
640         return ($cl, $evt);
641 }
642
643 sub fetch_copy_locations {
644         my $self = shift; 
645         return $self->simplereq(
646                 'open-ils.storage', 
647                 'open-ils.storage.direct.asset.copy_location.retrieve.all.atomic');
648 }
649
650 sub fetch_copy_location_by_name {
651         my( $self, $name, $org ) = @_;
652         my $evt;
653         my $cl = $self->storagereq(
654                 'open-ils.storage.direct.asset.copy_location.search_where',
655                         { name => $name, owning_lib => $org } );
656         $evt = OpenILS::Event->new('COPY_LOCATION_NOT_FOUND') unless $cl;
657         return ($cl, $evt);
658 }
659
660 sub fetch_callnumber {
661         my( $self, $id ) = @_;
662         my $evt = undef;
663         $logger->debug("Fetching callnumber $id");
664
665         my $cn = $self->simplereq(
666                 'open-ils.storage',
667                 'open-ils.storage.direct.asset.call_number.retrieve', $id );
668         $evt = OpenILS::Event->new( 'VOLUME_NOT_FOUND', id => $id ) unless $cn;
669
670         return ( $cn, $evt );
671 }
672
673 sub fetch_org_unit {
674         my( $self, $id ) = @_;
675         return $id if( ref($id) eq 'Fieldmapper::actor::org_unit' );
676         $logger->debug("Fetching org unit $id");
677         my $evt = undef;
678
679         my $org = $self->simplereq(
680                 'open-ils.storage', 
681                 'open-ils.storage.direct.actor.org_unit.retrieve', $id );
682         $evt = OpenILS::Event->new( 'ORG_UNIT_NOT_FOUND', id => $id ) unless $org;
683
684         return ($org, $evt);
685 }
686
687 sub fetch_stat_cat {
688         my( $self, $type, $id ) = @_;
689         my( $cat, $evt );
690         $logger->debug("Fetching $type stat cat: $id");
691         $cat = $self->simplereq(
692                 'open-ils.storage', 
693                 "open-ils.storage.direct.$type.stat_cat.retrieve", $id );
694         $evt = OpenILS::Event->new( 'STAT_CAT_NOT_FOUND', id => $id ) unless $cat;
695         return ( $cat, $evt );
696 }
697
698 sub fetch_stat_cat_entry {
699         my( $self, $type, $id ) = @_;
700         my( $entry, $evt );
701         $logger->debug("Fetching $type stat cat entry: $id");
702         $entry = $self->simplereq(
703                 'open-ils.storage', 
704                 "open-ils.storage.direct.$type.stat_cat_entry.retrieve", $id );
705         $evt = OpenILS::Event->new( 'STAT_CAT_ENTRY_NOT_FOUND', id => $id ) unless $entry;
706         return ( $entry, $evt );
707 }
708
709
710 sub find_org {
711         my( $self, $org_tree, $orgid )  = @_;
712         return $org_tree if ( $org_tree->id eq $orgid );
713         return undef unless ref($org_tree->children);
714         for my $c (@{$org_tree->children}) {
715                 my $o = $self->find_org($c, $orgid);
716                 return $o if $o;
717         }
718         return undef;
719 }
720
721 sub fetch_non_cat_type_by_name_and_org {
722         my( $self, $name, $orgId ) = @_;
723         $logger->debug("Fetching non cat type $name at org $orgId");
724         my $types = $self->simplereq(
725                 'open-ils.storage',
726                 'open-ils.storage.direct.config.non_cataloged_type.search_where.atomic',
727                 { name => $name, owning_lib => $orgId } );
728         return ($types->[0], undef) if($types and @$types);
729         return (undef, OpenILS::Event->new('NON_CAT_TYPE_NOT_FOUND') );
730 }
731
732 sub fetch_non_cat_type {
733         my( $self, $id ) = @_;
734         $logger->debug("Fetching non cat type $id");
735         my( $type, $evt );
736         $type = $self->simplereq(
737                 'open-ils.storage', 
738                 'open-ils.storage.direct.config.non_cataloged_type.retrieve', $id );
739         $evt = OpenILS::Event->new('NON_CAT_TYPE_NOT_FOUND') unless $type;
740         return ($type, $evt);
741 }
742
743 sub DB_UPDATE_FAILED { 
744         my( $self, $payload ) = @_;
745         return OpenILS::Event->new('DATABASE_UPDATE_FAILED', 
746                 payload => ($payload) ? $payload : undef ); 
747 }
748
749 sub fetch_circ_duration_by_name {
750         my( $self, $name ) = @_;
751         my( $dur, $evt );
752         $dur = $self->simplereq(
753                 'open-ils.storage', 
754                 'open-ils.storage.direct.config.rules.circ_duration.search.name.atomic', $name );
755         $dur = $dur->[0];
756         $evt = OpenILS::Event->new('CIRC_DURATION_NOT_FOUND') unless $dur;
757         return ($dur, $evt);
758 }
759
760 sub fetch_recurring_fine_by_name {
761         my( $self, $name ) = @_;
762         my( $obj, $evt );
763         $obj = $self->simplereq(
764                 'open-ils.storage', 
765                 'open-ils.storage.direct.config.rules.recuring_fine.search.name.atomic', $name );
766         $obj = $obj->[0];
767         $evt = OpenILS::Event->new('RECURRING_FINE_NOT_FOUND') unless $obj;
768         return ($obj, $evt);
769 }
770
771 sub fetch_max_fine_by_name {
772         my( $self, $name ) = @_;
773         my( $obj, $evt );
774         $obj = $self->simplereq(
775                 'open-ils.storage', 
776                 'open-ils.storage.direct.config.rules.max_fine.search.name.atomic', $name );
777         $obj = $obj->[0];
778         $evt = OpenILS::Event->new('MAX_FINE_NOT_FOUND') unless $obj;
779         return ($obj, $evt);
780 }
781
782 sub storagereq {
783         my( $self, $method, @params ) = @_;
784         return $self->simplereq(
785                 'open-ils.storage', $method, @params );
786 }
787
788 sub event_equals {
789         my( $self, $e, $name ) =  @_;
790         if( $e and ref($e) eq 'HASH' and 
791                 defined($e->{textcode}) and $e->{textcode} eq $name ) {
792                 return 1 ;
793         }
794         return 0;
795 }
796
797 sub logmark {
798         my( undef, $f, $l ) = caller(0);
799         my( undef, undef, undef, $s ) = caller(1);
800         $s =~ s/.*:://g;
801         $f =~ s/.*\///g;
802         $logger->debug("LOGMARK: $f:$l:$s");
803 }
804
805 # takes a copy id 
806 sub fetch_open_circulation {
807         my( $self, $cid ) = @_;
808         my $evt;
809         $self->logmark;
810         my $circ = $self->storagereq(
811                 'open-ils.storage.direct.action.open_circulation.search_where',
812                 { target_copy => $cid, stop_fines_time => undef } );
813         $evt = OpenILS::Event->new('CIRCULATION_NOT_FOUND') unless $circ;       
814         return ($circ, $evt);
815 }
816
817 my $copy_statuses;
818 sub copy_status_from_name {
819         my( $self, $name ) = @_;
820         $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
821         for my $status (@$copy_statuses) { 
822                 return $status if( $status->name =~ /$name/i );
823         }
824         return undef;
825 }
826
827 sub copy_status_to_name {
828         my( $self, $sid ) = @_;
829         $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
830         for my $status (@$copy_statuses) { 
831                 return $status->name if( $status->id == $sid );
832         }
833         return undef;
834 }
835
836 sub fetch_open_transit_by_copy {
837         my( $self, $copyid ) = @_;
838         my($transit, $evt);
839         $transit = $self->storagereq(
840                 'open-ils.storage.direct.action.transit_copy.search_where',
841                 { target_copy => $copyid, dest_recv_time => undef });
842         $evt = OpenILS::Event->new('TRANSIT_NOT_FOUND') unless $transit;
843         return ($transit, $evt);
844 }
845
846 sub unflesh_copy {
847         my( $self, $copy ) = @_;
848         return undef unless $copy;
849         $copy->status( $copy->status->id ) if ref($copy->status);
850         $copy->location( $copy->location->id ) if ref($copy->location);
851         $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
852         return $copy;
853 }
854
855 # un-fleshes a copy and updates it in the DB
856 # returns a DB_UPDATE_FAILED event on error
857 # returns undef on success
858 sub update_copy {
859         my( $self, %params ) = @_;
860
861         my $copy                = $params{copy} || die "update_copy(): copy required";
862         my $editor      = $params{editor} || die "update_copy(): copy editor required";
863         my $session = $params{session};
864
865         $logger->debug("Updating copy in the database: " . $copy->id);
866
867         $self->unflesh_copy($copy);
868         $copy->editor( $editor );
869         $copy->edit_date( 'now' );
870
871         my $s;
872         my $meth = 'open-ils.storage.direct.asset.copy.update';
873
874         $s = $session->request( $meth, $copy )->gather(1) if $session;
875         $s = $self->storagereq( $meth, $copy );
876
877         $logger->debug("Update of copy ".$copy->id." returned: $s");
878
879         return $self->DB_UPDATE_FAILED($copy) unless $s;
880         return undef;
881 }
882
883 sub fetch_billable_xact {
884         my( $self, $id ) = @_;
885         my($xact, $evt);
886         $logger->debug("Fetching billable transaction %id");
887         $xact = $self->storagereq(
888                 'open-ils.storage.direct.money.billable_transaction.retrieve', $id );
889         $evt = OpenILS::Event->new('TRANSACTION_NOT_FOUND') unless $xact;
890         return ($xact, $evt);
891 }
892
893
894 sub fetch_fleshed_copy {
895         my( $self, $id ) = @_;
896         my( $copy, $evt );
897         $logger->info("Fetching fleshed copy $id");
898         $copy = $self->storagereq(
899                 "open-ils.storage.fleshed.asset.copy.retrieve", $id );
900         $evt = OpenILS::Event->new('COPY_NOT_FOUND', id => $id) unless $copy;
901         return ($copy, $evt);
902 }
903
904 1;
905