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