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