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 # we used to send alerts about upcoming credit card expiration here
  42 my $conf = new FS::Conf;
  43 if($conf->exists('alert_expiration')) {
  44   warn "WARNING: the alert_expiration option is obsolete.  If you ran
  45   freeside-upgrade, it should have configured credit card expiration alerts
  46   as billing events.\n";
  47 }
  48
  49 #what to do about the below when using -m?  that is the question.
  50
  51 #you don't want to skip this, besides, it should be cheap
  52 use FS::Cron::expire_user_pref qw(expire_user_pref);
  53 expire_user_pref();
  54
  55 unless ( $opt{k} ) {
  56   use FS::Cron::notify qw(notify_flat_delay);
  57   notify_flat_delay(%opt);
  58 }
  59
  60 #same
  61 use FS::Cron::rt_tasks qw(rt_daily);
  62 rt_daily(%opt);
  63
  64 #does nothing unless batch-gateway-* configs are set
  65 use FS::Cron::pay_batch qw(pay_batch_submit pay_batch_receive);
  66 pay_batch_submit(%opt);
  67 pay_batch_receive(%opt);
  68
  69 #does nothing unless there are batch-style exports with batches
  70 use FS::Cron::export_batch qw(export_batch_submit);
  71 export_batch_submit(%opt);
  72
  73 #you can skip this by not having the config
  74 use FS::Cron::agent_email qw(agent_email);
  75 agent_email(%opt);
  76
  77 #does nothing unless there are cacti imports
  78 #should run before backup, no need to backup cacti imports
  79 use FS::Cron::cacti_cleanup qw(cacti_cleanup);
  80 cacti_cleanup();
  81
  82 my $deldir = "$FS::UID::cache_dir/cache.$FS::UID::datasrc/";
  83 unlink <${deldir}.invoice*>;
  84 unlink <${deldir}.letter*>;
  85 unlink <${deldir}.CGItemp*>;
  86
  87 #backup should be last
  88 #you can skip this just by not having the config
  89 use FS::Cron::backup qw(backup);
  90 backup();
  91
  92 #except we'd rather not start cleanup jobs until the backup is done
  93 use FS::Cron::cleanup qw(cleanup);
  94 cleanup();
  95
  96 $log->info('finish');
  97
  98 ###
  99 # subroutines
 100 ###
 101
 102 sub untaint_argv {
 103   foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
 104     #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
 105     # Date::Parse
 106     $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
 107     $ARGV[$_]=$1;
 108   }
 109 }
 110
 111 sub usage {
 112   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";
 113 }
 114
 115 ###
 116 # documentation
 117 ###
 118
 119 =head1 NAME
 120
 121 freeside-daily - Run daily billing and invoice collection events.
 122
 123 =head1 SYNOPSIS
 124
 125   freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum,agentnum,... ] [ -s ] [ -o ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ]
 126
 127 =head1 DESCRIPTION
 128
 129 Bills customers and runs invoice collection events.  Should be run from
 130 crontab daily.
 131
 132 Bills customers.  Searches for customers who are due for billing and calls
 133 the bill and collect methods of a cust_main object.  See L<FS::cust_main>.
 134
 135   -d: Pretend it's 'date'.  Date is in any format Date::Parse is happy with,
 136       but be careful.
 137
 138   -y: In addition to -d, which specifies an absolute date, the -y switch
 139       specifies an offset, in days.  For example, "-y 15" would increment the
 140       "pretend date" 15 days from whatever was specified by the -d switch
 141       (or now, if no -d switch was given).
 142
 143   -n: When used with "-d" and/or "-y", specifies that invoices should be dated
 144       with today's date, irregardless of the pretend date used to pre-generate
 145       the invoices.
 146
 147   -p: Only process customers with the specified payby (CARD, DCRD, CHEK, DCHK, BILL, COMP, LECB)
 148
 149   -a: Only process customers with the specified agentnum.  Multiple agentnums can be specified, separated with commas.
 150
 151   -g: Don't process the provided pkgpart (or pkgparts, specified as a comma-
 152       separated list).
 153
 154   -s: re-charge setup fees
 155
 156   -o: For packages which are more than one billing period behind, only charge for one billing period rather than catching up.
 157
 158   -v: enable debugging
 159
 160   -l: debugging level
 161
 162   -m: Multi-process mode uses the job queue for multi-process and/or multi-machine billing.
 163
 164   -r: Multi-process mode dry run option
 165
 166   -k: skip notify_flat_delay
 167
 168 user: From the mapsecrets file - see config.html from the base documentation
 169
 170 custnum: if one or more customer numbers are specified, only bills those
 171 customers.  Otherwise, bills all customers.
 172
 173 =head1 BUGS
 174
 175 =head1 SEE ALSO
 176
 177 L<FS::cust_main>, config.html from the base documentation
 178
 179 =cut
 180