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