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

   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);
   9 use OpenILS::Event;
  10 use Data::Dumper;
  11 use OpenILS::Utils::CStoreEditor;
  12 use OpenILS::Const qw/:const/;
  13 use Unicode::Normalize;
  14 use OpenSRF::Utils::SettingsClient;
  15 use UUID::Tiny;
  16 use Encode;
  17 use DateTime;
  18 use DateTime::Format::ISO8601;
  19 use List::MoreUtils qw/uniq/;
  20 use Digest::MD5 qw(md5_hex);
  21
  22 # ---------------------------------------------------------------------------
  23 # Pile of utilty methods used accross applications.
  24 # ---------------------------------------------------------------------------
  25 my $cache_client = "OpenSRF::Utils::Cache";
  26
  27
  28 # ---------------------------------------------------------------------------
  29 # on sucess, returns the created session, on failure throws ERROR exception
  30 # ---------------------------------------------------------------------------
  31 sub start_db_session {
  32
  33     my $self = shift;
  34     my $session = OpenSRF::AppSession->connect( "open-ils.storage" );
  35     my $trans_req = $session->request( "open-ils.storage.transaction.begin" );
  36
  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() ) {
  40         throw OpenSRF::ERROR
  41             ("Unable to Begin Transaction with database" );
  42     }
  43     $trans_req->finish();
  44
  45     $logger->debug("Setting global storage session to ".
  46         "session: " . $session->session_id . " : " . $session->app );
  47
  48     return $session;
  49 }
  50
  51 sub set_audit_info {
  52     my $self = shift;
  53     my $session = shift;
  54     my $authtoken = shift;
  55     my $user_id = shift;
  56     my $ws_id = shift;
  57
  58     my $audit_req = $session->request( "open-ils.storage.set_audit_info", $authtoken, $user_id, $ws_id );
  59     my $audit_resp = $audit_req->recv();
  60     $audit_req->finish();
  61 }
  62
  63 my $PERM_QUERY = {
  64     select => {
  65         au => [ {
  66             transform => 'permission.usr_has_perm',
  67             alias => 'has_perm',
  68             column => 'id',
  69             params => []
  70         } ]
  71     },
  72     from => 'au',
  73     where => {},
  74 };
  75
  76
  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");
  82
  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});
  87     }
  88     return undef;
  89 }
  90
  91 # checks the list of user perms.  The first one that fails returns a new
  92 sub check_perms {
  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;
  96     return undef;
  97 }
  98
  99
 100
 101 # ---------------------------------------------------------------------------
 102 # commits and destroys the session
 103 # ---------------------------------------------------------------------------
 104 sub commit_db_session {
 105     my( $self, $session ) = @_;
 106
 107     my $req = $session->request( "open-ils.storage.transaction.commit" );
 108     my $resp = $req->recv();
 109
 110     if(!$resp) {
 111         throw OpenSRF::EX::ERROR ("Unable to commit db session");
 112     }
 113
 114     if(UNIVERSAL::isa($resp,"Error")) {
 115         throw $resp ($resp->stringify);
 116     }
 117
 118     if(!$resp->content) {
 119         throw OpenSRF::EX::ERROR ("Unable to commit db session");
 120     }
 121
 122     $session->finish();
 123     $session->disconnect();
 124     $session->kill_me();
 125 }
 126
 127 sub rollback_db_session {
 128     my( $self, $session ) = @_;
 129
 130     my $req = $session->request("open-ils.storage.transaction.rollback");
 131     my $resp = $req->recv();
 132     if(UNIVERSAL::isa($resp,"Error")) { throw $resp;  }
 133
 134     $session->finish();
 135     $session->disconnect();
 136     $session->kill_me();
 137 }
 138
 139
 140 # returns undef it the event is not an ILS event
 141 # returns the event code otherwise
 142 sub event_code {
 143     my( $self, $evt ) = @_;
 144     return $evt->{ilsevent} if $self->is_event($evt);
 145     return undef;
 146 }
 147
 148 # some events, in particular auto-generated events, don't have an
 149 # ilsevent key.  treat hashes with a 'textcode' key as events.
 150 sub is_event {
 151     my ($self, $evt) = @_;
 152     return (
 153         ref($evt) eq 'HASH' and (
 154             defined $evt->{ilsevent} or
 155             defined $evt->{textcode}
 156         )
 157     );
 158 }
 159
 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 ) = @_;
 166
 167     my $content = $self->simplereq(
 168         'open-ils.auth',
 169         'open-ils.auth.session.retrieve', $user_session);
 170
 171     return undef if (!$content) or $self->event_code($content);
 172     return $content;
 173 }
 174
 175 # generic simple request returning a scalar value
 176 sub simplereq {
 177     my($self, $service, $method, @params) = @_;
 178     return $self->simple_scalar_request($service, $method, @params);
 179 }
 180
 181
 182 sub simple_scalar_request {
 183     my($self, $service, $method, @params) = @_;
 184
 185     my $session = OpenSRF::AppSession->create( $service );
 186
 187     my $request = $session->request( $method, @params );
 188
 189     my $val;
 190     my $err;
 191     try  {
 192
 193         $val = $request->gather(1);
 194
 195     } catch Error with {
 196         $err = shift;
 197     };
 198
 199     if( $err ) {
 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 : " );
 202     }
 203
 204     return $val;
 205 }
 206
 207 sub build_org_tree {
 208     my( $self, $orglist ) = @_;
 209
 210     return $orglist unless ref $orglist;
 211     return $$orglist[0] if @$orglist == 1;
 212
 213     my @list = sort {
 214         $a->ou_type <=> $b->ou_type ||
 215         $a->name cmp $b->name } @$orglist;
 216
 217     for my $org (@list) {
 218
 219         next unless ($org);
 220         next if (!defined($org->parent_ou) || $org->parent_ou eq "");
 221
 222         my ($parent) = grep { $_->id == $org->parent_ou } @list;
 223         next unless $parent;
 224         $parent->children([]) unless defined($parent->children);
 225         push( @{$parent->children}, $org );
 226     }
 227
 228     return $list[0];
 229 }
 230
 231 sub fetch_closed_date {
 232     my( $self, $cd ) = @_;
 233     my $evt;
 234
 235     $logger->debug("Fetching closed_date $cd from cstore");
 236
 237     my $cd_obj = $self->simplereq(
 238         'open-ils.cstore',
 239         'open-ils.cstore.direct.actor.org_unit.closed_date.retrieve', $cd );
 240
 241     if(!$cd_obj) {
 242         $logger->info("closed_date $cd not found in the db");
 243         $evt = OpenILS::Event->new('ACTOR_USER_NOT_FOUND');
 244     }
 245
 246     return ($cd_obj, $evt);
 247 }
 248
 249 sub fetch_user {
 250     my( $self, $userid ) = @_;
 251     my( $user, $evt );
 252
 253     $logger->debug("Fetching user $userid from cstore");
 254
 255     $user = $self->simplereq(
 256         'open-ils.cstore',
 257         'open-ils.cstore.direct.actor.user.retrieve', $userid );
 258
 259     if(!$user) {
 260         $logger->info("User $userid not found in the db");
 261         $evt = OpenILS::Event->new('ACTOR_USER_NOT_FOUND');
 262     }
 263
 264     return ($user, $evt);
 265 }
 266
 267 sub checkses {
 268     my( $self, $session ) = @_;
 269     my $user = $self->check_user_session($session) or
 270         return (undef, OpenILS::Event->new('NO_SESSION'));
 271     return ($user);
 272 }
 273
 274
 275 # verifiese the session and checks the permissions agains the
 276 # session user and the user's home_ou as the org id
 277 sub checksesperm {
 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);
 285 }
 286
 287
 288 sub checkrequestor {
 289     my( $self, $staffobj, $userid, @perms ) = @_;
 290     my $user; my $evt;
 291     $userid = $staffobj->id unless defined $userid;
 292
 293     $logger->debug("checkrequestor(): requestor => " . $staffobj->id . ", target => $userid");
 294
 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 );
 299
 300     } else {
 301         $user = $staffobj;
 302     }
 303
 304     return ($user, $evt);
 305 }
 306
 307 sub checkses_requestor {
 308     my( $self, $authtoken, $targetid, @perms ) = @_;
 309     my( $requestor, $target, $evt );
 310
 311     ($requestor, $evt) = $self->checkses($authtoken);
 312     return (undef, undef, $evt) if $evt;
 313
 314     ($target, $evt) = $self->checkrequestor( $requestor, $targetid, @perms );
 315     return( $requestor, $target, $evt);
 316 }
 317
 318 sub fetch_copy {
 319     my( $self, $copyid ) = @_;
 320     my( $copy, $evt );
 321
 322     $logger->debug("Fetching copy $copyid from cstore");
 323
 324     $copy = $self->simplereq(
 325         'open-ils.cstore',
 326         'open-ils.cstore.direct.asset.copy.retrieve', $copyid );
 327
 328     if(!$copy) { $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND'); }
 329
 330     return( $copy, $evt );
 331 }
 332
 333
 334 # retrieves a circ object by id
 335 sub fetch_circulation {
 336     my( $self, $circid ) = @_;
 337     my $circ; my $evt;
 338
 339     $logger->debug("Fetching circ $circid from cstore");
 340
 341     $circ = $self->simplereq(
 342         'open-ils.cstore',
 343         "open-ils.cstore.direct.action.circulation.retrieve", $circid );
 344
 345     if(!$circ) {
 346         $evt = OpenILS::Event->new('ACTION_CIRCULATION_NOT_FOUND', circid => $circid );
 347     }
 348
 349     return ( $circ, $evt );
 350 }
 351
 352 sub fetch_record_by_copy {
 353     my( $self, $copyid ) = @_;
 354     my( $record, $evt );
 355
 356     $logger->debug("Fetching record by copy $copyid from cstore");
 357
 358     $record = $self->simplereq(
 359         'open-ils.cstore',
 360         'open-ils.cstore.direct.asset.copy.retrieve', $copyid,
 361         { flesh => 3,
 362           flesh_fields => { bre => [ 'fixed_fields' ],
 363                     acn => [ 'record' ],
 364                     acp => [ 'call_number' ],
 365                   }
 366         }
 367     );
 368
 369     if(!$record) {
 370         $evt = OpenILS::Event->new('BIBLIO_RECORD_ENTRY_NOT_FOUND');
 371     } else {
 372         $record = $record->call_number->record;
 373     }
 374
 375     return ($record, $evt);
 376 }
 377
 378 # turns a record object into an mvr (mods) object
 379 sub record_to_mvr {
 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);
 387     return $mods;
 388 }
 389
 390 sub fetch_hold {
 391     my( $self, $holdid ) = @_;
 392     my( $hold, $evt );
 393
 394     $logger->debug("Fetching hold $holdid from cstore");
 395
 396     $hold = $self->simplereq(
 397         'open-ils.cstore',
 398         'open-ils.cstore.direct.action.hold_request.retrieve', $holdid);
 399
 400     $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND', holdid => $holdid) unless $hold;
 401
 402     return ($hold, $evt);
 403 }
 404
 405
 406 sub fetch_hold_transit_by_hold {
 407     my( $self, $holdid ) = @_;
 408     my( $transit, $evt );
 409
 410     $logger->debug("Fetching transit by hold $holdid from cstore");
 411
 412     $transit = $self->simplereq(
 413         'open-ils.cstore',
 414         'open-ils.cstore.direct.action.hold_transit_copy.search', { hold => $holdid, cancel_time => undef } );
 415
 416     $evt = OpenILS::Event->new('ACTION_HOLD_TRANSIT_COPY_NOT_FOUND', holdid => $holdid) unless $transit;
 417
 418     return ($transit, $evt );
 419 }
 420
 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");
 425     my( $hold, $evt );
 426
 427     $hold = $self->cstorereq(
 428         'open-ils.cstore.direct.action.hold_request.search',
 429         {
 430             current_copy        => $copyid ,
 431             capture_time        => { "!=" => undef },
 432             fulfillment_time    => undef,
 433             cancel_time         => undef,
 434         } );
 435
 436     $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND', copyid => $copyid) unless $hold;
 437     return ($hold, $evt);
 438 }
 439
 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);
 448 }
 449
 450 sub fetch_copy_by_barcode {
 451     my( $self, $barcode ) = @_;
 452     my( $copy, $evt );
 453
 454     $logger->debug("Fetching copy by barcode $barcode from cstore");
 455
 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 );
 459
 460     $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', barcode => $barcode) unless $copy;
 461
 462     return ($copy, $evt);
 463 }
 464
 465 sub fetch_open_billable_transaction {
 466     my( $self, $transid ) = @_;
 467     my( $transaction, $evt );
 468
 469     $logger->debug("Fetching open billable transaction $transid from cstore");
 470
 471     $transaction = $self->simplereq(
 472         'open-ils.cstore',
 473         'open-ils.cstore.direct.money.open_billable_transaction_summary.retrieve',  $transid);
 474
 475     $evt = OpenILS::Event->new(
 476         'MONEY_OPEN_BILLABLE_TRANSACTION_SUMMARY_NOT_FOUND', transid => $transid ) unless $transaction;
 477
 478     return ($transaction, $evt);
 479 }
 480
 481
 482
 483 my %buckets;
 484 $buckets{'biblio'} = 'biblio_record_entry_bucket';
 485 $buckets{'callnumber'} = 'call_number_bucket';
 486 $buckets{'copy'} = 'copy_bucket';
 487 $buckets{'user'} = 'user_bucket';
 488
 489 sub fetch_container {
 490     my( $self, $id, $type ) = @_;
 491     my( $bucket, $evt );
 492
 493     $logger->debug("Fetching container $id with type $type");
 494
 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';
 499
 500     my $meth = $buckets{$type};
 501     $bucket = $self->simplereq(
 502         'open-ils.cstore',
 503         "open-ils.cstore.direct.container.$meth.retrieve", $id );
 504
 505     $evt = OpenILS::Event->new(
 506         $e, container => $id, container_type => $type ) unless $bucket;
 507
 508     return ($bucket, $evt);
 509 }
 510
 511
 512 sub fetch_container_e {
 513     my( $self, $editor, $id, $type ) = @_;
 514
 515     my( $bucket, $evt );
 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';
 520
 521     $evt = $editor->event unless $bucket;
 522     return ($bucket, $evt);
 523 }
 524
 525 sub fetch_container_item_e {
 526     my( $self, $editor, $id, $type ) = @_;
 527
 528     my( $bucket, $evt );
 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';
 533
 534     $evt = $editor->event unless $bucket;
 535     return ($bucket, $evt);
 536 }
 537
 538
 539
 540
 541
 542 sub fetch_container_item {
 543     my( $self, $id, $type ) = @_;
 544     my( $bucket, $evt );
 545
 546     $logger->debug("Fetching container item $id with type $type");
 547
 548     my $meth = $buckets{$type} . "_item";
 549
 550     $bucket = $self->simplereq(
 551         'open-ils.cstore',
 552         "open-ils.cstore.direct.container.$meth.retrieve", $id );
 553
 554
 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';
 559
 560     $evt = OpenILS::Event->new(
 561         $e, itemid => $id, container_type => $type ) unless $bucket;
 562
 563     return ($bucket, $evt);
 564 }
 565
 566
 567 sub fetch_patron_standings {
 568     my $self = shift;
 569     $logger->debug("Fetching patron standings");
 570     return $self->simplereq(
 571         'open-ils.cstore',
 572         'open-ils.cstore.direct.config.standing.search.atomic', { id => { '!=' => undef } });
 573 }
 574
 575
 576 sub fetch_permission_group_tree {
 577     my $self = shift;
 578     $logger->debug("Fetching patron profiles");
 579     return $self->simplereq(
 580         'open-ils.actor',
 581         'open-ils.actor.groups.tree.retrieve' );
 582 }
 583
 584 sub fetch_permission_group_descendants {
 585     my( $self, $profile ) = @_;
 586     my $group_tree = $self->fetch_permission_group_tree();
 587     my $start_here;
 588     my @groups;
 589
 590     # FIXME: okay, so it's not an org tree, but it is compatible
 591     $self->walk_org_tree($group_tree, sub {
 592         my $g = shift;
 593         if ($g->id == $profile) {
 594             $start_here = $g;
 595         }
 596     });
 597
 598     $self->walk_org_tree($start_here, sub {
 599         my $g = shift;
 600         push(@groups,$g->id);
 601     });
 602
 603     return \@groups;
 604 }
 605
 606 sub fetch_patron_circ_summary {
 607     my( $self, $userid ) = @_;
 608     $logger->debug("Fetching patron summary for $userid");
 609     my $summary = $self->simplereq(
 610         'open-ils.storage',
 611         "open-ils.storage.action.circulation.patron_summary", $userid );
 612
 613     if( $summary ) {
 614         $summary->[0] ||= 0;
 615         $summary->[1] ||= 0.0;
 616         return $summary;
 617     }
 618     return undef;
 619 }
 620
 621
 622 sub fetch_copy_statuses {
 623     my( $self ) = @_;
 624     $logger->debug("Fetching copy statuses");
 625     return $self->simplereq(
 626         'open-ils.cstore',
 627         'open-ils.cstore.direct.config.copy_status.search.atomic', { id => { '!=' => undef } });
 628 }
 629
 630 sub fetch_copy_location {
 631     my( $self, $id ) = @_;
 632     my $evt;
 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;
 636     return ($cl, $evt);
 637 }
 638
 639 sub fetch_copy_locations {
 640     my $self = shift;
 641     return $self->simplereq(
 642         'open-ils.cstore',
 643         'open-ils.cstore.direct.asset.copy_location.search.atomic', { id => { '!=' => undef }, deleted => 'f' });
 644 }
 645
 646 sub fetch_copy_location_by_name {
 647     my( $self, $name, $org ) = @_;
 648     my $evt;
 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;
 653     return ($cl, $evt);
 654 }
 655
 656 sub fetch_callnumber {
 657     my( $self, $id, $flesh, $e ) = @_;
 658
 659     $e ||= OpenILS::Utils::CStoreEditor->new;
 660
 661     my $evt = OpenILS::Event->new( 'ASSET_CALL_NUMBER_NOT_FOUND', id => $id );
 662     return( undef, $evt ) unless $id;
 663
 664     $logger->debug("Fetching callnumber $id");
 665
 666     my $cn = $e->retrieve_asset_call_number([
 667         $id,
 668         { flesh => $flesh, flesh_fields => { acn => [ 'prefix', 'suffix', 'label_class' ] } },
 669     ]);
 670
 671     return ( $cn, $e->event );
 672 }
 673
 674 my %ORG_CACHE; # - these rarely change, so cache them..
 675 sub fetch_org_unit {
 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");
 681     my $evt = undef;
 682
 683     my $org = $self->simplereq(
 684         'open-ils.cstore',
 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;
 688
 689     return ($org, $evt);
 690 }
 691
 692 sub fetch_stat_cat {
 693     my( $self, $type, $id ) = @_;
 694     my( $cat, $evt );
 695     $logger->debug("Fetching $type stat cat: $id");
 696     $cat = $self->simplereq(
 697         'open-ils.cstore',
 698         "open-ils.cstore.direct.$type.stat_cat.retrieve", $id );
 699
 700     my $e = 'ASSET_STAT_CAT_NOT_FOUND';
 701     $e = 'ACTOR_STAT_CAT_NOT_FOUND' if $type eq 'actor';
 702
 703     $evt = OpenILS::Event->new( $e, id => $id ) unless $cat;
 704     return ( $cat, $evt );
 705 }
 706
 707 sub fetch_stat_cat_entry {
 708     my( $self, $type, $id ) = @_;
 709     my( $entry, $evt );
 710     $logger->debug("Fetching $type stat cat entry: $id");
 711     $entry = $self->simplereq(
 712         'open-ils.cstore',
 713         "open-ils.cstore.direct.$type.stat_cat_entry.retrieve", $id );
 714
 715     my $e = 'ASSET_STAT_CAT_ENTRY_NOT_FOUND';
 716     $e = 'ACTOR_STAT_CAT_ENTRY_NOT_FOUND' if $type eq 'actor';
 717
 718     $evt = OpenILS::Event->new( $e, id => $id ) unless $entry;
 719     return ( $entry, $evt );
 720 }
 721
 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(
 727         'open-ils.cstore',
 728         "open-ils.cstore.direct.$type.stat_cat_entry_default.retrieve", $id );
 729
 730     my $e = 'ASSET_STAT_CAT_ENTRY_DEFAULT_NOT_FOUND';
 731     $e = 'ACTOR_STAT_CAT_ENTRY_DEFAULT_NOT_FOUND' if $type eq 'actor';
 732
 733     $evt = OpenILS::Event->new( $e, id => $id ) unless $entry_default;
 734     return ( $entry_default, $evt );
 735 }
 736
 737 sub fetch_stat_cat_entry_default_by_stat_cat_and_org {
 738     my( $self, $type, $stat_cat, $orgId ) = @_;
 739     my $entry_default;
 740     $logger->info("### Fetching $type stat cat entry default with stat_cat $stat_cat owned by org_unit $orgId");
 741     $entry_default = $self->simplereq(
 742         'open-ils.cstore',
 743         "open-ils.cstore.direct.$type.stat_cat_entry_default.search.atomic",
 744         { stat_cat => $stat_cat, owner => $orgId } );
 745
 746     $entry_default = $entry_default->[0];
 747     return ($entry_default, undef) if $entry_default;
 748
 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) );
 752 }
 753
 754 sub find_org {
 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);
 761         return $o if $o;
 762     }
 763     return undef;
 764 }
 765
 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(
 770         'open-ils.cstore',
 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') );
 775 }
 776
 777 sub fetch_non_cat_type {
 778     my( $self, $id ) = @_;
 779     $logger->debug("Fetching non cat type $id");
 780     my( $type, $evt );
 781     $type = $self->simplereq(
 782         'open-ils.cstore',
 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);
 786 }
 787
 788 sub DB_UPDATE_FAILED {
 789     my( $self, $payload ) = @_;
 790     return OpenILS::Event->new('DATABASE_UPDATE_FAILED',
 791         payload => ($payload) ? $payload : undef );
 792 }
 793
 794 sub fetch_booking_reservation {
 795     my( $self, $id ) = @_;
 796     my( $res, $evt );
 797
 798     $res = $self->simplereq(
 799         'open-ils.cstore',
 800         'open-ils.cstore.direct.booking.reservation.retrieve', $id
 801     );
 802
 803     # simplereq doesn't know how to flesh so ...
 804     if ($res) {
 805         $res->usr(
 806             $self->simplereq(
 807                 'open-ils.cstore',
 808                 'open-ils.cstore.direct.actor.user.retrieve', $res->usr
 809             )
 810         );
 811
 812         $res->target_resource_type(
 813             $self->simplereq(
 814                 'open-ils.cstore',
 815                 'open-ils.cstore.direct.booking.resource_type.retrieve', $res->target_resource_type
 816             )
 817         );
 818
 819         if ($res->current_resource) {
 820             $res->current_resource(
 821                 $self->simplereq(
 822                     'open-ils.cstore',
 823                     'open-ils.cstore.direct.booking.resource.retrieve', $res->current_resource
 824                 )
 825             );
 826
 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 ) );
 829             }
 830         }
 831
 832         if ($res->target_resource) {
 833             $res->target_resource(
 834                 $self->simplereq(
 835                     'open-ils.cstore',
 836                     'open-ils.cstore.direct.booking.resource.retrieve', $res->target_resource
 837                 )
 838             );
 839
 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 ) );
 842             }
 843         }
 844
 845     } else {
 846         $evt = OpenILS::Event->new('RESERVATION_NOT_FOUND');
 847     }
 848
 849     return ($res, $evt);
 850 }
 851
 852 sub fetch_circ_duration_by_name {
 853     my( $self, $name ) = @_;
 854     my( $dur, $evt );
 855     $dur = $self->simplereq(
 856         'open-ils.cstore',
 857         'open-ils.cstore.direct.config.rules.circ_duration.search.atomic', { name => $name } );
 858     $dur = $dur->[0];
 859     $evt = OpenILS::Event->new('CONFIG_RULES_CIRC_DURATION_NOT_FOUND') unless $dur;
 860     return ($dur, $evt);
 861 }
 862
 863 sub fetch_recurring_fine_by_name {
 864     my( $self, $name ) = @_;
 865     my( $obj, $evt );
 866     $obj = $self->simplereq(
 867         'open-ils.cstore',
 868         'open-ils.cstore.direct.config.rules.recurring_fine.search.atomic', { name => $name } );
 869     $obj = $obj->[0];
 870     $evt = OpenILS::Event->new('CONFIG_RULES_RECURRING_FINE_NOT_FOUND') unless $obj;
 871     return ($obj, $evt);
 872 }
 873
 874 sub fetch_max_fine_by_name {
 875     my( $self, $name ) = @_;
 876     my( $obj, $evt );
 877     $obj = $self->simplereq(
 878         'open-ils.cstore',
 879         'open-ils.cstore.direct.config.rules.max_fine.search.atomic', { name => $name } );
 880     $obj = $obj->[0];
 881     $evt = OpenILS::Event->new('CONFIG_RULES_MAX_FINE_NOT_FOUND') unless $obj;
 882     return ($obj, $evt);
 883 }
 884
 885 sub fetch_hard_due_date_by_name {
 886     my( $self, $name ) = @_;
 887     my( $obj, $evt );
 888     $obj = $self->simplereq(
 889         'open-ils.cstore',
 890         'open-ils.cstore.direct.config.hard_due_date.search.atomic', { name => $name } );
 891     $obj = $obj->[0];
 892     $evt = OpenILS::Event->new('CONFIG_RULES_HARD_DUE_DATE_NOT_FOUND') unless $obj;
 893     return ($obj, $evt);
 894 }
 895
 896 sub storagereq {
 897     my( $self, $method, @params ) = @_;
 898     return $self->simplereq(
 899         'open-ils.storage', $method, @params );
 900 }
 901
 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);
 907     return $val;
 908 }
 909
 910 sub cstorereq {
 911     my( $self, $method, @params ) = @_;
 912     return $self->simplereq(
 913         'open-ils.cstore', $method, @params );
 914 }
 915
 916 sub event_equals {
 917     my( $self, $e, $name ) =  @_;
 918     if( $e and ref($e) eq 'HASH' and
 919         defined($e->{textcode}) and $e->{textcode} eq $name ) {
 920         return 1 ;
 921     }
 922     return 0;
 923 }
 924
 925 sub logmark {
 926     my( undef, $f, $l ) = caller(0);
 927     my( undef, undef, undef, $s ) = caller(1);
 928     $s =~ s/.*:://g;
 929     $f =~ s/.*\///g;
 930     $logger->debug("LOGMARK: $f:$l:$s");
 931 }
 932
 933 # takes a copy id
 934 sub fetch_open_circulation {
 935     my( $self, $cid ) = @_;
 936     $self->logmark;
 937
 938     my $e = OpenILS::Utils::CStoreEditor->new;
 939     my $circ = $e->search_action_circulation({
 940         target_copy => $cid,
 941         stop_fines_time => undef,
 942         checkin_time => undef
 943     })->[0];
 944
 945     return ($circ, $e->event);
 946 }
 947
 948 my $copy_statuses;
 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 );
 954     }
 955     return undef;
 956 }
 957
 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 );
 963     }
 964     return undef;
 965 }
 966
 967
 968 sub copy_status {
 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;
 973     return $stat;
 974 }
 975
 976 sub fetch_open_transit_by_copy {
 977     my( $self, $copyid ) = @_;
 978     my($transit, $evt);
 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);
 984 }
 985
 986 sub unflesh_copy {
 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);
 992     return $copy;
 993 }
 994
 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;
