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