5 use FS::UID qw(adminsuidsetup);
9 &untaint_argv; #what it sounds like (eww)
11 getopts("p:a:d:vl:sy:nmqrkg:ox", \%opt);
13 my $user = shift or die &usage;
16 die "The -p option has been removed in version 4 -- customers no longer have ".
17 "a single, specific payment type\n"
20 my $log = FS::Log->new('daily');
23 #you can skip this by not having a NetworkMonitoringSystem configured
24 use FS::Cron::nms_report qw(nms_report);
27 #you can skip this by not having any vitelity exports configured
28 use FS::Cron::lnp_vitelity qw(lnp_vitelity);
31 #no way to skip this yet, but should be harmless/quick
32 use FS::Cron::expire_banned_pay qw(expire_banned_pay);
33 expire_banned_pay(%opt);
35 #you can skip this by setting the disable_cron_billing config
36 use FS::Cron::bill qw(bill);
39 #you can skip this by not setting enable_taxproducts to 'billsoft'
40 use FS::Cron::tax_batch qw(process_tax_batch);
41 process_tax_batch(%opt);
43 #you can skip this just by not having the config
44 use FS::Cron::breakage qw(reconcile_breakage);
45 reconcile_breakage(%opt);
47 #you can skip this just by not having the config
48 use FS::Cron::upload qw(upload);
51 #this only takes effect if WA sales taxes are enabled
52 use FS::Cron::tax_rate_update qw(tax_rate_update);
53 tax_rate_update(%opt);
55 use FS::Cron::set_lata_have_usage qw(set_lata_have_usage);
56 set_lata_have_usage(%opt);
58 # we used to send alerts about upcoming credit card expiration here
59 my $conf = new FS::Conf;
60 if($conf->exists('alert_expiration')) {
61 warn "WARNING: the alert_expiration option is obsolete. If you ran
62 freeside-upgrade, it should have configured credit card expiration alerts
63 as billing events.\n";
66 #what to do about the below when using -m? that is the question.
68 #you don't want to skip this, besides, it should be cheap
69 use FS::Cron::expire_user_pref qw(expire_user_pref);
73 use FS::Cron::notify qw(notify_flat_delay);
74 notify_flat_delay(%opt);
78 use FS::Cron::rt_tasks qw(rt_daily);
81 #does nothing unless batch-gateway-* configs are set
82 use FS::Cron::pay_batch qw(pay_batch_submit pay_batch_receive);
83 pay_batch_submit(%opt);
84 pay_batch_receive(%opt);
86 #does nothing unless there are batch-style exports with batches
87 use FS::Cron::export_batch qw(export_batch_submit);
88 export_batch_submit(%opt);
90 #does nothing unless there are users with subscribed searches
91 use FS::Cron::send_subscribed qw(send_subscribed);
92 send_subscribed(%opt);
94 #does nothing unless quotation_disable_after_days is set.
95 use FS::Cron::disable_quotation qw(disable_quotation);
98 #clears out cacti imports & deletes select database cache files
99 use FS::Cron::cleanup qw( cleanup cleanup_before_backup );
100 cleanup_before_backup();
102 #backup should be last
103 #you can skip this just by not having the config (or with the -x option)
104 use FS::Cron::backup qw(backup);
105 backup() unless $opt{'x'};
107 #except we'd rather not start cleanup jobs until the backup is done
108 cleanup( quiet => !$opt{'v'} );
110 $log->info('finish');
117 foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
118 #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
120 $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
126 die "Usage:\n\n freeside-daily [ -d 'date' ] [ -y days ] [ -a agentnum,agentnum,... ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -k ] [ -x ] user [ custnum custnum ... ]\n";
135 freeside-daily - Run daily billing and invoice collection events.
139 freeside-daily [ -d 'date' ] [ -y days ] [ -a agentnum,agentnum,... ] [ -s ] [ -o ] [ -v ] [ -l level ] [ -m [ -q ] [ -r ] ] [ -k ] user [ custnum custnum ... ]
143 Bills customers and runs invoice collection events. Should be run from
146 Bills customers. Searches for customers who are due for billing and calls
147 the bill and collect methods of a cust_main object. See L<FS::cust_main>.
149 -d: Pretend it's 'date'. Date is in any format Date::Parse is happy with,
152 -y: In addition to -d, which specifies an absolute date, the -y switch
153 specifies an offset, in days. For example, "-y 15" would increment the
154 "pretend date" 15 days from whatever was specified by the -d switch
155 (or now, if no -d switch was given).
157 -n: When used with "-d" and/or "-y", specifies that invoices should be dated
158 with today's date, irregardless of the pretend date used to pre-generate
161 -p: Deprecated, will produce a fatal error (formerly was: Only process customers with the specified payby (CARD, DCRD, CHEK, DCHK, BILL, COMP, LECB))
163 -a: Only process customers with the specified agentnum. Multiple agentnums can be specified, separated with commas.
165 -g: Don't process the provided pkgpart (or pkgparts, specified as a comma-
168 -s: re-charge setup fees
170 -o: For packages which are more than one billing period behind, only charge for one billing period rather than catching up.
176 -m: Multi-process mode uses the job queue for multi-process and/or multi-machine billing.
178 -q: When using multi-process mode, queue a additional billing job even if ones for the customer are already in the queue
180 -r: Multi-process mode dry run option
182 -k: skip notify_flat_delay
186 user: Typically "fs_daily"
188 custnum: if one or more customer numbers are specified, only bills those
189 customers. Otherwise, bills all customers.
195 L<FS::cust_main>, config.html from the base documentation