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