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