1 package OpenILS::Application::AppUtils;
2 use strict; use warnings;
3 use OpenILS::Application;
4 use base qw/OpenILS::Application/;
5 use OpenSRF::Utils::Cache;
6 use OpenSRF::Utils::Logger qw/$logger/;
7 use OpenILS::Utils::ModsParser;
8 use OpenSRF::EX qw(:try);
11 use OpenILS::Utils::CStoreEditor;
12 use OpenILS::Const qw/:const/;
13 use Unicode::Normalize;
14 use OpenSRF::Utils::SettingsClient;
18 use DateTime::Format::ISO8601;
19 use List::MoreUtils qw/uniq/;
20 use Digest::MD5 qw(md5_hex);
22 # ---------------------------------------------------------------------------
23 # Pile of utilty methods used accross applications.
24 # ---------------------------------------------------------------------------
25 my $cache_client = "OpenSRF::Utils::Cache";
28 # ---------------------------------------------------------------------------
29 # on sucess, returns the created session, on failure throws ERROR exception
30 # ---------------------------------------------------------------------------
31 sub start_db_session {
34 my $session = OpenSRF::AppSession->connect( "open-ils.storage" );
35 my $trans_req = $session->request( "open-ils.storage.transaction.begin" );
37 my $trans_resp = $trans_req->recv();
38 if(ref($trans_resp) and UNIVERSAL::isa($trans_resp,"Error")) { throw $trans_resp; }
39 if( ! $trans_resp->content() ) {
41 ("Unable to Begin Transaction with database" );
45 $logger->debug("Setting global storage session to ".
46 "session: " . $session->session_id . " : " . $session->app );
54 my $authtoken = shift;
58 my $audit_req = $session->request( "open-ils.storage.set_audit_info", $authtoken, $user_id, $ws_id );
59 my $audit_resp = $audit_req->recv();
66 transform => 'permission.usr_has_perm',
77 # returns undef if user has all of the perms provided
78 # returns the first failed perm on failure
79 sub check_user_perms {
80 my($self, $user_id, $org_id, @perm_types ) = @_;
81 $logger->debug("Checking perms with user : $user_id , org: $org_id, @perm_types");
83 for my $type (@perm_types) {
84 $PERM_QUERY->{select}->{au}->[0]->{params} = [$type, $org_id];
85 $PERM_QUERY->{where}->{id} = $user_id;
86 return $type unless $self->is_true(OpenILS::Utils::CStoreEditor->new->json_query($PERM_QUERY)->[0]->{has_perm});
91 # checks the list of user perms. The first one that fails returns a new
93 my( $self, $user_id, $org_id, @perm_types ) = @_;
94 my $t = $self->check_user_perms( $user_id, $org_id, @perm_types );
95 return OpenILS::Event->new('PERM_FAILURE', ilsperm => $t, ilspermloc => $org_id ) if $t;
101 # ---------------------------------------------------------------------------
102 # commits and destroys the session
103 # ---------------------------------------------------------------------------
104 sub commit_db_session {
105 my( $self, $session ) = @_;
107 my $req = $session->request( "open-ils.storage.transaction.commit" );
108 my $resp = $req->recv();
111 throw OpenSRF::EX::ERROR ("Unable to commit db session");
114 if(UNIVERSAL::isa($resp,"Error")) {
115 throw $resp ($resp->stringify);
118 if(!$resp->content) {
119 throw OpenSRF::EX::ERROR ("Unable to commit db session");
123 $session->disconnect();
127 sub rollback_db_session {
128 my( $self, $session ) = @_;
130 my $req = $session->request("open-ils.storage.transaction.rollback");
131 my $resp = $req->recv();
132 if(UNIVERSAL::isa($resp,"Error")) { throw $resp; }
135 $session->disconnect();
140 # returns undef it the event is not an ILS event
141 # returns the event code otherwise
143 my( $self, $evt ) = @_;
144 return $evt->{ilsevent} if $self->is_event($evt);
148 # some events, in particular auto-generated events, don't have an
149 # ilsevent key. treat hashes with a 'textcode' key as events.
151 my ($self, $evt) = @_;
153 ref($evt) eq 'HASH' and (
154 defined $evt->{ilsevent} or
155 defined $evt->{textcode}
160 # ---------------------------------------------------------------------------
161 # Checks to see if a user is logged in. Returns the user record on success,
162 # throws an exception on error.
163 # ---------------------------------------------------------------------------
164 sub check_user_session {
165 my( $self, $user_session ) = @_;
167 my $content = $self->simplereq(
169 'open-ils.auth.session.retrieve', $user_session);
171 return undef if (!$content) or $self->event_code($content);
175 # generic simple request returning a scalar value
177 my($self, $service, $method, @params) = @_;
178 return $self->simple_scalar_request($service, $method, @params);
182 sub simple_scalar_request {
183 my($self, $service, $method, @params) = @_;
185 my $session = OpenSRF::AppSession->create( $service );
187 my $request = $session->request( $method, @params );
193 $val = $request->gather(1);
200 warn "received error : service=$service : method=$method : params=".Dumper(\@params) . "\n $err";
201 throw $err ("Call to $service for method $method \n failed with exception: $err : " );
208 my( $self, $orglist ) = @_;
210 return $orglist unless ref $orglist;
211 return $$orglist[0] if @$orglist == 1;
214 $a->ou_type <=> $b->ou_type ||
215 $a->name cmp $b->name } @$orglist;
217 for my $org (@list) {
220 next if (!defined($org->parent_ou) || $org->parent_ou eq "");
222 my ($parent) = grep { $_->id == $org->parent_ou } @list;
224 $parent->children([]) unless defined($parent->children);
225 push( @{$parent->children}, $org );
231 sub fetch_closed_date {
232 my( $self, $cd ) = @_;
235 $logger->debug("Fetching closed_date $cd from cstore");
237 my $cd_obj = $self->simplereq(
239 'open-ils.cstore.direct.actor.org_unit.closed_date.retrieve', $cd );
242 $logger->info("closed_date $cd not found in the db");
243 $evt = OpenILS::Event->new('ACTOR_USER_NOT_FOUND');
246 return ($cd_obj, $evt);
250 my( $self, $userid ) = @_;
253 $logger->debug("Fetching user $userid from cstore");
255 $user = $self->simplereq(
257 'open-ils.cstore.direct.actor.user.retrieve', $userid );
260 $logger->info("User $userid not found in the db");
261 $evt = OpenILS::Event->new('ACTOR_USER_NOT_FOUND');
264 return ($user, $evt);
268 my( $self, $session ) = @_;
269 my $user = $self->check_user_session($session) or
270 return (undef, OpenILS::Event->new('NO_SESSION'));
275 # verifiese the session and checks the permissions agains the
276 # session user and the user's home_ou as the org id
278 my( $self, $session, @perms ) = @_;
279 my $user; my $evt; my $e;
280 $logger->debug("Checking user session $session and perms @perms");
281 ($user, $evt) = $self->checkses($session);
282 return (undef, $evt) if $evt;
283 $evt = $self->check_perms($user->id, $user->home_ou, @perms);
284 return ($user, $evt);
289 my( $self, $staffobj, $userid, @perms ) = @_;
291 $userid = $staffobj->id unless defined $userid;
293 $logger->debug("checkrequestor(): requestor => " . $staffobj->id . ", target => $userid");
295 if( $userid ne $staffobj->id ) {
296 ($user, $evt) = $self->fetch_user($userid);
297 return (undef, $evt) if $evt;
298 $evt = $self->check_perms( $staffobj->id, $user->home_ou, @perms );
304 return ($user, $evt);
307 sub checkses_requestor {
308 my( $self, $authtoken, $targetid, @perms ) = @_;
309 my( $requestor, $target, $evt );
311 ($requestor, $evt) = $self->checkses($authtoken);
312 return (undef, undef, $evt) if $evt;
314 ($target, $evt) = $self->checkrequestor( $requestor, $targetid, @perms );
315 return( $requestor, $target, $evt);
319 my( $self, $copyid ) = @_;
322 $logger->debug("Fetching copy $copyid from cstore");
324 $copy = $self->simplereq(
326 'open-ils.cstore.direct.asset.copy.retrieve', $copyid );
328 if(!$copy) { $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND'); }
330 return( $copy, $evt );
334 # retrieves a circ object by id
335 sub fetch_circulation {
336 my( $self, $circid ) = @_;
339 $logger->debug("Fetching circ $circid from cstore");
341 $circ = $self->simplereq(
343 "open-ils.cstore.direct.action.circulation.retrieve", $circid );
346 $evt = OpenILS::Event->new('ACTION_CIRCULATION_NOT_FOUND', circid => $circid );
349 return ( $circ, $evt );
352 sub fetch_record_by_copy {
353 my( $self, $copyid ) = @_;
356 $logger->debug("Fetching record by copy $copyid from cstore");
358 $record = $self->simplereq(
360 'open-ils.cstore.direct.asset.copy.retrieve', $copyid,
362 flesh_fields => { bre => [ 'fixed_fields' ],
364 acp => [ 'call_number' ],
370 $evt = OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND');
372 $record = $record->call_number->record;
375 return ($record, $evt);
378 # turns a record object into an mvr (mods) object
380 my( $self, $record ) = @_;
381 return undef unless $record and $record->marc;
382 my $u = OpenILS::Utils::ModsParser->new();
383 $u->start_mods_batch( $record->marc );
384 my $mods = $u->finish_mods_batch();
385 $mods->doc_id($record->id);
386 $mods->tcn($record->tcn_value);
391 my( $self, $holdid ) = @_;
394 $logger->debug("Fetching hold $holdid from cstore");
396 $hold = $self->simplereq(
398 'open-ils.cstore.direct.action.hold_request.retrieve', $holdid);
400 $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND', holdid => $holdid) unless $hold;
402 return ($hold, $evt);
406 sub fetch_hold_transit_by_hold {
407 my( $self, $holdid ) = @_;
408 my( $transit, $evt );
410 $logger->debug("Fetching transit by hold $holdid from cstore");
412 $transit = $self->simplereq(
414 'open-ils.cstore.direct.action.hold_transit_copy.search', { hold => $holdid, cancel_time => undef } );
416 $evt = OpenILS::Event->new('ACTION_HOLD_TRANSIT_COPY_NOT_FOUND', holdid => $holdid) unless $transit;
418 return ($transit, $evt );
421 # fetches the captured, but not fulfilled hold attached to a given copy
422 sub fetch_open_hold_by_copy {
423 my( $self, $copyid ) = @_;
424 $logger->debug("Searching for active hold for copy $copyid");
427 $hold = $self->cstorereq(
428 'open-ils.cstore.direct.action.hold_request.search',
430 current_copy => $copyid ,
431 capture_time => { "!=" => undef },
432 fulfillment_time => undef,
433 cancel_time => undef,
436 $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND', copyid => $copyid) unless $hold;
437 return ($hold, $evt);
440 sub fetch_hold_transit {
441 my( $self, $transid ) = @_;
442 my( $htransit, $evt );
443 $logger->debug("Fetching hold transit with hold id $transid");
444 $htransit = $self->cstorereq(
445 'open-ils.cstore.direct.action.hold_transit_copy.retrieve', $transid );
446 $evt = OpenILS::Event->new('ACTION_HOLD_TRANSIT_COPY_NOT_FOUND', id => $transid) unless $htransit;
447 return ($htransit, $evt);
450 sub fetch_copy_by_barcode {
451 my( $self, $barcode ) = @_;
454 $logger->debug("Fetching copy by barcode $barcode from cstore");
456 $copy = $self->simplereq( 'open-ils.cstore',
457 'open-ils.cstore.direct.asset.copy.search', { barcode => $barcode, deleted => 'f'} );
458 #'open-ils.storage.direct.asset.copy.search.barcode', $barcode );
460 $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', barcode => $barcode) unless $copy;
462 return ($copy, $evt);
465 sub fetch_open_billable_transaction {
466 my( $self, $transid ) = @_;
467 my( $transaction, $evt );
469 $logger->debug("Fetching open billable transaction $transid from cstore");
471 $transaction = $self->simplereq(
473 'open-ils.cstore.direct.money.open_billable_transaction_summary.retrieve', $transid);
475 $evt = OpenILS::Event->new(
476 'MONEY_OPEN_BILLABLE_TRANSACTION_SUMMARY_NOT_FOUND', transid => $transid ) unless $transaction;
478 return ($transaction, $evt);
484 $buckets{'biblio'} = 'biblio_record_entry_bucket';
485 $buckets{'callnumber'} = 'call_number_bucket';
486 $buckets{'copy'} = 'copy_bucket';
487 $buckets{'user'} = 'user_bucket';
489 sub fetch_container {
490 my( $self, $id, $type ) = @_;
493 $logger->debug("Fetching container $id with type $type");
495 my $e = 'CONTAINER_CALL_NUMBER_BUCKET_NOT_FOUND';
496 $e = 'CONTAINER_BIBLIO_RECORD_ENTRY_BUCKET_NOT_FOUND' if $type eq 'biblio';
497 $e = 'CONTAINER_USER_BUCKET_NOT_FOUND' if $type eq 'user';
498 $e = 'CONTAINER_COPY_BUCKET_NOT_FOUND' if $type eq 'copy';
500 my $meth = $buckets{$type};
501 $bucket = $self->simplereq(
503 "open-ils.cstore.direct.container.$meth.retrieve", $id );
505 $evt = OpenILS::Event->new(
506 $e, container => $id, container_type => $type ) unless $bucket;
508 return ($bucket, $evt);
512 sub fetch_container_e {
513 my( $self, $editor, $id, $type ) = @_;
516 $bucket = $editor->retrieve_container_copy_bucket($id) if $type eq 'copy';
517 $bucket = $editor->retrieve_container_call_number_bucket($id) if $type eq 'callnumber';
518 $bucket = $editor->retrieve_container_biblio_record_entry_bucket($id) if $type eq 'biblio';
519 $bucket = $editor->retrieve_container_user_bucket($id) if $type eq 'user';
521 $evt = $editor->event unless $bucket;
522 return ($bucket, $evt);
525 sub fetch_container_item_e {
526 my( $self, $editor, $id, $type ) = @_;
529 $bucket = $editor->retrieve_container_copy_bucket_item($id) if $type eq 'copy';
530 $bucket = $editor->retrieve_container_call_number_bucket_item($id) if $type eq 'callnumber';
531 $bucket = $editor->retrieve_container_biblio_record_entry_bucket_item($id) if $type eq 'biblio';
532 $bucket = $editor->retrieve_container_user_bucket_item($id) if $type eq 'user';
534 $evt = $editor->event unless $bucket;
535 return ($bucket, $evt);
542 sub fetch_container_item {
543 my( $self, $id, $type ) = @_;
546 $logger->debug("Fetching container item $id with type $type");
548 my $meth = $buckets{$type} . "_item";
550 $bucket = $self->simplereq(
552 "open-ils.cstore.direct.container.$meth.retrieve", $id );
555 my $e = 'CONTAINER_CALL_NUMBER_BUCKET_ITEM_NOT_FOUND';
556 $e = 'CONTAINER_BIBLIO_RECORD_ENTRY_BUCKET_ITEM_NOT_FOUND' if $type eq 'biblio';
557 $e = 'CONTAINER_USER_BUCKET_ITEM_NOT_FOUND' if $type eq 'user';
558 $e = 'CONTAINER_COPY_BUCKET_ITEM_NOT_FOUND' if $type eq 'copy';
560 $evt = OpenILS::Event->new(
561 $e, itemid => $id, container_type => $type ) unless $bucket;
563 return ($bucket, $evt);
567 sub fetch_patron_standings {
569 $logger->debug("Fetching patron standings");
570 return $self->simplereq(
572 'open-ils.cstore.direct.config.standing.search.atomic', { id => { '!=' => undef } });
576 sub fetch_permission_group_tree {
578 $logger->debug("Fetching patron profiles");
579 return $self->simplereq(
581 'open-ils.actor.groups.tree.retrieve' );
584 sub fetch_permission_group_descendants {
585 my( $self, $profile ) = @_;
586 my $group_tree = $self->fetch_permission_group_tree();
590 # FIXME: okay, so it's not an org tree, but it is compatible
591 $self->walk_org_tree($group_tree, sub {
593 if ($g->id == $profile) {
598 $self->walk_org_tree($start_here, sub {
600 push(@groups,$g->id);
606 sub fetch_patron_circ_summary {
607 my( $self, $userid ) = @_;
608 $logger->debug("Fetching patron summary for $userid");
609 my $summary = $self->simplereq(
611 "open-ils.storage.action.circulation.patron_summary", $userid );
615 $summary->[1] ||= 0.0;
622 sub fetch_copy_statuses {
624 $logger->debug("Fetching copy statuses");
625 return $self->simplereq(
627 'open-ils.cstore.direct.config.copy_status.search.atomic', { id => { '!=' => undef } });
630 sub fetch_copy_location {
631 my( $self, $id ) = @_;
633 my $cl = $self->cstorereq(
634 'open-ils.cstore.direct.asset.copy_location.retrieve', $id );
635 $evt = OpenILS::Event->new('ASSET_COPY_LOCATION_NOT_FOUND') unless $cl;
639 sub fetch_copy_locations {
641 return $self->simplereq(
643 'open-ils.cstore.direct.asset.copy_location.search.atomic', { id => { '!=' => undef }, deleted => 'f' });
646 sub fetch_copy_location_by_name {
647 my( $self, $name, $org ) = @_;
649 my $cl = $self->cstorereq(
650 'open-ils.cstore.direct.asset.copy_location.search',
651 { name => $name, owning_lib => $org, deleted => 'f' } );
652 $evt = OpenILS::Event->new('ASSET_COPY_LOCATION_NOT_FOUND') unless $cl;
656 sub fetch_callnumber {
657 my( $self, $id, $flesh, $e ) = @_;
659 $e ||= OpenILS::Utils::CStoreEditor->new;
661 my $evt = OpenILS::Event->new( 'ASSET_CALL_NUMBER_NOT_FOUND', id => $id );
662 return( undef, $evt ) unless $id;
664 $logger->debug("Fetching callnumber $id");
666 my $cn = $e->retrieve_asset_call_number([
668 { flesh => $flesh, flesh_fields => { acn => [ 'prefix', 'suffix', 'label_class' ] } },
671 return ( $cn, $e->event );
674 my %ORG_CACHE; # - these rarely change, so cache them..
676 my( $self, $id ) = @_;
677 return undef unless $id;
678 return $id if( ref($id) eq 'Fieldmapper::actor::org_unit' );
679 return $ORG_CACHE{$id} if $ORG_CACHE{$id};
680 $logger->debug("Fetching org unit $id");
683 my $org = $self->simplereq(
685 'open-ils.cstore.direct.actor.org_unit.retrieve', $id );
686 $evt = OpenILS::Event->new( 'ACTOR_ORG_UNIT_NOT_FOUND', id => $id ) unless $org;
687 $ORG_CACHE{$id} = $org;
693 my( $self, $type, $id ) = @_;
695 $logger->debug("Fetching $type stat cat: $id");
696 $cat = $self->simplereq(
698 "open-ils.cstore.direct.$type.stat_cat.retrieve", $id );
700 my $e = 'ASSET_STAT_CAT_NOT_FOUND';
701 $e = 'ACTOR_STAT_CAT_NOT_FOUND' if $type eq 'actor';
703 $evt = OpenILS::Event->new( $e, id => $id ) unless $cat;
704 return ( $cat, $evt );
707 sub fetch_stat_cat_entry {
708 my( $self, $type, $id ) = @_;
710 $logger->debug("Fetching $type stat cat entry: $id");
711 $entry = $self->simplereq(
713 "open-ils.cstore.direct.$type.stat_cat_entry.retrieve", $id );
715 my $e = 'ASSET_STAT_CAT_ENTRY_NOT_FOUND';
716 $e = 'ACTOR_STAT_CAT_ENTRY_NOT_FOUND' if $type eq 'actor';
718 $evt = OpenILS::Event->new( $e, id => $id ) unless $entry;
719 return ( $entry, $evt );
722 sub fetch_stat_cat_entry_default {
723 my( $self, $type, $id ) = @_;
724 my( $entry_default, $evt );
725 $logger->debug("Fetching $type stat cat entry default: $id");
726 $entry_default = $self->simplereq(
728 "open-ils.cstore.direct.$type.stat_cat_entry_default.retrieve", $id );
730 my $e = 'ASSET_STAT_CAT_ENTRY_DEFAULT_NOT_FOUND';
731 $e = 'ACTOR_STAT_CAT_ENTRY_DEFAULT_NOT_FOUND' if $type eq 'actor';
733 $evt = OpenILS::Event->new( $e, id => $id ) unless $entry_default;
734 return ( $entry_default, $evt );
737 sub fetch_stat_cat_entry_default_by_stat_cat_and_org {
738 my( $self, $type, $stat_cat, $orgId ) = @_;
740 $logger->info("### Fetching $type stat cat entry default with stat_cat $stat_cat owned by org_unit $orgId");
741 $entry_default = $self->simplereq(
743 "open-ils.cstore.direct.$type.stat_cat_entry_default.search.atomic",
744 { stat_cat => $stat_cat, owner => $orgId } );
746 $entry_default = $entry_default->[0];
747 return ($entry_default, undef) if $entry_default;
749 my $e = 'ASSET_STAT_CAT_ENTRY_DEFAULT_NOT_FOUND';
750 $e = 'ACTOR_STAT_CAT_ENTRY_DEFAULT_NOT_FOUND' if $type eq 'actor';
751 return (undef, OpenILS::Event->new($e) );
755 my( $self, $org_tree, $orgid ) = @_;
756 return undef unless $org_tree and defined $orgid;
757 return $org_tree if ( $org_tree->id eq $orgid );
758 return undef unless ref($org_tree->children);
759 for my $c (@{$org_tree->children}) {
760 my $o = $self->find_org($c, $orgid);
766 sub fetch_non_cat_type_by_name_and_org {
767 my( $self, $name, $orgId ) = @_;
768 $logger->debug("Fetching non cat type $name at org $orgId");
769 my $types = $self->simplereq(
771 'open-ils.cstore.direct.config.non_cataloged_type.search.atomic',
772 { name => $name, owning_lib => $orgId } );
773 return ($types->[0], undef) if($types and @$types);
774 return (undef, OpenILS::Event->new('CONFIG_NON_CATALOGED_TYPE_NOT_FOUND') );
777 sub fetch_non_cat_type {
778 my( $self, $id ) = @_;
779 $logger->debug("Fetching non cat type $id");
781 $type = $self->simplereq(
783 'open-ils.cstore.direct.config.non_cataloged_type.retrieve', $id );
784 $evt = OpenILS::Event->new('CONFIG_NON_CATALOGED_TYPE_NOT_FOUND') unless $type;
785 return ($type, $evt);
788 sub DB_UPDATE_FAILED {
789 my( $self, $payload ) = @_;
790 return OpenILS::Event->new('DATABASE_UPDATE_FAILED',
791 payload => ($payload) ? $payload : undef );
794 sub fetch_booking_reservation {
795 my( $self, $id ) = @_;
798 $res = $self->simplereq(
800 'open-ils.cstore.direct.booking.reservation.retrieve', $id
803 # simplereq doesn't know how to flesh so ...
808 'open-ils.cstore.direct.actor.user.retrieve', $res->usr
812 $res->target_resource_type(
815 'open-ils.cstore.direct.booking.resource_type.retrieve', $res->target_resource_type
819 if ($res->current_resource) {
820 $res->current_resource(
823 'open-ils.cstore.direct.booking.resource.retrieve', $res->current_resource
827 if ($self->is_true( $res->target_resource_type->catalog_item )) {
828 $res->current_resource->catalog_item( $self->fetch_copy_by_barcode( $res->current_resource->barcode ) );
832 if ($res->target_resource) {
833 $res->target_resource(
836 'open-ils.cstore.direct.booking.resource.retrieve', $res->target_resource
840 if ($self->is_true( $res->target_resource_type->catalog_item )) {
841 $res->target_resource->catalog_item( $self->fetch_copy_by_barcode( $res->target_resource->barcode ) );
846 $evt = OpenILS::Event->new('RESERVATION_NOT_FOUND');
852 sub fetch_circ_duration_by_name {
853 my( $self, $name ) = @_;
855 $dur = $self->simplereq(
857 'open-ils.cstore.direct.config.rules.circ_duration.search.atomic', { name => $name } );
859 $evt = OpenILS::Event->new('CONFIG_RULES_CIRC_DURATION_NOT_FOUND') unless $dur;
863 sub fetch_recurring_fine_by_name {
864 my( $self, $name ) = @_;
866 $obj = $self->simplereq(
868 'open-ils.cstore.direct.config.rules.recurring_fine.search.atomic', { name => $name } );
870 $evt = OpenILS::Event->new('CONFIG_RULES_RECURRING_FINE_NOT_FOUND') unless $obj;
874 sub fetch_max_fine_by_name {
875 my( $self, $name ) = @_;
877 $obj = $self->simplereq(
879 'open-ils.cstore.direct.config.rules.max_fine.search.atomic', { name => $name } );
881 $evt = OpenILS::Event->new('CONFIG_RULES_MAX_FINE_NOT_FOUND') unless $obj;
885 sub fetch_hard_due_date_by_name {
886 my( $self, $name ) = @_;
888 $obj = $self->simplereq(
890 'open-ils.cstore.direct.config.hard_due_date.search.atomic', { name => $name } );
892 $evt = OpenILS::Event->new('CONFIG_RULES_HARD_DUE_DATE_NOT_FOUND') unless $obj;
897 my( $self, $method, @params ) = @_;
898 return $self->simplereq(
899 'open-ils.storage', $method, @params );
902 sub storagereq_xact {
903 my($self, $method, @params) = @_;
904 my $ses = $self->start_db_session();
905 my $val = $ses->request($method, @params)->gather(1);
906 $self->rollback_db_session($ses);
911 my( $self, $method, @params ) = @_;
912 return $self->simplereq(
913 'open-ils.cstore', $method, @params );
917 my( $self, $e, $name ) = @_;
918 if( $e and ref($e) eq 'HASH' and
919 defined($e->{textcode}) and $e->{textcode} eq $name ) {
926 my( undef, $f, $l ) = caller(0);
927 my( undef, undef, undef, $s ) = caller(1);
930 $logger->debug("LOGMARK: $f:$l:$s");
934 sub fetch_open_circulation {
935 my( $self, $cid ) = @_;
938 my $e = OpenILS::Utils::CStoreEditor->new;
939 my $circ = $e->search_action_circulation({
941 stop_fines_time => undef,
942 checkin_time => undef
945 return ($circ, $e->event);
949 sub copy_status_from_name {
950 my( $self, $name ) = @_;
951 $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
952 for my $status (@$copy_statuses) {
953 return $status if( $status->name =~ /$name/i );
958 sub copy_status_to_name {
959 my( $self, $sid ) = @_;
960 $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
961 for my $status (@$copy_statuses) {
962 return $status->name if( $status->id == $sid );
969 my( $self, $arg ) = @_;
970 return $arg if ref $arg;
971 $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
972 my ($stat) = grep { $_->id == $arg } @$copy_statuses;
976 sub fetch_open_transit_by_copy {
977 my( $self, $copyid ) = @_;
979 $transit = $self->cstorereq(
980 'open-ils.cstore.direct.action.transit_copy.search',
981 { target_copy => $copyid, dest_recv_time => undef, cancel_time => undef });
982 $evt = OpenILS::Event->new('ACTION_TRANSIT_COPY_NOT_FOUND') unless $transit;
983 return ($transit, $evt);
987 my( $self, $copy ) = @_;
988 return undef unless $copy;
989 $copy->status( $copy->status->id ) if ref($copy->status);
990 $copy->location( $copy->location->id ) if ref($copy->location);
991 $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
995 sub unflesh_reservation {
996 my( $self, $reservation ) = @_;
997 return undef unless $reservation;
998 $reservation->usr( $reservation->usr->id ) if ref($reservation->usr);
999 $reservation->target_resource_type( $reservation->target_resource_type->id ) if ref($reservation->target_resource_type);
1000 $reservation->target_resource( $reservation->target_resource->id ) if ref($reservation->target_resource);
1001 $reservation->current_resource( $reservation->current_resource->id ) if ref($reservation->current_resource);
1002 return $reservation;
1005 # un-fleshes a copy and updates it in the DB
1006 # returns a DB_UPDATE_FAILED event on error
1007 # returns undef on success
1009 my( $self, %params ) = @_;
1011 my $copy = $params{copy} || die "update_copy(): copy required";
1012 my $editor = $params{editor} || die "update_copy(): copy editor required";
1013 my $session = $params{session};
1015 $logger->debug("Updating copy in the database: " . $copy->id);
1017 $self->unflesh_copy($copy);
1018 $copy->editor( $editor );
1019 $copy->edit_date( 'now' );
1022 my $meth = 'open-ils.storage.direct.asset.copy.update';
1024 $s = $session->request( $meth, $copy )->gather(1) if $session;
1025 $s = $self->storagereq( $meth, $copy ) unless $session;
1027 $logger->debug("Update of copy ".$copy->id." returned: $s");
1029 return $self->DB_UPDATE_FAILED($copy) unless $s;
1033 sub update_reservation {
1034 my( $self, %params ) = @_;
1036 my $reservation = $params{reservation} || die "update_reservation(): reservation required";
1037 my $editor = $params{editor} || die "update_reservation(): copy editor required";
1038 my $session = $params{session};
1040 $logger->debug("Updating copy in the database: " . $reservation->id);
1042 $self->unflesh_reservation($reservation);
1045 my $meth = 'open-ils.cstore.direct.booking.reservation.update';
1047 $s = $session->request( $meth, $reservation )->gather(1) if $session;
1048 $s = $self->cstorereq( $meth, $reservation ) unless $session;
1050 $logger->debug("Update of copy ".$reservation->id." returned: $s");
1052 return $self->DB_UPDATE_FAILED($reservation) unless $s;
1056 sub fetch_billable_xact {
1057 my( $self, $id ) = @_;
1059 $logger->debug("Fetching billable transaction %id");
1060 $xact = $self->cstorereq(
1061 'open-ils.cstore.direct.money.billable_transaction.retrieve', $id );
1062 $evt = OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_NOT_FOUND') unless $xact;
1063 return ($xact, $evt);
1066 sub fetch_billable_xact_summary {
1067 my( $self, $id ) = @_;
1069 $logger->debug("Fetching billable transaction summary %id");
1070 $xact = $self->cstorereq(
1071 'open-ils.cstore.direct.money.billable_transaction_summary.retrieve', $id );
1072 $evt = OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_NOT_FOUND') unless $xact;
1073 return ($xact, $evt);
1076 sub fetch_fleshed_copy {
1077 my( $self, $id ) = @_;
1079 $logger->info("Fetching fleshed copy $id");
1080 $copy = $self->cstorereq(
1081 "open-ils.cstore.direct.asset.copy.retrieve", $id,
1083 flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
1086 $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', id => $id) unless $copy;
1087 return ($copy, $evt);
1091 # returns the org that owns the callnumber that the copy
1093 sub fetch_copy_owner {
1094 my( $self, $copyid ) = @_;
1095 my( $copy, $cn, $evt );
1096 $logger->debug("Fetching copy owner $copyid");
1097 ($copy, $evt) = $self->fetch_copy($copyid);
1098 return (undef,$evt) if $evt;
1099 ($cn, $evt) = $self->fetch_callnumber($copy->call_number);
1100 return (undef,$evt) if $evt;
1101 return ($cn->owning_lib);
1104 sub fetch_copy_note {
1105 my( $self, $id ) = @_;
1107 $logger->debug("Fetching copy note $id");
1108 $note = $self->cstorereq(
1109 'open-ils.cstore.direct.asset.copy_note.retrieve', $id );
1110 $evt = OpenILS::Event->new('ASSET_COPY_NOTE_NOT_FOUND', id => $id ) unless $note;
1111 return ($note, $evt);
1114 sub fetch_call_numbers_by_title {
1115 my( $self, $titleid ) = @_;
1116 $logger->info("Fetching call numbers by title $titleid");
1117 return $self->cstorereq(
1118 'open-ils.cstore.direct.asset.call_number.search.atomic',
1119 { record => $titleid, deleted => 'f' });
1120 #'open-ils.storage.direct.asset.call_number.search.record.atomic', $titleid);
1123 sub fetch_copies_by_call_number {
1124 my( $self, $cnid ) = @_;
1125 $logger->info("Fetching copies by call number $cnid");
1126 return $self->cstorereq(
1127 'open-ils.cstore.direct.asset.copy.search.atomic', { call_number => $cnid, deleted => 'f' } );
1128 #'open-ils.storage.direct.asset.copy.search.call_number.atomic', $cnid );
1131 sub fetch_user_by_barcode {
1132 my( $self, $bc ) = @_;
1133 my $cardid = $self->cstorereq(
1134 'open-ils.cstore.direct.actor.card.id_list', { barcode => $bc } );
1135 return (undef, OpenILS::Event->new('ACTOR_CARD_NOT_FOUND', barcode => $bc)) unless $cardid;
1136 my $user = $self->cstorereq(
1137 'open-ils.cstore.direct.actor.user.search', { card => $cardid } );
1138 return (undef, OpenILS::Event->new('ACTOR_USER_NOT_FOUND', card => $cardid)) unless $user;
1144 my( $self, $billid ) = @_;
1145 $logger->debug("Fetching billing $billid");
1146 my $bill = $self->cstorereq(
1147 'open-ils.cstore.direct.money.billing.retrieve', $billid );
1148 my $evt = OpenILS::Event->new('MONEY_BILLING_NOT_FOUND') unless $bill;
1149 return($bill, $evt);
1153 my( $self, $node, $callback ) = @_;
1154 return unless $node;
1156 if( $node->children ) {
1157 $self->walk_org_tree($_, $callback) for @{$node->children};
1162 my( $self, $item ) = @_;
1163 return 1 if $item and $item !~ /^f$/i;
1169 my ($self, $client, $service, $method, @params) = @_;
1170 my ($response, $err);
1172 my $session = create OpenSRF::AppSession($service);
1173 my $request = $session->request($method, @params);
1176 my $give_up = time + 1000;
1179 while (time < $give_up) {
1180 $response = $request->recv("timeout" => $spurt);
1181 last if $request->complete;
1183 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1185 } catch Error with {
1190 warn "received error : service=$service : method=$method : params=".Dumper(\@params) . "\n $err";
1191 throw $err ("Call to $service for method $method \n failed with exception: $err : " );
1194 return $response->content;
1197 # This logic now lives in storage
1198 sub __patron_money_owed {
1199 my( $self, $patronid ) = @_;
1200 my $ses = OpenSRF::AppSession->create('open-ils.storage');
1201 my $req = $ses->request(
1202 'open-ils.storage.money.billable_transaction.summary.search',
1203 { usr => $patronid, xact_finish => undef } );
1207 while( $data = $req->recv ) {
1208 $data = $data->content;
1209 $total += $data->balance_owed;
1214 sub patron_money_owed {
1215 my( $self, $userid ) = @_;
1216 my $ses = $self->start_db_session();
1217 my $val = $ses->request(
1218 'open-ils.storage.actor.user.total_owed', $userid)->gather(1);
1219 $self->rollback_db_session($ses);
1223 sub patron_total_items_out {
1224 my( $self, $userid ) = @_;
1225 my $ses = $self->start_db_session();
1226 my $val = $ses->request(
1227 'open-ils.storage.actor.user.total_out', $userid)->gather(1);
1228 $self->rollback_db_session($ses);
1235 #---------------------------------------------------------------------
1236 # Returns ($summary, $event)
1237 #---------------------------------------------------------------------
1241 my $e = shift || OpenILS::Utils::CStoreEditor->new;
1242 $id = $id->id if ref($id);
1244 my $xact = $e->retrieve_money_billable_transaction_summary($id)
1245 or return (undef, $e->event);
1251 #---------------------------------------------------------------------
1252 # Given a list of money.billable_transaction objects, this creates
1253 # transaction summary objects for each
1254 #--------------------------------------------------------------------
1259 return () if (!@xacts);
1260 return @{$e->search_money_billable_transaction_summary({id => [ map { $_->id } @xacts ]})};
1264 sub ou_ancestor_setting_value {
1265 my($self, $org_id, $name, $e) = @_;
1266 $e = $e || OpenILS::Utils::CStoreEditor->new;
1267 my $set = $self->ou_ancestor_setting($org_id, $name, $e);
1268 return $set->{value} if $set;
1273 # If an authentication token is provided AND this org unit setting has a
1274 # view_perm, then make sure the user referenced by the auth token has
1275 # that permission. This means that if you call this method without an
1276 # authtoken param, you can get whatever org unit setting values you want.
1279 # NOTE: If you supply an editor ($e) arg AND an auth token arg, the editor's
1280 # authtoken is checked, but the $auth arg is NOT checked. To say that another
1281 # way, be sure NOT to pass an editor argument if you want your token checked.
1282 # Otherwise the auth arg is just a flag saying "check the editor".
1284 sub ou_ancestor_setting {
1285 my( $self, $orgid, $name, $e, $auth ) = @_;
1286 $e = $e || OpenILS::Utils::CStoreEditor->new(
1287 (defined $auth) ? (authtoken => $auth) : ()
1291 my $coust = $e->retrieve_config_org_unit_setting_type([
1292 $name, {flesh => 1, flesh_fields => {coust => ['view_perm']}}
1294 if ($coust && $coust->view_perm) {
1295 # And you can't have permission if you don't have a valid session.
1296 return undef if not $e->checkauth;
1297 # And now that we know you MIGHT have permission, we check it.
1298 return undef if not $e->allowed($coust->view_perm->code, $orgid);
1302 my $query = {from => ['actor.org_unit_ancestor_setting', $name, $orgid]};
1303 my $setting = $e->json_query($query)->[0];
1304 return undef unless $setting;
1305 return {org => $setting->{org_unit}, value => OpenSRF::Utils::JSON->JSON2perl($setting->{value})};
1308 # This fetches a set of OU settings in one fell swoop,
1309 # which can be significantly faster than invoking
1310 # $U->ou_ancestor_setting() one setting at a time.
1311 # As the "_insecure" implies, however, callers are
1312 # responsible for ensuring that the settings to be
1313 # fetch do not need view permission checks.
1314 sub ou_ancestor_setting_batch_insecure {
1315 my( $self, $orgid, $names ) = @_;
1317 my %result = map { $_ => undef } @$names;
1320 'actor.org_unit_ancestor_setting_batch',
1322 '{' . join(',', @$names) . '}'
1325 my $e = OpenILS::Utils::CStoreEditor->new();
1326 my $settings = $e->json_query($query);
1327 foreach my $setting (@$settings) {
1328 $result{$setting->{name}} = {
1329 org => $setting->{org_unit},
1330 value => OpenSRF::Utils::JSON->JSON2perl($setting->{value})
1336 # Returns a hash of hashes like so:
1338 # $lookup_org_id => {org => $context_org, value => $setting_value},
1339 # $lookup_org_id2 => {org => $context_org2, value => $setting_value2},
1340 # $lookup_org_id3 => {} # example of no setting value exists
1343 sub ou_ancestor_setting_batch_by_org_insecure {
1344 my ($self, $org_ids, $name, $e) = @_;
1346 $e ||= OpenILS::Utils::CStoreEditor->new();
1347 my %result = map { $_ => {value => undef} } @$org_ids;
1351 'actor.org_unit_ancestor_setting_batch_by_org',
1352 $name, '{' . join(',', @$org_ids) . '}'
1356 # DB func returns an array of settings matching the order of the
1357 # list of org unit IDs. If the setting does not contain a valid
1358 # ->id value, then no setting value exists for that org unit.
1359 my $settings = $e->json_query($query);
1360 for my $idx (0 .. $#$org_ids) {
1361 my $setting = $settings->[$idx];
1362 my $org_id = $org_ids->[$idx];
1364 next unless $setting->{id}; # null ID means no value is present.
1366 $result{$org_id}->{org} = $setting->{org_unit};
1367 $result{$org_id}->{value} =
1368 OpenSRF::Utils::JSON->JSON2perl($setting->{value});
1374 # returns the ISO8601 string representation of the requested epoch in GMT
1376 my( $self, $epoch ) = @_;
1377 my ($sec,$min,$hour,$mday,$mon,$year) = gmtime($epoch);
1378 $year += 1900; $mon += 1;
1380 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1381 $year, $mon, $mday, $hour, $min, $sec);
1385 sub find_highest_perm_org {
1386 my ( $self, $perm, $userid, $start_org, $org_tree ) = @_;
1387 my $org = $self->find_org($org_tree, $start_org );
1391 last if ($self->check_perms( $userid, $org->id, $perm )); # perm failed
1393 $org = $self->find_org( $org_tree, $org->parent_ou() );
1400 # returns the org_unit ID's
1401 sub user_has_work_perm_at {
1402 my($self, $e, $perm, $options, $user_id) = @_;
1404 $user_id = (defined $user_id) ? $user_id : $e->requestor->id;
1406 my $func = 'permission.usr_has_perm_at';
1407 $func = $func.'_all' if $$options{descendants};
1409 my $orgs = $e->json_query({from => [$func, $user_id, $perm]});
1410 $orgs = [map { $_->{ (keys %$_)[0] } } @$orgs];
1412 return $orgs unless $$options{objects};
1414 return $e->search_actor_org_unit({id => $orgs});
1417 sub get_user_work_ou_ids {
1418 my($self, $e, $userid) = @_;
1419 my $work_orgs = $e->json_query({
1420 select => {puwoum => ['work_ou']},
1422 where => {usr => $e->requestor->id}});
1424 return [] unless @$work_orgs;
1426 push(@work_orgs, $_->{work_ou}) for @$work_orgs;
1434 my($self, $client) = @_;
1435 return $org_types if $org_types;
1436 return $org_types = OpenILS::Utils::CStoreEditor->new->retrieve_all_actor_org_unit_type();
1442 my $locale = shift || '';
1443 my $cache = OpenSRF::Utils::Cache->new("global", 0);
1444 my $tree = $ORG_TREE{$locale} || $cache->get_cache("orgtree.$locale");
1445 return $tree if $tree;
1447 my $ses = OpenILS::Utils::CStoreEditor->new;
1448 $ses->session->session_locale($locale);
1449 $tree = $ses->search_actor_org_unit(
1451 {"parent_ou" => undef },
1454 flesh_fields => { aou => ['children'] },
1455 order_by => { aou => 'name'}
1460 $ORG_TREE{$locale} = $tree;
1461 $cache->put_cache("orgtree.$locale", $tree);
1465 sub get_org_descendants {
1466 my($self, $org_id, $depth) = @_;
1469 transform => 'actor.org_unit_descendants',
1471 result_field => 'id',
1473 $select->{params} = [$depth] if defined $depth;
1475 my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1476 select => {aou => [$select]},
1478 where => {id => $org_id}
1481 push(@orgs, $_->{id}) for @$org_list;
1485 sub get_org_ancestors {
1486 my($self, $org_id, $use_cache) = @_;
1491 $cache = OpenSRF::Utils::Cache->new("global", 0);
1492 $orgs = $cache->get_cache("org.ancestors.$org_id");
1493 return $orgs if $orgs;
1496 my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1499 transform => 'actor.org_unit_ancestors',
1501 result_field => 'id',
1506 where => {id => $org_id}
1509 $orgs = [ map { $_->{id} } @$org_list ];
1511 $cache->put_cache("org.ancestors.$org_id", $orgs) if $use_cache;
1515 sub get_org_full_path {
1516 my($self, $org_id, $depth) = @_;
1521 transform => 'actor.org_unit_full_path',
1523 result_field => 'id',
1527 where => {id => $org_id}
1530 $query->{select}->{aou}->[0]->{params} = [$depth] if defined $depth;
1531 my $org_list = OpenILS::Utils::CStoreEditor->new->json_query($query);
1532 return [ map {$_->{id}} @$org_list ];
1535 # returns the ID of the org unit ancestor at the specified depth
1536 sub org_unit_ancestor_at_depth {
1537 my($class, $org_id, $depth) = @_;
1538 my $resp = OpenILS::Utils::CStoreEditor->new->json_query(
1539 {from => ['actor.org_unit_ancestor_at_depth', $org_id, $depth]})->[0];
1540 return ($resp) ? $resp->{id} : undef;
1543 # Returns the proximity value between two org units.
1544 sub get_org_unit_proximity {
1545 my ($class, $e, $from_org, $to_org) = @_;
1546 $e = OpenILS::Utils::CStoreEditor->new unless ($e);
1547 my $r = $e->json_query(
1549 select => {aoup => ['prox']},
1551 where => {from_org => $from_org, to_org => $to_org}
1554 if (ref($r) eq 'ARRAY' && @$r) {
1555 return $r->[0]->{prox};
1560 # returns the user's configured locale as a string. Defaults to en-US if none is configured.
1561 sub get_user_locale {
1562 my($self, $user_id, $e) = @_;
1563 $e ||= OpenILS::Utils::CStoreEditor->new;
1565 # first, see if the user has an explicit locale set
1566 my $setting = $e->search_actor_user_setting(
1567 {usr => $user_id, name => 'global.locale'})->[0];
1568 return OpenSRF::Utils::JSON->JSON2perl($setting->value) if $setting;
1570 my $user = $e->retrieve_actor_user($user_id) or return $e->event;
1571 return $self->get_org_locale($user->home_ou, $e);
1574 # returns org locale setting
1575 sub get_org_locale {
1576 my($self, $org_id, $e) = @_;
1577 $e ||= OpenILS::Utils::CStoreEditor->new;
1580 if(defined $org_id) {
1581 $locale = $self->ou_ancestor_setting_value($org_id, 'global.default_locale', $e);
1582 return $locale if $locale;
1585 # system-wide default
1586 my $sclient = OpenSRF::Utils::SettingsClient->new;
1587 $locale = $sclient->config_value('default_locale');
1588 return $locale if $locale;
1590 # if nothing else, fallback to locale=cowboy
1595 # xml-escape non-ascii characters
1597 my($self, $string, $form) = @_;
1601 $string = NFD($string);
1603 $string = NFC($string);
1606 # Convert raw ampersands to entities
1607 $string =~ s/&(?!\S+;)/&/gso;
1609 # Convert Unicode characters to entities
1610 $string =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
1615 # x0000-x0008 isn't legal in XML documents
1616 # XXX Perhaps this should just go into our standard entityize method
1617 sub strip_ctrl_chars {
1618 my ($self, $string) = @_;
1620 $string =~ s/([\x{0000}-\x{0008}])//sgoe;
1624 sub get_copy_price {
1625 my($self, $e, $copy, $volume) = @_;
1627 $copy->price(0) if $copy->price and $copy->price < 0;
1632 if($volume->id == OILS_PRECAT_CALL_NUMBER) {
1633 $owner = $copy->circ_lib;
1635 $owner = $volume->owning_lib;
1638 if($copy->call_number == OILS_PRECAT_CALL_NUMBER) {
1639 $owner = $copy->circ_lib;
1641 $owner = $e->retrieve_asset_call_number($copy->call_number)->owning_lib;
1645 my $min_price = $self->ou_ancestor_setting_value($owner, OILS_SETTING_MIN_ITEM_PRICE);
1646 my $max_price = $self->ou_ancestor_setting_value($owner, OILS_SETTING_MAX_ITEM_PRICE);
1647 my $charge_on_0 = $self->ou_ancestor_setting_value($owner, OILS_SETTING_CHARGE_LOST_ON_ZERO, $e);
1649 my $price = $copy->price;
1651 # set the default price if needed
1652 if (!defined $price or ($price == 0 and $charge_on_0)) {
1653 # set to default price
1654 $price = $self->ou_ancestor_setting_value(
1655 $owner, OILS_SETTING_DEF_ITEM_PRICE, $e) || 0;
1658 # adjust to min/max range if needed
1659 if (defined $max_price and $price > $max_price) {
1660 $price = $max_price;
1661 } elsif (defined $min_price and $price < $min_price
1662 and ($price != 0 or $charge_on_0 or !defined $charge_on_0)) {
1663 # default to raising the price to the minimum,
1664 # but let 0 fall through if $charge_on_0 is set and is false
1665 $price = $min_price;
1671 # given a transaction ID, this returns the context org_unit for the transaction
1673 my($self, $xact_id, $e) = @_;
1674 $e ||= OpenILS::Utils::CStoreEditor->new;
1676 my $loc = $e->json_query({
1677 "select" => {circ => ["circ_lib"]},
1679 "where" => {id => $xact_id},
1682 return $loc->[0]->{circ_lib} if @$loc;
1684 $loc = $e->json_query({
1685 "select" => {bresv => ["request_lib"]},
1687 "where" => {id => $xact_id},
1690 return $loc->[0]->{request_lib} if @$loc;
1692 $loc = $e->json_query({
1693 "select" => {mg => ["billing_location"]},
1695 "where" => {id => $xact_id},
1698 return $loc->[0]->{billing_location};
1702 sub find_event_def_by_hook {
1703 my($self, $hook, $context_org, $e) = @_;
1705 $e ||= OpenILS::Utils::CStoreEditor->new;
1707 my $orgs = $self->get_org_ancestors($context_org);
1709 # search from the context org up
1710 for my $org_id (reverse @$orgs) {
1712 my $def = $e->search_action_trigger_event_definition(
1713 {hook => $hook, owner => $org_id, active => 't'})->[0];
1715 return $def if $def;
1723 # If an event_def ID is not provided, use the hook and context org to find the
1724 # most appropriate event. create the event, fire it, then return the resulting
1725 # event with fleshed template_output and error_output
1726 sub fire_object_event {
1727 my($self, $event_def, $hook, $object, $context_org, $granularity, $user_data, $client) = @_;
1729 my $e = OpenILS::Utils::CStoreEditor->new;
1732 my $auto_method = "open-ils.trigger.event.autocreate.by_definition";
1735 $def = $e->retrieve_action_trigger_event_definition($event_def)
1736 or return $e->event;
1738 $auto_method .= '.include_inactive';
1742 # find the most appropriate event def depending on context org
1743 $def = $self->find_event_def_by_hook($hook, $context_org, $e)
1744 or return $e->event;
1749 if($def->group_field) {
1750 # we have a list of objects
1751 $object = [$object] unless ref $object eq 'ARRAY';
1755 for my $i (0..$#$object) {
1756 my $obj = $$object[$i];
1757 my $udata = $$user_data[$i];
1758 my $event_id = $self->simplereq(
1759 'open-ils.trigger', $auto_method, $def->id, $obj, $context_org, $udata);
1760 push(@event_ids, $event_id);
1763 $logger->info("EVENTS = " . OpenSRF::Utils::JSON->perl2JSON(\@event_ids));
1766 if (not defined $client) {
1767 $resp = $self->simplereq(
1769 'open-ils.trigger.event_group.fire',
1772 $resp = $self->patientreq(
1774 "open-ils.trigger", "open-ils.trigger.event_group.fire",
1779 if($resp and $resp->{events} and @{$resp->{events}}) {
1782 $final_resp = $e->retrieve_action_trigger_event([
1783 $resp->{events}->[0]->id,
1784 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1791 $object = $$object[0] if ref $object eq 'ARRAY';
1796 if (not defined $client) {
1797 $event_id = $self->simplereq(
1799 $auto_method, $def->id, $object, $context_org, $user_data
1802 $resp = $self->simplereq(
1804 'open-ils.trigger.event.fire',
1808 $event_id = $self->patientreq(
1811 $auto_method, $def->id, $object, $context_org, $user_data
1814 $resp = $self->patientreq(
1817 'open-ils.trigger.event.fire',
1822 if($resp and $resp->{event}) {
1824 $final_resp = $e->retrieve_action_trigger_event([
1826 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1836 sub create_events_for_hook {
1837 my($self, $hook, $obj, $org_id, $granularity, $user_data, $wait) = @_;
1838 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1839 my $req = $ses->request('open-ils.trigger.event.autocreate',
1840 $hook, $obj, $org_id, $granularity, $user_data);
1841 return undef unless $wait;
1842 my $resp = $req->recv;
1843 return $resp->content if $resp;
1846 sub create_uuid_string {
1847 return create_UUID_as_string();
1850 sub create_circ_chain_summary {
1851 my($class, $e, $circ_id) = @_;
1852 my $sum = $e->json_query({from => ['action.summarize_all_circ_chain', $circ_id]})->[0];
1853 return undef unless $sum;
1854 my $obj = Fieldmapper::action::circ_chain_summary->new;
1855 $obj->$_($sum->{$_}) for keys %$sum;
1860 # Returns "mra" attribute key/value pairs for a set of bre's
1861 # Takes a list of bre IDs, returns a hash of hashes,
1862 # {bre_id1 => {key1 => {code => value1, label => label1}, ...}...}
1865 my ($class, $bre_ids, $e) = @_;
1866 $e = $e || OpenILS::Utils::CStoreEditor->new;
1869 return $attrs unless defined $bre_ids;
1870 $bre_ids = [$bre_ids] unless ref $bre_ids;
1872 my $mra = $e->json_query({
1880 transform => 'each',
1881 result_field => 'key',
1885 transform => 'each',
1886 result_field => 'value',
1892 where => {id => $bre_ids}
1895 return $attrs unless $mra;
1897 $ccvm_cache = $ccvm_cache || $e->search_config_coded_value_map({id => {'!=' => undef}});
1899 for my $id (@$bre_ids) {
1901 for my $mra (grep { $_->{bre} eq $id } @$mra) {
1902 my $ctype = $mra->{key};
1903 my $code = $mra->{value};
1904 $attrs->{$id}->{$ctype} = {code => $code};
1906 my ($ccvm) = grep { $_->ctype eq $ctype and $_->code eq $code } @$ccvm_cache;
1907 $attrs->{$id}->{$ctype}->{label} = $ccvm->value if $ccvm;
1915 # Shorter version of bib_container_items_via_search() below, only using
1916 # the queryparser record_list filter instead of the container filter.
1917 sub bib_record_list_via_search {
1918 my ($class, $search_query, $search_args) = @_;
1920 # First, Use search API to get container items sorted in any way that crad
1922 my $search_result = $class->simplereq(
1923 "open-ils.search", "open-ils.search.biblio.multiclass.query",
1924 $search_args, $search_query
1927 unless ($search_result) {
1928 # empty result sets won't cause this, but actual errors should.
1929 $logger->warn("bib_record_list_via_search() got nothing from search");
1933 # Throw away other junk from search, keeping only bib IDs.
1934 return [ map { shift @$_ } @{$search_result->{ids}} ];
1937 # 'no_flesh' avoids fleshing the target_biblio_record_entry
1938 sub bib_container_items_via_search {
1939 my ($class, $container_id, $search_query, $search_args, $no_flesh) = @_;
1941 # First, Use search API to get container items sorted in any way that crad
1943 my $search_result = $class->simplereq(
1944 "open-ils.search", "open-ils.search.biblio.multiclass.query",
1945 $search_args, $search_query
1947 unless ($search_result) {
1948 # empty result sets won't cause this, but actual errors should.
1949 $logger->warn("bib_container_items_via_search() got nothing from search");
1953 # Throw away other junk from search, keeping only bib IDs.
1954 my $id_list = [ map { shift @$_ } @{$search_result->{ids}} ];
1956 return [] unless @$id_list;
1958 # Now get the bib container items themselves...
1959 my $e = new OpenILS::Utils::CStoreEditor;
1961 $logger->warn("bib_container_items_via_search() couldn't get cstoreeditor");
1965 my @flesh_fields = qw/notes/;
1966 push(@flesh_fields, 'target_biblio_record_entry') unless $no_flesh;
1968 my $items = $e->search_container_biblio_record_entry_bucket_item([
1970 "target_biblio_record_entry" => $id_list,
1971 "bucket" => $container_id
1974 flesh_fields => {"cbrebi" => \@flesh_fields}
1976 ], {substream => 1});
1980 "bib_container_items_via_search() couldn't get bucket items: " .
1981 $e->die_event->{textcode}
1986 # ... and put them in the same order that the search API said they
1988 my %ordering_hash = map {
1989 ($no_flesh) ? $_->target_biblio_record_entry : $_->target_biblio_record_entry->id,
1993 return [map { $ordering_hash{$_} } @$id_list];
1996 # returns undef on success, Event on error
1997 sub log_user_activity {
1998 my ($class, $user_id, $who, $what, $e, $async) = @_;
2002 $e = OpenILS::Utils::CStoreEditor->new(xact => 1);
2006 my $res = $e->json_query({
2008 'actor.insert_usr_activity',
2009 $user_id, $who, $what, OpenSRF::AppSession->ingress
2013 if ($res) { # call returned OK
2015 $e->commit if $commit and @$res;
2016 $e->rollback if $commit and !@$res;
2019 return $e->die_event;
2025 # I hate to put this here exactly, but this code needs to be shared between
2026 # the TPAC's mod_perl module and open-ils.serial.
2028 # There is a reason every part of the query *except* those parts dealing
2029 # with scope are moved here from the code's origin in TPAC. The serials
2030 # use case does *not* want the same scoping logic.
2032 # Also, note that for the serials uses case, we may filter in OPAC visible
2033 # status and copy/call_number deletedness, but we don't filter on any
2034 # particular values for serial.item.status or serial.item.date_received.
2035 # Since we're only using this *after* winnowing down the set of issuances
2036 # that copies should be related to, I'm not sure we need any such serial.item
2039 sub basic_opac_copy_query {
2040 ######################################################################
2041 # Pass a defined value for either $rec_id OR ($iss_id AND $dist_id), #
2043 ######################################################################
2044 my ($self,$rec_id,$iss_id,$dist_id,$copy_limit,$copy_offset,$staff) = @_;
2048 acp => ['id', 'barcode', 'circ_lib', 'create_date', 'active_date',
2049 'age_protect', 'holdable', 'copy_number'],
2051 {column => 'name', alias => 'copy_location'},
2052 {column => 'holdable', alias => 'location_holdable'},
2053 {column => 'url', alias => 'location_url'}
2056 {column => 'id', alias => 'status_code'},
2057 {column => 'name', alias => 'copy_status'},
2058 {column => 'holdable', alias => 'status_holdable'}
2061 {column => 'label', alias => 'call_number_label'},
2062 {column => 'id', alias => 'call_number'},
2063 {column => 'owning_lib', alias => 'call_number_owning_lib'}
2065 circ => ['due_date'],
2067 {column => 'label', alias => 'call_number_prefix_label'},
2068 {column => 'id', alias => 'call_number_prefix'}
2071 {column => 'label', alias => 'call_number_suffix_label'},
2072 {column => 'id', alias => 'call_number_suffix'}
2075 {column => 'label', alias => 'part_label'},
2077 ($iss_id ? (sitem => ["issuance"]) : ())
2086 filter => {issuance => $iss_id},
2094 acnp => { fkey => 'prefix' },
2095 acns => { fkey => 'suffix' }
2099 ($rec_id ? {record => $rec_id} : ())
2102 circ => { # If the copy is circulating, retrieve the open circ
2104 filter => {checkin_time => undef}
2109 ($staff ? () : ( opac_visible => 't' )),
2113 ($staff ? () : (filter => { opac_visible => 't' }))
2119 bmp => { type => 'left', filter => { deleted => 'f' } }
2128 ($staff ? () : (opac_visible => 't'))
2130 ($dist_id ? ( '+sstr' => { distribution => $dist_id } ) : ()),
2131 ($staff ? () : ( '+aou' => { opac_visible => 't' } ))
2135 {class => 'aou', field => 'name'},
2136 {class => 'acn', field => 'label_sortkey'},
2137 {class => 'bmp', field => 'label_sortkey'},
2138 {class => 'acp', field => 'copy_number'},
2139 {class => 'acp', field => 'barcode'}
2142 limit => $copy_limit,
2143 offset => $copy_offset
2147 # Compare two dates, date1 and date2. If date2 is not defined, then
2148 # DateTime->now will be used. Assumes dates are in ISO8601 format as
2149 # supported by DateTime::Format::ISO8601. (A future enhancement might
2150 # be to support other formats.)
2152 # Returns -1 if $date1 < $date2
2153 # Returns 0 if $date1 == $date2
2154 # Returns 1 if $date1 > $date2
2160 # Check for timezone offsets and limit them to 2 digits:
2161 if ($date1 && $date1 =~ /(?:-|\+)\d\d\d\d$/) {
2162 $date1 = substr($date1, 0, length($date1) - 2);
2164 if ($date2 && $date2 =~ /(?:-|\+)\d\d\d\d$/) {
2165 $date2 = substr($date2, 0, length($date2) - 2);
2169 unless (UNIVERSAL::isa($date1, "DateTime")) {
2170 $date1 = DateTime::Format::ISO8601->parse_datetime($date1);
2175 $date2 = DateTime->now;
2177 unless (UNIVERSAL::isa($date2, "DateTime")) {
2178 $date2 = DateTime::Format::ISO8601->parse_datetime($date2);
2182 return DateTime->compare($date1, $date2);
2186 # marcdoc is an XML::LibXML document
2187 # updates the doc and returns the entityized MARC string
2188 sub strip_marc_fields {
2189 my ($class, $e, $marcdoc, $grps) = @_;
2191 my $orgs = $class->get_org_ancestors($e->requestor->ws_ou);
2194 select => {vibtf => ['field']},
2195 from => {vibtf => 'vibtg'},
2196 where => {'+vibtg' => {owner => $orgs}},
2200 # give me always-apply groups plus any selected groups
2201 if ($grps and @$grps) {
2202 $query->{where}->{'+vibtg'}->{'-or'} = [
2204 {always_apply => 't'}
2208 $query->{where}->{'+vibtg'}->{always_apply} = 't';
2211 my $fields = $e->json_query($query);
2213 for my $field (@$fields) {
2214 my $tag = $field->{field};
2215 for my $node ($marcdoc->findnodes('//*[@tag="'.$tag.'"]')) {
2216 $node->parentNode->removeChild($node);
2220 return $class->entityize($marcdoc->documentElement->toString);
2223 # marcdoc is an XML::LibXML document
2224 # updates the document and returns the entityized MARC string.
2226 my ($class, $marcdoc, $username) = @_;
2228 # Look for existing 905$u subfields. If any exist, do nothing.
2229 my @nodes = $marcdoc->findnodes('//*[@tag="905"]/*[@code="u"]');
2231 # We create a new 905 and the subfield u to that.
2232 my $parentNode = $marcdoc->createElement('datafield');
2233 $parentNode->setAttribute('tag', '905');
2234 $parentNode->setAttribute('ind1', '');
2235 $parentNode->setAttribute('ind2', '');
2236 $marcdoc->documentElement->addChild($parentNode);
2237 my $node = $marcdoc->createElement('subfield');
2238 $node->setAttribute('code', 'u');
2239 $node->appendTextNode($username);
2240 $parentNode->addChild($node);
2244 return $class->entityize($marcdoc->documentElement->toString);
2247 # Given a list of PostgreSQL arrays of numbers,
2248 # unnest the numbers and return a unique set, skipping any list elements
2249 # that are just '{NULL}'.
2250 sub unique_unnested_numbers {
2253 no warnings 'numeric';
2258 map { $_ eq 'NULL' ? undef : (split /,/, $_) }
2259 map { substr($_, 1, -1) } @_
2264 # Check if a transaction should be left open or closed. Close the
2265 # transaction if it should be closed or open it otherwise. Returns
2266 # undef on success or a failure event.
2267 sub check_open_xact {
2268 my( $self, $editor, $xactid, $xact ) = @_;
2270 # Grab the transaction
2271 $xact ||= $editor->retrieve_money_billable_transaction($xactid);
2272 return $editor->event unless $xact;
2273 $xactid ||= $xact->id;
2275 # grab the summary and see how much is owed on this transaction
2276 my ($summary) = $self->fetch_mbts($xactid, $editor);
2278 # grab the circulation if it is a circ;
2279 my $circ = $editor->retrieve_action_circulation($xactid);
2281 # If nothing is owed on the transaction but it is still open
2282 # and this transaction is not an open circulation, close it
2284 ( $summary->balance_owed == 0 and ! $xact->xact_finish ) and
2285 ( !$circ or $circ->stop_fines )) {
2287 $logger->info("closing transaction ".$xact->id. ' because balance_owed == 0');
2288 $xact->xact_finish('now');
2289 $editor->update_money_billable_transaction($xact)
2290 or return $editor->event;
2294 # If money is owed or a refund is due on the xact and xact_finish
2295 # is set, clear it (to reopen the xact) and update
2296 if( $summary->balance_owed != 0 and $xact->xact_finish ) {
2297 $logger->info("re-opening transaction ".$xact->id. ' because balance_owed != 0');
2298 $xact->clear_xact_finish;
2299 $editor->update_money_billable_transaction($xact)
2300 or return $editor->event;
2306 # Because floating point math has rounding issues, and Dyrcona gets
2307 # tired of typing out the code to multiply floating point numbers
2308 # before adding and subtracting them and then dividing the result by
2309 # 100 each time, he wrote this little subroutine for subtracting
2310 # floating point values. It can serve as a model for the other
2311 # operations if you like.
2313 # It takes a list of floating point values as arguments. The rest are
2314 # all subtracted from the first and the result is returned. The
2315 # values are all multiplied by 100 before being used, and the result
2316 # is divided by 100 in order to avoid decimal rounding errors inherent
2317 # in floating point math.
2319 # XXX shifting using multiplication/division *may* still introduce
2320 # rounding errors -- better to implement using string manipulation?
2322 my ($class, @args) = @_;
2323 my $result = shift(@args) * 100;
2324 while (my $arg = shift(@args)) {
2325 $result -= $arg * 100;
2327 return $result / 100;
2331 my ($class, @args) = @_;
2332 my $result = shift(@args) * 100;
2333 while (my $arg = shift(@args)) {
2334 $result += $arg * 100;
2336 return $result / 100;
2339 # Non-migrated passwords can be verified directly in the DB
2340 # with any extra hashing.
2341 sub verify_user_password {
2342 my ($class, $e, $user_id, $passwd, $pw_type) = @_;
2344 $pw_type ||= 'main'; # primary login password
2346 my $verify = $e->json_query({
2348 'actor.verify_passwd',
2349 $user_id, $pw_type, $passwd
2353 return $class->is_true($verify->{'actor.verify_passwd'});
2356 # Passwords migrated from the original MD5 scheme are passed through 2
2357 # extra layers of MD5 hashing for backwards compatibility with the
2358 # MD5 passwords of yore and the MD5-based chap-style authentication.
2359 # Passwords are stored in the DB like this:
2360 # CRYPT( MD5( pw_salt || MD5(real_password) ), pw_salt )
2362 # If 'as_md5' is true, the password provided has already been
2364 sub verify_migrated_user_password {
2365 my ($class, $e, $user_id, $passwd, $as_md5) = @_;
2367 # 'main' is the primary login password. This is the only password
2368 # type that requires the additional MD5 hashing.
2369 my $pw_type = 'main';
2371 # Sometimes we have the bare password, sometimes the MD5 version.
2372 my $md5_pass = $as_md5 ? $passwd : md5_hex($passwd);
2374 my $salt = $e->json_query({
2382 $salt = $salt->{'actor.get_salt'};
2384 return $class->verify_user_password(
2385 $e, $user_id, md5_hex($salt . $md5_pass), $pw_type);