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