1003 }
1004
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
1008 sub update_copy {
1009     my( $self, %params ) = @_;
1010
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};
1014
1015     $logger->debug("Updating copy in the database: " . $copy->id);
1016
1017     $self->unflesh_copy($copy);
1018     $copy->editor( $editor );
1019     $copy->edit_date( 'now' );
1020
1021     my $s;
1022     my $meth = 'open-ils.storage.direct.asset.copy.update';
1023
1024     $s = $session->request( $meth, $copy )->gather(1) if $session;
1025     $s = $self->storagereq( $meth, $copy ) unless $session;
1026
1027     $logger->debug("Update of copy ".$copy->id." returned: $s");
1028
1029     return $self->DB_UPDATE_FAILED($copy) unless $s;
1030     return undef;
1031 }
1032
1033 sub update_reservation {
1034     my( $self, %params ) = @_;
1035
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};
1039
1040     $logger->debug("Updating copy in the database: " . $reservation->id);
1041
1042     $self->unflesh_reservation($reservation);
1043
1044     my $s;
1045     my $meth = 'open-ils.cstore.direct.booking.reservation.update';
1046
1047     $s = $session->request( $meth, $reservation )->gather(1) if $session;
1048     $s = $self->cstorereq( $meth, $reservation ) unless $session;
1049
1050     $logger->debug("Update of copy ".$reservation->id." returned: $s");
1051
1052     return $self->DB_UPDATE_FAILED($reservation) unless $s;
1053     return undef;
1054 }
1055
1056 sub fetch_billable_xact {
1057     my( $self, $id ) = @_;
1058     my($xact, $evt);
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);
1064 }
1065
1066 sub fetch_billable_xact_summary {
1067     my( $self, $id ) = @_;
1068     my($xact, $evt);
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);
1074 }
1075
1076 sub fetch_fleshed_copy {
1077     my( $self, $id ) = @_;
1078     my( $copy, $evt );
1079     $logger->info("Fetching fleshed copy $id");
1080     $copy = $self->cstorereq(
1081         "open-ils.cstore.direct.asset.copy.retrieve", $id,
1082         { flesh => 1,
1083           flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
1084         }
1085     );
1086     $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', id => $id) unless $copy;
1087     return ($copy, $evt);
1088 }
1089
1090
1091 # returns the org that owns the callnumber that the copy
1092 # is attached to
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);
1102 }
1103
1104 sub fetch_copy_note {
1105     my( $self, $id ) = @_;
1106     my( $note, $evt );
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);
1112 }
1113
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);
1121 }
1122
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 );
1129 }
1130
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;
1139     return ($user);
1140
1141 }
1142
1143 sub fetch_bill {
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);
1150 }
1151
1152 sub walk_org_tree {
1153     my( $self, $node, $callback ) = @_;
1154     return unless $node;
1155     $callback->($node);
1156     if( $node->children ) {
1157         $self->walk_org_tree($_, $callback) for @{$node->children};
1158     }
1159 }
1160
1161 sub is_true {
1162     my( $self, $item ) = @_;
1163     return 1 if $item and $item !~ /^f$/i;
1164     return 0;
1165 }
1166
1167
1168 sub patientreq {
1169     my ($self, $client, $service, $method, @params) = @_;
1170     my ($response, $err);
1171
1172     my $session = create OpenSRF::AppSession($service);
1173     my $request = $session->request($method, @params);
1174
1175     my $spurt = 10;
1176     my $give_up = time + 1000;
1177
1178     try {
1179         while (time < $give_up) {
1180             $response = $request->recv("timeout" => $spurt);
1181             last if $request->complete;
1182
1183             $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1184         }
1185     } catch Error with {
1186         $err = shift;
1187     };
1188
1189     if ($err) {
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 : " );
1192     }
1193
1194     return $response->content;
1195 }
1196
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 } );
1204
1205     my $total = 0;
1206     my $data;
1207     while( $data = $req->recv ) {
1208         $data = $data->content;
1209         $total += $data->balance_owed;
1210     }
1211     return $total;
1212 }
1213
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);
1220     return $val;
1221 }
1222
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);
1229     return $val;
1230 }
1231
1232
1233
1234
1235 #---------------------------------------------------------------------
1236 # Returns  ($summary, $event)
1237 #---------------------------------------------------------------------
1238 sub fetch_mbts {
1239     my $self = shift;
1240     my $id  = shift;
1241     my $e = shift || OpenILS::Utils::CStoreEditor->new;
1242     $id = $id->id if ref($id);
1243
1244     my $xact = $e->retrieve_money_billable_transaction_summary($id)
1245         or return (undef, $e->event);
1246
1247     return ($xact);
1248 }
1249
1250
1251 #---------------------------------------------------------------------
1252 # Given a list of money.billable_transaction objects, this creates
1253 # transaction summary objects for each
1254 #--------------------------------------------------------------------
1255 sub make_mbts {
1256     my $self = shift;
1257     my $e = shift;
1258     my @xacts = @_;
1259     return () if (!@xacts);
1260     return @{$e->search_money_billable_transaction_summary({id => [ map { $_->id } @xacts ]})};
1261 }
1262
1263
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;
1269     return undef;
1270 }
1271
1272
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.
1277 # API users beware.
1278 #
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".
1283
1284 sub ou_ancestor_setting {
1285     my( $self, $orgid, $name, $e, $auth ) = @_;
1286     $e = $e || OpenILS::Utils::CStoreEditor->new(
1287         (defined $auth) ? (authtoken => $auth) : ()
1288     );
1289
1290     if ($auth) {
1291         my $coust = $e->retrieve_config_org_unit_setting_type([
1292             $name, {flesh => 1, flesh_fields => {coust => ['view_perm']}}
1293         ]);
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);
1299         }
1300     }
1301
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})};
1306 }
1307
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 ) = @_;
1316
1317     my %result = map { $_ => undef } @$names;
1318     my $query = {
1319         from => [
1320             'actor.org_unit_ancestor_setting_batch',
1321             $orgid,
1322             '{' . join(',', @$names) . '}'
1323         ]
1324     };
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})
1331         };
1332     }
1333     return %result;
1334 }
1335
1336 # Returns a hash of hashes like so:
1337 # {
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
1341 #   ...
1342 # }
1343 sub ou_ancestor_setting_batch_by_org_insecure {
1344     my ($self, $org_ids, $name, $e) = @_;
1345
1346     $e ||= OpenILS::Utils::CStoreEditor->new();
1347     my %result = map { $_ => {value => undef} } @$org_ids;
1348
1349     my $query = {
1350         from => [
1351             'actor.org_unit_ancestor_setting_batch_by_org',
1352             $name, '{' . join(',', @$org_ids) . '}'
1353         ]
1354     };
1355
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];
1363
1364         next unless $setting->{id}; # null ID means no value is present.
1365
1366         $result{$org_id}->{org} = $setting->{org_unit};
1367         $result{$org_id}->{value} =
1368             OpenSRF::Utils::JSON->JSON2perl($setting->{value});
1369     }
1370
1371     return %result;
1372 }
1373
1374 # returns the ISO8601 string representation of the requested epoch in GMT
1375 sub epoch2ISO8601 {
1376     my( $self, $epoch ) = @_;
1377     my ($sec,$min,$hour,$mday,$mon,$year) = gmtime($epoch);
1378     $year += 1900; $mon += 1;
1379     my $date = sprintf(
1380         '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1381         $year, $mon, $mday, $hour, $min, $sec);
1382     return $date;
1383 }
1384
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 );
1388
1389     my $lastid = -1;
1390     while( $org ) {
1391         last if ($self->check_perms( $userid, $org->id, $perm )); # perm failed
1392         $lastid = $org->id;
1393         $org = $self->find_org( $org_tree, $org->parent_ou() );
1394     }
1395
1396     return $lastid;
1397 }
1398
1399
1400 # returns the org_unit ID's
1401 sub user_has_work_perm_at {
1402     my($self, $e, $perm, $options, $user_id) = @_;
1403     $options ||= {};
1404     $user_id = (defined $user_id) ? $user_id : $e->requestor->id;
1405
1406     my $func = 'permission.usr_has_perm_at';
1407     $func = $func.'_all' if $$options{descendants};
1408
1409     my $orgs = $e->json_query({from => [$func, $user_id, $perm]});
1410     $orgs = [map { $_->{ (keys %$_)[0] } } @$orgs];
1411
1412     return $orgs unless $$options{objects};
1413
1414     return $e->search_actor_org_unit({id => $orgs});
1415 }
1416
1417 sub get_user_work_ou_ids {
1418     my($self, $e, $userid) = @_;
1419     my $work_orgs = $e->json_query({
1420         select => {puwoum => ['work_ou']},
1421         from => 'puwoum',
1422         where => {usr => $e->requestor->id}});
1423
1424     return [] unless @$work_orgs;
1425     my @work_orgs;
1426     push(@work_orgs, $_->{work_ou}) for @$work_orgs;
1427
1428     return \@work_orgs;
1429 }
1430
1431
1432 my $org_types;
1433 sub get_org_types {
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();
1437 }
1438
1439 my %ORG_TREE;
1440 sub get_org_tree {
1441     my $self = shift;
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;
1446
1447     my $ses = OpenILS::Utils::CStoreEditor->new;
1448     $ses->session->session_locale($locale);
1449     $tree = $ses->search_actor_org_unit(
1450         [
1451             {"parent_ou" => undef },
1452             {
1453                 flesh               => -1,
1454                 flesh_fields    => { aou =>  ['children'] },
1455                 order_by            => { aou => 'name'}
1456             }
1457         ]
1458     )->[0];
1459
1460     $ORG_TREE{$locale} = $tree;
1461     $cache->put_cache("orgtree.$locale", $tree);
1462     return $tree;
1463 }
1464
1465 sub get_org_descendants {
1466     my($self, $org_id, $depth) = @_;
1467
1468     my $select = {
1469         transform => 'actor.org_unit_descendants',
1470         column => 'id',
1471         result_field => 'id',
1472     };
1473     $select->{params} = [$depth] if defined $depth;
1474
1475     my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1476         select => {aou => [$select]},
1477         from => 'aou',
1478         where => {id => $org_id}
1479     });
1480     my @orgs;
1481     push(@orgs, $_->{id}) for @$org_list;
1482     return \@orgs;
1483 }
1484
1485 sub get_org_ancestors {
1486     my($self, $org_id, $use_cache) = @_;
1487
1488     my ($cache, $orgs);
1489
1490     if ($use_cache) {
1491         $cache = OpenSRF::Utils::Cache->new("global", 0);
1492         $orgs = $cache->get_cache("org.ancestors.$org_id");
1493         return $orgs if $orgs;
1494     }
1495
1496     my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1497         select => {
1498             aou => [{
1499                 transform => 'actor.org_unit_ancestors',
1500                 column => 'id',
1501                 result_field => 'id',
1502                 params => []
1503             }],
1504         },
1505         from => 'aou',
1506         where => {id => $org_id}
1507     });
1508
1509     $orgs = [ map { $_->{id} } @$org_list ];
1510
1511     $cache->put_cache("org.ancestors.$org_id", $orgs) if $use_cache;
1512     return $orgs;
1513 }
1514
1515 sub get_org_full_path {
1516     my($self, $org_id, $depth) = @_;
1517
1518     my $query = {
1519         select => {
1520             aou => [{
1521                 transform => 'actor.org_unit_full_path',
1522                 column => 'id',
1523                 result_field => 'id',
1524             }],
1525         },
1526         from => 'aou',
1527         where => {id => $org_id}
1528     };
1529
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 ];
1533 }
1534
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;
1541 }
1542
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(
1548         {
1549             select => {aoup => ['prox']},
1550             from => 'aoup',
1551             where => {from_org => $from_org, to_org => $to_org}
1552         }
1553     );
1554     if (ref($r) eq 'ARRAY' && @$r) {
1555         return $r->[0]->{prox};
1556     }
1557     return undef;
1558 }
1559
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;
1564
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;
1569
1570     my $user = $e->retrieve_actor_user($user_id) or return $e->event;
1571     return $self->get_org_locale($user->home_ou, $e);
1572 }
1573
1574 # returns org locale setting
1575 sub get_org_locale {
1576     my($self, $org_id, $e) = @_;
1577     $e ||= OpenILS::Utils::CStoreEditor->new;
1578
1579     my $locale;
1580     if(defined $org_id) {
1581         $locale = $self->ou_ancestor_setting_value($org_id, 'global.default_locale', $e);
1582         return $locale if $locale;
1583     }
1584
1585     # system-wide default
1586     my $sclient = OpenSRF::Utils::SettingsClient->new;
1587     $locale = $sclient->config_value('default_locale');
1588     return $locale if $locale;
1589
1590     # if nothing else, fallback to locale=cowboy
1591     return 'en-US';
1592 }
1593
1594
1595 # xml-escape non-ascii characters
1596 sub entityize {
1597     my($self, $string, $form) = @_;
1598     $form ||= "";
1599
1600     if ($form eq 'D') {
1601         $string = NFD($string);
1602     } else {
1603         $string = NFC($string);
1604     }
1605
1606     # Convert raw ampersands to entities
1607     $string =~ s/&(?!\S+;)/&amp;/gso;
1608
1609     # Convert Unicode characters to entities
1610     $string =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
1611
1612     return $string;
1613 }
1614
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) = @_;
1619
1620     $string =~ s/([\x{0000}-\x{0008}])//sgoe;
1621     return $string;
1622 }
1623
1624 sub get_copy_price {
1625     my($self, $e, $copy, $volume) = @_;
1626
1627     $copy->price(0) if $copy->price and $copy->price < 0;
1628
1629
1630     my $owner;
1631     if(ref $volume) {
1632         if($volume->id == OILS_PRECAT_CALL_NUMBER) {
1633             $owner = $copy->circ_lib;
1634         } else {
1635             $owner = $volume->owning_lib;
1636         }
1637     } else {
1638         if($copy->call_number == OILS_PRECAT_CALL_NUMBER) {
1639             $owner = $copy->circ_lib;
1640         } else {
1641             $owner = $e->retrieve_asset_call_number($copy->call_number)->owning_lib;
1642         }
1643     }
1644
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);
1648
1649     my $price = $copy->price;
1650
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;
1656     }
1657
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;
1666     }
1667
1668     return $price;
1669 }
1670
1671 # given a transaction ID, this returns the context org_unit for the transaction
1672 sub xact_org {
1673     my($self, $xact_id, $e) = @_;
1674     $e ||= OpenILS::Utils::CStoreEditor->new;
1675
1676     my $loc = $e->json_query({
1677         "select" => {circ => ["circ_lib"]},
1678         from     => "circ",
1679         "where"  => {id => $xact_id},
1680     });
1681
1682     return $loc->[0]->{circ_lib} if @$loc;
1683
1684     $loc = $e->json_query({
1685         "select" => {bresv => ["request_lib"]},
1686         from     => "bresv",
1687         "where"  => {id => $xact_id},
1688     });
1689
1690     return $loc->[0]->{request_lib} if @$loc;
1691
1692     $loc = $e->json_query({
1693         "select" => {mg => ["billing_location"]},
1694         from     => "mg",
1695         "where"  => {id => $xact_id},
1696     });
1697
1698     return $loc->[0]->{billing_location};
1699 }
1700
1701
1702 sub find_event_def_by_hook {
1703     my($self, $hook, $context_org, $e) = @_;
1704
1705     $e ||= OpenILS::Utils::CStoreEditor->new;
1706
1707     my $orgs = $self->get_org_ancestors($context_org);
1708
1709     # search from the context org up
1710     for my $org_id (reverse @$orgs) {
1711
1712         my $def = $e->search_action_trigger_event_definition(
1713             {hook => $hook, owner => $org_id, active => 't'})->[0];
1714
1715         return $def if $def;
1716     }
1717
1718     return undef;
1719 }
1720
1721
1722
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) = @_;
1728
1729     my $e = OpenILS::Utils::CStoreEditor->new;
1730     my $def;
1731
1732     my $auto_method = "open-ils.trigger.event.autocreate.by_definition";
1733
1734     if($event_def) {
1735         $def = $e->retrieve_action_trigger_event_definition($event_def)
1736             or return $e->event;
1737
1738         $auto_method .= '.include_inactive';
1739
1740     } else {
1741
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;
1745     }
1746
1747     my $final_resp;
1748
1749     if($def->group_field) {
1750         # we have a list of objects
1751         $object = [$object] unless ref $object eq 'ARRAY';
1752
1753         my @event_ids;
1754         $user_data ||= [];
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);
1761         }
1762
1763         $logger->info("EVENTS = " . OpenSRF::Utils::JSON->perl2JSON(\@event_ids));
1764
1765         my $resp;
1766         if (not defined $client) {
1767             $resp = $self->simplereq(
1768                 'open-ils.trigger',
1769                 'open-ils.trigger.event_group.fire',
1770                 \@event_ids);
1771         } else {
1772             $resp = $self->patientreq(
1773                 $client,
1774                 "open-ils.trigger", "open-ils.trigger.event_group.fire",
1775                 \@event_ids
1776             );
1777         }
1778
1779         if($resp and $resp->{events} and @{$resp->{events}}) {
1780
1781             $e->xact_begin;
1782             $final_resp = $e->retrieve_action_trigger_event([
1783                 $resp->{events}->[0]->id,
1784                 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1785             ]);
1786             $e->rollback;
1787         }
1788
1789     } else {
1790
1791         $object = $$object[0] if ref $object eq 'ARRAY';
1792
1793         my $event_id;
1794         my $resp;
1795
1796         if (not defined $client) {
1797             $event_id = $self->simplereq(
1798                 'open-ils.trigger',
1799                 $auto_method, $def->id, $object, $context_org, $user_data
1800             );
1801
1802             $resp = $self->simplereq(
1803                 'open-ils.trigger',
1804                 'open-ils.trigger.event.fire',
1805                 $event_id
1806             );
1807         } else {
1808             $event_id = $self->patientreq(
1809                 $client,
1810                 'open-ils.trigger',
1811                 $auto_method, $def->id, $object, $context_org, $user_data
1812             );
1813
1814             $resp = $self->patientreq(
1815                 $client,
1816                 'open-ils.trigger',
1817                 'open-ils.trigger.event.fire',
1818                 $event_id
1819             );
1820         }
1821
1822         if($resp and $resp->{event}) {
1823             $e->xact_begin;
1824             $final_resp = $e->retrieve_action_trigger_event([
1825                 $resp->{event}->id,
1826                 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1827             ]);
1828             $e->rollback;
1829         }
1830     }
1831
1832     return $final_resp;
1833 }
1834
1835
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;
1844 }
1845
1846 sub create_uuid_string {
1847     return create_UUID_as_string();
1848 }
1849
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;
1856     return $obj;
1857 }
1858
1859
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}, ...}...}
1863 my $ccvm_cache;
1864 sub get_bre_attrs {
1865     my ($class, $bre_ids, $e) = @_;
1866     $e = $e || OpenILS::Utils::CStoreEditor->new;
1867
1868     my $attrs = {};
1869     return $attrs unless defined $bre_ids;
1870     $bre_ids = [$bre_ids] unless ref $bre_ids;
1871
1872     my $mra = $e->json_query({
1873         select => {
1874             mra => [
1875                 {
1876                     column => 'id',
1877                     alias => 'bre'
1878                 }, {
1879                     column => 'attrs',
1880                     transform => 'each',
1881                     result_field => 'key',
1882                     alias => 'key'
1883                 },{
1884                     column => 'attrs',
1885                     transform => 'each',
1886                     result_field => 'value',
1887                     alias => 'value'
1888                 }
1889             ]
1890         },
1891         from => 'mra',
1892         where => {id => $bre_ids}
1893     });
1894
1895     return $attrs unless $mra;
1896
1897     $ccvm_cache = $ccvm_cache || $e->search_config_coded_value_map({id => {'!=' => undef}});
1898
1899     for my $id (@$bre_ids) {
1900         $attrs->{$id} = {};
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};
1905             if($code) {
1906                 my ($ccvm) = grep { $_->ctype eq $ctype and $_->code eq $code } @$ccvm_cache;
1907                 $attrs->{$id}->{$ctype}->{label} = $ccvm->value if $ccvm;
1908             }
1909         }
1910     }
1911
1912     return $attrs;
1913 }
1914
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) = @_;
1919
1920     # First, Use search API to get container items sorted in any way that crad
1921     # sorters support.
1922     my $search_result = $class->simplereq(
1923         "open-ils.search", "open-ils.search.biblio.multiclass.query",
1924         $search_args, $search_query
1925     );
1926
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");
1930         return;
1931     }
1932
1933     # Throw away other junk from search, keeping only bib IDs.
1934     return [ map { shift @$_ } @{$search_result->{ids}} ];
1935 }
1936
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) = @_;
1940
1941     # First, Use search API to get container items sorted in any way that crad
1942     # sorters support.
1943     my $search_result = $class->simplereq(
1944         "open-ils.search", "open-ils.search.biblio.multiclass.query",
1945         $search_args, $search_query
1946     );
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");
1950         return;
1951     }
1952
1953     # Throw away other junk from search, keeping only bib IDs.
1954     my $id_list = [ map { shift @$_ } @{$search_result->{ids}} ];
1955
1956     return [] unless @$id_list;
1957
1958     # Now get the bib container items themselves...
1959     my $e = new OpenILS::Utils::CStoreEditor;
1960     unless ($e) {
1961         $logger->warn("bib_container_items_via_search() couldn't get cstoreeditor");
1962         return;
1963     }
1964
1965     my @flesh_fields = qw/notes/;
1966     push(@flesh_fields, 'target_biblio_record_entry') unless $no_flesh;
1967
1968     my $items = $e->search_container_biblio_record_entry_bucket_item([
1969         {
1970             "target_biblio_record_entry" => $id_list,
1971             "bucket" => $container_id
1972         }, {
1973             flesh => 1,
1974             flesh_fields => {"cbrebi" => \@flesh_fields}
1975         }
1976     ], {substream => 1});
1977
1978     unless ($items) {
1979         $logger->warn(
1980             "bib_container_items_via_search() couldn't get bucket items: " .
1981             $e->die_event->{textcode}
1982         );
1983         return;
1984     }
1985
1986     # ... and put them in the same order that the search API said they
1987     # should be in.
1988     my %ordering_hash = map {
1989         ($no_flesh) ? $_->target_biblio_record_entry : $_->target_biblio_record_entry->id,
1990         $_
1991     } @$items;
1992
1993     return [map { $ordering_hash{$_} } @$id_list];
1994 }
1995
1996 # returns undef on success, Event on error
1997 sub log_user_activity {
1998     my ($class, $user_id, $who, $what, $e, $async) = @_;
1999
2000     my $commit = 0;
2001     if (!$e) {
2002         $e = OpenILS::Utils::CStoreEditor->new(xact => 1);
2003         $commit = 1;
2004     }
2005
2006     my $res = $e->json_query({
2007         from => [
2008             'actor.insert_usr_activity',
2009             $user_id, $who, $what, OpenSRF::AppSession->ingress
2010         ]
2011     });
2012
2013     if ($res) { # call returned OK
2014
2015         $e->commit   if $commit and @$res;
2016         $e->rollback if $commit and !@$res;
2017
2018     } else {
2019         return $e->die_event;
2020     }
2021
2022     return undef;
2023 }
2024
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.
2027 #
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.
2031 #
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
2037 # filters.
2038
2039 sub basic_opac_copy_query {
2040     ######################################################################
2041     # Pass a defined value for either $rec_id OR ($iss_id AND $dist_id), #
2042     # not both.                                                          #
2043     ######################################################################
2044     my ($self,$rec_id,$iss_id,$dist_id,$copy_limit,$copy_offset,$staff) = @_;
2045
2046     return {
2047         select => {
2048             acp => ['id', 'barcode', 'circ_lib', 'create_date', 'active_date',
2049                     'age_protect', 'holdable', 'copy_number'],
2050             acpl => [
2051                 {column => 'name', alias => 'copy_location'},
2052                 {column => 'holdable', alias => 'location_holdable'},
2053                 {column => 'url', alias => 'location_url'}
2054             ],
2055             ccs => [
2056                 {column => 'id', alias => 'status_code'},
2057                 {column => 'name', alias => 'copy_status'},
2058                 {column => 'holdable', alias => 'status_holdable'}
2059             ],
2060             acn => [
2061                 {column => 'label', alias => 'call_number_label'},
2062                 {column => 'id', alias => 'call_number'},
2063                 {column => 'owning_lib', alias => 'call_number_owning_lib'}
2064             ],
2065             circ => ['due_date'],
2066             acnp => [
2067                 {column => 'label', alias => 'call_number_prefix_label'},
2068                 {column => 'id', alias => 'call_number_prefix'}
2069             ],
2070             acns => [
2071                 {column => 'label', alias => 'call_number_suffix_label'},
2072                 {column => 'id', alias => 'call_number_suffix'}
2073             ],
2074             bmp => [
2075                 {column => 'label', alias => 'part_label'},
2076             ],
2077             ($iss_id ? (sitem => ["issuance"]) : ())
2078         },
2079
2080         from => {
2081             acp => {
2082                 ($iss_id ? (
2083                     sitem => {
2084                         fkey => 'id',
2085                         field => 'unit',
2086                         filter => {issuance => $iss_id},
2087                         join => {
2088                             sstr => { }
2089                         }
2090                     }
2091                 ) : ()),
2092                 acn => {
2093                     join => {
2094                         acnp => { fkey => 'prefix' },
2095                         acns => { fkey => 'suffix' }
2096                     },
2097                     filter => [
2098                         {deleted => 'f'},
2099                         ($rec_id ? {record => $rec_id} : ())
2100                     ],
2101                 },
2102                 circ => { # If the copy is circulating, retrieve the open circ
2103                     type => 'left',
2104                     filter => {checkin_time => undef}
2105                 },
2106                 acpl => {
2107                     filter => {
2108                         deleted => 'f',
2109                         ($staff ? () : ( opac_visible => 't' )),
2110                     },
2111                 },
2112                 ccs => {
2113                     ($staff ? () : (filter => { opac_visible => 't' }))
2114                 },
2115                 aou => {},
2116                 acpm => {
2117                     type => 'left',
2118                     join => {
2119                         bmp => { type => 'left', filter => { deleted => 'f' } }
2120                     }
2121                 }
2122             }
2123         },
2124
2125         where => {
2126             '+acp' => {
2127                 deleted => 'f',
2128                 ($staff ? () : (opac_visible => 't'))
2129             },
2130             ($dist_id ? ( '+sstr' => { distribution => $dist_id } ) : ()),
2131             ($staff ? () : ( '+aou' => { opac_visible => 't' } ))
2132         },
2133
2134         order_by => [
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'}
2140         ],
2141
2142         limit => $copy_limit,
2143         offset => $copy_offset
2144     };
2145 }
2146
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.)
2151 #
2152 # Returns -1 if $date1 < $date2
2153 # Returns 0 if $date1 == $date2
2154 # Returns 1 if $date1 > $date2
2155 sub datecmp {
2156     my $self = shift;
2157     my $date1 = shift;
2158     my $date2 = shift;
2159
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);
2163     }
2164     if ($date2 && $date2 =~ /(?:-|\+)\d\d\d\d$/) {
2165         $date2 = substr($date2, 0, length($date2) - 2);
2166     }
2167
2168     # check date1:
2169     unless (UNIVERSAL::isa($date1, "DateTime")) {
2170         $date1 = DateTime::Format::ISO8601->parse_datetime($date1);
2171     }
2172
2173     # Check for date2:
2174     unless ($date2) {
2175         $date2 = DateTime->now;
2176     } else {
2177         unless (UNIVERSAL::isa($date2, "DateTime")) {
2178             $date2 = DateTime::Format::ISO8601->parse_datetime($date2);
2179         }
2180     }
2181
2182     return DateTime->compare($date1, $date2);
2183 }
2184
2185
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) = @_;
2190
2191     my $orgs = $class->get_org_ancestors($e->requestor->ws_ou);
2192
2193     my $query = {
2194         select  => {vibtf => ['field']},
2195         from    => {vibtf => 'vibtg'},
2196         where   => {'+vibtg' => {owner => $orgs}},
2197         distinct => 1
2198     };
2199
2200     # give me always-apply groups plus any selected groups
2201     if ($grps and @$grps) {
2202         $query->{where}->{'+vibtg'}->{'-or'} = [
2203             {id => $grps},
2204             {always_apply => 't'}
2205         ];
2206
2207     } else {
2208         $query->{where}->{'+vibtg'}->{always_apply} = 't';
2209     }
2210
2211     my $fields = $e->json_query($query);
2212
2213     for my $field (@$fields) {
2214         my $tag = $field->{field};
2215         for my $node ($marcdoc->findnodes('//*[@tag="'.$tag.'"]')) {
2216             $node->parentNode->removeChild($node);
2217         }
2218     }
2219
2220     return $class->entityize($marcdoc->documentElement->toString);
2221 }
2222
2223 # marcdoc is an XML::LibXML document
2224 # updates the document and returns the entityized MARC string.
2225 sub set_marc_905u {
2226     my ($class, $marcdoc, $username) = @_;
2227
2228     # Look for existing 905$u subfields. If any exist, do nothing.
2229     my @nodes = $marcdoc->findnodes('//*[@tag="905"]/*[@code="u"]');
2230     unless (@nodes) {
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);
2241
2242     }
2243
2244     return $class->entityize($marcdoc->documentElement->toString);
2245 }
2246
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 {
2251     my $class = shift;
2252
2253     no warnings 'numeric';
2254
2255     return uniq(
2256         map(
2257             int,
2258             map { $_ eq 'NULL' ? undef : (split /,/, $_) }
2259                 map { substr($_, 1, -1) } @_
2260         )
2261     );
2262 }
2263
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 ) = @_;
2269
2270     # Grab the transaction
2271     $xact ||= $editor->retrieve_money_billable_transaction($xactid);
2272     return $editor->event unless $xact;
2273     $xactid ||= $xact->id;
2274
2275     # grab the summary and see how much is owed on this transaction
2276     my ($summary) = $self->fetch_mbts($xactid, $editor);
2277
2278     # grab the circulation if it is a circ;
2279     my $circ = $editor->retrieve_action_circulation($xactid);
2280
2281     # If nothing is owed on the transaction but it is still open
2282     # and this transaction is not an open circulation, close it
2283     if(
2284         ( $summary->balance_owed == 0 and ! $xact->xact_finish ) and
2285         ( !$circ or $circ->stop_fines )) {
2286
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;
2291         return undef;
2292     }
2293
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;
2301         return undef;
2302     }
2303     return undef;
2304 }
2305
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.
2312 #
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.
2318 #
2319 # XXX shifting using multiplication/division *may* still introduce
2320 # rounding errors -- better to implement using string manipulation?
2321 sub fpdiff {
2322     my ($class, @args) = @_;
2323     my $result = shift(@args) * 100;
2324     while (my $arg = shift(@args)) {
2325         $result -= $arg * 100;
2326     }
2327     return $result / 100;
2328 }
2329
2330 sub fpsum {
2331     my ($class, @args) = @_;
2332     my $result = shift(@args) * 100;
2333     while (my $arg = shift(@args)) {
2334         $result += $arg * 100;
2335     }
2336     return $result / 100;
2337 }
2338
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) = @_;
2343
2344     $pw_type ||= 'main'; # primary login password
2345
2346     my $verify = $e->json_query({
2347         from => [
2348             'actor.verify_passwd',
2349             $user_id, $pw_type, $passwd
2350         ]
2351     })->[0];
2352
2353     return $class->is_true($verify->{'actor.verify_passwd'});
2354 }
2355
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 )
2361 #
2362 # If 'as_md5' is true, the password provided has already been
2363 # MD5 hashed.
2364 sub verify_migrated_user_password {
2365     my ($class, $e, $user_id, $passwd, $as_md5) = @_;
2366
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';
2370
2371     # Sometimes we have the bare password, sometimes the MD5 version.
2372     my $md5_pass = $as_md5 ? $passwd : md5_hex($passwd);
2373
2374     my $salt = $e->json_query({
2375         from => [
2376             'actor.get_salt',
2377             $user_id,
2378             $pw_type
2379         ]
2380     })->[0];
2381
2382     $salt = $salt->{'actor.get_salt'};
2383
2384     return $class->verify_user_password(
2385         $e, $user_id, md5_hex($salt . $md5_pass), $pw_type);
2386 }
2387
2388
2389 1;
2390