FS/FS/Cron/alert_expiration.pm

   1 package FS::Cron::alert_expiration;
   2
   3 use vars qw( @ISA @EXPORT_OK);
   4 use Exporter;
   5 use FS::Record qw(qsearch qsearchs);
   6 use FS::Conf;
   7 use FS::cust_main;
   8 use FS::Misc;
   9 use Time::Local;
  10 use Date::Parse qw(str2time);
  11
  12
  13 @ISA = qw( Exporter );
  14 @EXPORT_OK = qw( alert_expiration );
  15
  16 my $warning_time = 30 * 24 * 60 * 60;
  17 my $urgent_time = 15 * 24 * 60 * 60;
  18 my $panic_time = 5 * 24 * 60 * 60;
  19 my $window_time = 24 * 60 * 60;
  20
  21 sub alert_expiration {
  22   my $conf = new FS::Conf;
  23   my $smtpmachine = $conf->config('smtpmachine');
  24
  25   my %opt = @_;
  26   my ($_date) = $opt{'d'} ? str2time($opt{'d'}) : $^T;
  27   $_date += $opt{'y'} * 86400 if $opt{'y'};
  28   my ($sec, $min, $hour, $mday, $mon, $year) = (localtime($_date)) [0..5];
  29   $mon++;
  30
  31   my $debug = 0;
  32   $debug = 1 if $opt{'v'};
  33   $debug = $opt{'l'} if $opt{'l'};
  34
  35   $FS::cust_main::DEBUG = $debug;
  36
  37   # Get a list of customers.
  38
  39   my %limit;
  40   $limit{'agentnum'} = $opt{'a'} if $opt{'a'};
  41   $limit{'payby'}    = $opt{'p'} if $opt{'p'};
  42
  43   my @customers;
  44
  45   if(my @custnums = @ARGV) {
  46     # We're given an explicit list of custnums, so select those.  Then check against
  47     # -a and -p to avoid doing anything unexpected.
  48     foreach (@custnums) {
  49       my $customer = FS::cust_main->by_key($_);
  50       if($customer and (!$opt{'a'} or $customer->agentnum == $opt{'a'})
  51                    and (!$opt{'p'} or $customer->payby eq $opt{'p'}) ) {
  52         push @customers, $customer;
  53       }
  54     }
  55   }
  56   else { # no @ARGV
  57     @customers = qsearch('cust_main', \%limit);
  58   }
  59   return if(!@customers);
  60   foreach my $customer (@customers) {
  61     next if !($customer->ncancelled_pkgs); # skip inactive customers
  62     my $paydate = $customer->paydate;
  63     next if $paydate =~ /^\s*$/; # skip empty expiration dates
  64
  65     my $custnum = $customer->custnum;
  66     my $first   = $customer->first;
  67     my $last    = $customer->last;
  68     my $company = $customer->company;
  69     my $payby   = $customer->payby;
  70     my $payinfo = $customer->payinfo;
  71     my $daytime = $customer->daytime;
  72     my $night   = $customer->night;
  73
  74     my ($paymonth, $payyear) = $customer->paydate_monthyear;
  75     $paymonth--; # localtime() convention
  76     $payday = 1; # This is enforced by FS::cust_main::check.
  77     my $expire_time;
  78     if($payby eq 'CARD' || $payby eq 'DCRD') {
  79       # Credit cards expire at the end of the month/year.
  80       if($paymonth == 11) {
  81         $payyear++;
  82         $paymonth = 0;
  83       } else {
  84         $paymonth++;
  85       }
  86       $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear) - 1;
  87     }
  88     else {
  89       $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
  90     }
  91
  92     if (grep { $expire_time < $_date + $_ &&
  93                $expire_time > $_date + $_ - $window_time }
  94                ($warning_time, $urgent_time, $panic_time) ) {
  95       # Send an expiration notice.
  96       my $agentnum = $customer->agentnum;
  97       my $error = '';
  98
  99       my $msgnum = $conf->config('alerter_msgnum', $agentnum);
 100       if ( $msgnum ) { # new hotness
 101         my $msg_template = qsearchs('msg_template', { msgnum => $msgnum } );
 102         $customer->setfield('expdate', $expire_time);
 103         $error = $msg_template->send('cust_main' => $customer);
 104       }
 105       else { #!$msgnum, the hard way
 106         $mail_sender = $conf->config('invoice_from', $agentnum);
 107         $failure_recipient = $conf->config('invoice_from', $agentnum)
 108           || 'postmaster';
 109
 110         my @alerter_template = $conf->config('alerter_template', $agentnum)
 111           or die 'cannot load config file alerter_template';
 112
 113         my $alerter = new Text::Template(TYPE   => 'ARRAY',
 114                                          SOURCE => [
 115                                            map "$_\n", @alerter_template
 116                                            ])
 117           or die "can't create Text::Template object: $Text::Template::ERROR";
 118
 119         $alerter->compile()
 120           or die "can't compile template: $Text::Template::ERROR";
 121
 122         my @invoicing_list = $customer->invoicing_list;
 123         my @to_addrs = grep { $_ ne 'POST' } @invoicing_list;
 124         if(@to_addrs) {
 125           # Set up template fields.
 126           my %fill_in;
 127           $fill_in{$_} = $customer->getfield($_)
 128             foreach(qw(first last company));
 129           $fill_in{'expdate'} = $expire_time;
 130           $fill_in{'company_name'} = $conf->config('company_name', $agentnum);
 131           $fill_in{'company_address'} =
 132             join("\n",$conf->config('company_address',$agentnum))."\n";
 133           if($payby eq 'CARD' || $payby eq 'DCRD') {
 134             $fill_in{'payby'} = "credit card (".
 135               substr($customer->payinfo, 0, 2) . "xxxxxxxxxx" .
 136               substr($payinfo, -4) . ")";
 137           }
 138           elsif($payby eq 'COMP') {
 139             $fill_in{'payby'} = 'complimentary account';
 140           }
 141           else {
 142             $fill_in{'payby'} = 'current method';
 143           }
 144           # Send it already!
 145           $error = FS::Misc::send_email (
 146             from    =>  $mail_sender,
 147             to      =>  [ @to_addrs ],
 148             subject =>  'Billing Arrangement Expiration',
 149             body    =>  [ $alerter->fill_in( HASH => \%fill_in ) ],
 150           );
 151       }
 152       else { # if(@to_addrs)
 153         push @{$agent_failure_body{$customer->agentnum}},
 154           sprintf(qq{%5d %-32.32s %4s %10s %12s %12s},
 155             $custnum,
 156             $first . " " . $last . "   " . $company,
 157             $payby,
 158             $paydate,
 159             $daytime,
 160             $night );
 161       }
 162     } # if($msgnum)
 163
 164 # should we die here rather than report failure as below?
 165     die "can't send expiration alert: $error"
 166       if $error;
 167
 168     } # if(expired)
 169   } # foreach(@customers)
 170
 171   # Failure notification
 172   foreach my $agentnum (keys %agent_failure_body) {
 173     $mail_sender = $conf->config('invoice_from', $agentnum)
 174       if($conf->exists('invoice_from', $agentnum));
 175     $failure_recipient = $conf->config('invoice_from', $agentnum)
 176       if($conf->exists('invoice_from', $agentnum));
 177     my $error = FS::Misc::send_email (
 178       from    =>  $mail_sender,
 179       to      =>  $failure_recipient,
 180       subject =>  'Unnotified Billing Arrangement Expirations',
 181       body    =>  [ @{$agent_failure_body{$agentnum}} ],
 182       );
 183     die "can't send alerter failure email to $failure_recipient: $error"
 184       if $error;
 185   }
 186
 187 }
 188
 189 1;