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