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:ox", \%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 #this only takes effect if WA sales taxes are enabled
  39 use FS::Cron::tax_rate_update qw(tax_rate_update);
  40 tax_rate_update(%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 #does nothing unless there are users with subscribed searches
  82 use FS::Cron::send_subscribed qw(send_subscribed);
  83 send_subscribed(%opt);
  84
  85 #does nothing unless quotation_disable_after_days is set.
  86 use FS::Cron::disable_quotation qw(disable_quotation);
  87 disable_quotation();
  88
  89 #clears out cacti imports & deletes select database cache files
  90 use FS::Cron::cleanup qw( cleanup cleanup_before_backup );
  91 cleanup_before_backup();
  92
  93 #backup should be last
  94 #you can skip this just by not having the config (or with the -x option)
  95 use FS::Cron::backup qw(backup);
  96 backup() unless $opt{'x'};
  97
  98 #except we'd rather not start cleanup jobs until the backup is done
  99 cleanup();
 100
 101 $log->info('finish');
 102
 103 ###
 104 # subroutines
 105 ###
 106
 107 sub untaint_argv {
 108   foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
 109     #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
 110     # Date::Parse
 111     $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
 112     $ARGV[$_]=$1;
 113   }
 114 }
 115
 116 sub usage {
 117   die "Usage:\n\n  freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum,agentnum,... ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -k ] [ -x ] user [ custnum custnum ... ]\n";
 118 }
 119
 120 ###
 121 # documentation
 122 ###
 123
 124 =head1 NAME
 125
 126 freeside-daily - Run daily billing and invoice collection events.
 127
 128 =head1 SYNOPSIS
 129
 130   freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum,agentnum,... ] [ -s ] [ -o ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ]
 131
 132 =head1 DESCRIPTION
 133
 134 Bills customers and runs invoice collection events.  Should be run from
 135 crontab daily.
 136
 137 Bills customers.  Searches for customers who are due for billing and calls
 138 the bill and collect methods of a cust_main object.  See L<FS::cust_main>.
 139
 140   -d: Pretend it's 'date'.  Date is in any format Date::Parse is happy with,
 141       but be careful.
 142
 143   -y: In addition to -d, which specifies an absolute date, the -y switch
 144       specifies an offset, in days.  For example, "-y 15" would increment the
 145       "pretend date" 15 days from whatever was specified by the -d switch
 146       (or now, if no -d switch was given).
 147
 148   -n: When used with "-d" and/or "-y", specifies that invoices should be dated
 149       with today's date, irregardless of the pretend date used to pre-generate
 150       the invoices.
 151
 152   -p: Only process customers with the specified payby (CARD, DCRD, CHEK, DCHK, BILL, COMP, LECB)
 153
 154   -a: Only process customers with the specified agentnum.  Multiple agentnums can be specified, separated with commas.
 155
 156   -g: Don't process the provided pkgpart (or pkgparts, specified as a comma-
 157       separated list).
 158
 159   -s: re-charge setup fees
 160
 161   -o: For packages which are more than one billing period behind, only charge for one billing period rather than catching up.
 162
 163   -v: enable debugging
 164
 165   -l: debugging level
 166
 167   -m: Multi-process mode uses the job queue for multi-process and/or multi-machine billing.
 168
 169   -r: Multi-process mode dry run option
 170
 171   -k: skip notify_flat_delay
 172
 173   -x: skip backup
 174
 175 user: Typically "fs_daily"
 176
 177 custnum: if one or more customer numbers are specified, only bills those
 178 customers.  Otherwise, bills all customers.
 179
 180 =head1 BUGS
 181
 182 =head1 SEE ALSO
 183
 184 L<FS::cust_main>, config.html from the base documentation
 185
 186 =cut
 187