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