being yet more careful about the requestor field
[Evergreen.git] / 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
23
24 # -----------------------------------------------------------------------
25 # Possible Args:
26 #  copy
27 #  copy_id
28 #  copy_barcode
29 #
30 #  patron
31 #  patron_id
32 #  patron_barcode
33 #
34 #  fetch_patron_circ_info - load info on items out, overdues, and fines.
35 #
36 #  _direct - this is a hash of key/value pairs to shove directly into the 
37 #  script runner.  Use this to cover data not covered by this module
38 # -----------------------------------------------------------------------
39 sub build {
40         my( $class, $args ) = @_;
41
42         my $evt;
43         my @evts;
44
45         my $editor = $$args{editor} || new_editor();
46
47         $args->{_direct} = {} unless $args->{_direct};
48         
49         $evt = fetch_bib_data($editor, $args);
50         push(@evts, $evt) if $evt;
51         $evt = fetch_user_data($editor, $args);
52         push(@evts, $evt) if $evt;
53
54         if(@evts) {
55                 my @e;
56                 push( @e, $_->{textcode} ) for @evts;
57                 $logger->info("script_builder: some events occurred: @e");
58                 $logger->debug("script_builder: some events occurred: " . Dumper(\@evts));
59                 $args->{_events} = \@evts;
60         }
61
62         return build_runner($editor, $args);
63 }
64
65
66 sub build_runner {
67         my $editor      = shift;
68         my $ctx         = shift;
69
70         my $runner = OpenILS::Utils::ScriptRunner->new;
71
72         my $gt = $GROUP_TREE;
73         $runner->insert( "$evt.groupTree",      $gt, 1);
74
75
76         $runner->insert( "$evt.patron",         $ctx->{patron}, 1);
77         $runner->insert( "$evt.copy",                   $ctx->{copy}, 1);
78         $runner->insert( "$evt.volume",         $ctx->{volume}, 1);
79         $runner->insert( "$evt.title",          $ctx->{title}, 1);
80
81         if( ref $ctx->{requestor} ) {
82                 $runner->insert( "$evt.requestor",      $ctx->{requestor}, 1);
83                 $runner->insert( "$evt.location",       
84                         $editor->retrieve_actor_org_unit($ctx->{requestor}->ws_ou), 1);
85         }
86
87         $runner->insert( "$evt.patronItemsOut", $ctx->{patronItemsOut}, 1 );
88         $runner->insert( "$evt.patronOverdueCount", $ctx->{patronOverdue}, 1 );
89         $runner->insert( "$evt.patronFines", $ctx->{patronFines}, 1 );
90
91         $runner->insert("$evt.$_", $ctx->{_direct}->{$_}, 1) for keys %{$ctx->{_direct}};
92
93         insert_org_methods( $editor, $runner );
94         insert_copy_methods( $editor, $ctx, $runner );
95
96         return $runner;
97 }
98
99 sub fetch_bib_data {
100         my $e = shift;
101         my $ctx = shift;
102
103         if(!$ctx->{copy}) {
104
105                 my $flesh = { flesh => 1, flesh_fields => { acp => [ 'location', 'status', 'circ_lib' ] } };
106
107                 if($ctx->{copy_id}) {
108                         $ctx->{copy} = $e->retrieve_asset_copy(
109                                 [$ctx->{copy_id}, $flesh ]) or return $e->event;
110
111                 } elsif( $ctx->{copy_barcode} ) {
112
113                         $ctx->{copy} = $e->search_asset_copy(
114                                 [{barcode => $ctx->{copy_barcode}}, $flesh ])->[0]
115                                 or return $e->event;
116                 }
117         }
118
119         return undef unless my $copy = $ctx->{copy};
120
121         $copy->location($e->retrieve_asset_copy_location($copy->location))
122                 unless( ref $copy->location );
123
124         $copy->status($e->retrieve_config_copy_status($copy->status))
125                 unless( ref $copy->status );
126
127         $copy->circ_lib( 
128                 $e->retrieve_actor_org_unit($copy->circ_lib)) 
129                 unless ref $copy->circ_lib;
130
131         $ctx->{volume} = $e->retrieve_asset_call_number(
132                 $ctx->{copy}->call_number) or return $e->event;
133
134         $ctx->{title} = $e->retrieve_biblio_record_entry(
135                 $ctx->{volume}->record) or return $e->event;
136
137         $copy->age_protect(
138                 $e->retrieve_config_rules_age_hold_protect($copy->age_protect))
139                 if $ctx->{flesh_age_protect} and $copy->age_protect;
140
141         return undef;
142 }
143
144
145
146 sub fetch_user_data {
147         my( $e, $ctx ) = @_;
148         
149         if(!$ctx->{patron}) {
150
151                 if( $ctx->{patron_id} ) {
152                         $ctx->{patron} = $e->retrieve_actor_user($ctx->{patron_id});
153
154                 } elsif( $ctx->{patron_barcode} ) {
155
156                         my $card = $e->search_actor_card( 
157                                 { barcode => $ctx->{patron_barcode} } )->[0] or return $e->event;
158
159                         $ctx->{patron} = $e->search_actor_user( 
160                                 { card => $card->id })->[0] or return $e->event;
161
162                 } elsif( $ctx->{fetch_patron_by_circ_copy} ) {
163
164                         if( my $copy = $ctx->{copy} ) {
165                                 my $circs = $e->search_action_circulation(
166                                         { target_copy => $copy->id, stop_fines_time => undef });
167
168                                 if( my $circ = $circs->[0] ) {
169                                         $ctx->{patron} = $e->retrieve_actor_user($circ->usr)
170                                                 or return $e->event;
171                                 }
172                         }
173                 }
174         }
175
176         return undef unless my $patron = $ctx->{patron};
177
178         return OpenILS::Event->new('PATRON_INACTIVE')
179                 unless $U->is_true($patron->active);
180
181         $patron->card($e->retrieve_actor_card($patron->card));
182
183         return OpenILS::Event->new('PATRON_CARD_INACTIVE')
184                 unless $U->is_true($patron->card->active);
185
186         my $expire = DateTime::Format::ISO8601->new->parse_datetime(
187                 clense_ISO8601($patron->expire_date));
188
189         return OpenILS::Event->new('PATRON_ACCOUNT_EXPIRED')
190                 if( CORE::time > $expire->epoch ) ;
191
192         $patron->home_ou( 
193                 $e->retrieve_actor_org_unit($patron->home_ou) ) 
194                 unless ref $patron->home_ou;
195
196         $patron->home_ou->ou_type(
197                 $patron->home_ou->ou_type->id) 
198                 if ref $patron->home_ou->ou_type;
199
200         if(!%GROUP_SET) {
201                 $GROUP_TREE = $e->search_permission_grp_tree(
202                         [
203                                 { parent => undef }, 
204                                 { 
205                                         flesh => 100,
206                                         flesh_fields => { pgt => ['children'] }
207                                 } 
208                         ]
209                 )->[0];
210
211                 flatten_groups($GROUP_TREE);
212         }
213
214         $patron->profile( $GROUP_SET{$patron->profile} )
215                 unless ref $patron->profile;
216
217
218         $ctx->{requestor} = $ctx->{requestor} || $e->requestor;
219
220         # this could alter the requestor object within the editor..
221         #if( my $req = $ctx->{requestor} ) {
222         #       $req->home_ou( $e->retrieve_actor_org_unit($requestor->home_ou) );      
223         #       $req->ws_ou( $e->retrieve_actor_org_unit($requestor->ws_ou) );  
224         #}
225
226         if( $ctx->{fetch_patron_circ_info} ) {
227
228                 my $circ_counts = 
229                         OpenILS::Application::Actor::_checked_out(1, $e, $patron->id);
230
231                 $ctx->{patronOverdue} = $circ_counts->{overdue} || 0;
232                 $ctx->{patronItemsOut} = $ctx->{patronOverdue} + $circ_counts->{out};
233
234                 # Grab the fines
235                 my $fxacts = $e->search_money_open_billable_transaction_summary(
236                         { usr => $patron->id, balance_owed => { "!=" => 0 } });
237
238                 my $fines = 0;
239                 $fines += $_->balance_owed for @$fxacts;
240                 $ctx->{patronFines} = $fines;
241
242                 $logger->debug("script_builder: patron fines determined to be $fines");
243                 $logger->debug("script_builder: patron overdue count is " . $ctx->{patronOverdue});
244         }
245
246         return undef;
247 }
248
249
250 sub flatten_groups {
251         my $tree = shift;
252         return undef unless $tree;
253         $GROUP_SET{$tree->id} = $tree;
254         if( $tree->children ) {
255                 flatten_groups($_) for @{$tree->children};
256         }
257 }
258
259 sub flatten_org_tree {
260         my $tree = shift;
261         return undef unless $tree;
262         push( @ORG_LIST, $tree );
263         if( $tree->children ) {
264                 flatten_org_tree($_) for @{$tree->children};
265         }
266 }
267
268
269
270 sub insert_org_methods {
271         my ( $editor, $runner ) = @_;
272
273         if(!$ORG_TREE) {
274                 $ORG_TREE = $editor->search_actor_org_unit(
275                         [
276                                 {"parent_ou" => undef },
277                                 {
278                                         flesh                           => 2,
279                                         flesh_fields    => { aou =>  ['children'] },
280                                         order_by                        => { aou => 'name'}
281                                 }
282                         ]
283                 )->[0];
284                 flatten_org_tree($ORG_TREE);
285         }
286
287         my $r = $runner;
288         weaken($r);
289
290         $r->insert(__OILS_FUNC_isOrgDescendent  => 
291                 sub {
292                         my( $write_key, $sname, $id ) = @_;
293                         my ($parent)    = grep { $_->shortname eq $sname } @ORG_LIST;
294                         my ($child)             = grep { $_->id == $id } @ORG_LIST;
295                         my $val = is_org_descendent( $parent, $child );
296                         $logger->debug("script_builder: is_org_desc returned val $val, writing to $write_key");
297                         $r->insert($write_key, $val, 1) if $val; # Needs testing, was dying before
298                         return $val;
299                 }
300         );
301
302 }
303
304
305 sub is_org_descendent {
306         my( $parent, $child ) = @_;
307         return 0 unless $parent and $child;
308         $logger->debug("script_builder: is_org_desc checking parent=".$parent->id.", child=".$child->id);
309         do {
310                 return 0 unless defined $child->parent_ou;
311                 return 1 if $parent->id == $child->id;
312         } while( ($child) = grep { $_->id == $child->parent_ou } @ORG_LIST );
313         return 0;
314 }
315
316 sub insert_copy_methods {
317         my( $e, $ctx,  $runner ) = @_;
318         if( my $copy = $ctx->{copy} ) {
319                 $runner->insert_method( 'environment.copy', '__OILS_FUNC_fetch_best_hold', sub {
320                                 my $key = shift;
321                                 $logger->debug("script_builder: searching for permitted hold for copy ".$copy->barcode);
322                                 my ($hold) = $holdcode->find_nearest_permitted_hold(
323                                         OpenSRF::AppSession->create('open-ils.storage'), $copy, $e->requestor );
324                                 $runner->insert( $key, $hold, 1 );
325                         }
326                 );
327         }
328 }
329
330
331
332
333
334 1;