1 package OpenILS::Application::AppUtils;
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);
12 use OpenILS::Utils::CStoreEditor;
13 use OpenILS::Const qw/:const/;
14 use Unicode::Normalize;
15 use OpenSRF::Utils::SettingsClient;
19 # ---------------------------------------------------------------------------
20 # Pile of utilty methods used accross applications.
21 # ---------------------------------------------------------------------------
22 my $cache_client = "OpenSRF::Utils::Cache";
25 # ---------------------------------------------------------------------------
26 # on sucess, returns the created session, on failure throws ERROR exception
27 # ---------------------------------------------------------------------------
28 sub start_db_session {
31 my $session = OpenSRF::AppSession->connect( "open-ils.storage" );
32 my $trans_req = $session->request( "open-ils.storage.transaction.begin" );
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() ) {
38 ("Unable to Begin Transaction with database" );
42 $logger->debug("Setting global storage session to ".
43 "session: " . $session->session_id . " : " . $session->app );
51 transform => 'permission.usr_has_perm',
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");
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});
76 # checks the list of user perms. The first one that fails returns a new
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;
86 # ---------------------------------------------------------------------------
87 # commits and destroys the session
88 # ---------------------------------------------------------------------------
89 sub commit_db_session {
90 my( $self, $session ) = @_;
92 my $req = $session->request( "open-ils.storage.transaction.commit" );
93 my $resp = $req->recv();
96 throw OpenSRF::EX::ERROR ("Unable to commit db session");
99 if(UNIVERSAL::isa($resp,"Error")) {
100 throw $resp ($resp->stringify);
103 if(!$resp->content) {
104 throw OpenSRF::EX::ERROR ("Unable to commit db session");
108 $session->disconnect();
112 sub rollback_db_session {
113 my( $self, $session ) = @_;
115 my $req = $session->request("open-ils.storage.transaction.rollback");
116 my $resp = $req->recv();
117 if(UNIVERSAL::isa($resp,"Error")) { throw $resp; }
120 $session->disconnect();
125 # returns undef it the event is not an ILS event
126 # returns the event code otherwise
128 my( $self, $evt ) = @_;
129 return $evt->{ilsevent} if( ref($evt) eq 'HASH' and defined($evt->{ilsevent})) ;
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 ) = @_;
140 my $content = $self->simplereq(
142 'open-ils.auth.session.retrieve', $user_session);
144 return undef if (!$content) or $self->event_code($content);
148 # generic simple request returning a scalar value
150 my($self, $service, $method, @params) = @_;
151 return $self->simple_scalar_request($service, $method, @params);
155 sub simple_scalar_request {
156 my($self, $service, $method, @params) = @_;
158 my $session = OpenSRF::AppSession->create( $service );
160 my $request = $session->request( $method, @params );
166 $val = $request->gather(1);
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 : " );
186 my $org_typelist = undef;
187 my $org_typelist_hash = {};
191 # can we throw this version away??
194 if($tree) { return $tree; }
196 # see if it's in the cache
197 $tree = $cache_client->new()->get_cache('_orgtree');
198 if($tree) { return $tree; }
201 warn "Retrieving Org Tree\n";
202 $orglist = $self->simple_scalar_request(
204 "open-ils.cstore.direct.actor.org_unit.search.atomic",
205 { id => { '!=' => undef } }
209 if( ! $org_typelist ) {
210 warn "Retrieving org types\n";
211 $org_typelist = $self->simple_scalar_request(
213 "open-ils.cstore.direct.actor.org_unit_type.search.atomic",
214 { id => { '!=' => undef } }
216 $self->build_org_type($org_typelist);
219 $tree = $self->build_org_tree($orglist,1);
220 $cache_client->new()->put_cache('_orgtree', $tree);
225 my $slimtree = undef;
226 sub get_slim_org_tree {
229 if($slimtree) { return $slimtree; }
231 # see if it's in the cache
232 $slimtree = $cache_client->new()->get_cache('slimorgtree');
233 if($slimtree) { return $slimtree; }
236 warn "Retrieving Org Tree\n";
237 $orglist = $self->simple_scalar_request(
239 "open-ils.cstore.direct.actor.org_unit.search.atomic",
240 { id => { '!=' => undef } }
244 $slimtree = $self->build_org_tree($orglist);
245 $cache_client->new->put_cache('slimorgtree', $slimtree);
252 my($self, $org_typelist) = @_;
253 for my $type (@$org_typelist) {
254 $org_typelist_hash->{$type->id()} = $type;
262 my( $self, $orglist, $add_types ) = @_;
264 return $orglist unless ref $orglist;
265 return $$orglist[0] if @$orglist == 1;
268 $a->ou_type <=> $b->ou_type ||
269 $a->name cmp $b->name } @$orglist;
271 for my $org (@list) {
275 if(!ref($org->ou_type()) and $add_types) {
276 $org->ou_type( $org_typelist_hash->{$org->ou_type()});
279 next unless (defined($org->parent_ou));
281 my ($parent) = grep { $_->id == $org->parent_ou } @list;
283 $parent->children([]) unless defined($parent->children);
284 push( @{$parent->children}, $org );
290 sub fetch_closed_date {
291 my( $self, $cd ) = @_;
294 $logger->debug("Fetching closed_date $cd from cstore");
296 my $cd_obj = $self->simplereq(
298 'open-ils.cstore.direct.actor.org_unit.closed_date.retrieve', $cd );
301 $logger->info("closed_date $cd not found in the db");
302 $evt = OpenILS::Event->new('ACTOR_USER_NOT_FOUND');
305 return ($cd_obj, $evt);
309 my( $self, $userid ) = @_;
312 $logger->debug("Fetching user $userid from cstore");
314 $user = $self->simplereq(
316 'open-ils.cstore.direct.actor.user.retrieve', $userid );
319 $logger->info("User $userid not found in the db");
320 $evt = OpenILS::Event->new('ACTOR_USER_NOT_FOUND');
323 return ($user, $evt);
327 my( $self, $session ) = @_;
328 my $user = $self->check_user_session($session) or
329 return (undef, OpenILS::Event->new('NO_SESSION'));
334 # verifiese the session and checks the permissions agains the
335 # session user and the user's home_ou as the org id
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);
348 my( $self, $staffobj, $userid, @perms ) = @_;
350 $userid = $staffobj->id unless defined $userid;
352 $logger->debug("checkrequestor(): requestor => " . $staffobj->id . ", target => $userid");
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 );
363 return ($user, $evt);
366 sub checkses_requestor {
367 my( $self, $authtoken, $targetid, @perms ) = @_;
368 my( $requestor, $target, $evt );
370 ($requestor, $evt) = $self->checkses($authtoken);
371 return (undef, undef, $evt) if $evt;
373 ($target, $evt) = $self->checkrequestor( $requestor, $targetid, @perms );
374 return( $requestor, $target, $evt);
378 my( $self, $copyid ) = @_;
381 $logger->debug("Fetching copy $copyid from cstore");
383 $copy = $self->simplereq(
385 'open-ils.cstore.direct.asset.copy.retrieve', $copyid );
387 if(!$copy) { $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND'); }
389 return( $copy, $evt );
393 # retrieves a circ object by id
394 sub fetch_circulation {
395 my( $self, $circid ) = @_;
398 $logger->debug("Fetching circ $circid from cstore");
400 $circ = $self->simplereq(
402 "open-ils.cstore.direct.action.circulation.retrieve", $circid );
405 $evt = OpenILS::Event->new('ACTION_CIRCULATION_NOT_FOUND', circid => $circid );
408 return ( $circ, $evt );
411 sub fetch_record_by_copy {
412 my( $self, $copyid ) = @_;
415 $logger->debug("Fetching record by copy $copyid from cstore");
417 $record = $self->simplereq(
419 'open-ils.cstore.direct.asset.copy.retrieve', $copyid,
421 flesh_fields => { bre => [ 'fixed_fields' ],
423 acp => [ 'call_number' ],
429 $evt = OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND');
431 $record = $record->call_number->record;
434 return ($record, $evt);
437 # turns a record object into an mvr (mods) object
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);
450 my( $self, $holdid ) = @_;
453 $logger->debug("Fetching hold $holdid from cstore");
455 $hold = $self->simplereq(
457 'open-ils.cstore.direct.action.hold_request.retrieve', $holdid);
459 $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND', holdid => $holdid) unless $hold;
461 return ($hold, $evt);
465 sub fetch_hold_transit_by_hold {
466 my( $self, $holdid ) = @_;
467 my( $transit, $evt );
469 $logger->debug("Fetching transit by hold $holdid from cstore");
471 $transit = $self->simplereq(
473 'open-ils.cstore.direct.action.hold_transit_copy.search', { hold => $holdid } );
475 $evt = OpenILS::Event->new('ACTION_HOLD_TRANSIT_COPY_NOT_FOUND', holdid => $holdid) unless $transit;
477 return ($transit, $evt );
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");
486 $hold = $self->cstorereq(
487 'open-ils.cstore.direct.action.hold_request.search',
489 current_copy => $copyid ,
490 capture_time => { "!=" => undef },
491 fulfillment_time => undef,
492 cancel_time => undef,
495 $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND', copyid => $copyid) unless $hold;
496 return ($hold, $evt);
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);
509 sub fetch_copy_by_barcode {
510 my( $self, $barcode ) = @_;
513 $logger->debug("Fetching copy by barcode $barcode from cstore");
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 );
519 $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', barcode => $barcode) unless $copy;
521 return ($copy, $evt);
524 sub fetch_open_billable_transaction {
525 my( $self, $transid ) = @_;
526 my( $transaction, $evt );
528 $logger->debug("Fetching open billable transaction $transid from cstore");
530 $transaction = $self->simplereq(
532 'open-ils.cstore.direct.money.open_billable_transaction_summary.retrieve', $transid);
534 $evt = OpenILS::Event->new(
535 'MONEY_OPEN_BILLABLE_TRANSACTION_SUMMARY_NOT_FOUND', transid => $transid ) unless $transaction;
537 return ($transaction, $evt);
543 $buckets{'biblio'} = 'biblio_record_entry_bucket';
544 $buckets{'callnumber'} = 'call_number_bucket';
545 $buckets{'copy'} = 'copy_bucket';
546 $buckets{'user'} = 'user_bucket';
548 sub fetch_container {
549 my( $self, $id, $type ) = @_;
552 $logger->debug("Fetching container $id with type $type");
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';
559 my $meth = $buckets{$type};
560 $bucket = $self->simplereq(
562 "open-ils.cstore.direct.container.$meth.retrieve", $id );
564 $evt = OpenILS::Event->new(
565 $e, container => $id, container_type => $type ) unless $bucket;
567 return ($bucket, $evt);
571 sub fetch_container_e {
572 my( $self, $editor, $id, $type ) = @_;
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';
580 $evt = $editor->event unless $bucket;
581 return ($bucket, $evt);
584 sub fetch_container_item_e {
585 my( $self, $editor, $id, $type ) = @_;
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';
593 $evt = $editor->event unless $bucket;
594 return ($bucket, $evt);
601 sub fetch_container_item {
602 my( $self, $id, $type ) = @_;
605 $logger->debug("Fetching container item $id with type $type");
607 my $meth = $buckets{$type} . "_item";
609 $bucket = $self->simplereq(
611 "open-ils.cstore.direct.container.$meth.retrieve", $id );
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';
619 $evt = OpenILS::Event->new(
620 $e, itemid => $id, container_type => $type ) unless $bucket;
622 return ($bucket, $evt);
626 sub fetch_patron_standings {
628 $logger->debug("Fetching patron standings");
629 return $self->simplereq(
631 'open-ils.cstore.direct.config.standing.search.atomic', { id => { '!=' => undef } });
635 sub fetch_permission_group_tree {
637 $logger->debug("Fetching patron profiles");
638 return $self->simplereq(
640 'open-ils.actor.groups.tree.retrieve' );
644 sub fetch_patron_circ_summary {
645 my( $self, $userid ) = @_;
646 $logger->debug("Fetching patron summary for $userid");
647 my $summary = $self->simplereq(
649 "open-ils.storage.action.circulation.patron_summary", $userid );
653 $summary->[1] ||= 0.0;
660 sub fetch_copy_statuses {
662 $logger->debug("Fetching copy statuses");
663 return $self->simplereq(
665 'open-ils.cstore.direct.config.copy_status.search.atomic', { id => { '!=' => undef } });
668 sub fetch_copy_location {
669 my( $self, $id ) = @_;
671 my $cl = $self->cstorereq(
672 'open-ils.cstore.direct.asset.copy_location.retrieve', $id );
673 $evt = OpenILS::Event->new('ASSET_COPY_LOCATION_NOT_FOUND') unless $cl;
677 sub fetch_copy_locations {
679 return $self->simplereq(
681 'open-ils.cstore.direct.asset.copy_location.search.atomic', { id => { '!=' => undef } });
684 sub fetch_copy_location_by_name {
685 my( $self, $name, $org ) = @_;
687 my $cl = $self->cstorereq(
688 'open-ils.cstore.direct.asset.copy_location.search',
689 { name => $name, owning_lib => $org } );
690 $evt = OpenILS::Event->new('ASSET_COPY_LOCATION_NOT_FOUND') unless $cl;
694 sub fetch_callnumber {
695 my( $self, $id ) = @_;
698 my $e = OpenILS::Event->new( 'ASSET_CALL_NUMBER_NOT_FOUND', id => $id );
699 return( undef, $e ) unless $id;
701 $logger->debug("Fetching callnumber $id");
703 my $cn = $self->simplereq(
705 'open-ils.cstore.direct.asset.call_number.retrieve', $id );
706 $evt = $e unless $cn;
708 return ( $cn, $evt );
711 my %ORG_CACHE; # - these rarely change, so cache them..
713 my( $self, $id ) = @_;
714 return undef unless $id;
715 return $id if( ref($id) eq 'Fieldmapper::actor::org_unit' );
716 return $ORG_CACHE{$id} if $ORG_CACHE{$id};
717 $logger->debug("Fetching org unit $id");
720 my $org = $self->simplereq(
722 'open-ils.cstore.direct.actor.org_unit.retrieve', $id );
723 $evt = OpenILS::Event->new( 'ACTOR_ORG_UNIT_NOT_FOUND', id => $id ) unless $org;
724 $ORG_CACHE{$id} = $org;
730 my( $self, $type, $id ) = @_;
732 $logger->debug("Fetching $type stat cat: $id");
733 $cat = $self->simplereq(
735 "open-ils.cstore.direct.$type.stat_cat.retrieve", $id );
737 my $e = 'ASSET_STAT_CAT_NOT_FOUND';
738 $e = 'ACTOR_STAT_CAT_NOT_FOUND' if $type eq 'actor';
740 $evt = OpenILS::Event->new( $e, id => $id ) unless $cat;
741 return ( $cat, $evt );
744 sub fetch_stat_cat_entry {
745 my( $self, $type, $id ) = @_;
747 $logger->debug("Fetching $type stat cat entry: $id");
748 $entry = $self->simplereq(
750 "open-ils.cstore.direct.$type.stat_cat_entry.retrieve", $id );
752 my $e = 'ASSET_STAT_CAT_ENTRY_NOT_FOUND';
753 $e = 'ACTOR_STAT_CAT_ENTRY_NOT_FOUND' if $type eq 'actor';
755 $evt = OpenILS::Event->new( $e, id => $id ) unless $entry;
756 return ( $entry, $evt );
761 my( $self, $org_tree, $orgid ) = @_;
762 return undef unless $org_tree and defined $orgid;
763 return $org_tree if ( $org_tree->id eq $orgid );
764 return undef unless ref($org_tree->children);
765 for my $c (@{$org_tree->children}) {
766 my $o = $self->find_org($c, $orgid);
772 sub fetch_non_cat_type_by_name_and_org {
773 my( $self, $name, $orgId ) = @_;
774 $logger->debug("Fetching non cat type $name at org $orgId");
775 my $types = $self->simplereq(
777 'open-ils.cstore.direct.config.non_cataloged_type.search.atomic',
778 { name => $name, owning_lib => $orgId } );
779 return ($types->[0], undef) if($types and @$types);
780 return (undef, OpenILS::Event->new('CONFIG_NON_CATALOGED_TYPE_NOT_FOUND') );
783 sub fetch_non_cat_type {
784 my( $self, $id ) = @_;
785 $logger->debug("Fetching non cat type $id");
787 $type = $self->simplereq(
789 'open-ils.cstore.direct.config.non_cataloged_type.retrieve', $id );
790 $evt = OpenILS::Event->new('CONFIG_NON_CATALOGED_TYPE_NOT_FOUND') unless $type;
791 return ($type, $evt);
794 sub DB_UPDATE_FAILED {
795 my( $self, $payload ) = @_;
796 return OpenILS::Event->new('DATABASE_UPDATE_FAILED',
797 payload => ($payload) ? $payload : undef );
800 sub fetch_booking_reservation {
801 my( $self, $id ) = @_;
804 $res = $self->simplereq(
806 'open-ils.cstore.direct.booking.reservation.retrieve', $id
809 # simplereq doesn't know how to flesh so ...
814 'open-ils.cstore.direct.actor.user.retrieve', $res->usr
818 $res->target_resource_type(
821 'open-ils.cstore.direct.booking.resource_type.retrieve', $res->target_resource_type
825 if ($res->current_resource) {
826 $res->current_resource(
829 'open-ils.cstore.direct.booking.resource.retrieve', $res->current_resource
833 if ($self->is_true( $res->target_resource_type->catalog_item )) {
834 $res->current_resource->catalog_item( $self->fetch_copy_by_barcode( $res->current_resource->barcode ) );
838 if ($res->target_resource) {
839 $res->target_resource(
842 'open-ils.cstore.direct.booking.resource.retrieve', $res->target_resource
846 if ($self->is_true( $res->target_resource_type->catalog_item )) {
847 $res->target_resource->catalog_item( $self->fetch_copy_by_barcode( $res->target_resource->barcode ) );
852 $evt = OpenILS::Event->new('RESERVATION_NOT_FOUND');
858 sub fetch_circ_duration_by_name {
859 my( $self, $name ) = @_;
861 $dur = $self->simplereq(
863 'open-ils.cstore.direct.config.rules.circ_duration.search.atomic', { name => $name } );
865 $evt = OpenILS::Event->new('CONFIG_RULES_CIRC_DURATION_NOT_FOUND') unless $dur;
869 sub fetch_recurring_fine_by_name {
870 my( $self, $name ) = @_;
872 $obj = $self->simplereq(
874 'open-ils.cstore.direct.config.rules.recurring_fine.search.atomic', { name => $name } );
876 $evt = OpenILS::Event->new('CONFIG_RULES_RECURRING_FINE_NOT_FOUND') unless $obj;
880 sub fetch_max_fine_by_name {
881 my( $self, $name ) = @_;
883 $obj = $self->simplereq(
885 'open-ils.cstore.direct.config.rules.max_fine.search.atomic', { name => $name } );
887 $evt = OpenILS::Event->new('CONFIG_RULES_MAX_FINE_NOT_FOUND') unless $obj;
892 my( $self, $method, @params ) = @_;
893 return $self->simplereq(
894 'open-ils.storage', $method, @params );
897 sub storagereq_xact {
898 my($self, $method, @params) = @_;
899 my $ses = $self->start_db_session();
900 my $val = $ses->request($method, @params)->gather(1);
901 $self->rollback_db_session($ses);
906 my( $self, $method, @params ) = @_;
907 return $self->simplereq(
908 'open-ils.cstore', $method, @params );
912 my( $self, $e, $name ) = @_;
913 if( $e and ref($e) eq 'HASH' and
914 defined($e->{textcode}) and $e->{textcode} eq $name ) {
921 my( undef, $f, $l ) = caller(0);
922 my( undef, undef, undef, $s ) = caller(1);
925 $logger->debug("LOGMARK: $f:$l:$s");
929 sub fetch_open_circulation {
930 my( $self, $cid ) = @_;
933 my $circ = $self->cstorereq(
934 'open-ils.cstore.direct.action.open_circulation.search',
935 { target_copy => $cid, stop_fines_time => undef } );
936 $evt = OpenILS::Event->new('ACTION_CIRCULATION_NOT_FOUND') unless $circ;
937 return ($circ, $evt);
940 sub fetch_all_open_circulation {
941 my( $self, $cid ) = @_;
944 my $circ = $self->cstorereq(
945 'open-ils.cstore.direct.action.open_circulation.search',
946 { target_copy => $cid, xact_finish => undef } );
947 $evt = OpenILS::Event->new('ACTION_CIRCULATION_NOT_FOUND') unless $circ;
948 return ($circ, $evt);
952 sub copy_status_from_name {
953 my( $self, $name ) = @_;
954 $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
955 for my $status (@$copy_statuses) {
956 return $status if( $status->name =~ /$name/i );
961 sub copy_status_to_name {
962 my( $self, $sid ) = @_;
963 $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
964 for my $status (@$copy_statuses) {
965 return $status->name if( $status->id == $sid );
972 my( $self, $arg ) = @_;
973 return $arg if ref $arg;
974 $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
975 my ($stat) = grep { $_->id == $arg } @$copy_statuses;
979 sub fetch_open_transit_by_copy {
980 my( $self, $copyid ) = @_;
982 $transit = $self->cstorereq(
983 'open-ils.cstore.direct.action.transit_copy.search',
984 { target_copy => $copyid, dest_recv_time => undef });
985 $evt = OpenILS::Event->new('ACTION_TRANSIT_COPY_NOT_FOUND') unless $transit;
986 return ($transit, $evt);
990 my( $self, $copy ) = @_;
991 return undef unless $copy;
992 $copy->status( $copy->status->id ) if ref($copy->status);
993 $copy->location( $copy->location->id ) if ref($copy->location);
994 $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
998 sub unflesh_reservation {
999 my( $self, $reservation ) = @_;
1000 return undef unless $reservation;
1001 $reservation->usr( $reservation->usr->id ) if ref($reservation->usr);
1002 $reservation->target_resource_type( $reservation->target_resource_type->id ) if ref($reservation->target_resource_type);
1003 $reservation->target_resource( $reservation->target_resource->id ) if ref($reservation->target_resource);
1004 $reservation->current_resource( $reservation->current_resource->id ) if ref($reservation->current_resource);
1005 return $reservation;
1008 # un-fleshes a copy and updates it in the DB
1009 # returns a DB_UPDATE_FAILED event on error
1010 # returns undef on success
1012 my( $self, %params ) = @_;
1014 my $copy = $params{copy} || die "update_copy(): copy required";
1015 my $editor = $params{editor} || die "update_copy(): copy editor required";
1016 my $session = $params{session};
1018 $logger->debug("Updating copy in the database: " . $copy->id);
1020 $self->unflesh_copy($copy);
1021 $copy->editor( $editor );
1022 $copy->edit_date( 'now' );
1025 my $meth = 'open-ils.storage.direct.asset.copy.update';
1027 $s = $session->request( $meth, $copy )->gather(1) if $session;
1028 $s = $self->storagereq( $meth, $copy ) unless $session;
1030 $logger->debug("Update of copy ".$copy->id." returned: $s");
1032 return $self->DB_UPDATE_FAILED($copy) unless $s;
1036 sub update_reservation {
1037 my( $self, %params ) = @_;
1039 my $reservation = $params{reservation} || die "update_reservation(): reservation required";
1040 my $editor = $params{editor} || die "update_reservation(): copy editor required";
1041 my $session = $params{session};
1043 $logger->debug("Updating copy in the database: " . $reservation->id);
1045 $self->unflesh_reservation($reservation);
1048 my $meth = 'open-ils.cstore.direct.booking.reservation.update';
1050 $s = $session->request( $meth, $reservation )->gather(1) if $session;
1051 $s = $self->cstorereq( $meth, $reservation ) unless $session;
1053 $logger->debug("Update of copy ".$reservation->id." returned: $s");
1055 return $self->DB_UPDATE_FAILED($reservation) unless $s;
1059 sub fetch_billable_xact {
1060 my( $self, $id ) = @_;
1062 $logger->debug("Fetching billable transaction %id");
1063 $xact = $self->cstorereq(
1064 'open-ils.cstore.direct.money.billable_transaction.retrieve', $id );
1065 $evt = OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_NOT_FOUND') unless $xact;
1066 return ($xact, $evt);
1069 sub fetch_billable_xact_summary {
1070 my( $self, $id ) = @_;
1072 $logger->debug("Fetching billable transaction summary %id");
1073 $xact = $self->cstorereq(
1074 'open-ils.cstore.direct.money.billable_transaction_summary.retrieve', $id );
1075 $evt = OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_NOT_FOUND') unless $xact;
1076 return ($xact, $evt);
1079 sub fetch_fleshed_copy {
1080 my( $self, $id ) = @_;
1082 $logger->info("Fetching fleshed copy $id");
1083 $copy = $self->cstorereq(
1084 "open-ils.cstore.direct.asset.copy.retrieve", $id,
1086 flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
1089 $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', id => $id) unless $copy;
1090 return ($copy, $evt);
1094 # returns the org that owns the callnumber that the copy
1096 sub fetch_copy_owner {
1097 my( $self, $copyid ) = @_;
1098 my( $copy, $cn, $evt );
1099 $logger->debug("Fetching copy owner $copyid");
1100 ($copy, $evt) = $self->fetch_copy($copyid);
1101 return (undef,$evt) if $evt;
1102 ($cn, $evt) = $self->fetch_callnumber($copy->call_number);
1103 return (undef,$evt) if $evt;
1104 return ($cn->owning_lib);
1107 sub fetch_copy_note {
1108 my( $self, $id ) = @_;
1110 $logger->debug("Fetching copy note $id");
1111 $note = $self->cstorereq(
1112 'open-ils.cstore.direct.asset.copy_note.retrieve', $id );
1113 $evt = OpenILS::Event->new('ASSET_COPY_NOTE_NOT_FOUND', id => $id ) unless $note;
1114 return ($note, $evt);
1117 sub fetch_call_numbers_by_title {
1118 my( $self, $titleid ) = @_;
1119 $logger->info("Fetching call numbers by title $titleid");
1120 return $self->cstorereq(
1121 'open-ils.cstore.direct.asset.call_number.search.atomic',
1122 { record => $titleid, deleted => 'f' });
1123 #'open-ils.storage.direct.asset.call_number.search.record.atomic', $titleid);
1126 sub fetch_copies_by_call_number {
1127 my( $self, $cnid ) = @_;
1128 $logger->info("Fetching copies by call number $cnid");
1129 return $self->cstorereq(
1130 'open-ils.cstore.direct.asset.copy.search.atomic', { call_number => $cnid, deleted => 'f' } );
1131 #'open-ils.storage.direct.asset.copy.search.call_number.atomic', $cnid );
1134 sub fetch_user_by_barcode {
1135 my( $self, $bc ) = @_;
1136 my $cardid = $self->cstorereq(
1137 'open-ils.cstore.direct.actor.card.id_list', { barcode => $bc } );
1138 return (undef, OpenILS::Event->new('ACTOR_CARD_NOT_FOUND', barcode => $bc)) unless $cardid;
1139 my $user = $self->cstorereq(
1140 'open-ils.cstore.direct.actor.user.search', { card => $cardid } );
1141 return (undef, OpenILS::Event->new('ACTOR_USER_NOT_FOUND', card => $cardid)) unless $user;
1147 my( $self, $billid ) = @_;
1148 $logger->debug("Fetching billing $billid");
1149 my $bill = $self->cstorereq(
1150 'open-ils.cstore.direct.money.billing.retrieve', $billid );
1151 my $evt = OpenILS::Event->new('MONEY_BILLING_NOT_FOUND') unless $bill;
1152 return($bill, $evt);
1156 sub fetch_org_tree {
1158 return $ORG_TREE if $ORG_TREE;
1159 return $ORG_TREE = OpenILS::Utils::CStoreEditor->new->search_actor_org_unit(
1161 {"parent_ou" => undef },
1164 flesh_fields => { aou => ['children'] },
1165 order_by => { aou => 'name'}
1172 my( $self, $node, $callback ) = @_;
1173 return unless $node;
1175 if( $node->children ) {
1176 $self->walk_org_tree($_, $callback) for @{$node->children};
1181 my( $self, $item ) = @_;
1182 return 1 if $item and $item !~ /^f$/i;
1187 # This logic now lives in storage
1188 sub __patron_money_owed {
1189 my( $self, $patronid ) = @_;
1190 my $ses = OpenSRF::AppSession->create('open-ils.storage');
1191 my $req = $ses->request(
1192 'open-ils.storage.money.billable_transaction.summary.search',
1193 { usr => $patronid, xact_finish => undef } );
1197 while( $data = $req->recv ) {
1198 $data = $data->content;
1199 $total += $data->balance_owed;
1204 sub patron_money_owed {
1205 my( $self, $userid ) = @_;
1206 my $ses = $self->start_db_session();
1207 my $val = $ses->request(
1208 'open-ils.storage.actor.user.total_owed', $userid)->gather(1);
1209 $self->rollback_db_session($ses);
1213 sub patron_total_items_out {
1214 my( $self, $userid ) = @_;
1215 my $ses = $self->start_db_session();
1216 my $val = $ses->request(
1217 'open-ils.storage.actor.user.total_out', $userid)->gather(1);
1218 $self->rollback_db_session($ses);
1225 #---------------------------------------------------------------------
1226 # Returns ($summary, $event)
1227 #---------------------------------------------------------------------
1231 my $e = shift || OpenILS::Utils::CStoreEditor->new;
1232 $id = $id->id if ref($id);
1234 my $xact = $e->retrieve_money_billable_transaction_summary($id)
1235 or return (undef, $e->event);
1241 #---------------------------------------------------------------------
1242 # Given a list of money.billable_transaction objects, this creates
1243 # transaction summary objects for each
1244 #--------------------------------------------------------------------
1249 return () if (!@xacts);
1250 return @{$e->search_money_billable_transaction_summary({id => [ map { $_->id } @xacts ]})};
1254 sub ou_ancestor_setting_value {
1255 my($self, $org_id, $name, $e) = @_;
1256 $e = $e || OpenILS::Utils::CStoreEditor->new;
1257 my $set = $self->ou_ancestor_setting($org_id, $name, $e);
1258 return $set->{value} if $set;
1263 # If an authentication token is provided AND this org unit setting has a
1264 # view_perm, then make sure the user referenced by the auth token has
1265 # that permission. This means that if you call this method without an
1266 # authtoken param, you can get whatever org unit setting values you want.
1268 sub ou_ancestor_setting {
1269 my( $self, $orgid, $name, $e, $auth ) = @_;
1270 $e = $e || OpenILS::Utils::CStoreEditor->new(
1271 (defined $auth) ? (authtoken => $auth) : ()
1273 my $coust = $e->retrieve_config_org_unit_setting_type([
1274 $name, {flesh => 1, flesh_fields => {coust => ['view_perm']}}
1277 if ($auth && $coust && $coust->view_perm) {
1278 # And you can't have permission if you don't have a valid session.
1279 return undef if not $e->checkauth;
1280 # And now that we know you MIGHT have permission, we check it.
1281 return undef if not $e->allowed($coust->view_perm->code, $orgid);
1284 my $query = {from => ['actor.org_unit_ancestor_setting', $name, $orgid]};
1285 my $setting = $e->json_query($query)->[0];
1286 return undef unless $setting;
1287 return {org => $setting->{org_unit}, value => OpenSRF::Utils::JSON->JSON2perl($setting->{value})};
1291 # returns the ISO8601 string representation of the requested epoch in GMT
1293 my( $self, $epoch ) = @_;
1294 my ($sec,$min,$hour,$mday,$mon,$year) = gmtime($epoch);
1295 $year += 1900; $mon += 1;
1297 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1298 $year, $mon, $mday, $hour, $min, $sec);
1302 sub find_highest_perm_org {
1303 my ( $self, $perm, $userid, $start_org, $org_tree ) = @_;
1304 my $org = $self->find_org($org_tree, $start_org );
1308 last if ($self->check_perms( $userid, $org->id, $perm )); # perm failed
1310 $org = $self->find_org( $org_tree, $org->parent_ou() );
1317 # returns the org_unit ID's
1318 sub user_has_work_perm_at {
1319 my($self, $e, $perm, $options, $user_id) = @_;
1321 $user_id = (defined $user_id) ? $user_id : $e->requestor->id;
1323 my $func = 'permission.usr_has_perm_at';
1324 $func = $func.'_all' if $$options{descendants};
1326 my $orgs = $e->json_query({from => [$func, $user_id, $perm]});
1327 $orgs = [map { $_->{ (keys %$_)[0] } } @$orgs];
1329 return $orgs unless $$options{objects};
1331 return $e->search_actor_org_unit({id => $orgs});
1334 sub get_user_work_ou_ids {
1335 my($self, $e, $userid) = @_;
1336 my $work_orgs = $e->json_query({
1337 select => {puwoum => ['work_ou']},
1339 where => {usr => $e->requestor->id}});
1341 return [] unless @$work_orgs;
1343 push(@work_orgs, $_->{work_ou}) for @$work_orgs;
1351 my($self, $client) = @_;
1352 return $org_types if $org_types;
1353 return $org_types = OpenILS::Utils::CStoreEditor->new->retrieve_all_actor_org_unit_type();
1358 my $locale = shift || '';
1359 my $cache = OpenSRF::Utils::Cache->new("global", 0);
1360 my $tree = $cache->get_cache("orgtree.$locale");
1361 return $tree if $tree;
1363 my $ses = OpenILS::Utils::CStoreEditor->new;
1364 $ses->session->session_locale($locale);
1365 $tree = $ses->search_actor_org_unit(
1367 {"parent_ou" => undef },
1370 flesh_fields => { aou => ['children'] },
1371 order_by => { aou => 'name'}
1376 $cache->put_cache("orgtree.$locale", $tree);
1380 sub get_org_descendants {
1381 my($self, $org_id, $depth) = @_;
1384 transform => 'actor.org_unit_descendants',
1386 result_field => 'id',
1388 $select->{params} = [$depth] if defined $depth;
1390 my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1391 select => {aou => [$select]},
1393 where => {id => $org_id}
1396 push(@orgs, $_->{id}) for @$org_list;
1400 sub get_org_ancestors {
1401 my($self, $org_id) = @_;
1403 my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1406 transform => 'actor.org_unit_ancestors',
1408 result_field => 'id',
1413 where => {id => $org_id}
1417 push(@orgs, $_->{id}) for @$org_list;
1421 sub get_org_full_path {
1422 my($self, $org_id, $depth) = @_;
1427 transform => 'actor.org_unit_full_path',
1429 result_field => 'id',
1433 where => {id => $org_id}
1436 $query->{select}->{aou}->[0]->{params} = [$depth] if defined $depth;
1437 my $org_list = OpenILS::Utils::CStoreEditor->new->json_query($query);
1438 return [ map {$_->{id}} @$org_list ];
1441 # returns the ID of the org unit ancestor at the specified depth
1442 sub org_unit_ancestor_at_depth {
1443 my($class, $org_id, $depth) = @_;
1444 my $resp = OpenILS::Utils::CStoreEditor->new->json_query(
1445 {from => ['actor.org_unit_ancestor_at_depth', $org_id, $depth]})->[0];
1446 return ($resp) ? $resp->{id} : undef;
1449 # returns the user's configured locale as a string. Defaults to en-US if none is configured.
1450 sub get_user_locale {
1451 my($self, $user_id, $e) = @_;
1452 $e ||= OpenILS::Utils::CStoreEditor->new;
1454 # first, see if the user has an explicit locale set
1455 my $setting = $e->search_actor_user_setting(
1456 {usr => $user_id, name => 'global.locale'})->[0];
1457 return OpenSRF::Utils::JSON->JSON2perl($setting->value) if $setting;
1459 my $user = $e->retrieve_actor_user($user_id) or return $e->event;
1460 return $self->get_org_locale($user->home_ou, $e);
1463 # returns org locale setting
1464 sub get_org_locale {
1465 my($self, $org_id, $e) = @_;
1466 $e ||= OpenILS::Utils::CStoreEditor->new;
1469 if(defined $org_id) {
1470 $locale = $self->ou_ancestor_setting_value($org_id, 'global.default_locale', $e);
1471 return $locale if $locale;
1474 # system-wide default
1475 my $sclient = OpenSRF::Utils::SettingsClient->new;
1476 $locale = $sclient->config_value('default_locale');
1477 return $locale if $locale;
1479 # if nothing else, fallback to locale=cowboy
1484 # xml-escape non-ascii characters
1486 my($self, $string, $form) = @_;
1489 # If we're going to convert non-ASCII characters to XML entities,
1490 # we had better be dealing with a UTF8 string to begin with
1491 $string = decode_utf8($string);
1494 $string = NFD($string);
1496 $string = NFC($string);
1499 # Convert raw ampersands to entities
1500 $string =~ s/&(?!\S+;)/&/gso;
1502 # Convert Unicode characters to entities
1503 $string =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
1508 # x0000-x0008 isn't legal in XML documents
1509 # XXX Perhaps this should just go into our standard entityize method
1510 sub strip_ctrl_chars {
1511 my ($self, $string) = @_;
1513 $string =~ s/([\x{0000}-\x{0008}])//sgoe;
1517 sub get_copy_price {
1518 my($self, $e, $copy, $volume) = @_;
1520 $copy->price(0) if $copy->price and $copy->price < 0;
1522 return $copy->price if $copy->price and $copy->price > 0;
1527 if($volume->id == OILS_PRECAT_CALL_NUMBER) {
1528 $owner = $copy->circ_lib;
1530 $owner = $volume->owning_lib;
1533 if($copy->call_number == OILS_PRECAT_CALL_NUMBER) {
1534 $owner = $copy->circ_lib;
1536 $owner = $e->retrieve_asset_call_number($copy->call_number)->owning_lib;
1540 my $default_price = $self->ou_ancestor_setting_value(
1541 $owner, OILS_SETTING_DEF_ITEM_PRICE, $e) || 0;
1543 return $default_price unless defined $copy->price;
1545 # price is 0. Use the default?
1546 my $charge_on_0 = $self->ou_ancestor_setting_value(
1547 $owner, OILS_SETTING_CHARGE_LOST_ON_ZERO, $e) || 0;
1549 return $default_price if $charge_on_0;
1553 # given a transaction ID, this returns the context org_unit for the transaction
1555 my($self, $xact_id, $e) = @_;
1556 $e ||= OpenILS::Utils::CStoreEditor->new;
1558 my $loc = $e->json_query({
1559 "select" => {circ => ["circ_lib"]},
1561 "where" => {id => $xact_id},
1564 return $loc->[0]->{circ_lib} if @$loc;
1566 $loc = $e->json_query({
1567 "select" => {mg => ["billing_location"]},
1569 "where" => {id => $xact_id},
1572 return $loc->[0]->{billing_location};
1576 # If an event_def ID is not provided, use the hook and context org to find the
1577 # most appropriate event. create the event, fire it, then return the resulting
1578 # event with fleshed template_output and error_output
1579 sub fire_object_event {
1580 my($self, $event_def, $hook, $object, $context_org, $granularity, $user_data) = @_;
1582 my $e = OpenILS::Utils::CStoreEditor->new;
1585 my $auto_method = "open-ils.trigger.event.autocreate.by_definition";
1588 $def = $e->retrieve_action_trigger_event_definition($event_def)
1589 or return $e->event;
1591 $auto_method .= '.include_inactive';
1594 # find the most appropriate event def depending on context org
1596 my $orgs = $self->get_org_ancestors($context_org);
1597 $orgs = $e->search_actor_org_unit(
1598 [{id => $orgs}, {flesh => 1, flesh_fields => {aou => ['ou_type']}}]);
1599 $orgs = [ sort { $a->ou_type->depth cmp $b->ou_type->depth } @$orgs ];
1601 for my $org (reverse @$orgs) {
1602 $def = $e->search_action_trigger_event_definition(
1603 {hook => $hook, owner => $org->id}
1608 return $e->event unless $def;
1611 if($def->group_field) {
1612 # we have a list of objects
1613 $object = [$object] unless ref $object eq 'ARRAY';
1617 for my $i (0..$#$object) {
1618 my $obj = $$object[$i];
1619 my $udata = $$user_data[$i];
1620 my $event_id = $self->simplereq(
1621 'open-ils.trigger', $auto_method, $def->id, $obj, $context_org, $udata);
1622 push(@event_ids, $event_id);
1625 $logger->info("EVENTS = " . OpenSRF::Utils::JSON->perl2JSON(\@event_ids));
1627 my $resp = $self->simplereq(
1629 'open-ils.trigger.event_group.fire',
1632 return undef unless $resp and $resp->{events} and @{$resp->{events}};
1634 return $e->retrieve_action_trigger_event([
1635 $resp->{events}->[0]->id,
1636 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1641 $object = $$object[0] if ref $object eq 'ARRAY';
1643 my $event_id = $self->simplereq(
1644 'open-ils.trigger', $auto_method, $def->id, $object, $context_org, $user_data);
1646 my $resp = $self->simplereq(
1648 'open-ils.trigger.event.fire',
1651 return undef unless $resp and $resp->{event};
1653 return $e->retrieve_action_trigger_event([
1655 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1661 sub create_trigger_event {
1662 my($self, $hook, $obj, $org_id) = @_;
1663 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1664 $ses->request('open-ils.trigger.event.autocreate', $hook, $obj, $org_id);
1667 sub create_uuid_string {
1668 return create_UUID_as_string();