Open-ILS/src/perlmods/lib/OpenILS/Application/AppUtils.pm

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