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