LP#1410369: Create user messages when configured to do so
[Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Trigger / Reactor.pm
1 package OpenILS::Application::Trigger::Reactor;
2 use strict; use warnings;
3 use Encode qw/ encode /;
4 use Template;
5 use DateTime;
6 use DateTime::Format::ISO8601;
7 use Unicode::Normalize;
8 use XML::LibXML;
9 use OpenSRF::Utils qw/:datetime/;
10 use OpenSRF::Utils::Logger qw(:logger);
11 use OpenSRF::Utils::JSON;
12 use OpenILS::Application::AppUtils;
13 use OpenILS::Utils::CStoreEditor qw/:funcs/;
14 my $U = 'OpenILS::Application::AppUtils';
15
16 sub fourty_two { return 42 }
17 sub NOOP_True  { return  1 }
18 sub NOOP_False { return  0 }
19
20
21 # To be used in two places within $_TT_helpers.  Without putting the code out
22 # here, we can't really reuse it within that structure.
23 sub get_li_attr {
24     my $name = shift or return;     # the first arg is always the name
25     my ($type, $attr) = (scalar(@_) == 1) ? (undef, $_[0]) : @_;
26     # if the next is the last, it's the attributes, otherwise type
27     # use Data::Dumper; $logger->warn("get_li_attr: " . Dumper($attr));
28     ($name and @$attr) or return;
29     my $length;
30     $name =~ s/^(\D+)_(\d+)$/$1/ and $length = $2;
31     foreach (@$attr) {
32         $_->attr_name eq $name or next;
33         next if $length and $length != length($_->attr_value);
34         return $_->attr_value if (! $type) or $type eq $_->attr_type;
35     }
36     return;
37 }
38
39 # helper functions inserted into the TT environment
40 my $_TT_helpers; # define first so one helper can use another
41 $_TT_helpers = {
42
43     # turns a date into something TT can understand
44     format_date => sub {
45         my $date = shift;
46         $date = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($date));
47         return sprintf(
48             "%0.2d:%0.2d:%0.2d %0.2d-%0.2d-%0.4d",
49             $date->hour,
50             $date->minute,
51             $date->second,
52             $date->day,
53             $date->month,
54             $date->year
55         );
56     },
57
58     # escapes a string for inclusion in an XML document.  escapes &, <, and > characters
59     escape_xml => sub {
60         my $str = shift;
61         $str =~ s/&/&amp;/sog;
62         $str =~ s/</&lt;/sog;
63         $str =~ s/>/&gt;/sog;
64         return $str;
65     },
66
67     escape_json => sub {
68         my $str = shift;
69         $str =~ s/([\x{0080}-\x{fffd}])/sprintf('\u%0.4x',ord($1))/sgoe;
70         return $str;
71     },
72
73     # encode email headers in UTF-8, per RFC2231
74     escape_email_header => sub {
75         my $str = shift;
76         $str = encode("MIME-Header", $str);
77         return $str;
78     },
79
80     # strip non-ASCII characters after splitting base characters and diacritics
81     # least common denominator for EDIFACT messages using the UNOB character set
82     force_jedi_unob => sub {
83         my $str = shift;
84         $str = NFD($str);
85         $str =~ s/[\x{0080}-\x{fffd}]//g;
86         return $str;
87     },
88
89     # returns the calculated user locale
90     get_user_locale => sub { 
91         my $user_id = shift;
92         return $U->get_user_locale($user_id);
93     },
94
95     # returns the calculated copy price
96     get_copy_price => sub {
97         my $copy_id = shift;
98         return $U->get_copy_price(new_editor(xact=>1), $copy_id);
99     },
100
101     get_org_unit => sub {
102         my $org_id = shift;
103         return $org_id if ref $org_id;
104         return new_editor()->retrieve_actor_org_unit($org_id);
105     },
106
107     # given a copy, returns the title and author in a hash
108     get_copy_bib_basics => sub {
109         my $copy_id = shift;
110         my $copy = new_editor(xact=>1)->retrieve_asset_copy([
111             $copy_id,
112             {
113                 flesh => 2,
114                 flesh_fields => {
115                     acp => ['call_number'],
116                     acn => ['record']
117                 }
118             }
119         ]);
120         if($copy->call_number->id == -1) {
121             return {
122                 title  => $copy->dummy_title,
123                 author => $copy->dummy_author,
124             };
125         } else {
126             my $mvr = $U->record_to_mvr($copy->call_number->record);
127             return {
128                 title  => $mvr->title,
129                 author => $mvr->author
130             };
131         }
132     },
133
134     # given a call number, returns the copy location with the most copies
135     get_most_populous_location => sub {
136         my $acn_id = shift;
137
138         # FIXME - there's probably a more efficient way to do this with json_query/SQL
139         my $call_number = new_editor(xact=>1)->retrieve_asset_call_number([
140             $acn_id,
141             {
142                 flesh => 1,
143                 flesh_fields => {
144                     acn => ['copies']
145                 }
146             }
147         ]);
148         my %location_count = (); my $winning_location; my $winning_total;
149         use Data::Dumper;
150         foreach my $copy (@{$call_number->copies()}) {
151             if (! defined $location_count{ $copy->location() }) {
152                 $location_count{ $copy->location() } = 1;
153             } else {
154                 $location_count{ $copy->location() } += 1;
155             }
156             if ($location_count{ $copy->location() } > $winning_total) {
157                 $winning_total = $location_count{ $copy->location() };
158                 $winning_location = $copy->location();
159             }
160         }
161
162         my $location = new_editor(xact=>1)->retrieve_asset_copy_location([
163             $winning_location, {}
164         ]);
165         return $location;
166     },
167
168     # returns the org unit setting value
169     get_org_setting => sub {
170         my($org_id, $setting) = @_;
171         return $U->ou_ancestor_setting_value($org_id, $setting);
172     },
173
174     get_user_setting => sub {
175         my ($user_id, $setting) = @_;
176         my $val = new_editor()->search_actor_user_setting(
177             {usr => $user_id, name => $setting})->[0];
178         return undef unless $val; 
179         return OpenSRF::Utils::JSON->JSON2perl($val->value);  
180     },
181
182     # This basically greps/maps out ths isbn string values, but also promotes the first isbn-13 to the
183     # front of the line (so that the EDI translator takes it as primary) if there is one.
184     get_li_isbns => sub {
185         my $attrs = shift;
186         my @isbns;
187         my $primary;
188         foreach (@$attrs) {
189             $_->attr_name eq 'isbn' or next;
190             my $val = $_->attr_value;
191             if (! $primary and length($val) == 13) {
192                 $primary = $val;
193             } else {
194                 push @isbns, $val;
195             }
196         }
197         $primary and unshift @isbns, $primary;
198         $logger->debug("get_li_isbns returning isbns: " . join(', ', @isbns));
199         return @isbns;
200     },
201
202     get_li_order_ident => sub {
203         my $attrs = shift;
204
205         # preferred identifier
206         my ($attr) =  grep { $U->is_true($_->order_ident) } @$attrs;
207         return $attr if $attr;
208
209         # note we're not using get_li_attr, since we need the 
210         # attr object and not just the attr value
211
212         # isbn-13
213         ($attr) = grep { 
214             $_->attr_name eq 'isbn' and 
215             $_->attr_type eq 'lineitem_marc_attr_definition' and
216             length($_->attr_value) == 13
217         } @$attrs;
218         return $attr if $attr;
219
220         for my $name (qw/isbn issn upc/) {
221             ($attr) = grep { 
222                 $_->attr_name eq $name and 
223                 $_->attr_type eq 'lineitem_marc_attr_definition'
224             } @$attrs;
225             return $attr if $attr;
226         }
227
228         # any 'identifier' attr
229         return ( grep { $_->attr_name eq 'identifier' } @$attrs)[0];
230     },
231
232     # helpers.get_li_attr('isbn_13', li.attributes)
233     # returns matching line item attribute, or undef
234     get_li_attr => \&get_li_attr,
235
236     # get_li_attr_jedi() returns a JSON-encoded string without the enclosing
237     # quotes.  The function also removes other characters from the string
238     # that the EDI translator doesn't like.
239     #
240     # This *always* return a string, so don't use this in conditional
241     # expressions in your templates unless you really mean to.
242     get_li_attr_jedi => sub {
243         # This helper has to mangle data in at least three interesting ways.
244         #
245         # 1) We'll be receiving data that may already have some \-escaped
246         # characters.
247         #
248         # 2) We need our output to be valid JSON.
249         #
250         # 3) We need our output to yield valid and unproblematic EDI when
251         # passed through edi4r by the edi_pusher.pl script.
252
253         my $value = get_li_attr(@_);
254
255         {
256             no warnings 'uninitialized';
257             $value .= "";   # force to string
258         };
259
260         # Here we can add any number of special case transformations to
261         # avoid problems with the EDI translator (or bad JSON).
262
263         # Typical vendors dealing with EDIFACT (or is the problem with
264         # our EDI translator itself?) would seem not to want
265         # any characters outside the ASCII range, so trash them.
266         $value =~ s/[^[:ascii:]]//g;
267
268         # Remove anything somehow already JSON-escaped as a Unicode
269         # character. (even though for our part, we haven't JSON-escaped
270         # anything yet).
271         $value =~ s/\\u[0-9a-f]{4}//g;
272
273         # What the heck, get rid of [ ] too (although I couldn't get them
274         # to cause any problems for me, problems have been reported. See
275         # LP #812593).
276         $value =~ s/[\[\]]//g;
277
278         $value = OpenSRF::Utils::JSON->perl2JSON($value);
279
280         # Existing action/trigger templates expect an unquoted string.
281         $value =~ s/^"//g;
282         $value =~ s/"$//g;
283
284         # The ? character, if in the final position of a string, breaks
285         # the translator. + or ' or : could be problematic, too. And we must
286         # avoid leaving a hanging \.
287         while ($value =~ /[\\\?\+':]$/) {
288             chop $value;
289         }
290
291         return $value;
292     },
293
294     get_queued_bib_attr => sub {
295         my $name = shift or return;     # the first arg is always the name
296         my ($attr) = @_;
297         # use Data::Dumper; $logger->warn("get_queued_bib_attr: " . Dumper($attr));
298         ($name and @$attr) or return;
299
300         my $query = {
301             select => {'vqbrad' => ['id']},
302             from => 'vqbrad',
303             where => {code => $name}
304         };
305
306         my $def_ids = new_editor()->json_query($query);
307         @$def_ids or return;
308
309         my $length;
310         $name =~ s/^(\D+)_(\d+)$/$1/ and $length = $2;
311         foreach (@$attr) {
312             $_->field eq @{$def_ids}[0]->{id} or next;
313             next if $length and $length != length($_->attr_value);
314             return $_->attr_value;
315         }
316         return;
317     },
318
319     get_queued_auth_attr => sub {
320         my $name = shift or return;     # the first arg is always the name
321         my ($attr) = @_;
322         # use Data::Dumper; $logger->warn("get_queued_auth_attr: " . Dumper($attr));
323         ($name and @$attr) or return;
324
325         my $query = {
326             select => {'vqarad' => ['id']},
327             from => 'vqarad',
328             where => {code => $name}
329         };
330
331         my $def_ids = new_editor()->json_query($query);
332         @$def_ids or return;
333
334         my $length;
335         $name =~ s/^(\D+)_(\d+)$/$1/ and $length = $2;
336         foreach (@$attr) {
337             $_->field eq @{$def_ids}[0]->{id} or next;
338             next if $length and $length != length($_->attr_value);
339             return $_->attr_value;
340         }
341         return;
342     },
343
344     csv_datum => sub {
345         my ($str) = @_;
346
347         if ($str =~ /\,/ || $str =~ /"/) {
348             $str =~ s/"/""/g;
349             $str = '"' . $str . '"';
350         }
351
352         return $str;
353     },
354
355
356     bre_open_hold_count => sub {
357         my $bre_id = shift;
358         return 0 unless $bre_id;
359         return $U->simplereq(
360             'open-ils.circ',
361             'open-ils.circ.bre.holds.count', $bre_id);
362     },
363
364     xml_doc => sub {
365         my ($str) = @_;
366         return $str ? (new XML::LibXML)->parse_string($str) : undef;
367     },
368
369     # returns an email addresses derived from sms_carrier and sms_notify
370     get_sms_gateway_email => sub {
371         my $sms_carrier = shift;
372         my $sms_notify = shift;
373
374         if (! defined $sms_notify || $sms_notify eq '') {
375             return '';
376         }
377
378         my $query = {
379             select => {'csc' => ['id','name','email_gateway']},
380             from => 'csc',
381             where => {id => $sms_carrier}
382         };
383         my $carriers = new_editor()->json_query($query);
384
385         # If this looks like a pretty-formatted number drop the pretty-formatting
386         # Otherwise assume it may be a literal alias instead of a real number
387         if ($sms_notify =~ m/^[- ()0-9]*$/) {
388             $sms_notify =~ s/[- ()]//g;
389         }
390
391         my @addresses = ();
392         foreach my $carrier ( @{ $carriers } ) {
393             my $address = $carrier->{email_gateway};
394             $address =~ s/\$number/$sms_notify/g;
395             push @addresses, $address;
396         }
397
398         return join(',',@addresses);
399     },
400
401     unapi_bre => sub {
402         my ($bre_id, $unapi_args) = @_;
403         $unapi_args ||= {};
404         $unapi_args->{flesh} ||= '{}',
405
406         my $query = { 
407             from => [
408                 'unapi.bre', $bre_id, 'marcxml','record', 
409                 $unapi_args->{flesh}, 
410                 $unapi_args->{site}, 
411                 $unapi_args->{depth}, 
412                 $unapi_args->{flesh_depth}, 
413             ]
414         };
415
416         my $unapi = new_editor()->json_query($query);
417         return undef unless @$unapi;
418         return $_TT_helpers->{xml_doc}->($unapi->[0]->{'unapi.bre'});
419     },
420
421     # escapes quotes in csv string values
422     escape_csv => sub {
423         my $string = shift;
424         $string =~ s/"/""/og;
425         return $string;
426     }
427 };
428
429
430 # processes templates.  Returns template output on success, undef on error
431 sub run_TT {
432     my $self = shift;
433     my $env = shift;
434     my $nostore = shift;
435     return undef unless $env->{template};
436
437     my $error;
438     my $output = '';
439     my $tt = Template->new;
440     # my $tt = Template->new(ENCODING => 'utf8');   # ??
441     $env->{helpers} = $_TT_helpers;
442
443     unless( $tt->process(\$env->{template}, $env, \$output) ) {
444         $output = undef;
445         ($error = $tt->error) =~ s/\n/ /og;
446         $logger->error("Error processing Trigger template: $error");
447     }
448
449     if ( $error or (!$nostore && $output) ) {
450         my $t_o = Fieldmapper::action_trigger::event_output->new;
451         $t_o->data( ($error) ? $error : $output );
452         $t_o->is_error( ($error) ? 't' : 'f' );
453         $logger->info("trigger: writing " . length($t_o->data) . " bytes to template output");
454
455         $env->{EventProcessor}->editor->xact_begin;
456         $t_o = $env->{EventProcessor}->editor->create_action_trigger_event_output( $t_o );
457
458         my $state = (ref $$env{event} eq 'ARRAY') ? $$env{event}->[0]->state : $env->{event}->state;
459         my $key = ($error) ? 'error_output' : 'template_output';
460         $env->{EventProcessor}->update_state( $state, { $key => $t_o->id } );
461     }
462     
463     return $output;
464 }
465
466 # processes message templates.  Returns template output on success, undef on error
467 sub run_message_TT {
468     my $self = shift;
469     my $env = shift;
470     return undef unless $env->{usr_message}{template};
471
472     my $error;
473     my $output = '';
474     my $tt = Template->new;
475     # my $tt = Template->new(ENCODING => 'utf8');   # ??
476     $env->{helpers} = $_TT_helpers;
477
478     unless( $tt->process(\$env->{usr_message}{template}, $env, \$output) ) {
479         $output = undef;
480         ($error = $tt->error) =~ s/\n/ /og;
481         $logger->error("Error processing Trigger message template: $error");
482     }
483     
484     return $output;
485 }
486
487
488 1;