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:nmrk", \%opt);
  11
  12 my $user = shift or die &usage;
  13 adminsuidsetup $user;
  14
  15 use FS::Cron::bill qw(bill);
  16 bill(%opt);
  17
  18 # Send alerts about upcoming credit card expiration.
  19 use FS::Cron::alert_expiration qw(alert_expiration);
  20 my $conf = new FS::Conf;
  21 alert_expiration(%opt) if($conf->exists('alert_expiration'));
  22
  23 #what to do about the below when using -m?  that is the question.
  24
  25 #you don't want to skip this, besides, it should be cheap
  26 use FS::Cron::expire_user_pref qw(expire_user_pref);
  27 expire_user_pref();
  28
  29 unless ( $opt{k} ) {
  30
  31   use FS::Cron::notify qw(notify_flat_delay);
  32   notify_flat_delay(%opt);
  33
  34   use FS::Cron::vacuum qw(vacuum);
  35   vacuum();
  36
  37 }
  38
  39 #you can skip this just by not having the config
  40 use FS::Cron::backup qw(backup_scp);
  41 backup_scp();
  42
  43 ###
  44 # subroutines
  45 ###
  46
  47 sub untaint_argv {
  48   foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
  49     #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
  50     # Date::Parse
  51     $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
  52     $ARGV[$_]=$1;
  53   }
  54 }
  55
  56 sub usage {
  57   die "Usage:\n\n  freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -k ] user [ custnum custnum ... ]\n";
  58 }
  59
  60 ###
  61 # documentation
  62 ###
  63
  64 =head1 NAME
  65
  66 freeside-daily - Run daily billing and invoice collection events.
  67
  68 =head1 SYNOPSIS
  69
  70   freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ]
  71
  72 =head1 DESCRIPTION
  73
  74 Bills customers and runs invoice collection events.  Should be run from
  75 crontab daily.
  76
  77 Bills customers.  Searches for customers who are due for billing and calls
  78 the bill and collect methods of a cust_main object.  See L<FS::cust_main>.
  79
  80   -d: Pretend it's 'date'.  Date is in any format Date::Parse is happy with,
  81       but be careful.
  82
  83   -y: In addition to -d, which specifies an absolute date, the -y switch
  84       specifies an offset, in days.  For example, "-y 15" would increment the
  85       "pretend date" 15 days from whatever was specified by the -d switch
  86       (or now, if no -d switch was given).
  87
  88   -n: When used with "-d" and/or "-y", specifies that invoices should be dated
  89       with today's date, irregardless of the pretend date used to pre-generate
  90       the invoices.
  91
  92   -p: Only process customers with the specified payby (I<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)
  93
  94   -a: Only process customers with the specified agentnum
  95
  96   -s: re-charge setup fees
  97
  98   -v: enable debugging
  99
 100   -l: debugging level
 101
 102   -m: Experimental multi-process mode uses the job queue for multi-process and/or multi-machine billing.
 103
 104   -r: Multi-process mode dry run option
 105
 106   -k: skip notify_flat_delay and vacuum
 107
 108 user: From the mapsecrets file - see config.html from the base documentation
 109
 110 custnum: if one or more customer numbers are specified, only bills those
 111 customers.  Otherwise, bills all customers.
 112
 113 =head1 BUGS
 114
 115 =head1 SEE ALSO
 116
 117 L<FS::cust_main>, config.html from the base documentation
 118
 119 =cut
 120