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