X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2Fbin%2Ffreeside-daily;h=5276a2ff0472556a906d94f157616c1a0776873a;hp=142b0c73ae37ef2757e3d1743ac12c1ebed74166;hb=0f9f314fa40adf66b672065f8f3477789c50ae56;hpb=6414c4c23d3fac2012d1524f17c0aae5e5012935 diff --git a/FS/bin/freeside-daily b/FS/bin/freeside-daily index 142b0c73a..5276a2ff0 100755 --- a/FS/bin/freeside-daily +++ b/FS/bin/freeside-daily @@ -1,54 +1,108 @@ #!/usr/bin/perl -w use strict; -use Fcntl qw(:flock); -use Date::Parse; use Getopt::Std; -use FS::UID qw(adminsuidsetup driver_name dbh); -use FS::Record qw(qsearch qsearchs); -use FS::cust_main; +use FS::UID qw(adminsuidsetup); +use FS::Conf; +use FS::Log; &untaint_argv; #what it sounds like (eww) -use vars qw($opt_d $opt_v); -getopts("d:v"); -my $user = shift or die &usage; +use vars qw(%opt); +getopts("p:a:d:vl:sy:nmrkg:ox", \%opt); +my $user = shift or die &usage; adminsuidsetup $user; +my $log = FS::Log->new('daily'); +$log->info('start'); + +#you can skip this by not having a NetworkMonitoringSystem configured +use FS::Cron::nms_report qw(nms_report); +nms_report(%opt); + +#no way to skip this yet, but should be harmless/quick +use FS::Cron::expire_banned_pay qw(expire_banned_pay); +expire_banned_pay(%opt); + +#you can skip this by setting the disable_cron_billing config +use FS::Cron::bill qw(bill); +bill(%opt); + +#you can skip this just by not having the config +use FS::Cron::breakage qw(reconcile_breakage); +reconcile_breakage(%opt); + +#you can skip this just by not having the config +use FS::Cron::upload qw(upload); +upload(%opt); + +#this only takes effect if WA sales taxes are enabled +use FS::Cron::tax_rate_update qw(tax_rate_update); +tax_rate_update(%opt); + +use FS::Cron::set_lata_have_usage qw(set_lata_have_usage); +set_lata_have_usage(%opt); + +# we used to send alerts about upcoming credit card expiration here +my $conf = new FS::Conf; +if($conf->exists('alert_expiration')) { + warn "WARNING: the alert_expiration option is obsolete. If you ran + freeside-upgrade, it should have configured credit card expiration alerts + as billing events.\n"; +} -$FS::cust_main::Debug = 1 if $opt_v; +#what to do about the below when using -m? that is the question. -my @cust_main = @ARGV - ? map { qsearchs('cust_main', { custnum => $_ } ) } @ARGV - : qsearch('cust_main', {} ) -; +#you don't want to skip this, besides, it should be cheap +use FS::Cron::expire_user_pref qw(expire_user_pref); +expire_user_pref(); -#we're at now now (and later). -my($time)= $opt_d ? str2time($opt_d) : $^T; +unless ( $opt{k} ) { + use FS::Cron::notify qw(notify_flat_delay); + notify_flat_delay(%opt); +} -my($cust_main,%saw); -foreach $cust_main ( @cust_main ) { +#same +use FS::Cron::rt_tasks qw(rt_daily); +rt_daily(%opt); - my $error; +#does nothing unless batch-gateway-* configs are set +use FS::Cron::pay_batch qw(pay_batch_submit pay_batch_receive); +pay_batch_submit(%opt); +pay_batch_receive(%opt); - $error = $cust_main->bill( 'time' => $time ); - warn "Error billing, custnum ". $cust_main->custnum. ": $error" if $error; +#does nothing unless there are batch-style exports with batches +use FS::Cron::export_batch qw(export_batch_submit); +export_batch_submit(%opt); - $cust_main->apply_payments; - $cust_main->apply_credits; +#you can skip this by not having the config +use FS::Cron::agent_email qw(agent_email); +agent_email(%opt); - $error=$cust_main->collect( 'invoice_time' => $time ); - warn "Error collecting, custnum". $cust_main->custnum. ": $error" if $error; +#does nothing unless there are users with subscribed searches +use FS::Cron::send_subscribed qw(send_subscribed); +send_subscribed(%opt); -} +#does nothing unless quotation_disable_after_days is set. +use FS::Cron::disable_quotation qw(disable_quotation); +disable_quotation(); -if ( driver_name eq 'Pg' ) { - foreach my $statement ( 'vacuum', 'vacuum analyze' ) { - my $sth = dbh->prepare($statement) or die dbh->errstr; - $sth->execute or die $sth->errstr; - } -} +#clears out cacti imports & deletes select database cache files +use FS::Cron::cleanup qw( cleanup cleanup_before_backup ); +cleanup_before_backup(); +#backup should be last +#you can skip this just by not having the config (or with the -x option) +use FS::Cron::backup qw(backup); +backup() unless $opt{'x'}; + +#except we'd rather not start cleanup jobs until the backup is done +cleanup(); + +$log->info('finish'); + +### # subroutines +### sub untaint_argv { foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV @@ -60,31 +114,65 @@ sub untaint_argv { } sub usage { - die "Usage:\n\n freeside-daily [ -d 'date' ] user [ custnum custnum ... ]\n"; + die "Usage:\n\n freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum,agentnum,... ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -k ] [ -x ] user [ custnum custnum ... ]\n"; } +### +# documentation +### + =head1 NAME freeside-daily - Run daily billing and invoice collection events. =head1 SYNOPSIS - freeside-daily [ -d 'date' ] user [ custnum custnum ... ] + freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum,agentnum,... ] [ -s ] [ -o ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ] =head1 DESCRIPTION Bills customers and runs invoice collection events. Should be run from crontab daily. -This script replaces freeside-bill from 1.3.1. - Bills customers. Searches for customers who are due for billing and calls the bill and collect methods of a cust_main object. See L. -d: Pretend it's 'date'. Date is in any format Date::Parse is happy with, but be careful. -user: From the mapsecrets file - see config.html from the base documentation + -y: In addition to -d, which specifies an absolute date, the -y switch + specifies an offset, in days. For example, "-y 15" would increment the + "pretend date" 15 days from whatever was specified by the -d switch + (or now, if no -d switch was given). + + -n: When used with "-d" and/or "-y", specifies that invoices should be dated + with today's date, irregardless of the pretend date used to pre-generate + the invoices. + + -p: Only process customers with the specified payby (CARD, DCRD, CHEK, DCHK, BILL, COMP, LECB) + + -a: Only process customers with the specified agentnum. Multiple agentnums can be specified, separated with commas. + + -g: Don't process the provided pkgpart (or pkgparts, specified as a comma- + separated list). + + -s: re-charge setup fees + + -o: For packages which are more than one billing period behind, only charge for one billing period rather than catching up. + + -v: enable debugging + + -l: debugging level + + -m: Multi-process mode uses the job queue for multi-process and/or multi-machine billing. + + -r: Multi-process mode dry run option + + -k: skip notify_flat_delay + + -x: skip backup + +user: Typically "fs_daily" custnum: if one or more customer numbers are specified, only bills those customers. Otherwise, bills all customers.