FS/bin/freeside-daily

   1 #!/usr/bin/perl -w
   2
   3 use strict;
   4 use Getopt::Std;
   5 use FS::UID qw(adminsuidsetup);
   6 use FS::Conf;
   7 use FS::Log;
   8
   9 &untaint_argv;  #what it sounds like  (eww)
  10 use vars qw(%opt);
  11 getopts("p:a:d:vl:sy:nmrkg:o", \%opt);
  12
  13 my $user = shift or die &usage;
  14 adminsuidsetup $user;
  15 my $log = FS::Log->new('daily');
  16 $log->info('start');
  17
  18 #you can skip this by not having a NetworkMonitoringSystem configured
  19 use FS::Cron::nms_report qw(nms_report);
  20 nms_report(%opt);
  21
  22 #no way to skip this yet, but should be harmless/quick
  23 use FS::Cron::expire_banned_pay qw(expire_banned_pay);
  24 expire_banned_pay(%opt);
  25
  26 #you can skip this by setting the disable_cron_billing config
  27 use FS::Cron::bill qw(bill);
  28 bill(%opt);
  29
  30 #you can skip this just by not having the config
  31 use FS::Cron::breakage qw(reconcile_breakage);
  32 reconcile_breakage(%opt);
  33
  34 #you can skip this just by not having the config
  35 use FS::Cron::upload qw(upload);
  36 upload(%opt);
  37
  38 use FS::Cron::set_lata_have_usage qw(set_lata_have_usage);
  39 set_lata_have_usage(%opt);
  40
  41 # Send alerts about upcoming credit card expiration.
  42 use FS::Cron::alert_expiration qw(alert_expiration);
  43 my $conf = new FS::Conf;
  44 alert_expiration(%opt) if($conf->exists('alert_expiration'));
  45
  46 #what to do about the below when using -m?  that is the question.
  47
  48 #you don't want to skip this, besides, it should be cheap
  49 use FS::Cron::expire_user_pref qw(expire_user_pref);
  50 expire_user_pref();
  51
  52 unless ( $opt{k} ) {
  53   use FS::Cron::notify qw(notify_flat_delay);
  54   notify_flat_delay(%opt);
  55 }
  56
  57 #same
  58 use FS::Cron::rt_tasks qw(rt_daily);
  59 rt_daily(%opt);
  60
  61 #does nothing unless batch-gateway-* configs are set
  62 use FS::Cron::pay_batch qw(batch_submit batch_receive);
  63 batch_submit(%opt);
  64 batch_receive(%opt);
  65
  66 #you can skip this by not having the config
  67 use FS::Cron::agent_email qw(agent_email);
  68 agent_email(%opt);
  69
  70 my $deldir = "$FS::UID::cache_dir/cache.$FS::UID::datasrc/";
  71 unlink <${deldir}.invoice*>;
  72 unlink <${deldir}.letter*>;
  73 unlink <${deldir}.CGItemp*>;
  74
  75 #backup should be last
  76 #you can skip this just by not having the config
  77 use FS::Cron::backup qw(backup);
  78 backup();
  79
  80 $log->info('finish');
  81
  82 ###
  83 # subroutines
  84 ###
  85
  86 sub untaint_argv {
  87   foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
  88     #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
  89     # Date::Parse
  90     $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
  91     $ARGV[$_]=$1;
  92   }
  93 }
  94
  95 sub usage {
  96   die "Usage:\n\n  freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum,agentnum,... ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -k ] user [ custnum custnum ... ]\n";
  97 }
  98
  99 ###
 100 # documentation
 101 ###
 102
 103 =head1 NAME
 104
 105 freeside-daily - Run daily billing and invoice collection events.
 106
 107 =head1 SYNOPSIS
 108
 109   freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum,agentnum,... ] [ -s ] [ -o ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ]
 110
 111 =head1 DESCRIPTION
 112
 113 Bills customers and runs invoice collection events.  Should be run from
 114 crontab daily.
 115
 116 Bills customers.  Searches for customers who are due for billing and calls
 117 the bill and collect methods of a cust_main object.  See L<FS::cust_main>.
 118
 119   -d: Pretend it's 'date'.  Date is in any format Date::Parse is happy with,
 120       but be careful.
 121
 122   -y: In addition to -d, which specifies an absolute date, the -y switch
 123       specifies an offset, in days.  For example, "-y 15" would increment the
 124       "pretend date" 15 days from whatever was specified by the -d switch
 125       (or now, if no -d switch was given).
 126
 127   -n: When used with "-d" and/or "-y", specifies that invoices should be dated
 128       with today's date, irregardless of the pretend date used to pre-generate
 129       the invoices.
 130
 131   -p: Only process customers with the specified payby (CARD, DCRD, CHEK, DCHK, BILL, COMP, LECB)
 132
 133   -a: Only process customers with the specified agentnum.  Multiple agentnums can be specified, separated with commas.
 134
 135   -g: Don't process the provided pkgpart (or pkgparts, specified as a comma-
 136       separated list).
 137
 138   -s: re-charge setup fees
 139
 140   -o: For packages which are more than one billing period behind, only charge for one billing period rather than catching up.
 141
 142   -v: enable debugging
 143
 144   -l: debugging level
 145
 146   -m: Multi-process mode uses the job queue for multi-process and/or multi-machine billing.
 147
 148   -r: Multi-process mode dry run option
 149
 150   -k: skip notify_flat_delay
 151
 152 user: From the mapsecrets file - see config.html from the base documentation
 153
 154 custnum: if one or more customer numbers are specified, only bills those
 155 customers.  Otherwise, bills all customers.
 156
 157 =head1 BUGS
 158
 159 =head1 SEE ALSO
 160
 161 L<FS::cust_main>, config.html from the base documentation
 162
 163 =cut
 164