FS/bin/freeside-daily

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