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