Open-ILS/src/support-scripts/generate_circ_notices.pl

   1 #!/usr/bin/perl
   2 # ---------------------------------------------------------------
   3 # Copyright (C) 2008  Georgia Public Library Service
   4 # Bill Erickson <erickson@esilibrary.com>
   5 #
   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.
  10 #
  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';
  18 use vars qw/$logger/;
  19 use DateTime;
  20 use Template;
  21 use Data::Dumper;
  22 use Email::Send;
  23 use Getopt::Long;
  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';
  34
  35 my $settings = undef;
  36 my $e = OpenILS::Utils::CStoreEditor->new;
  37
  38 my @global_overdue_circs; # all circ collections stored here go into the final global XML file
  39
  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;
  51
  52 GetOptions(
  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,
  63 );
  64
  65 help() and exit if $opt_show_help;
  66
  67 sub help {
  68     print <<HELP;
  69
  70 Evergreen Circulation Notice Generator
  71
  72     ---osrf_config <config_file>
  73
  74     --send-email
  75         If set, generate email notices
  76
  77     --use-email-outfile <file>
  78         Instead of sending emails, append each email (complete with headers) to this file
  79
  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.
  84
  85     --generate-day-intervals
  86         If set, notices which have a notify_interval of >= 1 day will be processed.
  87
  88     --generate-global-templates
  89         Collect all non-emailed notices into a global set and generate templates based on that set.
  90
  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
  94         is enabled.
  95
  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.
 101
 102     --notice-types <overdue,predue,...>
 103         Comma-separated list of notice types to generate for this run of the script
 104
 105     --help
 106         Print this help message
 107 HELP
 108 }
 109
 110
 111 sub main {
 112     osrf_connect($opt_osrf_config);
 113     $settings = OpenSRF::Utils::SettingsClient->new;
 114
 115     die "Please specify at least 1 type of notice to generate with --notice-types\n"
 116         unless $opt_notice_types;
 117
 118     unlink $opt_use_email_outfile if $opt_use_email_outfile;
 119
 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');
 125
 126     $overdue_notices = [$overdue_notices] unless ref $overdue_notices eq 'ARRAY';
 127     $predue_notices = [$predue_notices] unless ref $predue_notices eq 'ARRAY';
 128
 129     my @overdues = sort {
 130         OpenSRF::Utils->interval_to_seconds($a->{notify_interval}) <=>
 131         OpenSRF::Utils->interval_to_seconds($b->{notify_interval}) } @$overdue_notices;
 132
 133     my @predues = sort {
 134         OpenSRF::Utils->interval_to_seconds($a->{notify_interval}) <=>
 135         OpenSRF::Utils->interval_to_seconds($b->{notify_interval}) } @$predue_notices;
 136
 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;
 140         }
 141         if($opt_notice_types =~ /predue/) {
 142             generate_notice_set($_, 'predue', $db) for @predues;
 143         }
 144     }
 145
 146     generate_global_overdue_file() if $opt_gen_global_templates;
 147 }
 148
 149 sub generate_global_overdue_file {
 150     $logger->info("notice: processing ".scalar(@global_overdue_circs)." for global template");
 151     return unless @global_overdue_circs;
 152
 153     my $tt = Template->new({ABSOLUTE => 1});
 154
 155     $tt->process(
 156         $settings->config_value(notifications => overdue => 'combined_template'),
 157         {
 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,
 162         },
 163         \&global_overdue_output
 164     ) or $logger->error('notice: Template error '.$tt->error);
 165 }
 166
 167 sub global_overdue_output {
 168     binmode F, ":utf8";
 169     print shift();
 170 }
 171
 172
 173 sub generate_notice_set {
 174     my($notice, $type, $days_back) = @_;
 175
 176     my $notify_interval = OpenSRF::Utils->interval_to_seconds($notice->{notify_interval});
 177     $notify_interval = -$notify_interval if $type eq 'overdue';
 178
 179     my ($start_date, $end_date) = make_date_range($notify_interval - $days_back * 86400);
 180
 181     $logger->info("notice: retrieving circs with due date in range $start_date -> $end_date");
 182
 183     my $QUERY = {
 184         select => {
 185             circ => ['id']
 186         },
 187         from => 'circ',
 188         where => {
 189             '+circ' => {
 190                 checkin_time => undef,
 191                 '-or' => [
 192                     {stop_fines => {'not in' => ["LOST","LONGOVERDUE","CLAIMSRETURNED"]}},
 193                     {stop_fines => undef}
 194                 ],
 195                                 due_date => {between => [$start_date, $end_date]},
 196             }
 197         }
 198     };
 199
 200     # if a circ duration is defined for this type of notice
 201     if(my $durs = $notice->{circ_duration_range}) {
 202         $QUERY->{where}->{'+circ'}->{duration} = {between => [$durs->{from}, $durs->{to}]};
 203     }
 204
 205     my $circs = $e->json_query($QUERY, {timeout => 18000, substream => 1});
 206     process_circs($notice, $type, map {$_->{id}} @$circs);
 207 }
 208
 209
 210 sub process_circs {
 211     my $notice = shift;
 212     my $type = shift;
 213     my @circs = @_;
 214
 215         return unless @circs;
 216
 217         $logger->info("notice: processing $type notices with notify interval ".
 218         $notice->{notify_interval}."  and ".scalar(@circs)." circs");
 219
 220         my $org;
 221         my $patron;
 222         my @current;
 223
 224         my $x = 0;
 225         for my $circ (@circs) {
 226                 $circ = $e->retrieve_action_circulation($circ);
 227
 228                 if( !defined $org or
 229                                 $circ->circ_lib != $org  or $circ->usr ne $patron ) {
 230                         $org = $circ->circ_lib;
 231                         $patron = $circ->usr;
 232                         generate_notice($notice, $type, @current) if @current;
 233                         @current = ();
 234                 }
 235
 236                 push(@current, $circ);
 237                 $x++;
 238         }
 239
 240         $logger->info("notice: processed $x circs");
 241         generate_notice($notice, $type, @current);
 242 }
 243
 244 my %ORG_CACHE;
 245 my %ORG_FROM_CACHE;
 246
 247 sub get_from_addr {
 248     my $type = shift;
 249     my $org_id = shift;
 250     my $sender;
 251
 252     if(defined $ORG_FROM_CACHE{$org_id}) {
 253         # we have we already loaded the setting for this org unit
 254                 $sender = $ORG_FROM_CACHE{$org_id};
 255
 256     } elsif(my $set = $e->search_actor_org_unit_setting(
 257                         {name => 'org.bounced_emails', org_unit => $org_id} )->[0]) {
 258                 my $bemail = OpenSRF::Utils::JSON->JSON2perl($set->value);
 259                 $sender = $ORG_FROM_CACHE{$org_id} = $bemail if $bemail;
 260         }
 261
 262     unless($sender) {
 263         # there is no setting, use the configured sender
 264         $sender = $settings->config_value(
 265             notifications => $type => 'sender_address') ||
 266             $settings->config_value(notifications => 'sender_address');
 267         $ORG_FROM_CACHE{$org_id} = '';
 268     }
 269
 270     return $sender;
 271 }
 272
 273 sub generate_notice {
 274     my $notice = shift;
 275     my $type = shift;
 276     my @circs = @_;
 277     return unless @circs;
 278     my $circ_list = fetch_circ_data(@circs);
 279     my $tt = Template->new({ABSOLUTE => 1});
 280
 281     # see if there is a configured bounce address for this org unit.
 282     # if so, use that as the sender
 283     my $org_id = $circ_list->[0]->circ_lib->id;
 284     my $sender = get_from_addr($type, $org_id);
 285
 286     my $context = {
 287         circ_list => $circ_list,
 288         get_bib_attr => \&get_bib_attr,
 289         parse_due_date => \&parse_due_date, # let the templates decide date format
 290         smtp_sender => $sender,
 291         notice => $notice,
 292     };
 293
 294     push(@global_overdue_circs, $context) if
 295         $type eq 'overdue' and $notice->{file_append} =~ /always/i;
 296
 297     if( ($opt_send_email or $opt_use_email_outfile) and
 298             $notice->{email_notify} and
 299             my $email = $circ_list->[0]->usr->email) {
 300
 301         if(my $tmpl = $notice->{email_template}) {
 302             $tt->process($tmpl, $context,
 303                 sub {
 304                     handle_email_template_output($notice, $type, $context, $email, @_);
 305                 }
 306             ) or $logger->error('notice: Template error '.$tt->error);
 307         }
 308     } else {
 309         push(@global_overdue_circs, $context)
 310             if $type eq 'overdue' and $notice->{file_append} =~ /noemail/i;
 311     }
 312 }
 313
 314 my $last_mvr;
 315 sub get_bib_attr {
 316     my $circ = shift;
 317     my $attr = shift;
 318     my $copy = $circ->target_copy;
 319     if($copy->call_number->id == OILS_PRECAT_CALL_NUMBER) {
 320         return $copy->dummy_title || '' if $attr eq 'title';
 321         return $copy->dummy_author || '' if $attr eq 'author';
 322     } else {
 323         $last_mvr = $U->record_to_mvr($copy->call_number->record)
 324             unless $last_mvr and $last_mvr->doc_id == $copy->call_number->record->id;
 325         return $last_mvr->title || '' if $attr eq 'title';
 326         return $last_mvr->author || '' if $attr eq 'author';
 327     }
 328 }
 329
 330 # provides a date that Template::Plugin::Date can parse
 331 sub parse_due_date {
 332     my $circ = shift;
 333     my $due = DateTime::Format::ISO8601->new->parse_datetime(clense_ISO8601($circ->due_date));
 334     return sprintf(
 335         "%0.2d:%0.2d:%0.2d %0.2d-%0.2d-%0.4d",
 336         $due->hour,
 337         $due->minute,
 338         $due->second,
 339         $due->day,
 340         $due->month,
 341         $due->year
 342     );
 343 }
 344
 345 sub escape_xml {
 346     my $str = shift;
 347     $str =~ s/&/&amp;/sog;
 348     $str =~ s/</&lt;/sog;
 349     $str =~ s/>/&gt;/sog;
 350     return $str;
 351 }
 352
 353
 354 sub handle_email_template_output {
 355     my $notice = shift;
 356     my $type = shift;
 357     my $context = shift;
 358     my $email = shift;
 359     my $msg = shift;
 360
 361     if($opt_use_email_outfile) {
 362         if(open(F, ">>$opt_use_email_outfile")) {
 363             binmode F, ":utf8";
 364             $logger->debug("notice: appending emails to outfile $opt_use_email_outfile");
 365             print F $msg;
 366             close F;
 367         } else {
 368             $logger->error("notice: unable to open --use-email-outfile $opt_use_email_outfile for writing: $@");
 369         }
 370     }
 371
 372
 373     if($opt_send_email) {
 374             my $sender = Email::Send->new({mailer => 'SMTP'});
 375         my $smtp_server = $settings->config_value(notifications => 'smtp_server');
 376         $logger->debug("notice: smtp server is $smtp_server");
 377             $sender->mailer_args([Host => $smtp_server]);
 378             my $stat = $sender->send($msg);
 379
 380             if( $stat and $stat->type eq 'success' ) {
 381                     $logger->info("notice: successfully sent $type email to $email");
 382             } else {
 383                     $logger->warn("notice: unable to send $type email to $email: ".Dumper($stat));
 384             # if we were unable to send the email, add this notice set to the global notify set
 385             push(@global_overdue_circs, $context)
 386                 if $opt_append_global_email_fail and
 387                     $type eq 'overdue' and $notice->{file_append} =~ /noemail/i;
 388             }
 389     }
 390 }
 391
 392 sub fetch_circ_data {
 393     my @circs = @_;
 394
 395         my $circ_lib_id = $circs[0]->circ_lib;
 396         my $usr_id = $circs[0]->usr;
 397         $logger->debug("notice: printing user:$usr_id circ_lib:$circ_lib_id");
 398
 399     my $usr = $e->retrieve_actor_user([
 400         $usr_id,
 401         {   flesh => 1,
 402             flesh_fields => {
 403                 au => [qw/card billing_address mailing_address/]
 404             }
 405         }
 406     ]);
 407
 408     # if the caller has defined a test email recipient, override
 409     # the user's email if they have one.
 410     $usr->email($opt_use_email_recipient) if $usr->email and $opt_use_email_recipient;
 411
 412     my $circ_lib = $ORG_CACHE{$circ_lib_id} ||
 413         $e->retrieve_actor_org_unit([
 414             $circ_lib_id,
 415             {   flesh => 1,
 416                 flesh_fields => {
 417                     aou => [qw/billing_address mailing_address/],
 418                 }
 419             }
 420         ]);
 421     $ORG_CACHE{$circ_lib_id} = $circ_lib;
 422
 423     my $circ_objs = $e->search_action_circulation([
 424         {id => [map {$_->id} @circs]},
 425         {   flesh => 3,
 426             flesh_fields => {
 427                 circ => [q/target_copy/],
 428                 acp => ['call_number'],
 429                 acn => ['record'],
 430             }
 431         }
 432     ]);
 433
 434     $_->circ_lib($circ_lib) for @$circ_objs;
 435     $_->usr($usr) for @$circ_objs;
 436
 437     return $circ_objs
 438 }
 439
 440
 441 sub make_date_range {
 442         my $offset = shift;
 443     #my $is_day_precision = shift; # window?
 444
 445         my $epoch = CORE::time + $offset;
 446         my $date = DateTime->from_epoch(epoch => $epoch, time_zone => 'local');
 447
 448         $date->set_hour(0);
 449         $date->set_minute(0);
 450         $date->set_second(0);
 451         my $start = "$date";
 452
 453         $date->set_hour(23);
 454         $date->set_minute(59);
 455         $date->set_second(59);
 456
 457         return ($start, "$date");
 458 }
 459
 460 main();