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