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