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