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