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 find_org_by_shortname {
 767     my( $self, $org_tree, $shortname )  = @_;
 768     return undef unless $org_tree and defined $shortname;
 769     return $org_tree if ( $org_tree->shortname eq $shortname );
 770     return undef unless ref($org_tree->children);
 771     for my $c (@{$org_tree->children}) {
 772         my $o = $self->find_org_by_shortname($c, $shortname);
 773         return $o if $o;
 774     }
 775     return undef;
 776 }
 777
 778 sub fetch_non_cat_type_by_name_and_org {
 779     my( $self, $name, $orgId ) = @_;
 780     $logger->debug("Fetching non cat type $name at org $orgId");
 781     my $types = $self->simplereq(
 782         'open-ils.cstore',
 783         'open-ils.cstore.direct.config.non_cataloged_type.search.atomic',
 784         { name => $name, owning_lib => $orgId } );
 785     return ($types->[0], undef) if($types and @$types);
 786     return (undef, OpenILS::Event->new('CONFIG_NON_CATALOGED_TYPE_NOT_FOUND') );
 787 }
 788
 789 sub fetch_non_cat_type {
 790     my( $self, $id ) = @_;
 791     $logger->debug("Fetching non cat type $id");
 792     my( $type, $evt );
 793     $type = $self->simplereq(
 794         'open-ils.cstore',
 795         'open-ils.cstore.direct.config.non_cataloged_type.retrieve', $id );
 796     $evt = OpenILS::Event->new('CONFIG_NON_CATALOGED_TYPE_NOT_FOUND') unless $type;
 797     return ($type, $evt);
 798 }
 799
 800 sub DB_UPDATE_FAILED {
 801     my( $self, $payload ) = @_;
 802     return OpenILS::Event->new('DATABASE_UPDATE_FAILED',
 803         payload => ($payload) ? $payload : undef );
 804 }
 805
 806 sub fetch_booking_reservation {
 807     my( $self, $id ) = @_;
 808     my( $res, $evt );
 809
 810     $res = $self->simplereq(
 811         'open-ils.cstore',
 812         'open-ils.cstore.direct.booking.reservation.retrieve', $id
 813     );
 814
 815     # simplereq doesn't know how to flesh so ...
 816     if ($res) {
 817         $res->usr(
 818             $self->simplereq(
 819                 'open-ils.cstore',
 820                 'open-ils.cstore.direct.actor.user.retrieve', $res->usr
 821             )
 822         );
 823
 824         $res->target_resource_type(
 825             $self->simplereq(
 826                 'open-ils.cstore',
 827                 'open-ils.cstore.direct.booking.resource_type.retrieve', $res->target_resource_type
 828             )
 829         );
 830
 831         if ($res->current_resource) {
 832             $res->current_resource(
 833                 $self->simplereq(
 834                     'open-ils.cstore',
 835                     'open-ils.cstore.direct.booking.resource.retrieve', $res->current_resource
 836                 )
 837             );
 838
 839             if ($self->is_true( $res->target_resource_type->catalog_item )) {
 840                 $res->current_resource->catalog_item( $self->fetch_copy_by_barcode( $res->current_resource->barcode ) );
 841             }
 842         }
 843
 844         if ($res->target_resource) {
 845             $res->target_resource(
 846                 $self->simplereq(
 847                     'open-ils.cstore',
 848                     'open-ils.cstore.direct.booking.resource.retrieve', $res->target_resource
 849                 )
 850             );
 851
 852             if ($self->is_true( $res->target_resource_type->catalog_item )) {
 853                 $res->target_resource->catalog_item( $self->fetch_copy_by_barcode( $res->target_resource->barcode ) );
 854             }
 855         }
 856
 857     } else {
 858         $evt = OpenILS::Event->new('RESERVATION_NOT_FOUND');
 859     }
 860
 861     return ($res, $evt);
 862 }
 863
 864 sub fetch_circ_duration_by_name {
 865     my( $self, $name ) = @_;
 866     my( $dur, $evt );
 867     $dur = $self->simplereq(
 868         'open-ils.cstore',
 869         'open-ils.cstore.direct.config.rules.circ_duration.search.atomic', { name => $name } );
 870     $dur = $dur->[0];
 871     $evt = OpenILS::Event->new('CONFIG_RULES_CIRC_DURATION_NOT_FOUND') unless $dur;
 872     return ($dur, $evt);
 873 }
 874
 875 sub fetch_recurring_fine_by_name {
 876     my( $self, $name ) = @_;
 877     my( $obj, $evt );
 878     $obj = $self->simplereq(
 879         'open-ils.cstore',
 880         'open-ils.cstore.direct.config.rules.recurring_fine.search.atomic', { name => $name } );
 881     $obj = $obj->[0];
 882     $evt = OpenILS::Event->new('CONFIG_RULES_RECURRING_FINE_NOT_FOUND') unless $obj;
 883     return ($obj, $evt);
 884 }
 885
 886 sub fetch_max_fine_by_name {
 887     my( $self, $name ) = @_;
 888     my( $obj, $evt );
 889     $obj = $self->simplereq(
 890         'open-ils.cstore',
 891         'open-ils.cstore.direct.config.rules.max_fine.search.atomic', { name => $name } );
 892     $obj = $obj->[0];
 893     $evt = OpenILS::Event->new('CONFIG_RULES_MAX_FINE_NOT_FOUND') unless $obj;
 894     return ($obj, $evt);
 895 }
 896
 897 sub fetch_hard_due_date_by_name {
 898     my( $self, $name ) = @_;
 899     my( $obj, $evt );
 900     $obj = $self->simplereq(
 901         'open-ils.cstore',
 902         'open-ils.cstore.direct.config.hard_due_date.search.atomic', { name => $name } );
 903     $obj = $obj->[0];
 904     $evt = OpenILS::Event->new('CONFIG_RULES_HARD_DUE_DATE_NOT_FOUND') unless $obj;
 905     return ($obj, $evt);
 906 }
 907
 908 sub storagereq {
 909     my( $self, $method, @params ) = @_;
 910     return $self->simplereq(
 911         'open-ils.storage', $method, @params );
 912 }
 913
 914 sub storagereq_xact {
 915     my($self, $method, @params) = @_;
 916     my $ses = $self->start_db_session();
 917     my $val = $ses->request($method, @params)->gather(1);
 918     $self->rollback_db_session($ses);
 919     return $val;
 920 }
 921
 922 sub cstorereq {
 923     my( $self, $method, @params ) = @_;
 924     return $self->simplereq(
 925         'open-ils.cstore', $method, @params );
 926 }
 927
 928 sub event_equals {
 929     my( $self, $e, $name ) =  @_;
 930     if( $e and ref($e) eq 'HASH' and
 931         defined($e->{textcode}) and $e->{textcode} eq $name ) {
 932         return 1 ;
 933     }
 934     return 0;
 935 }
 936
 937 sub logmark {
 938     my( undef, $f, $l ) = caller(0);
 939     my( undef, undef, undef, $s ) = caller(1);
 940     $s =~ s/.*:://g;
 941     $f =~ s/.*\///g;
 942     $logger->debug("LOGMARK: $f:$l:$s");
 943 }
 944
 945 # takes a copy id
 946 sub fetch_open_circulation {
 947     my( $self, $cid ) = @_;
 948     $self->logmark;
 949
 950     my $e = OpenILS::Utils::CStoreEditor->new;
 951     my $circ = $e->search_action_circulation({
 952         target_copy => $cid,
 953         stop_fines_time => undef,
 954         checkin_time => undef
 955     })->[0];
 956
 957     return ($circ, $e->event);
 958 }
 959
 960 my $copy_statuses;
 961 sub copy_status_from_name {
 962     my( $self, $name ) = @_;
 963     $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
 964     for my $status (@$copy_statuses) {
 965         return $status if( $status->name =~ /$name/i );
 966     }
 967     return undef;
 968 }
 969
 970 sub copy_status_to_name {
 971     my( $self, $sid ) = @_;
 972     $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
 973     for my $status (@$copy_statuses) {
 974         return $status->name if( $status->id == $sid );
 975     }
 976     return undef;
 977 }
 978
 979
 980 sub copy_status {
 981     my( $self, $arg ) = @_;
 982     return $arg if ref $arg;
 983     $copy_statuses = $self->fetch_copy_statuses unless $copy_statuses;
 984     my ($stat) = grep { $_->id == $arg } @$copy_statuses;
 985     return $stat;
 986 }
 987
 988 sub fetch_open_transit_by_copy {
 989     my( $self, $copyid ) = @_;
 990     my($transit, $evt);
 991     $transit = $self->cstorereq(
 992         'open-ils.cstore.direct.action.transit_copy.search',
 993         { target_copy => $copyid, dest_recv_time => undef, cancel_time => undef });
 994     $evt = OpenILS::Event->new('ACTION_TRANSIT_COPY_NOT_FOUND') unless $transit;
 995     return ($transit, $evt);
 996 }
 997
 998 sub unflesh_copy {
 999     my( $self, $copy ) = @_;
1000     return undef unless $copy;
1001     $copy->status( $copy->status->id ) if ref($copy->status);
1002     $copy->location( $copy->location->id ) if ref($copy->location);
1003     $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
1004     return $copy;
1005 }
1006
1007 sub unflesh_reservation {
1008     my( $self, $reservation ) = @_;
1009     return undef unless $reservation;
1010     $reservation->usr( $reservation->usr->id ) if ref($reservation->usr);
1011     $reservation->target_resource_type( $reservation->target_resource_type->id ) if ref($reservation->target_resource_type);
1012     $reservation->target_resource( $reservation->target_resource->id ) if ref($reservation->target_resource);
1013     $reservation->current_resource( $reservation->current_resource->id ) if ref($reservation->current_resource);
1014     return $reservation;
1015 }
1016
1017 # un-fleshes a copy and updates it in the DB
1018 # returns a DB_UPDATE_FAILED event on error
1019 # returns undef on success
1020 sub update_copy {
1021     my( $self, %params ) = @_;
1022
1023     my $copy        = $params{copy} || die "update_copy(): copy required";
1024     my $editor  = $params{editor} || die "update_copy(): copy editor required";
1025     my $session = $params{session};
1026
1027     $logger->debug("Updating copy in the database: " . $copy->id);
1028
1029     $self->unflesh_copy($copy);
1030     $copy->editor( $editor );
1031     $copy->edit_date( 'now' );
1032
1033     my $s;
1034     my $meth = 'open-ils.storage.direct.asset.copy.update';
1035
1036     $s = $session->request( $meth, $copy )->gather(1) if $session;
1037     $s = $self->storagereq( $meth, $copy ) unless $session;
1038
1039     $logger->debug("Update of copy ".$copy->id." returned: $s");
1040
1041     return $self->DB_UPDATE_FAILED($copy) unless $s;
1042     return undef;
1043 }
1044
1045 sub update_reservation {
1046     my( $self, %params ) = @_;
1047
1048     my $reservation = $params{reservation}  || die "update_reservation(): reservation required";
1049     my $editor      = $params{editor} || die "update_reservation(): copy editor required";
1050     my $session     = $params{session};
1051
1052     $logger->debug("Updating copy in the database: " . $reservation->id);
1053
1054     $self->unflesh_reservation($reservation);
1055
1056     my $s;
1057     my $meth = 'open-ils.cstore.direct.booking.reservation.update';
1058
1059     $s = $session->request( $meth, $reservation )->gather(1) if $session;
1060     $s = $self->cstorereq( $meth, $reservation ) unless $session;
1061
1062     $logger->debug("Update of copy ".$reservation->id." returned: $s");
1063
1064     return $self->DB_UPDATE_FAILED($reservation) unless $s;
1065     return undef;
1066 }
1067
1068 sub fetch_billable_xact {
1069     my( $self, $id ) = @_;
1070     my($xact, $evt);
1071     $logger->debug("Fetching billable transaction %id");
1072     $xact = $self->cstorereq(
1073         'open-ils.cstore.direct.money.billable_transaction.retrieve', $id );
1074     $evt = OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_NOT_FOUND') unless $xact;
1075     return ($xact, $evt);
1076 }
1077
1078 sub fetch_billable_xact_summary {
1079     my( $self, $id ) = @_;
1080     my($xact, $evt);
1081     $logger->debug("Fetching billable transaction summary %id");
1082     $xact = $self->cstorereq(
1083         'open-ils.cstore.direct.money.billable_transaction_summary.retrieve', $id );
1084     $evt = OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_NOT_FOUND') unless $xact;
1085     return ($xact, $evt);
1086 }
1087
1088 sub fetch_fleshed_copy {
1089     my( $self, $id ) = @_;
1090     my( $copy, $evt );
1091     $logger->info("Fetching fleshed copy $id");
1092     $copy = $self->cstorereq(
1093         "open-ils.cstore.direct.asset.copy.retrieve", $id,
1094         { flesh => 1,
1095           flesh_fields => { acp => [ qw/ circ_lib location status stat_cat_entries / ] }
1096         }
1097     );
1098     $evt = OpenILS::Event->new('ASSET_COPY_NOT_FOUND', id => $id) unless $copy;
1099     return ($copy, $evt);
1100 }
1101
1102
1103 # returns the org that owns the callnumber that the copy
1104 # is attached to
1105 sub fetch_copy_owner {
1106     my( $self, $copyid ) = @_;
1107     my( $copy, $cn, $evt );
1108     $logger->debug("Fetching copy owner $copyid");
1109     ($copy, $evt) = $self->fetch_copy($copyid);
1110     return (undef,$evt) if $evt;
1111     ($cn, $evt) = $self->fetch_callnumber($copy->call_number);
1112     return (undef,$evt) if $evt;
1113     return ($cn->owning_lib);
1114 }
1115
1116 sub fetch_copy_note {
1117     my( $self, $id ) = @_;
1118     my( $note, $evt );
1119     $logger->debug("Fetching copy note $id");
1120     $note = $self->cstorereq(
1121         'open-ils.cstore.direct.asset.copy_note.retrieve', $id );
1122     $evt = OpenILS::Event->new('ASSET_COPY_NOTE_NOT_FOUND', id => $id ) unless $note;
1123     return ($note, $evt);
1124 }
1125
1126 sub fetch_call_numbers_by_title {
1127     my( $self, $titleid ) = @_;
1128     $logger->info("Fetching call numbers by title $titleid");
1129     return $self->cstorereq(
1130         'open-ils.cstore.direct.asset.call_number.search.atomic',
1131         { record => $titleid, deleted => 'f' });
1132         #'open-ils.storage.direct.asset.call_number.search.record.atomic', $titleid);
1133 }
1134
1135 sub fetch_copies_by_call_number {
1136     my( $self, $cnid ) = @_;
1137     $logger->info("Fetching copies by call number $cnid");
1138     return $self->cstorereq(
1139         'open-ils.cstore.direct.asset.copy.search.atomic', { call_number => $cnid, deleted => 'f' } );
1140         #'open-ils.storage.direct.asset.copy.search.call_number.atomic', $cnid );
1141 }
1142
1143 sub fetch_user_by_barcode {
1144     my( $self, $bc ) = @_;
1145     my $cardid = $self->cstorereq(
1146         'open-ils.cstore.direct.actor.card.id_list', { barcode => $bc } );
1147     return (undef, OpenILS::Event->new('ACTOR_CARD_NOT_FOUND', barcode => $bc)) unless $cardid;
1148     my $user = $self->cstorereq(
1149         'open-ils.cstore.direct.actor.user.search', { card => $cardid } );
1150     return (undef, OpenILS::Event->new('ACTOR_USER_NOT_FOUND', card => $cardid)) unless $user;
1151     return ($user);
1152
1153 }
1154
1155 sub fetch_bill {
1156     my( $self, $billid ) = @_;
1157     $logger->debug("Fetching billing $billid");
1158     my $bill = $self->cstorereq(
1159         'open-ils.cstore.direct.money.billing.retrieve', $billid );
1160     my $evt = OpenILS::Event->new('MONEY_BILLING_NOT_FOUND') unless $bill;
1161     return($bill, $evt);
1162 }
1163
1164 sub walk_org_tree {
1165     my( $self, $node, $callback ) = @_;
1166     return unless $node;
1167     $callback->($node);
1168     if( $node->children ) {
1169         $self->walk_org_tree($_, $callback) for @{$node->children};
1170     }
1171 }
1172
1173 sub is_true {
1174     my( $self, $item ) = @_;
1175     return 1 if $item and $item !~ /^f$/i;
1176     return 0;
1177 }
1178
1179
1180 sub patientreq {
1181     my ($self, $client, $service, $method, @params) = @_;
1182     my ($response, $err);
1183
1184     my $session = create OpenSRF::AppSession($service);
1185     my $request = $session->request($method, @params);
1186
1187     my $spurt = 10;
1188     my $give_up = time + 1000;
1189
1190     try {
1191         while (time < $give_up) {
1192             $response = $request->recv("timeout" => $spurt);
1193             last if $request->complete;
1194
1195             $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1196         }
1197     } catch Error with {
1198         $err = shift;
1199     };
1200
1201     if ($err) {
1202         warn "received error : service=$service : method=$method : params=".Dumper(\@params) . "\n $err";
1203         throw $err ("Call to $service for method $method \n failed with exception: $err : " );
1204     }
1205
1206     return $response->content;
1207 }
1208
1209 # This logic now lives in storage
1210 sub __patron_money_owed {
1211     my( $self, $patronid ) = @_;
1212     my $ses = OpenSRF::AppSession->create('open-ils.storage');
1213     my $req = $ses->request(
1214         'open-ils.storage.money.billable_transaction.summary.search',
1215         { usr => $patronid, xact_finish => undef } );
1216
1217     my $total = 0;
1218     my $data;
1219     while( $data = $req->recv ) {
1220         $data = $data->content;
1221         $total += $data->balance_owed;
1222     }
1223     return $total;
1224 }
1225
1226 sub patron_money_owed {
1227     my( $self, $userid ) = @_;
1228     my $ses = $self->start_db_session();
1229     my $val = $ses->request(
1230         'open-ils.storage.actor.user.total_owed', $userid)->gather(1);
1231     $self->rollback_db_session($ses);
1232     return $val;
1233 }
1234
1235 sub patron_total_items_out {
1236     my( $self, $userid ) = @_;
1237     my $ses = $self->start_db_session();
1238     my $val = $ses->request(
1239         'open-ils.storage.actor.user.total_out', $userid)->gather(1);
1240     $self->rollback_db_session($ses);
1241     return $val;
1242 }
1243
1244
1245
1246
1247 #---------------------------------------------------------------------
1248 # Returns  ($summary, $event)
1249 #---------------------------------------------------------------------
1250 sub fetch_mbts {
1251     my $self = shift;
1252     my $id  = shift;
1253     my $e = shift || OpenILS::Utils::CStoreEditor->new;
1254     $id = $id->id if ref($id);
1255
1256     my $xact = $e->retrieve_money_billable_transaction_summary($id)
1257         or return (undef, $e->event);
1258
1259     return ($xact);
1260 }
1261
1262
1263 #---------------------------------------------------------------------
1264 # Given a list of money.billable_transaction objects, this creates
1265 # transaction summary objects for each
1266 #--------------------------------------------------------------------
1267 sub make_mbts {
1268     my $self = shift;
1269     my $e = shift;
1270     my @xacts = @_;
1271     return () if (!@xacts);
1272     return @{$e->search_money_billable_transaction_summary({id => [ map { $_->id } @xacts ]})};
1273 }
1274
1275
1276 sub ou_ancestor_setting_value {
1277     my($self, $org_id, $name, $e) = @_;
1278     $e = $e || OpenILS::Utils::CStoreEditor->new;
1279     my $set = $self->ou_ancestor_setting($org_id, $name, $e);
1280     return $set->{value} if $set;
1281     return undef;
1282 }
1283
1284
1285 # If an authentication token is provided AND this org unit setting has a
1286 # view_perm, then make sure the user referenced by the auth token has
1287 # that permission.  This means that if you call this method without an
1288 # authtoken param, you can get whatever org unit setting values you want.
1289 # API users beware.
1290 #
1291 # NOTE: If you supply an editor ($e) arg AND an auth token arg, the editor's
1292 # authtoken is checked, but the $auth arg is NOT checked.  To say that another
1293 # way, be sure NOT to pass an editor argument if you want your token checked.
1294 # Otherwise the auth arg is just a flag saying "check the editor".
1295
1296 sub ou_ancestor_setting {
1297     my( $self, $orgid, $name, $e, $auth ) = @_;
1298     $e = $e || OpenILS::Utils::CStoreEditor->new(
1299         (defined $auth) ? (authtoken => $auth) : ()
1300     );
1301
1302     if ($auth) {
1303         my $coust = $e->retrieve_config_org_unit_setting_type([
1304             $name, {flesh => 1, flesh_fields => {coust => ['view_perm']}}
1305         ]);
1306         if ($coust && $coust->view_perm) {
1307             # And you can't have permission if you don't have a valid session.
1308             return undef if not $e->checkauth;
1309             # And now that we know you MIGHT have permission, we check it.
1310             return undef if not $e->allowed($coust->view_perm->code, $orgid);
1311         }
1312     }
1313
1314     my $query = {from => ['actor.org_unit_ancestor_setting', $name, $orgid]};
1315     my $setting = $e->json_query($query)->[0];
1316     return undef unless $setting;
1317     return {org => $setting->{org_unit}, value => OpenSRF::Utils::JSON->JSON2perl($setting->{value})};
1318 }
1319
1320 # This fetches a set of OU settings in one fell swoop,
1321 # which can be significantly faster than invoking
1322 # $U->ou_ancestor_setting() one setting at a time.
1323 # As the "_insecure" implies, however, callers are
1324 # responsible for ensuring that the settings to be
1325 # fetch do not need view permission checks.
1326 sub ou_ancestor_setting_batch_insecure {
1327     my( $self, $orgid, $names ) = @_;
1328
1329     my %result = map { $_ => undef } @$names;
1330     my $query = {
1331         from => [
1332             'actor.org_unit_ancestor_setting_batch',
1333             $orgid,
1334             '{' . join(',', @$names) . '}'
1335         ]
1336     };
1337     my $e = OpenILS::Utils::CStoreEditor->new();
1338     my $settings = $e->json_query($query);
1339     foreach my $setting (@$settings) {
1340         $result{$setting->{name}} = {
1341             org => $setting->{org_unit},
1342             value => OpenSRF::Utils::JSON->JSON2perl($setting->{value})
1343         };
1344     }
1345     return %result;
1346 }
1347
1348 # Returns a hash of hashes like so:
1349 # {
1350 #   $lookup_org_id => {org => $context_org, value => $setting_value},
1351 #   $lookup_org_id2 => {org => $context_org2, value => $setting_value2},
1352 #   $lookup_org_id3 => {} # example of no setting value exists
1353 #   ...
1354 # }
1355 sub ou_ancestor_setting_batch_by_org_insecure {
1356     my ($self, $org_ids, $name, $e) = @_;
1357
1358     $e ||= OpenILS::Utils::CStoreEditor->new();
1359     my %result = map { $_ => {value => undef} } @$org_ids;
1360
1361     my $query = {
1362         from => [
1363             'actor.org_unit_ancestor_setting_batch_by_org',
1364             $name, '{' . join(',', @$org_ids) . '}'
1365         ]
1366     };
1367
1368     # DB func returns an array of settings matching the order of the
1369     # list of org unit IDs.  If the setting does not contain a valid
1370     # ->id value, then no setting value exists for that org unit.
1371     my $settings = $e->json_query($query);
1372     for my $idx (0 .. $#$org_ids) {
1373         my $setting = $settings->[$idx];
1374         my $org_id = $org_ids->[$idx];
1375
1376         next unless $setting->{id}; # null ID means no value is present.
1377
1378         $result{$org_id}->{org} = $setting->{org_unit};
1379         $result{$org_id}->{value} =
1380             OpenSRF::Utils::JSON->JSON2perl($setting->{value});
1381     }
1382
1383     return %result;
1384 }
1385
1386 # returns the ISO8601 string representation of the requested epoch in GMT
1387 sub epoch2ISO8601 {
1388     my( $self, $epoch ) = @_;
1389     my ($sec,$min,$hour,$mday,$mon,$year) = gmtime($epoch);
1390     $year += 1900; $mon += 1;
1391     my $date = sprintf(
1392         '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1393         $year, $mon, $mday, $hour, $min, $sec);
1394     return $date;
1395 }
1396
1397 sub find_highest_perm_org {
1398     my ( $self, $perm, $userid, $start_org, $org_tree ) = @_;
1399     my $org = $self->find_org($org_tree, $start_org );
1400
1401     my $lastid = -1;
1402     while( $org ) {
1403         last if ($self->check_perms( $userid, $org->id, $perm )); # perm failed
1404         $lastid = $org->id;
1405         $org = $self->find_org( $org_tree, $org->parent_ou() );
1406     }
1407
1408     return $lastid;
1409 }
1410
1411
1412 # returns the org_unit ID's
1413 sub user_has_work_perm_at {
1414     my($self, $e, $perm, $options, $user_id) = @_;
1415     $options ||= {};
1416     $user_id = (defined $user_id) ? $user_id : $e->requestor->id;
1417
1418     my $func = 'permission.usr_has_perm_at';
1419     $func = $func.'_all' if $$options{descendants};
1420
1421     my $orgs = $e->json_query({from => [$func, $user_id, $perm]});
1422     $orgs = [map { $_->{ (keys %$_)[0] } } @$orgs];
1423
1424     return $orgs unless $$options{objects};
1425
1426     return $e->search_actor_org_unit({id => $orgs});
1427 }
1428
1429 sub get_user_work_ou_ids {
1430     my($self, $e, $userid) = @_;
1431     my $work_orgs = $e->json_query({
1432         select => {puwoum => ['work_ou']},
1433         from => 'puwoum',
1434         where => {usr => $e->requestor->id}});
1435
1436     return [] unless @$work_orgs;
1437     my @work_orgs;
1438     push(@work_orgs, $_->{work_ou}) for @$work_orgs;
1439
1440     return \@work_orgs;
1441 }
1442
1443
1444 my $org_types;
1445 sub get_org_types {
1446     my($self, $client) = @_;
1447     return $org_types if $org_types;
1448     return $org_types = OpenILS::Utils::CStoreEditor->new->retrieve_all_actor_org_unit_type();
1449 }
1450
1451 my %ORG_TREE;
1452 sub get_org_tree {
1453     my $self = shift;
1454     my $locale = shift || '';
1455     my $cache = OpenSRF::Utils::Cache->new("global", 0);
1456     my $tree = $ORG_TREE{$locale} || $cache->get_cache("orgtree.$locale");
1457     return $tree if $tree;
1458
1459     my $ses = OpenILS::Utils::CStoreEditor->new;
1460     $ses->session->session_locale($locale);
1461     $tree = $ses->search_actor_org_unit(
1462         [
1463             {"parent_ou" => undef },
1464             {
1465                 flesh               => -1,
1466                 flesh_fields    => { aou =>  ['children'] },
1467                 order_by            => { aou => 'name'}
1468             }
1469         ]
1470     )->[0];
1471
1472     $ORG_TREE{$locale} = $tree;
1473     $cache->put_cache("orgtree.$locale", $tree);
1474     return $tree;
1475 }
1476
1477 sub get_global_flag {
1478     my($self, $flag) = @_;
1479     return undef unless ($flag);
1480     return OpenILS::Utils::CStoreEditor->new->retrieve_config_global_flag($flag);
1481 }
1482
1483 sub get_org_descendants {
1484     my($self, $org_id, $depth) = @_;
1485
1486     my $select = {
1487         transform => 'actor.org_unit_descendants',
1488         column => 'id',
1489         result_field => 'id',
1490     };
1491     $select->{params} = [$depth] if defined $depth;
1492
1493     my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1494         select => {aou => [$select]},
1495         from => 'aou',
1496         where => {id => $org_id}
1497     });
1498     my @orgs;
1499     push(@orgs, $_->{id}) for @$org_list;
1500     return \@orgs;
1501 }
1502
1503 sub get_org_ancestors {
1504     my($self, $org_id, $use_cache) = @_;
1505
1506     my ($cache, $orgs);
1507
1508     if ($use_cache) {
1509         $cache = OpenSRF::Utils::Cache->new("global", 0);
1510         $orgs = $cache->get_cache("org.ancestors.$org_id");
1511         return $orgs if $orgs;
1512     }
1513
1514     my $org_list = OpenILS::Utils::CStoreEditor->new->json_query({
1515         select => {
1516             aou => [{
1517                 transform => 'actor.org_unit_ancestors',
1518                 column => 'id',
1519                 result_field => 'id',
1520                 params => []
1521             }],
1522         },
1523         from => 'aou',
1524         where => {id => $org_id}
1525     });
1526
1527     $orgs = [ map { $_->{id} } @$org_list ];
1528
1529     $cache->put_cache("org.ancestors.$org_id", $orgs) if $use_cache;
1530     return $orgs;
1531 }
1532
1533 sub get_org_full_path {
1534     my($self, $org_id, $depth) = @_;
1535
1536     my $query = {
1537         select => {
1538             aou => [{
1539                 transform => 'actor.org_unit_full_path',
1540                 column => 'id',
1541                 result_field => 'id',
1542             }],
1543         },
1544         from => 'aou',
1545         where => {id => $org_id}
1546     };
1547
1548     $query->{select}->{aou}->[0]->{params} = [$depth] if defined $depth;
1549     my $org_list = OpenILS::Utils::CStoreEditor->new->json_query($query);
1550     return [ map {$_->{id}} @$org_list ];
1551 }
1552
1553 # returns the ID of the org unit ancestor at the specified depth
1554 sub org_unit_ancestor_at_depth {
1555     my($class, $org_id, $depth) = @_;
1556     my $resp = OpenILS::Utils::CStoreEditor->new->json_query(
1557         {from => ['actor.org_unit_ancestor_at_depth', $org_id, $depth]})->[0];
1558     return ($resp) ? $resp->{id} : undef;
1559 }
1560
1561 # Returns the proximity value between two org units.
1562 sub get_org_unit_proximity {
1563     my ($class, $e, $from_org, $to_org) = @_;
1564     $e = OpenILS::Utils::CStoreEditor->new unless ($e);
1565     my $r = $e->json_query(
1566         {
1567             select => {aoup => ['prox']},
1568             from => 'aoup',
1569             where => {from_org => $from_org, to_org => $to_org}
1570         }
1571     );
1572     if (ref($r) eq 'ARRAY' && @$r) {
1573         return $r->[0]->{prox};
1574     }
1575     return undef;
1576 }
1577
1578 # returns the user's configured locale as a string.  Defaults to en-US if none is configured.
1579 sub get_user_locale {
1580     my($self, $user_id, $e) = @_;
1581     $e ||= OpenILS::Utils::CStoreEditor->new;
1582
1583     # first, see if the user has an explicit locale set
1584     my $setting = $e->search_actor_user_setting(
1585         {usr => $user_id, name => 'global.locale'})->[0];
1586     return OpenSRF::Utils::JSON->JSON2perl($setting->value) if $setting;
1587
1588     my $user = $e->retrieve_actor_user($user_id) or return $e->event;
1589     return $self->get_org_locale($user->home_ou, $e);
1590 }
1591
1592 # returns org locale setting
1593 sub get_org_locale {
1594     my($self, $org_id, $e) = @_;
1595     $e ||= OpenILS::Utils::CStoreEditor->new;
1596
1597     my $locale;
1598     if(defined $org_id) {
1599         $locale = $self->ou_ancestor_setting_value($org_id, 'global.default_locale', $e);
1600         return $locale if $locale;
1601     }
1602
1603     # system-wide default
1604     my $sclient = OpenSRF::Utils::SettingsClient->new;
1605     $locale = $sclient->config_value('default_locale');
1606     return $locale if $locale;
1607
1608     # if nothing else, fallback to locale=cowboy
1609     return 'en-US';
1610 }
1611
1612
1613 # xml-escape non-ascii characters
1614 sub entityize {
1615     my($self, $string, $form) = @_;
1616     $form ||= "";
1617
1618     if ($form eq 'D') {
1619         $string = NFD($string);
1620     } else {
1621         $string = NFC($string);
1622     }
1623
1624     # Convert raw ampersands to entities
1625     $string =~ s/&(?!\S+;)/&amp;/gso;
1626
1627     # Convert Unicode characters to entities
1628     $string =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
1629
1630     return $string;
1631 }
1632
1633 # x0000-x0008 isn't legal in XML documents
1634 # XXX Perhaps this should just go into our standard entityize method
1635 sub strip_ctrl_chars {
1636     my ($self, $string) = @_;
1637
1638     $string =~ s/([\x{0000}-\x{0008}])//sgoe;
1639     return $string;
1640 }
1641
1642 sub get_copy_price {
1643     my($self, $e, $copy, $volume) = @_;
1644
1645     $copy->price(0) if $copy->price and $copy->price < 0;
1646
1647
1648     my $owner;
1649     if(ref $volume) {
1650         if($volume->id == OILS_PRECAT_CALL_NUMBER) {
1651             $owner = $copy->circ_lib;
1652         } else {
1653             $owner = $volume->owning_lib;
1654         }
1655     } else {
1656         if($copy->call_number == OILS_PRECAT_CALL_NUMBER) {
1657             $owner = $copy->circ_lib;
1658         } else {
1659             $owner = $e->retrieve_asset_call_number($copy->call_number)->owning_lib;
1660         }
1661     }
1662
1663     my $min_price = $self->ou_ancestor_setting_value($owner, OILS_SETTING_MIN_ITEM_PRICE);
1664     my $max_price = $self->ou_ancestor_setting_value($owner, OILS_SETTING_MAX_ITEM_PRICE);
1665     my $charge_on_0 = $self->ou_ancestor_setting_value($owner, OILS_SETTING_CHARGE_LOST_ON_ZERO, $e);
1666
1667     my $price = $copy->price;
1668
1669     # set the default price if needed
1670     if (!defined $price or ($price == 0 and $charge_on_0)) {
1671         # set to default price
1672         $price = $self->ou_ancestor_setting_value(
1673             $owner, OILS_SETTING_DEF_ITEM_PRICE, $e) || 0;
1674     }
1675
1676     # adjust to min/max range if needed
1677     if (defined $max_price and $price > $max_price) {
1678         $price = $max_price;
1679     } elsif (defined $min_price and $price < $min_price
1680         and ($price != 0 or $charge_on_0 or !defined $charge_on_0)) {
1681         # default to raising the price to the minimum,
1682         # but let 0 fall through if $charge_on_0 is set and is false
1683         $price = $min_price;
1684     }
1685
1686     return $price;
1687 }
1688
1689 # given a transaction ID, this returns the context org_unit for the transaction
1690 sub xact_org {
1691     my($self, $xact_id, $e) = @_;
1692     $e ||= OpenILS::Utils::CStoreEditor->new;
1693
1694     my $loc = $e->json_query({
1695         "select" => {circ => ["circ_lib"]},
1696         from     => "circ",
1697         "where"  => {id => $xact_id},
1698     });
1699
1700     return $loc->[0]->{circ_lib} if @$loc;
1701
1702     $loc = $e->json_query({
1703         "select" => {bresv => ["request_lib"]},
1704         from     => "bresv",
1705         "where"  => {id => $xact_id},
1706     });
1707
1708     return $loc->[0]->{request_lib} if @$loc;
1709
1710     $loc = $e->json_query({
1711         "select" => {mg => ["billing_location"]},
1712         from     => "mg",
1713         "where"  => {id => $xact_id},
1714     });
1715
1716     return $loc->[0]->{billing_location};
1717 }
1718
1719
1720 sub find_event_def_by_hook {
1721     my($self, $hook, $context_org, $e) = @_;
1722
1723     $e ||= OpenILS::Utils::CStoreEditor->new;
1724
1725     my $orgs = $self->get_org_ancestors($context_org);
1726
1727     # search from the context org up
1728     for my $org_id (reverse @$orgs) {
1729
1730         my $def = $e->search_action_trigger_event_definition(
1731             {hook => $hook, owner => $org_id, active => 't'})->[0];
1732
1733         return $def if $def;
1734     }
1735
1736     return undef;
1737 }
1738
1739
1740
1741 # If an event_def ID is not provided, use the hook and context org to find the
1742 # most appropriate event.  create the event, fire it, then return the resulting
1743 # event with fleshed template_output and error_output
1744 sub fire_object_event {
1745     my($self, $event_def, $hook, $object, $context_org, $granularity, $user_data, $client) = @_;
1746
1747     my $e = OpenILS::Utils::CStoreEditor->new;
1748     my $def;
1749
1750     my $auto_method = "open-ils.trigger.event.autocreate.by_definition";
1751
1752     if($event_def) {
1753         $def = $e->retrieve_action_trigger_event_definition($event_def)
1754             or return $e->event;
1755
1756         $auto_method .= '.include_inactive';
1757
1758     } else {
1759
1760         # find the most appropriate event def depending on context org
1761         $def = $self->find_event_def_by_hook($hook, $context_org, $e)
1762             or return $e->event;
1763     }
1764
1765     my $final_resp;
1766
1767     if($def->group_field) {
1768         # we have a list of objects
1769         $object = [$object] unless ref $object eq 'ARRAY';
1770
1771         my @event_ids;
1772         $user_data ||= [];
1773         for my $i (0..$#$object) {
1774             my $obj = $$object[$i];
1775             my $udata = $$user_data[$i];
1776             my $event_id = $self->simplereq(
1777                 'open-ils.trigger', $auto_method, $def->id, $obj, $context_org, $udata);
1778             push(@event_ids, $event_id);
1779         }
1780
1781         $logger->info("EVENTS = " . OpenSRF::Utils::JSON->perl2JSON(\@event_ids));
1782
1783         my $resp;
1784         if (not defined $client) {
1785             $resp = $self->simplereq(
1786                 'open-ils.trigger',
1787                 'open-ils.trigger.event_group.fire',
1788                 \@event_ids);
1789         } else {
1790             $resp = $self->patientreq(
1791                 $client,
1792                 "open-ils.trigger", "open-ils.trigger.event_group.fire",
1793                 \@event_ids
1794             );
1795         }
1796
1797         if($resp and $resp->{events} and @{$resp->{events}}) {
1798
1799             $e->xact_begin;
1800             $final_resp = $e->retrieve_action_trigger_event([
1801                 $resp->{events}->[0]->id,
1802                 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1803             ]);
1804             $e->rollback;
1805         }
1806
1807     } else {
1808
1809         $object = $$object[0] if ref $object eq 'ARRAY';
1810
1811         my $event_id;
1812         my $resp;
1813
1814         if (not defined $client) {
1815             $event_id = $self->simplereq(
1816                 'open-ils.trigger',
1817                 $auto_method, $def->id, $object, $context_org, $user_data
1818             );
1819
1820             $resp = $self->simplereq(
1821                 'open-ils.trigger',
1822                 'open-ils.trigger.event.fire',
1823                 $event_id
1824             );
1825         } else {
1826             $event_id = $self->patientreq(
1827                 $client,
1828                 'open-ils.trigger',
1829                 $auto_method, $def->id, $object, $context_org, $user_data
1830             );
1831
1832             $resp = $self->patientreq(
1833                 $client,
1834                 'open-ils.trigger',
1835                 'open-ils.trigger.event.fire',
1836                 $event_id
1837             );
1838         }
1839
1840         if($resp and $resp->{event}) {
1841             $e->xact_begin;
1842             $final_resp = $e->retrieve_action_trigger_event([
1843                 $resp->{event}->id,
1844                 {flesh => 1, flesh_fields => {atev => ['template_output', 'error_output']}}
1845             ]);
1846             $e->rollback;
1847         }
1848     }
1849
1850     return $final_resp;
1851 }
1852
1853
1854 sub create_events_for_hook {
1855     my($self, $hook, $obj, $org_id, $granularity, $user_data, $wait) = @_;
1856     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1857     my $req = $ses->request('open-ils.trigger.event.autocreate',
1858         $hook, $obj, $org_id, $granularity, $user_data);
1859     return undef unless $wait;
1860     my $resp = $req->recv;
1861     return $resp->content if $resp;
1862 }
1863
1864 sub create_uuid_string {
1865     return create_UUID_as_string();
1866 }
1867
1868 sub create_circ_chain_summary {
1869     my($class, $e, $circ_id) = @_;
1870     my $sum = $e->json_query({from => ['action.summarize_all_circ_chain', $circ_id]})->[0];
1871     return undef unless $sum;
1872     my $obj = Fieldmapper::action::circ_chain_summary->new;
1873     $obj->$_($sum->{$_}) for keys %$sum;
1874     return $obj;
1875 }
1876
1877
1878 # Returns "mra" attribute key/value pairs for a set of bre's
1879 # Takes a list of bre IDs, returns a hash of hashes,
1880 # {bre_id1 => {key1 => {code => value1, label => label1}, ...}...}
1881 my $ccvm_cache;
1882 sub get_bre_attrs {
1883     my ($class, $bre_ids, $e) = @_;
1884     $e = $e || OpenILS::Utils::CStoreEditor->new;
1885
1886     my $attrs = {};
1887     return $attrs unless defined $bre_ids;
1888     $bre_ids = [$bre_ids] unless ref $bre_ids;
1889
1890     my $mra = $e->json_query({
1891         select => {
1892             mra => [
1893                 {
1894                     column => 'id',
1895                     alias => 'bre'
1896                 }, {
1897                     column => 'attrs',
1898                     transform => 'each',
1899                     result_field => 'key',
1900                     alias => 'key'
1901                 },{
1902                     column => 'attrs',
1903                     transform => 'each',
1904                     result_field => 'value',
1905                     alias => 'value'
1906                 }
1907             ]
1908         },
1909         from => 'mra',
1910         where => {id => $bre_ids}
1911     });
1912
1913     return $attrs unless $mra;
1914
1915     $ccvm_cache = $ccvm_cache || $e->search_config_coded_value_map({id => {'!=' => undef}});
1916
1917     for my $id (@$bre_ids) {
1918         $attrs->{$id} = {};
1919         for my $mra (grep { $_->{bre} eq $id } @$mra) {
1920             my $ctype = $mra->{key};
1921             my $code = $mra->{value};
1922             $attrs->{$id}->{$ctype} = {code => $code};
1923             if($code) {
1924                 my ($ccvm) = grep { $_->ctype eq $ctype and $_->code eq $code } @$ccvm_cache;
1925                 $attrs->{$id}->{$ctype}->{label} = $ccvm->value if $ccvm;
1926             }
1927         }
1928     }
1929
1930     return $attrs;
1931 }
1932
1933 # Shorter version of bib_container_items_via_search() below, only using
1934 # the queryparser record_list filter instead of the container filter.
1935 sub bib_record_list_via_search {
1936     my ($class, $search_query, $search_args) = @_;
1937
1938     # First, Use search API to get container items sorted in any way that crad
1939     # sorters support.
1940     my $search_result = $class->simplereq(
1941         "open-ils.search", "open-ils.search.biblio.multiclass.query",
1942         $search_args, $search_query
1943     );
1944
1945     unless ($search_result) {
1946         # empty result sets won't cause this, but actual errors should.
1947         $logger->warn("bib_record_list_via_search() got nothing from search");
1948         return;
1949     }
1950
1951     # Throw away other junk from search, keeping only bib IDs.
1952     return [ map { shift @$_ } @{$search_result->{ids}} ];
1953 }
1954
1955 # 'no_flesh' avoids fleshing the target_biblio_record_entry
1956 sub bib_container_items_via_search {
1957     my ($class, $container_id, $search_query, $search_args, $no_flesh) = @_;
1958
1959     # First, Use search API to get container items sorted in any way that crad
1960     # sorters support.
1961     my $search_result = $class->simplereq(
1962         "open-ils.search", "open-ils.search.biblio.multiclass.query",
1963         $search_args, $search_query
1964     );
1965     unless ($search_result) {
1966         # empty result sets won't cause this, but actual errors should.
1967         $logger->warn("bib_container_items_via_search() got nothing from search");
1968         return;
1969     }
1970
1971     # Throw away other junk from search, keeping only bib IDs.
1972     my $id_list = [ map { shift @$_ } @{$search_result->{ids}} ];
1973
1974     return [] unless @$id_list;
1975
1976     # Now get the bib container items themselves...
1977     my $e = new OpenILS::Utils::CStoreEditor;
1978     unless ($e) {
1979         $logger->warn("bib_container_items_via_search() couldn't get cstoreeditor");
1980         return;
1981     }
1982
1983     my @flesh_fields = qw/notes/;
1984     push(@flesh_fields, 'target_biblio_record_entry') unless $no_flesh;
1985
1986     my $items = $e->search_container_biblio_record_entry_bucket_item([
1987         {
1988             "target_biblio_record_entry" => $id_list,
1989             "bucket" => $container_id
1990         }, {
1991             flesh => 1,
1992             flesh_fields => {"cbrebi" => \@flesh_fields}
1993         }
1994     ], {substream => 1});
1995
1996     unless ($items) {
1997         $logger->warn(
1998             "bib_container_items_via_search() couldn't get bucket items: " .
1999             $e->die_event->{textcode}
2000         );
2001         return;
2002     }
2003
2004     # ... and put them in the same order that the search API said they
2005     # should be in.
2006     my %ordering_hash = map {
2007         ($no_flesh) ? $_->target_biblio_record_entry : $_->target_biblio_record_entry->id,
2008         $_
2009     } @$items;
2010
2011     return [map { $ordering_hash{$_} } @$id_list];
2012 }
2013
2014 # returns undef on success, Event on error
2015 sub log_user_activity {
2016     my ($class, $user_id, $who, $what, $e, $async) = @_;
2017
2018     my $commit = 0;
2019     if (!$e) {
2020         $e = OpenILS::Utils::CStoreEditor->new(xact => 1);
2021         $commit = 1;
2022     }
2023
2024     my $res = $e->json_query({
2025         from => [
2026             'actor.insert_usr_activity',
2027             $user_id, $who, $what, OpenSRF::AppSession->ingress
2028         ]
2029     });
2030
2031     if ($res) { # call returned OK
2032
2033         $e->commit   if $commit and @$res;
2034         $e->rollback if $commit and !@$res;
2035
2036     } else {
2037         return $e->die_event;
2038     }
2039
2040     return undef;
2041 }
2042
2043 # I hate to put this here exactly, but this code needs to be shared between
2044 # the TPAC's mod_perl module and open-ils.serial.
2045 #
2046 # There is a reason every part of the query *except* those parts dealing
2047 # with scope are moved here from the code's origin in TPAC.  The serials
2048 # use case does *not* want the same scoping logic.
2049 #
2050 # Also, note that for the serials uses case, we may filter in OPAC visible
2051 # status and copy/call_number deletedness, but we don't filter on any
2052 # particular values for serial.item.status or serial.item.date_received.
2053 # Since we're only using this *after* winnowing down the set of issuances
2054 # that copies should be related to, I'm not sure we need any such serial.item
2055 # filters.
2056
2057 sub basic_opac_copy_query {
2058     ######################################################################
2059     # Pass a defined value for either $rec_id OR ($iss_id AND $dist_id), #
2060     # not both.                                                          #
2061     ######################################################################
2062     my ($self,$rec_id,$iss_id,$dist_id,$copy_limit,$copy_offset,$staff) = @_;
2063
2064     return {
2065         select => {
2066             acp => ['id', 'barcode', 'circ_lib', 'create_date', 'active_date',
2067                     'age_protect', 'holdable', 'copy_number', 'circ_modifier'],
2068             acpl => [
2069                 {column => 'name', alias => 'copy_location'},
2070                 {column => 'holdable', alias => 'location_holdable'},
2071                 {column => 'url', alias => 'location_url'}
2072             ],
2073             ccs => [
2074                 {column => 'id', alias => 'status_code'},
2075                 {column => 'name', alias => 'copy_status'},
2076                 {column => 'holdable', alias => 'status_holdable'}
2077             ],
2078             acn => [
2079                 {column => 'label', alias => 'call_number_label'},
2080                 {column => 'id', alias => 'call_number'},
2081                 {column => 'owning_lib', alias => 'call_number_owning_lib'}
2082             ],
2083             circ => ['due_date',{column => 'circ_lib', alias => 'circ_circ_lib'}],
2084             acnp => [
2085                 {column => 'label', alias => 'call_number_prefix_label'},
2086                 {column => 'id', alias => 'call_number_prefix'}
2087             ],
2088             acns => [
2089                 {column => 'label', alias => 'call_number_suffix_label'},
2090                 {column => 'id', alias => 'call_number_suffix'}
2091             ],
2092             bmp => [
2093                 {column => 'label', alias => 'part_label'},
2094             ],
2095             ($iss_id ? (sitem => ["issuance"]) : ())
2096         },
2097
2098         from => {
2099             acp => [
2100                 {acn => { # 0
2101                     join => {
2102                         acnp => { fkey => 'prefix' },
2103                         acns => { fkey => 'suffix' }
2104                     },
2105                     filter => [
2106                         {deleted => 'f'},
2107                         ($rec_id ? {record => $rec_id} : ())
2108                     ],
2109                 }},
2110                 'aou', # 1
2111                 {circ => { # 2 If the copy is circulating, retrieve the open circ
2112                     type => 'left',
2113                     filter => {checkin_time => undef}
2114                 }},
2115                 {acpl => { # 3
2116                     filter => {
2117                         deleted => 'f',
2118                         ($staff ? () : ( opac_visible => 't' )),
2119                     },
2120                 }},
2121                 {ccs => { # 4
2122                     ($staff ? () : (filter => { opac_visible => 't' }))
2123                 }},
2124                 {acpm => { # 5
2125                     type => 'left',
2126                     join => {
2127                         bmp => { type => 'left', filter => { deleted => 'f' } }
2128                     }
2129                 }},
2130                 ($iss_id ? { # 6
2131                     sitem => {
2132                         fkey => 'id',
2133                         field => 'unit',
2134                         filter => {issuance => $iss_id},
2135                         join => {
2136                             sstr => { }
2137                         }
2138                     }
2139                 } : ())
2140             ]
2141         },
2142
2143         where => {
2144             '+acp' => {
2145                 deleted => 'f',
2146                 ($staff ? () : (opac_visible => 't'))
2147             },
2148             ($dist_id ? ( '+sstr' => { distribution => $dist_id } ) : ()),
2149             ($staff ? () : ( '+aou' => { opac_visible => 't' } ))
2150         },
2151
2152         order_by => [
2153             {class => 'aou', field => 'name'},
2154             {class => 'acn', field => 'label_sortkey'},
2155             {class => 'bmp', field => 'label_sortkey'},
2156             {class => 'acp', field => 'copy_number'},
2157             {class => 'acp', field => 'barcode'}
2158         ],
2159
2160         limit => $copy_limit,
2161         offset => $copy_offset
2162     };
2163 }
2164
2165 # Compare two dates, date1 and date2. If date2 is not defined, then
2166 # DateTime->now will be used. Assumes dates are in ISO8601 format as
2167 # supported by DateTime::Format::ISO8601. (A future enhancement might
2168 # be to support other formats.)
2169 #
2170 # Returns -1 if $date1 < $date2
2171 # Returns 0 if $date1 == $date2
2172 # Returns 1 if $date1 > $date2
2173 sub datecmp {
2174     my $self = shift;
2175     my $date1 = shift;
2176     my $date2 = shift;
2177
2178     # Check for timezone offsets and limit them to 2 digits:
2179     if ($date1 && $date1 =~ /(?:-|\+)\d\d\d\d$/) {
2180         $date1 = substr($date1, 0, length($date1) - 2);
2181     }
2182     if ($date2 && $date2 =~ /(?:-|\+)\d\d\d\d$/) {
2183         $date2 = substr($date2, 0, length($date2) - 2);
2184     }
2185
2186     # check date1:
2187     unless (UNIVERSAL::isa($date1, "DateTime")) {
2188         $date1 = DateTime::Format::ISO8601->parse_datetime($date1);
2189     }
2190
2191     # Check for date2:
2192     unless ($date2) {
2193         $date2 = DateTime->now;
2194     } else {
2195         unless (UNIVERSAL::isa($date2, "DateTime")) {
2196             $date2 = DateTime::Format::ISO8601->parse_datetime($date2);
2197         }
2198     }
2199
2200     return DateTime->compare($date1, $date2);
2201 }
2202
2203
2204 # marcdoc is an XML::LibXML document
2205 # updates the doc and returns the entityized MARC string
2206 sub strip_marc_fields {
2207     my ($class, $e, $marcdoc, $grps) = @_;
2208
2209     my $orgs = $class->get_org_ancestors($e->requestor->ws_ou);
2210
2211     my $query = {
2212         select  => {vibtf => ['field']},
2213         from    => {vibtf => 'vibtg'},
2214         where   => {'+vibtg' => {owner => $orgs}},
2215         distinct => 1
2216     };
2217
2218     # give me always-apply groups plus any selected groups
2219     if ($grps and @$grps) {
2220         $query->{where}->{'+vibtg'}->{'-or'} = [
2221             {id => $grps},
2222             {always_apply => 't'}
2223         ];
2224
2225     } else {
2226         $query->{where}->{'+vibtg'}->{always_apply} = 't';
2227     }
2228
2229     my $fields = $e->json_query($query);
2230
2231     for my $field (@$fields) {
2232         my $tag = $field->{field};
2233         for my $node ($marcdoc->findnodes('//*[@tag="'.$tag.'"]')) {
2234             $node->parentNode->removeChild($node);
2235         }
2236     }
2237
2238     return $class->entityize($marcdoc->documentElement->toString);
2239 }
2240
2241 # marcdoc is an XML::LibXML document
2242 # updates the document and returns the entityized MARC string.
2243 sub set_marc_905u {
2244     my ($class, $marcdoc, $username) = @_;
2245
2246     # Look for existing 905$u subfields. If any exist, do nothing.
2247     my @nodes = $marcdoc->findnodes('//*[@tag="905"]/*[@code="u"]');
2248     unless (@nodes) {
2249         # We create a new 905 and the subfield u to that.
2250         my $parentNode = $marcdoc->createElement('datafield');
2251         $parentNode->setAttribute('tag', '905');
2252         $parentNode->setAttribute('ind1', '');
2253         $parentNode->setAttribute('ind2', '');
2254         $marcdoc->documentElement->addChild($parentNode);
2255         my $node = $marcdoc->createElement('subfield');
2256         $node->setAttribute('code', 'u');
2257         $node->appendTextNode($username);
2258         $parentNode->addChild($node);
2259
2260     }
2261
2262     return $class->entityize($marcdoc->documentElement->toString);
2263 }
2264
2265 # Given a list of PostgreSQL arrays of numbers,
2266 # unnest the numbers and return a unique set, skipping any list elements
2267 # that are just '{NULL}'.
2268 sub unique_unnested_numbers {
2269     my $class = shift;
2270
2271     no warnings 'numeric';
2272
2273     return uniq(
2274         map(
2275             int,
2276             map { $_ eq 'NULL' ? undef : (split /,/, $_) }
2277                 map { substr($_, 1, -1) } @_
2278         )
2279     );
2280 }
2281
2282 # Check if a transaction should be left open or closed. Close the
2283 # transaction if it should be closed or open it otherwise. Returns
2284 # undef on success or a failure event.
2285 sub check_open_xact {
2286     my( $self, $editor, $xactid, $xact ) = @_;
2287
2288     # Grab the transaction
2289     $xact ||= $editor->retrieve_money_billable_transaction($xactid);
2290     return $editor->event unless $xact;
2291     $xactid ||= $xact->id;
2292
2293     # grab the summary and see how much is owed on this transaction
2294     my ($summary) = $self->fetch_mbts($xactid, $editor);
2295
2296     # grab the circulation if it is a circ;
2297     my $circ = $editor->retrieve_action_circulation($xactid);
2298
2299     # If nothing is owed on the transaction but it is still open
2300     # and this transaction is not an open circulation, close it
2301     if(
2302         ( $summary->balance_owed == 0 and ! $xact->xact_finish ) and
2303         ( !$circ or $circ->stop_fines )) {
2304
2305         $logger->info("closing transaction ".$xact->id. ' because balance_owed == 0');
2306         $xact->xact_finish('now');
2307         $editor->update_money_billable_transaction($xact)
2308             or return $editor->event;
2309         return undef;
2310     }
2311
2312     # If money is owed or a refund is due on the xact and xact_finish
2313     # is set, clear it (to reopen the xact) and update
2314     if( $summary->balance_owed != 0 and $xact->xact_finish ) {
2315         $logger->info("re-opening transaction ".$xact->id. ' because balance_owed != 0');
2316         $xact->clear_xact_finish;
2317         $editor->update_money_billable_transaction($xact)
2318             or return $editor->event;
2319         return undef;
2320     }
2321     return undef;
2322 }
2323
2324 # Because floating point math has rounding issues, and Dyrcona gets
2325 # tired of typing out the code to multiply floating point numbers
2326 # before adding and subtracting them and then dividing the result by
2327 # 100 each time, he wrote this little subroutine for subtracting
2328 # floating point values.  It can serve as a model for the other
2329 # operations if you like.
2330 #
2331 # It takes a list of floating point values as arguments.  The rest are
2332 # all subtracted from the first and the result is returned.  The
2333 # values are all multiplied by 100 before being used, and the result
2334 # is divided by 100 in order to avoid decimal rounding errors inherent
2335 # in floating point math.
2336 #
2337 # XXX shifting using multiplication/division *may* still introduce
2338 # rounding errors -- better to implement using string manipulation?
2339 sub fpdiff {
2340     my ($class, @args) = @_;
2341     my $result = shift(@args) * 100;
2342     while (my $arg = shift(@args)) {
2343         $result -= $arg * 100;
2344     }
2345     return $result / 100;
2346 }
2347
2348 sub fpsum {
2349     my ($class, @args) = @_;
2350     my $result = shift(@args) * 100;
2351     while (my $arg = shift(@args)) {
2352         $result += $arg * 100;
2353     }
2354     return $result / 100;
2355 }
2356
2357 # Non-migrated passwords can be verified directly in the DB
2358 # with any extra hashing.
2359 sub verify_user_password {
2360     my ($class, $e, $user_id, $passwd, $pw_type) = @_;
2361
2362     $pw_type ||= 'main'; # primary login password
2363
2364     my $verify = $e->json_query({
2365         from => [
2366             'actor.verify_passwd',
2367             $user_id, $pw_type, $passwd
2368         ]
2369     })->[0];
2370
2371     return $class->is_true($verify->{'actor.verify_passwd'});
2372 }
2373
2374 # Passwords migrated from the original MD5 scheme are passed through 2
2375 # extra layers of MD5 hashing for backwards compatibility with the
2376 # MD5 passwords of yore and the MD5-based chap-style authentication.
2377 # Passwords are stored in the DB like this:
2378 # CRYPT( MD5( pw_salt || MD5(real_password) ), pw_salt )
2379 #
2380 # If 'as_md5' is true, the password provided has already been
2381 # MD5 hashed.
2382 sub verify_migrated_user_password {
2383     my ($class, $e, $user_id, $passwd, $as_md5) = @_;
2384
2385     # 'main' is the primary login password. This is the only password
2386     # type that requires the additional MD5 hashing.
2387     my $pw_type = 'main';
2388
2389     # Sometimes we have the bare password, sometimes the MD5 version.
2390     my $md5_pass = $as_md5 ? $passwd : md5_hex($passwd);
2391
2392     my $salt = $e->json_query({
2393         from => [
2394             'actor.get_salt',
2395             $user_id,
2396             $pw_type
2397         ]
2398     })->[0];
2399
2400     $salt = $salt->{'actor.get_salt'};
2401
2402     return $class->verify_user_password(
2403         $e, $user_id, md5_hex($salt . $md5_pass), $pw_type);
2404 }
2405
2406
2407 1;
2408