X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2Fbin%2Ffreeside-daily;h=271c436c6a71988ffcccd1934b3ed32ed7b37b30;hb=45a4c5ad153a132ab392d71ca7cffbd08ff3c9c2;hp=8d839cb210f4ea2a9433b9a3f7a4c194f814bdca;hpb=7e3eb82f87c371785544b706b7347c7edde2b593;p=freeside.git diff --git a/FS/bin/freeside-daily b/FS/bin/freeside-daily index 8d839cb21..271c436c6 100755 --- a/FS/bin/freeside-daily +++ b/FS/bin/freeside-daily @@ -1,45 +1,48 @@ #!/usr/bin/perl -w use strict; -use Fcntl qw(:flock); -use Date::Parse; use Getopt::Std; use FS::UID qw(adminsuidsetup); -use FS::Record qw(qsearch qsearchs); -use FS::cust_main; +use FS::Conf; &untaint_argv; #what it sounds like (eww) -use vars qw($opt_d); -getopts("d:"); -my $user = shift or die &usage; +use vars qw(%opt); +getopts("p:a:d:vl:sy:nmrk", \%opt); +my $user = shift or die &usage; adminsuidsetup $user; -my @cust_main = @ARGV - ? map { qsearchs('cust_main', { custnum => $_ } ) } @ARGV - : qsearch('cust_main', {} ) -; +use FS::Cron::bill qw(bill); +bill(%opt); -#we're at now now (and later). -my($time)= $opt_d ? str2time($opt_d) : $^T; +# Send alerts about upcoming credit card expiration. +use FS::Cron::alert_expiration qw(alert_expiration); +my $conf = new FS::Conf; +alert_expiration(%opt) if($conf->exists('alert_expiration')); -my($cust_main,%saw); -foreach $cust_main ( @cust_main ) { +#what to do about the below when using -m? that is the question. - my $error; +#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(); - $error = $cust_main->bill( 'time' => $time ); - warn "Error billing, custnum ". $cust_main->custnum. ": $error" if $error; +unless ( $opt{k} ) { - $cust_main->apply_payments; - $cust_main->apply_credits; + use FS::Cron::notify qw(notify_flat_delay); + notify_flat_delay(%opt); - $error=$cust_main->collect( 'invoice_time' => $time ); - warn "Error collecting, custnum". $cust_main->custnum. ": $error" if $error; + use FS::Cron::vacuum qw(vacuum); + vacuum(); } +#you can skip this just by not having the config +use FS::Cron::backup qw(backup_scp); +backup_scp(); + +### # subroutines +### sub untaint_argv { foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV @@ -51,30 +54,57 @@ 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 ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -k ] 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 ] [ -s ] [ -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. + -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 (I, I, I, I, I, I, I) + + -a: Only process customers with the specified agentnum + + -s: re-charge setup fees + + -v: enable debugging + + -l: debugging level + + -m: Experimental 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 and vacuum + user: From the mapsecrets file - see config.html from the base documentation custnum: if one or more customer numbers are specified, only bills those