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