2 # ---------------------------------------------------------------
3 # Copyright (C) 2008 Georgia Public Library Service
4 # Bill Erickson <erickson@esilibrary.com>
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License
8 # as published by the Free Software Foundation; either version 2
9 # of the License, or (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
15 # ---------------------------------------------------------------
16 use strict; use warnings;
17 require 'oils_header.pl';
24 use Unicode::Normalize;
25 use DateTime::Format::ISO8601;
26 use OpenSRF::Utils qw/:datetime/;
27 use OpenSRF::Utils::JSON;
28 use OpenSRF::Utils::SettingsClient;
29 use OpenSRF::AppSession;
30 use OpenILS::Const qw/:const/;
31 use OpenILS::Application::AppUtils;
32 use OpenILS::Const qw/:const/;
33 my $U = 'OpenILS::Application::AppUtils';
36 my $e = OpenILS::Utils::CStoreEditor->new;
38 my @global_overdue_circs; # all circ collections stored here go into the final global XML file
40 # - set up default values
41 my $opt_osrf_config = '/openils/conf/opensrf_core.xml';
42 my $opt_send_email = 0;
43 my $opt_gen_day_intervals = 0;
44 my $opt_days_back = '';
45 my $opt_gen_global_templates = 0;
46 my $opt_show_help = 0;
47 my $opt_append_global_email_fail;
48 my $opt_notice_types = '';
49 my $opt_use_email_outfile;
50 my $opt_use_email_recipient;
53 'osrf_config=s' => \$opt_osrf_config,
54 'send-email' => \$opt_send_email,
55 'generate-day-intervals' => \$opt_gen_day_intervals,
56 'generate-global-templates' => \$opt_gen_global_templates,
57 'days-back=s' => \$opt_days_back,
58 'append-global-email-fail' => \$opt_append_global_email_fail,
59 'notice-types=s' => \$opt_notice_types,
60 'use-email-outfile=s' => \$opt_use_email_outfile,
61 'use-email-recipient=s' => \$opt_use_email_recipient,
62 'help' => \$opt_show_help,
65 help() and exit if $opt_show_help;
70 Evergreen Circulation Notice Generator
72 ---osrf_config <config_file>
75 If set, generate email notices
77 --use-email-outfile <file>
78 Instead of sending emails, append each email (complete with headers) to this file
80 --use-email-recipient <user\@example.com>
81 Send all email notices to this user instead of the patron. This updates the
82 email address on the user object attached to the circulations, so no
83 change to the email templates is required.
85 --generate-day-intervals
86 If set, notices which have a notify_interval of >= 1 day will be processed.
88 --generate-global-templates
89 Collect all non-emailed notices into a global set and generate templates based on that set.
91 --append-global-email-fail
92 If an attempt was made to send an email notice but it failed, the notice is appended
93 to the global notice file set. This will only have any bearing if --generate-global-templates
96 --days-back <days_back_comma_separted>
97 This is used to set the effective run date of the script.
98 This is useful if you don't want to generate notices on certain days. For example, if you don't
99 generate notices on the weekend, you would run this script on weekdays and set --days-back to
100 0,1,2 when it's run on Monday to capture any notices from Saturday and Sunday.
102 --notice-types <overdue,predue,...>
103 Comma-separated list of notice types to generate for this run of the script
106 Print this help message
112 osrf_connect($opt_osrf_config);
113 $settings = OpenSRF::Utils::SettingsClient->new;
115 die "Please specify at least 1 type of notice to generate with --notice-types\n"
116 unless $opt_notice_types;
118 unlink $opt_use_email_outfile if $opt_use_email_outfile;
120 my $sender_address = $settings->config_value(notifications => 'sender_address');
121 my $od_sender_addr = $settings->config_value(notifications => overdue => 'sender_address') || $sender_address;
122 my $pd_sender_addr = $settings->config_value(notifications => predue => 'sender_address') || $sender_address;
123 my $overdue_notices = $settings->config_value(notifications => overdue => 'notice');
124 my $predue_notices = $settings->config_value(notifications => predue => 'notice');
126 $overdue_notices = [$overdue_notices] unless ref $overdue_notices eq 'ARRAY';
127 $predue_notices = [$predue_notices] unless ref $predue_notices eq 'ARRAY';
129 my @overdues = sort {
130 OpenSRF::Utils->interval_to_seconds($a->{notify_interval}) <=>
131 OpenSRF::Utils->interval_to_seconds($b->{notify_interval}) } @$overdue_notices;
134 OpenSRF::Utils->interval_to_seconds($a->{notify_interval}) <=>
135 OpenSRF::Utils->interval_to_seconds($b->{notify_interval}) } @$predue_notices;
137 for my $db (($opt_days_back) ? split(',', $opt_days_back) : 0) {
138 if($opt_notice_types =~ /overdue/) {
139 generate_notice_set($_, 'overdue', $db) for @overdues;
141 if($opt_notice_types =~ /predue/) {
142 generate_notice_set($_, 'predue', $db) for @predues;
146 generate_global_overdue_file() if $opt_gen_global_templates;
149 sub generate_global_overdue_file {
150 $logger->info("notice: processing ".scalar(@global_overdue_circs)." for global template");
151 return unless @global_overdue_circs;
153 my $tt = Template->new({ABSOLUTE => 1});
156 $settings->config_value(notifications => overdue => 'combined_template'),
158 overdues => \@global_overdue_circs,
159 get_bib_attr => \&get_bib_attr,
160 parse_due_date => \&parse_due_date, # let the templates decide date format
161 escape_xml => \&escape_xml,
163 \&global_overdue_output
164 ) or $logger->error('notice: Template error '.$tt->error);
167 sub global_overdue_output {
168 binmode STDOUT, ":utf8";
173 sub generate_notice_set {
174 my($notice, $type, $days_back) = @_;
176 my $notify_interval = OpenSRF::Utils->interval_to_seconds($notice->{notify_interval});
177 $notify_interval = -$notify_interval if $type eq 'overdue';
179 my ($start_date, $end_date) = make_date_range($notify_interval - $days_back * 86400);
181 $logger->info("notice: retrieving circs with due date in range $start_date -> $end_date");
190 checkin_time => undef,
192 {stop_fines => {'not in' => ["LOST","LONGOVERDUE","CLAIMSRETURNED"]}},
193 {stop_fines => undef}
195 due_date => {between => [$start_date, $end_date]}
198 order_by => {circ => ['usr', 'circ_lib']}
201 # if a circ duration is defined for this type of notice
202 if(my $durs = $notice->{circ_duration_range}) {
203 $QUERY->{where}->{'+circ'}->{duration} = {between => [$durs->{from}, $durs->{to}]};
206 my $circs = $e->json_query($QUERY, {timeout => 18000, substream => 1});
207 process_circs($notice, $type, map {$_->{id}} @$circs);
216 return unless @circs;
218 $logger->info("notice: processing $type notices with notify interval ".
219 $notice->{notify_interval}." and ".scalar(@circs)." circs");
226 for my $circ (@circs) {
227 $circ = $e->retrieve_action_circulation($circ);
230 $circ->circ_lib != $org or $circ->usr ne $patron ) {
231 $org = $circ->circ_lib;
232 $patron = $circ->usr;
233 generate_notice($notice, $type, @current) if @current;
237 push(@current, $circ);
241 $logger->info("notice: processed $x circs");
242 generate_notice($notice, $type, @current);
252 return $ORG_FROM_CACHE{$org_id} if $ORG_FROM_CACHE{$org_id};
254 if(my $bemail = $U->ou_ancestor_setting_value($org_id, 'org.bounced_emails', $e)) {
255 return $ORG_FROM_CACHE{$org_id} = $bemail;
258 return $ORG_FROM_CACHE{$org_id} =
259 $settings->config_value(notifications => $type => 'sender_address') ||
260 $settings->config_value(notifications => 'sender_address');
263 sub generate_notice {
267 return unless @circs;
268 my $circ_list = fetch_circ_data(@circs);
269 my $tt = Template->new({ABSOLUTE => 1});
271 # see if there is a configured bounce address for this org unit.
272 # if so, use that as the sender
273 my $org_id = $circ_list->[0]->circ_lib->id;
274 my $sender = get_from_addr($type, $org_id);
277 circ_list => $circ_list,
278 get_bib_attr => \&get_bib_attr,
279 parse_due_date => \&parse_due_date, # let the templates decide date format
280 smtp_sender => $sender,
284 push(@global_overdue_circs, $context) if
285 $type eq 'overdue' and $notice->{file_append} =~ /always/i;
287 if( ($opt_send_email or $opt_use_email_outfile) and
288 $notice->{email_notify} and
289 my $email = $circ_list->[0]->usr->email) {
291 if(my $tmpl = $notice->{email_template}) {
292 $tt->process($tmpl, $context,
294 handle_email_template_output($notice, $type, $context, $email, @_);
296 ) or $logger->error('notice: Template error '.$tt->error);
299 push(@global_overdue_circs, $context)
300 if $type eq 'overdue' and $notice->{file_append} =~ /noemail/i;
308 my $copy = $circ->target_copy;
309 if($copy->call_number->id == OILS_PRECAT_CALL_NUMBER) {
310 return $copy->dummy_title || '' if $attr eq 'title';
311 return $copy->dummy_author || '' if $attr eq 'author';
313 $last_mvr = $U->record_to_mvr($copy->call_number->record)
314 unless $last_mvr and $last_mvr->doc_id == $copy->call_number->record->id;
315 return $last_mvr->title || '' if $attr eq 'title';
316 return $last_mvr->author || '' if $attr eq 'author';
320 # provides a date that Template::Plugin::Date can parse
323 my $due = DateTime::Format::ISO8601->new->parse_datetime(clense_ISO8601($circ->due_date));
325 "%0.2d:%0.2d:%0.2d %0.2d-%0.2d-%0.4d",
337 $str =~ s/&/&/sog;
338 $str =~ s/</</sog;
339 $str =~ s/>/>/sog;
344 sub handle_email_template_output {
351 if($opt_use_email_outfile) {
352 if(open(F, ">>$opt_use_email_outfile")) {
354 $logger->debug("notice: appending emails to outfile $opt_use_email_outfile");
358 $logger->error("notice: unable to open --use-email-outfile $opt_use_email_outfile for writing: $@");
363 if($opt_send_email) {
364 my $sender = Email::Send->new({mailer => 'SMTP'});
365 my $smtp_server = $settings->config_value(notifications => 'smtp_server');
366 $logger->debug("notice: smtp server is $smtp_server");
367 $sender->mailer_args([Host => $smtp_server]);
368 my $stat = $sender->send($msg);
370 if( $stat and $stat->type eq 'success' ) {
371 $logger->info("notice: successfully sent $type email to $email");
373 $logger->warn("notice: unable to send $type email to $email: ".Dumper($stat));
374 # if we were unable to send the email, add this notice set to the global notify set
375 push(@global_overdue_circs, $context)
376 if $opt_append_global_email_fail and
377 $type eq 'overdue' and $notice->{file_append} =~ /noemail/i;
382 sub fetch_circ_data {
385 my $circ_lib_id = $circs[0]->circ_lib;
386 my $usr_id = $circs[0]->usr;
387 $logger->debug("notice: printing user:$usr_id circ_lib:$circ_lib_id");
389 my $usr = $e->retrieve_actor_user([
393 au => [qw/card billing_address mailing_address/]
398 # if the caller has defined a test email recipient, override
399 # the user's email if they have one.
400 $usr->email($opt_use_email_recipient) if $usr->email and $opt_use_email_recipient;
402 my $circ_lib = $ORG_CACHE{$circ_lib_id} ||
403 $e->retrieve_actor_org_unit([
407 aou => [qw/billing_address mailing_address/],
411 $ORG_CACHE{$circ_lib_id} = $circ_lib;
413 my $circ_objs = $e->search_action_circulation([
414 {id => [map {$_->id} @circs]},
417 circ => [q/target_copy/],
418 acp => ['call_number'],
424 $_->circ_lib($circ_lib) for @$circ_objs;
425 $_->usr($usr) for @$circ_objs;
431 sub make_date_range {
433 #my $is_day_precision = shift; # window?
435 my $epoch = CORE::time + $offset;
436 my $date = DateTime->from_epoch(epoch => $epoch, time_zone => 'local');
439 $date->set_minute(0);
440 $date->set_second(0);
444 $date->set_minute(59);
445 $date->set_second(59);
447 return ($start, "$date");