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 Data::Dumper;
  21 use Email::Send;
  22 use Getopt::Long;
  23 use Unicode::Normalize;
  24 use DateTime::Format::ISO8601;
  25 use OpenSRF::Utils qw/:datetime/;
  26 use OpenSRF::Utils::JSON;
  27 use OpenSRF::Utils::SettingsClient;
  28 use OpenSRF::AppSession;
  29 use OpenILS::Const qw/:const/;
  30 use OpenILS::Application::AppUtils;
  31 use OpenILS::Const qw/:const/;
  32 my $U = 'OpenILS::Application::AppUtils';
  33
  34 my $settings = undef;
  35 my $e = OpenILS::Utils::CStoreEditor->new;
  36
  37 my ($osrf_config, $send_email, $gen_day_intervals, $days_back) =
  38     ('/openils/conf/opensrf_core.xml', 1, 0, 0);
  39
  40 GetOptions(
  41     'osrf_osrf_config=s' => \$osrf_config,
  42     'send-emails' => \$send_email,
  43     'generate-day-intervals' => \$gen_day_intervals,
  44     'days-back=s' => \$days_back,
  45 );
  46
  47 sub help {
  48     print <<HELP;
  49         --config <config_file>
  50
  51         --send-emails If set, generate email notices
  52
  53         --generate-day-intervals If set, notices which have a notify_interval of >= 1 day will be processed.
  54
  55         --days-back <days_back_comma_separted>  This is used to set the effective run date of the script.
  56             This is useful if you don't want to generate notices on certain days.  For example, if you don't
  57             generate notices on the weekend, you would run this script on weekdays and set --days-back to
  58             0,1,2 when it's run on Monday to capture any notices from Saturday and Sunday.
  59 HELP
  60 }
  61
  62
  63 sub main {
  64     osrf_connect($osrf_config);
  65     $settings = OpenSRF::Utils::SettingsClient->new;
  66
  67     my $smtp_server = $settings->config_value(notifications => 'smtp_server');
  68     my $sender_address = $settings->config_value(notifications => 'sender_address');
  69     my $od_sender_addr = $settings->config_value(notifications => overdue => 'sender_address') || $sender_address;
  70     my $pd_sender_addr = $settings->config_value(notifications => predue => 'sender_address') || $sender_address;
  71     my $overdue_notices = $settings->config_value(notifications => overdue => 'notice');
  72     my $predue_notices = $settings->config_value(notifications => predue => 'notice');
  73
  74     $overdue_notices = [$overdue_notices] unless ref $overdue_notices eq 'ARRAY';
  75     $predue_notices = [$predue_notices] unless ref $predue_notices eq 'ARRAY';
  76
  77     my @overdues = sort {
  78         OpenSRF::Utils->interval_to_seconds($a->{notify_interval}) <=>
  79         OpenSRF::Utils->interval_to_seconds($b->{notify_interval}) } @$overdue_notices;
  80
  81     my @predues = sort {
  82         OpenSRF::Utils->interval_to_seconds($a->{notify_interval}) <=>
  83         OpenSRF::Utils->interval_to_seconds($b->{notify_interval}) } @$predue_notices;
  84
  85     generate_notice_set($_, $od_sender_addr, 'overdue') for @overdues;
  86     generate_notice_set($_, $pd_sender_addr, 'predue') for @predues;
  87 }
  88
  89
  90 sub generate_notice_set {
  91     my($notice, $smtp_sender, $type) = @_;
  92
  93     my $notify_interval = OpenSRF::Utils->interval_to_seconds($notice->{notify_interval});
  94     $notify_interval = -$notify_interval if $type eq 'overdue';
  95
  96     my ($start_date, $end_date) = make_date_range(-$days_back + $notify_interval);
  97
  98     $logger->info("notice: retrieving circs with due date in range $start_date -> $end_date");
  99
 100     my $QUERY = {
 101         select => {
 102             circ => ['id']
 103         },
 104         from => 'circ',
 105         where => {
 106             '+circ' => {
 107                 checkin_time => undef,
 108                 '-or' => [
 109                     {stop_fines => ["LOST","LONGOVERDUE","CLAIMSRETURNED"]},
 110                     {stop_fines => undef}
 111                 ],
 112                                 due_date => {between => [$start_date, $end_date]},
 113             }
 114         }
 115     };
 116
 117     # if a circ duration is defined for this type of notice
 118     if(my $durs = $settings->{circ_duration_range}) {
 119         $QUERY->{where}->{'+circ'}->{duration} = {between => [$durs->{from}, $durs->{to}]};
 120     }
 121
 122     my $ses = OpenSRF::AppSession->create('open-ils.cstore');
 123     my $req = $ses->request('open-ils.cstore.json_query', $QUERY);
 124     my @circs;
 125     my $resp;
 126     push(@circs, $resp->content->{id}) while ($resp = $req->recv(timeout=>1800));
 127     process_circs($notice, @circs);
 128 }
 129
 130
 131 sub process_circs {
 132     my $notice = shift;
 133     my $type = shift;
 134     my @circs = @_;
 135
 136         return unless @circs;
 137
 138         $logger->info("notice: processing $type notices with notify interval ".
 139         $notice->{notify_interval}."  and ".scalar(@circs)." circs");
 140
 141         my $org;
 142         my $patron;
 143         my @current;
 144
 145         my $x = 0;
 146         for my $circ (@circs) {
 147                 $circ = $e->retrieve_action_circulation($circ);
 148
 149                 if( !defined $org or
 150                                 $circ->circ_lib != $org  or $circ->usr ne $patron ) {
 151                         $org = $circ->circ_lib;
 152                         $patron = $circ->usr;
 153                         generate_notice($notice, @current) if @current;
 154                         @current = ();
 155                 }
 156
 157                 push( @current, $circ );
 158                 $x++;
 159         }
 160
 161         $logger->info("notice: processed $x circs");
 162         generate_notice($notice, @current);
 163 }
 164
 165 sub generate_notice {
 166     my $notice = shift;
 167     my @circs = @_;
 168
 169         my $org = $circs[0]->circ_lib;
 170         my $usr = $circs[0]->usr;
 171         $logger->debug("notice: printing user:$usr org:$org");
 172
 173     my $circ_objs = $e->batch_retrieve_action_circulation([
 174         \@circs,
 175         {   flesh => 3,
 176             flesh_fields => {
 177                 circ => [q/target_copy circ_lib usr/],
 178                 acp => ['call_number'],
 179                 acn => ['record'],
 180                 aou => [qw/billing_address mailing_address/],
 181                 au => [qw/card billing_address mailing_address/]
 182             }
 183         }
 184     ]);
 185
 186     print $_->circ_lib->shortname . ' : ' . $_->usr->usrname .
 187         ' : ' .  $_->target_copy->barcode . "\n" for @$circ_objs;
 188 }
 189
 190 =head
 191         if( $circ->copy->call_number->id == OILS_PRECAT_CALL_NUMBER ) {
 192                 $data->{title} = $copy->dummy_title || '';
 193                 $data->{author} = $copy->dummy_author || '';
 194     } else {
 195         $data->{mvr} = $U->record_to_mvr($copy->call_number->record);
 196                 $data->{title} = $data->{mvr}->title || '';
 197                 $data->{author} = $data->{mvr}->author || '';
 198     }
 199 =cut
 200
 201 sub make_date_range {
 202         my $offset = shift;
 203     #my $is_day_precision = shift; # window?
 204
 205         my $epoch = CORE::time + $offset;
 206         my $date = DateTime->from_epoch(epoch => $epoch, time_zone => 'local');
 207
 208         $date->set_hour(0);
 209         $date->set_minute(0);
 210         $date->set_second(0);
 211         my $start = "$date";
 212
 213         $date->set_hour(23);
 214         $date->set_minute(59);
 215         $date->set_second(59);
 216
 217         return ($start, "$date");
 218 }
 219
 220 main();