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