Open-ILS/src/perlmods/OpenILS/Application/Circ/ScriptBuilder.pm

   1 package OpenILS::Application::Circ::ScriptBuilder;
   2 use strict; use warnings;
   3 use OpenILS::Utils::ScriptRunner;
   4 use OpenILS::Utils::CStoreEditor qw/:funcs/;
   5 use OpenILS::Application::AppUtils;
   6 use OpenILS::Application::Actor;
   7 use OpenSRF::Utils::Logger qw/$logger/;
   8 use OpenILS::Application::Circ::Holds;
   9 use DateTime::Format::ISO8601;
  10 use OpenSRF::Utils qw/:datetime/;
  11 use Scalar::Util qw/weaken/;
  12 my $U = "OpenILS::Application::AppUtils";
  13 use Data::Dumper;
  14
  15 my $holdcode = "OpenILS::Application::Circ::Holds";
  16
  17 my $evt = "environment";
  18 my %GROUP_SET;
  19 my $GROUP_TREE;
  20 my $ORG_TREE;
  21 my @ORG_LIST;
  22 my @OU_TYPES;
  23
  24
  25 # -----------------------------------------------------------------------
  26 # Possible Args:
  27 #  copy
  28 #  copy_id
  29 #  copy_barcode
  30 #
  31 #  patron
  32 #  patron_id
  33 #  patron_barcode
  34 #
  35 #  fetch_patron_circ_info - load info on items out, overdues, and fines.
  36 #
  37 #  _direct - this is a hash of key/value pairs to shove directly into the
  38 #  script runner.  Use this to cover data not covered by this module
  39 # -----------------------------------------------------------------------
  40 sub build {
  41         my( $class, $args ) = @_;
  42
  43         my $evt;
  44         my @evts;
  45
  46         my $editor = $$args{editor} || new_editor(xact => 1);
  47
  48         $args->{_direct} = {} unless $args->{_direct};
  49         $args->{editor} = $editor;
  50
  51         $evt = fetch_bib_data($editor, $args);
  52         push(@evts, $evt) if $evt;
  53         $evt = fetch_user_data($editor, $args);
  54         push(@evts, $evt) if $evt;
  55
  56         if(@evts) {
  57                 my @e;
  58                 push( @e, $_->{textcode} ) for @evts;
  59                 $logger->info("script_builder: some events occurred: @e");
  60                 $logger->debug("script_builder: some events occurred: " . Dumper(\@evts));
  61                 $args->{_events} = \@evts;
  62         }
  63
  64         return build_runner($editor, $args);
  65 }
  66
  67
  68 sub build_runner {
  69         my $editor      = shift;
  70         my $ctx         = shift;
  71
  72         my $runner = OpenILS::Utils::ScriptRunner->new;
  73
  74         my $gt = $GROUP_TREE;
  75         $runner->insert( "$evt.groupTree",      $gt, 1);
  76
  77
  78         $runner->insert( "$evt.patron",         $ctx->{patron}, 1);
  79         $runner->insert( "$evt.copy",                   $ctx->{copy}, 1);
  80         $runner->insert( "$evt.volume",         $ctx->{volume}, 1);
  81         $runner->insert( "$evt.title",          $ctx->{title}, 1);
  82
  83         if( ref $ctx->{requestor} ) {
  84                 $runner->insert( "$evt.requestor",      $ctx->{requestor}, 1);
  85                 if($ctx->{requestor}->ws_ou) {
  86                         $runner->insert( "$evt.location",
  87                                 $editor->retrieve_actor_org_unit($ctx->{requestor}->ws_ou), 1);
  88                 }
  89         }
  90
  91         $runner->insert( "$evt.patronItemsOut", $ctx->{patronItemsOut}, 1 );
  92         $runner->insert( "$evt.patronOverdueCount", $ctx->{patronOverdue}, 1 );
  93         $runner->insert( "$evt.patronFines", $ctx->{patronFines}, 1 );
  94
  95         $runner->insert("$evt.$_", $ctx->{_direct}->{$_}, 1) for keys %{$ctx->{_direct}};
  96
  97         insert_org_methods( $editor, $runner );
  98         insert_copy_methods( $editor, $ctx, $runner );
  99
 100         return $runner;
 101 }
 102
 103 sub fetch_bib_data {
 104         my $e = shift;
 105         my $ctx = shift;
 106
 107         if(!$ctx->{copy}) {
 108
 109                 my $flesh = { flesh => 1, flesh_fields => { acp => [ 'location', 'status', 'circ_lib' ] } };
 110
 111                 if($ctx->{copy_id}) {
 112                         $ctx->{copy} = $e->retrieve_asset_copy(
 113                                 [$ctx->{copy_id}, $flesh ]) or return $e->event;
 114
 115                 } elsif( $ctx->{copy_barcode} ) {
 116
 117                         $ctx->{copy} = $e->search_asset_copy(
 118                                 [{barcode => $ctx->{copy_barcode}, deleted => 'f'}, $flesh ])->[0]
 119                                 or return $e->event;
 120                 }
 121         }
 122
 123         return undef unless my $copy = $ctx->{copy};
 124
 125         $copy->location($e->retrieve_asset_copy_location($copy->location))
 126                 unless( ref $copy->location );
 127
 128         $copy->status($e->retrieve_config_copy_status($copy->status))
 129                 unless( ref $copy->status );
 130
 131         $copy->circ_lib(
 132                 $e->retrieve_actor_org_unit($copy->circ_lib))
 133                 unless ref $copy->circ_lib;
 134
 135         if( ref $copy->call_number ) {
 136                 $ctx->{volume} = $copy->call_number;
 137         } else {
 138                 $ctx->{volume} = $e->retrieve_asset_call_number(
 139                         $copy->call_number) or return $e->event;
 140         }
 141
 142         if( ref $ctx->{volume}->record ) {
 143                 $ctx->{title} = $ctx->{volume}->record;
 144         } else {
 145                 $ctx->{title} = $e->retrieve_biblio_record_entry(
 146                         $ctx->{volume}->record) or return $e->event;
 147         }
 148
 149         $copy->age_protect(
 150                 $e->retrieve_config_rules_age_hold_protect($copy->age_protect))
 151                 if $ctx->{flesh_age_protect} and $copy->age_protect;
 152
 153         return undef;
 154 }
 155
 156
 157
 158 sub fetch_user_data {
 159         my( $e, $ctx ) = @_;
 160
 161         if(!$ctx->{patron}) {
 162
 163                 if( $ctx->{patron_id} ) {
 164                         $ctx->{patron} = $e->retrieve_actor_user($ctx->{patron_id});
 165
 166                 } elsif( $ctx->{patron_barcode} ) {
 167
 168                         my $card = $e->search_actor_card(
 169                                 { barcode => $ctx->{patron_barcode} } )->[0] or return $e->event;
 170
 171                         $ctx->{patron} = $e->search_actor_user(
 172                                 { card => $card->id })->[0] or return $e->event;
 173
 174                 } elsif( $ctx->{fetch_patron_by_circ_copy} ) {
 175
 176                         if( my $copy = $ctx->{copy} ) {
 177                                 my $circs = $e->search_action_circulation(
 178                                         { target_copy => $copy->id, checkin_time => undef });
 179
 180                                 if( my $circ = $circs->[0] ) {
 181                                         $ctx->{patron} = $e->retrieve_actor_user($circ->usr)
 182                                                 or return $e->event;
 183                                 }
 184                         }
 185                 }
 186         }
 187
 188         return undef unless my $patron = $ctx->{patron};
 189
 190         $patron->home_ou(
 191                 $e->retrieve_actor_org_unit($patron->home_ou) )
 192                 unless ref $patron->home_ou;
 193
 194         $patron->home_ou->ou_type(
 195                 $patron->home_ou->ou_type->id)
 196                 if ref $patron->home_ou->ou_type;
 197
 198         if(!%GROUP_SET) {
 199                 $GROUP_TREE = $e->search_permission_grp_tree(
 200                         [
 201                                 { parent => undef },
 202                                 {
 203                                         flesh => 100,
 204                                         flesh_fields => { pgt => ['children'] }
 205                                 }
 206                         ]
 207                 )->[0];
 208
 209                 flatten_groups($GROUP_TREE);
 210         }
 211
 212         $patron->profile( $GROUP_SET{$patron->profile} )
 213                 unless ref $patron->profile;
 214
 215
 216         $ctx->{requestor} = $ctx->{requestor} || $e->requestor;
 217
 218         if( $ctx->{fetch_patron_circ_info} ) {
 219                 my $circ_counts =
 220                         OpenILS::Application::Actor::_checked_out(1, $e, $patron->id);
 221
 222                 $ctx->{patronOverdue} = $circ_counts->{overdue} || 0;
 223                 my $out = $ctx->{patronOverdue} + $circ_counts->{out};
 224
 225                 $ctx->{patronItemsOut} = $out
 226                         unless( $ctx->{patronItemsOut} and $ctx->{patronItemsOut} > $out );
 227
 228                 $logger->debug("script_builder: patron overdue count is " . $ctx->{patronOverdue});
 229         }
 230
 231         if( $ctx->{fetch_patron_money_info} ) {
 232                 $ctx->{patronFines} = $U->patron_money_owed($patron->id);
 233                 $logger->debug("script_builder: patron fines determined to be ".$ctx->{patronFines});
 234         }
 235
 236         unless( $ctx->{ignore_user_status} ) {
 237                 return OpenILS::Event->new('PATRON_INACTIVE')
 238                         unless $U->is_true($patron->active);
 239
 240                 $patron->card($e->retrieve_actor_card($patron->card))
 241                         unless ref $patron->card;
 242
 243                 return OpenILS::Event->new('PATRON_CARD_INACTIVE')
 244                         unless $U->is_true($patron->card->active);
 245
 246                 my $expire = DateTime::Format::ISO8601->new->parse_datetime(
 247                         clense_ISO8601($patron->expire_date));
 248
 249                 return OpenILS::Event->new('PATRON_ACCOUNT_EXPIRED')
 250                         if( CORE::time > $expire->epoch ) ;
 251         }
 252
 253         return undef;
 254 }
 255
 256
 257 sub flatten_groups {
 258         my $tree = shift;
 259         return undef unless $tree;
 260         $GROUP_SET{$tree->id} = $tree;
 261         if( $tree->children ) {
 262                 flatten_groups($_) for @{$tree->children};
 263         }
 264 }
 265
 266 sub flatten_org_tree {
 267         my $tree = shift;
 268         return undef unless $tree;
 269         push( @ORG_LIST, $tree );
 270         if( $tree->children ) {
 271                 flatten_org_tree($_) for @{$tree->children};
 272         }
 273 }
 274
 275
 276
 277 sub insert_org_methods {
 278         my ( $editor, $runner ) = @_;
 279
 280         if(!$ORG_TREE) {
 281                 $ORG_TREE = $editor->search_actor_org_unit(
 282                         [
 283                                 {"parent_ou" => undef },
 284                                 {
 285                                         flesh                           => 2,
 286                                         flesh_fields    => { aou =>  ['children'] },
 287                                         order_by                        => { aou => 'name'}
 288                                 }
 289                         ]
 290                 )->[0];
 291                 flatten_org_tree($ORG_TREE);
 292         }
 293
 294         my $r = $runner;
 295         weaken($r);
 296
 297         $r->insert(__OILS_FUNC_isOrgDescendent  =>
 298                 sub {
 299                         my( $write_key, $sname, $id ) = @_;
 300                         my ($parent)    = grep { $_->shortname eq $sname } @ORG_LIST;
 301                         my ($child)             = grep { $_->id == $id } @ORG_LIST;
 302                         my $val = is_org_descendent( $parent, $child );
 303                         $logger->debug("script_builder: is_org_desc $sname:$id returned val $val, writing to $write_key");
 304                         $r->insert($write_key, $val, 1) if $val;
 305                         return $val;
 306                 }
 307         );
 308
 309         $r->insert(__OILS_FUNC_hasCommonAncestor  =>
 310                 sub {
 311                         my( $write_key, $orgid1, $orgid2, $depth ) = @_;
 312                         my $val = has_common_ancestor( $orgid1, $orgid2, $depth );
 313                         $logger->debug("script_builder: has_common_ancestor resturned $val");
 314                         $r->insert($write_key, $val, 1) if $val;
 315                         return $val;
 316                 }
 317         );
 318 }
 319
 320
 321 sub is_org_descendent {
 322         my( $parent, $child ) = @_;
 323         return 0 unless $parent and $child;
 324         $logger->debug("script_builder: is_org_desc checking parent=".$parent->id.", child=".$child->id);
 325         do {
 326                 return 0 unless defined $child->parent_ou;
 327                 return 1 if $parent->id == $child->id;
 328         } while( ($child) = grep { $_->id == $child->parent_ou } @ORG_LIST );
 329         return 0;
 330 }
 331
 332 sub has_common_ancestor {
 333         my( $org1, $org2, $depth ) = @_;
 334         return 0 unless $org1 and $org2;
 335         $logger->debug("script_builder: has_common_ancestor checking orgs $org1 : $org2");
 336
 337         return 1 if $org1 == $org2;
 338         ($org1) = grep { $_->id == $org1 } @ORG_LIST;
 339         ($org2) = grep { $_->id == $org2 } @ORG_LIST;
 340
 341         my $p1 = find_parent_at_depth($org1, $depth);
 342         my $p2 = find_parent_at_depth($org2, $depth);
 343
 344         return 1 if $p1->id == $p2->id;
 345         return 0;
 346 }
 347
 348
 349 sub find_parent_at_depth {
 350         my $org = shift;
 351         my $depth = shift;
 352         return undef unless $org and $depth;
 353         fetch_ou_types();
 354         do {
 355                 my ($t) = grep { $_->id == $org->ou_type } @OU_TYPES;
 356                 return $org if $t->depth == $depth;
 357         } while( ($org) = grep { $_->id == $org->parent_ou } @ORG_LIST );
 358         return undef;
 359 }
 360
 361
 362 sub fetch_ou_types {
 363         return if @OU_TYPES;
 364         @OU_TYPES = @{new_editor()->retrieve_all_actor_org_unit_type()};
 365 }
 366
 367 sub insert_copy_methods {
 368         my( $e, $ctx,  $runner ) = @_;
 369         if( my $copy = $ctx->{copy} ) {
 370                 $runner->insert_method( 'environment.copy', '__OILS_FUNC_fetch_best_hold', sub {
 371                                 my $key = shift;
 372                                 $logger->debug("script_builder: searching for permitted hold for copy ".$copy->barcode);
 373                                 my ($hold) = $holdcode->find_nearest_permitted_hold(
 374                                         OpenSRF::AppSession->create('open-ils.storage'), $copy, $e->requestor );
 375                                 $runner->insert( $key, $hold, 1 );
 376                         }
 377                 );
 378         }
 379 }
 380
 381
 382
 383
 384
 385 1;