Evergreen/src/support-scripts/eg_gen_overdue.pl

   1 #!/usr/bin/perl
   2 # ---------------------------------------------------------------
   3 # Generates the overdue notices XML file
   4 # ./eg_gen_overdue.pl <bootstap> 0
   5 #               generates today's notices
   6 # ./eg_gen_overdue.pl <bootstap> 1 0
   7 #               generates notices for today - 1 and today
   8 # ./eg_gen_overdue.pl <bootstap> 2 1 0
   9 # ./eg_gen_overdue.pl <bootstap> 3 2 1 0  etc...
  10 # ---------------------------------------------------------------
  11
  12
  13
  14 use strict; use warnings;
  15 require '../../../Open-ILS/src/support-scripts/oils_header.pl';
  16 use vars qw/$logger $apputils/;
  17 use Data::Dumper;
  18 use OpenILS::Const qw/:const/;
  19 use OpenILS::Application::AppUtils;
  20 use DateTime;
  21 use Email::Send;
  22 use DateTime::Format::ISO8601;
  23 use OpenSRF::Utils qw/:datetime/;
  24 use Unicode::Normalize;
  25 use OpenILS::Const qw/:const/;
  26
  27 my $U = 'OpenILS::Application::AppUtils';
  28
  29 my $SEND_EMAILS = 1;
  30
  31 my $bsconfig = shift || die "usage: $0 <bootstrap_config>\n";
  32 my @goback = @ARGV;
  33 @goback = (0) unless @goback;
  34 osrf_connect($bsconfig);
  35 my $e = OpenILS::Utils::CStoreEditor->new;
  36
  37 my $smtp = $ENV{EG_OVERDUE_SMTP_HOST};
  38 my $mail_sender = $ENV{EG_OVERDUE_EMAIL_SENDER};
  39
  40 # ---------------------------------------------------------------
  41 # Set up the email template
  42 my $etmpl = $ENV{EG_OVERDUE_EMAIL_TEMPLATE};
  43 my $email_template;
  44 if( open(F,"$etmpl") ) {
  45         my @etmpl = <F>;
  46         $email_template = join('',@etmpl);
  47         close(F);
  48 }
  49 # ---------------------------------------------------------------
  50
  51
  52
  53 my @date = CORE::localtime;
  54 my $sec  = $date[0];
  55 my $min  = $date[1];
  56 my $hour = $date[2];
  57 my $day  = $date[3];
  58 my $mon  = $date[4] + 1;
  59 my $year = $date[5] + 1900;
  60
  61 my %USER_CACHE;
  62 my %ORG_CACHE;
  63
  64
  65 print <<XML;
  66 <?xml version='1.0' encoding='UTF-8'?>
  67 <file type="notice" date="$mon/$day/$year" time="$hour:$min:$sec">
  68         <agency name="PINES">
  69 XML
  70
  71 print_notices($_) for @goback;
  72
  73 print <<XML;
  74         </agency>
  75 </file>
  76 XML
  77
  78
  79 # -----------------------------------------------------------------------
  80 # -----------------------------------------------------------------------
  81
  82
  83 sub print_notices {
  84         my $goback = shift || 0;
  85
  86         for my $day ( qw/ 7 14 30 / ) {
  87                 my ($start, $end) = make_date_range($day + $goback);
  88
  89                 $logger->info("OD_notice: process date range $start -> $end");
  90
  91                 my $query = [
  92                         {
  93                                 checkin_time => undef,
  94                                 due_date => { between => [ $start, $end ] },
  95                         },
  96                         { order_by => { circ => 'usr, circ_lib' } }
  97                 ];
  98                 my $circs = $e->search_action_circulation($query, {idlist=>1});
  99
 100                 process_circs( $circs, "${day}day" );
 101         }
 102 }
 103
 104
 105 sub process_circs {
 106         my $circs = shift;
 107         my $range = shift;
 108
 109         return unless @$circs;
 110
 111         $logger->info("OD_notice: processing range $range and ".scalar(@$circs)." potential circs");
 112
 113         my $org;
 114         my $patron;
 115         my @current;
 116
 117         my $x = 0;
 118         for my $circ (@$circs) {
 119                 $circ = $e->retrieve_action_circulation($circ);
 120
 121                 if( !defined $org or
 122                                 $circ->circ_lib != $org  or $circ->usr ne $patron ) {
 123                         $org = $circ->circ_lib;
 124                         $patron = $circ->usr;
 125                         print_notice( $range, \@current ) if @current;
 126                         @current = ();
 127                 }
 128
 129                 push( @current, $circ );
 130                 $x++;
 131         }
 132
 133         $logger->info("OD_notice: processed $x circs");
 134         print_notice( $range, \@current );
 135 }
 136
 137 sub make_date_range {
 138         my $daysback = shift;
 139
 140         my $epoch = CORE::time - ($daysback * 24 * 60 * 60);
 141         my $date = DateTime->from_epoch( epoch => $epoch, time_zone => 'local');
 142
 143         $date->set_hour(0);
 144         $date->set_minute(0);
 145         $date->set_second(0);
 146         my $start = "$date";
 147
 148         $date->set_hour(23);
 149         $date->set_minute(59);
 150         $date->set_second(59);
 151
 152         return ($start, "$date");
 153 }
 154
 155
 156 sub print_notice {
 157         my( $range, $circs ) = @_;
 158         return unless @$circs;
 159
 160         my $s1 = scalar(@$circs);
 161
 162         # we don't charge for lost or claimsreturned
 163         $circs = [
 164                 grep {
 165                         !$_->stop_fines or (
 166                                 $_->stop_fines ne OILS_STOP_FINES_LOST and
 167                                 $_->stop_fines ne OILS_STOP_FINES_CLAIMSRETURNED
 168                         )
 169                 } @$circs
 170         ];
 171
 172         return unless @$circs;
 173
 174         my $s2 = $s1 - scalar(@$circs);
 175         $logger->info("OD_notice: dropped $s2 lost/CR from processing...") if $s2;
 176
 177         my $org = $circs->[0]->circ_lib;
 178         my $usr = $circs->[0]->usr;
 179         $logger->debug("OD_notice: printing $range user:$usr org:$org");
 180
 181         my @patron_data = fetch_patron_data($usr);
 182         my @org_data = fetch_org_data($org);
 183
 184         return unless (@patron_data and @org_data);
 185
 186         my $email;
 187
 188         if( $email = $patron_data[0]->email
 189                 and $email =~ /.+\@.+/
 190                 and ($range eq '7day' or $range eq '14day') ) {
 191
 192                         send_email($range, \@patron_data, \@org_data, $circs);
 193
 194         } else {
 195
 196                 if( $patron_data[9] ) {
 197
 198                         print "\t\t<notice type='overdue' count='$range'>\n";
 199                         print_patron_xml_chunk(@patron_data);
 200                         print_org_xml_chunk(@org_data);
 201                         print_circ_chunk($_) for @$circs;
 202                         print "\t\t</notice>\n";
 203
 204                 } else {
 205                         # There is no zip, therefore no address.
 206                         $logger->warn("OD_notice: unable to send mail notification for $usr due to lack of valid address");
 207                 }
 208         }
 209 }
 210
 211
 212 sub fetch_patron_data {
 213         my $user_id = shift;
 214
 215         my $patron = $USER_CACHE{$user_id};
 216
 217         if( ! $patron ) {
 218                 $logger->debug("OD_notice:   fetching patron $user_id");
 219
 220                 $patron = $e->retrieve_actor_user(
 221                         [
 222                                 $user_id,
 223                                 {
 224                                         flesh => 1,
 225                                         flesh_fields => {
 226                                                 'au' => [qw/ card billing_address mailing_address /]
 227                                         }
 228                                 }
 229                         ]
 230                 ) or return handle_event($e->event);
 231
 232                 $USER_CACHE{$user_id} = $patron;
 233         }
 234
 235         my $bc = $patron->card->barcode;
 236         my $fn = $patron->first_given_name;
 237         my $mn = $patron->second_given_name;
 238         my $ln = $patron->family_name;
 239
 240         my ( $s1, $s2, $city, $state, $zip );
 241
 242         my $baddr = $patron->mailing_address;
 243         unless( $baddr and $U->is_true($baddr->valid) ) {
 244                 $baddr = $patron->billing_address;
 245                 $baddr = undef unless( $baddr and $U->is_true($baddr->valid) );
 246         }
 247
 248         if( $baddr ) {
 249                 $s1             = $baddr->street1;
 250                 $s2             = $baddr->street2;
 251                 $city           = $baddr->city;
 252                 $state  = $baddr->state;
 253                 $zip            = $baddr->post_code;
 254         }
 255
 256         $bc = entityize($bc);
 257         $fn = entityize($fn);
 258         $mn = entityize($mn);
 259         $ln = entityize($ln);
 260         $s1 = entityize($s1);
 261         $s2 = entityize($s2);
 262         $city  = entityize($city);
 263         $state = entityize($state);
 264         $zip     = entityize($zip);
 265
 266         return ( $patron, $bc, $fn, $mn, $ln, $s1, $s2, $city, $state, $zip );
 267 }
 268
 269
 270 sub print_patron_xml_chunk {
 271         my( $patron, $bc, $fn, $mn, $ln, $s1, $s2, $city, $state, $zip ) = @_;
 272         my $pid = $patron->id;
 273         print <<"       XML";
 274                         <patron>
 275                                 <id type="barcode">$bc</id>
 276                                 <fullname>$fn $mn $ln</fullname>
 277                                 <street1>$s1 $s2</street1>
 278                                 <city_state_zip>$city, $state $zip</city_state_zip>
 279                                 <sys_id>$pid</sys_id>
 280                         </patron>
 281         XML
 282 }
 283
 284
 285 sub fetch_org_data {
 286         my $org_id = shift;
 287
 288         my $org = $ORG_CACHE{$org_id};
 289
 290         if( ! $org ) {
 291                 $logger->debug("OD_notice:   fetching org $org_id");
 292
 293                 $org = $e->retrieve_actor_org_unit(
 294                         [
 295                                 $org_id,
 296                                 {
 297                                         flesh => 1,
 298                                         flesh_fields =>
 299                                                 { aou => [ qw/billing_address mailing_address/ ] }
 300                                 }
 301                         ]
 302                 ) or return handle_event($e->event);
 303
 304                 $ORG_CACHE{$org_id} = $org;
 305         }
 306
 307         my $name = $org->name;
 308         my $email = $org->email;
 309         my $phone = $org->phone;
 310
 311         my( $s1, $s2, $city, $state, $zip );
 312         my $baddr = $org->billing_address || $org->mailing_address;
 313         if( $baddr ) {
 314                 $s1             = $baddr->street1;
 315                 $s2             = $baddr->street2;
 316                 $city           = $baddr->city;
 317                 $state  = $baddr->state;
 318                 $zip            = $baddr->post_code;
 319         }
 320
 321         $name  = entityize($name);
 322         $phone = entityize($phone);
 323         $s1      = entityize($s1);
 324         $s2      = entityize($s2);
 325         $city  = entityize($city);
 326         $state = entityize($state);
 327         $zip     = entityize($zip);
 328         $email = entityize($email);
 329
 330         return ( $org, $name, $phone, $s1, $s2, $city, $state, $zip, $email );
 331 }
 332
 333
 334 sub print_org_xml_chunk {
 335         my( $org, $name, $phone, $s1, $s2, $city, $state, $zip, $email ) = @_;
 336         print <<"       XML";
 337                         <library>
 338                                 <libname>$name</libname>
 339                                 <libphone>$phone</libphone>
 340                                 <libstreet1>$s1 $s2</libstreet1>
 341                                 <libcity_state_zip>$city, $state $zip</libcity_state_zip>
 342                         </library>
 343         XML
 344 }
 345
 346
 347 sub fetch_circ_data {
 348         my $circ = shift;
 349
 350         my $title;
 351         my $author;
 352         my $cn;
 353
 354         my $d = $circ->due_date;
 355         $d =~ s/[T ].*//og; # just for logging
 356         $logger->debug("OD_notice:   processing circ ".$circ->id." $d");
 357
 358         my $due = DateTime::Format::ISO8601->new->parse_datetime(
 359                 clense_ISO8601($circ->due_date));
 360
 361         my $day  = $due->day;
 362         my $mon  = $due->month;
 363         my $year = $due->year;
 364
 365         my $copy = $e->retrieve_asset_copy($circ->target_copy)
 366                 or return handle_event($e->event);
 367
 368         my $bc = $copy->barcode;
 369
 370         if( $copy->call_number == OILS_PRECAT_CALL_NUMBER ) {
 371                 $title = $copy->dummy_title || "";
 372                 $author = $copy->dummy_author || "";
 373
 374         } else {
 375
 376                 my $volume = $e->retrieve_asset_call_number(
 377                         [
 378                                 $copy->call_number,
 379                                 {
 380                                         flesh => 1,
 381                                         flesh_fields => {
 382                                                 acn => [ qw/record/ ]
 383                                         }
 384                                 }
 385                         ]
 386                 ) or return handle_event($e->event);
 387
 388                 $cn = $volume->label;
 389                 my $mods = $apputils->record_to_mvr($volume->record);
 390                 if( $mods ) {
 391                         $title = $mods->title || "";
 392                         $author = $mods->author || "";
 393                 }
 394         }
 395
 396         $title = entityize($title);
 397         $author = entityize($author);
 398         $cn = entityize($cn);
 399         $bc = entityize($bc);
 400
 401         return( $title, $author, $cn, $bc, $day, $mon, $year );
 402 }
 403
 404
 405 sub print_circ_chunk {
 406         my $circ = shift;
 407         my ( $title, $author, $cn, $bc, $day, $mon, $year ) = fetch_circ_data($circ);
 408         my $cid = $circ->id;
 409         print <<"       XML";
 410                         <item>
 411                                 <title>$title</title>
 412                                 <author>$author</author>
 413                                 <duedate>$mon/$day/$year</duedate>
 414                                 <callno>$cn</callno>
 415                                 <barcode>$bc</barcode>
 416                                 <circ_id>$cid</circ_id>
 417                         </item>
 418         XML
 419 }
 420
 421
 422
 423 sub send_email {
 424         my( $range, $patron_data, $org_data, $circs ) = @_;
 425         my( $org, $org_name, $org_phone, $org_s1, $org_s2, $org_city, $org_state, $org_zip, $org_email ) = @$org_data;
 426         my( $patron, $bc, $fn, $mn, $ln, $user_s1, $user_s2, $user_city, $user_state, $user_zip ) = @$patron_data;
 427
 428         return unless $SEND_EMAILS;
 429
 430         my $pemail = $patron_data->[0]->email;
 431
 432         my $tmpl = $email_template;
 433         my @time = localtime;
 434         my $year = $time[5] + 1900;
 435         my $mon  = $time[4] + 1;
 436         my $day  = $time[3];
 437
 438         my $r = ($range eq '7day') ? 7 : 14;
 439
 440         $org_email ||= $mail_sender;
 441
 442         $tmpl =~ s/\${EMAIL_RECIPIENT}/$pemail/;
 443         $tmpl =~ s/\${EMAIL_SENDER}/$mail_sender/o;
 444         $tmpl =~ s/\${EMAIL_REPLY_TO}/$org_email/;
 445    $tmpl =~ s/\${EMAIL_HEADERS}//;
 446
 447    $tmpl =~ s/\${RANGE}/$r/;
 448    $tmpl =~ s/\${DATE}/$mon\/$day\/$year/;
 449    $tmpl =~ s/\${FIRST_NAME}/$fn/;
 450    $tmpl =~ s/\${MIDDLE_NAME}/$mn/;
 451    $tmpl =~ s/\${LAST_NAME}/$ln/;
 452
 453         my ($itmpl) = $tmpl =~ /\${OVERDUE_ITEMS\[(.*)\]}/ms;
 454
 455         my $items = '';
 456         for my $circ (@$circs) {
 457                 my $circtmpl = $itmpl;
 458                 my ( $title, $author, $cn, $bc, $due_day, $due_mon, $due_year ) = fetch_circ_data($circ);
 459                 $circtmpl =~ s/\${TITLE}/$title/o;
 460                 $circtmpl =~ s/\${AUTHOR}/$author/o;
 461                 $circtmpl =~ s/\${CALL_NUMBER}/$cn/o;
 462                 $circtmpl =~ s/\${DUE_DAY}/$due_day/o;
 463                 $circtmpl =~ s/\${DUE_MONTH}/$due_mon/o;
 464                 $circtmpl =~ s/\${DUE_YEAR}/$due_year/o;
 465                 $circtmpl =~ s/\${ITEM_BARCODE}/$bc/o;
 466                 $items .= "$circtmpl\n";
 467         }
 468
 469         $tmpl =~ s/\${OVERDUE_ITEMS\[.*\]}/$items/ms;
 470
 471         my $org_addr = "$org_s1 $org_s2 $org_city, $org_state $org_zip";
 472         $tmpl =~ s/\${ORG_NAME}/$org_name/o;
 473         $tmpl =~ s/\${ORG_ADDRESS}/$org_addr/o;
 474         $tmpl =~ s/\${ORG_PHONE}/$org_phone/o;
 475
 476         $logger->debug("OD_notice: sending email to $pemail: $tmpl");
 477
 478         my $sender = Email::Send->new({mailer => 'SMTP'});
 479         $sender->mailer_args([Host => $smtp]);
 480
 481         my $stat = $sender->send($tmpl);
 482
 483         if( $stat and $stat->type eq 'success' ) {
 484                 $logger->info("OD_notice:   successfully sent overdue email");
 485         } else {
 486                 $logger->warn("OD_notice:   unable to send hold overdue email: ".Dumper($stat));
 487         }
 488
 489         $logger->info("OD_notice:   sending email to".$patron_data->[0]->email);
 490 }
 491
 492 sub handle_event {
 493         my $evt = shift;
 494         warn "OD_notice: ".Dumper($evt) . "\n";
 495         $logger->error("OD_notice: ".Dumper($evt));
 496         return undef;
 497 }
 498
 499
 500 sub entityize {
 501         my $stuff = shift || return "";
 502         $stuff =~ s/\</&lt;/og;
 503         $stuff =~ s/\>/&gt;/og;
 504         $stuff =~ s/\&/&amp;/og;
 505         $stuff = NFC($stuff);
 506         $stuff =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
 507         return $stuff;
 508 }
 509
 510
 511
 512