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