X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2Fbin%2Ffreeside-daily;h=6a542c7cd3aeaf878072c7161818623eb069353c;hp=63e621b575fa5a111dd9a72df0c1c1d853e629d4;hb=74e058c8a010ef6feb539248a550d0bb169c1e94;hpb=0ebeec96313dd7edfca340f01f8fbbbac1f4aa1d diff --git a/FS/bin/freeside-daily b/FS/bin/freeside-daily index 63e621b57..6a542c7cd 100755 --- a/FS/bin/freeside-daily +++ b/FS/bin/freeside-daily @@ -1,83 +1,58 @@ #!/usr/bin/perl -w use strict; -use Fcntl qw(:flock); -use Date::Parse; use Getopt::Std; -use FS::UID qw(adminsuidsetup driver_name dbh datasrc); -use FS::Record qw(qsearch qsearchs); +use FS::UID qw(adminsuidsetup); use FS::Conf; -use FS::cust_main; &untaint_argv; #what it sounds like (eww) -use vars qw($opt_d $opt_v $opt_p); -getopts("p:d:v"); -my $user = shift or die &usage; +use vars qw(%opt); +getopts("p:a:d:vl:sy:nmrkg:u", \%opt); +my $user = shift or die &usage; adminsuidsetup $user; -$FS::cust_main::Debug = 1 if $opt_v; - -my %search; -$search{'payby'} = $opt_p if $opt_p; +#you can skip this by setting the disable_cron_billing config +use FS::Cron::bill qw(bill); +bill(%opt); -my @cust_main = @ARGV - ? map { qsearchs('cust_main', { custnum => $_, %search } ) } @ARGV - : qsearch('cust_main', \%search ) -; +#you can skip this just by not having the config +use FS::Cron::breakage qw(reconcile_breakage); +reconcile_breakage(%opt); -#we're at now now (and later). -my($time)= $opt_d ? str2time($opt_d) : $^T; - -my($cust_main,%saw); -foreach $cust_main ( @cust_main ) { - - # $^T not $time because -d is for pre-printing invoices - foreach my $cust_pkg ( - grep { $_->expire && $_->expire <= $^T } $cust_main->ncancelled_pkgs - ) { - my $error = $cust_pkg->cancel; - warn "Error cancelling expired pkg ". $cust_pkg->pkgnum. " for custnum ". - $cust_main->custnum. ": $error" - if $error; - } +#you can skip this just by not having the config +use FS::Cron::upload qw(upload); +upload(%opt); - my $error = $cust_main->bill( 'time' => $time ); - warn "Error billing, custnum ". $cust_main->custnum. ": $error" if $error; +# 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')); - $cust_main->apply_payments; - $cust_main->apply_credits; +#what to do about the below when using -m? that is the question. - $error = $cust_main->collect( 'invoice_time' => $time ); - warn "Error collecting, custnum". $cust_main->custnum. ": $error" if $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(); +unless ( $opt{k} ) { + use FS::Cron::notify qw(notify_flat_delay); + notify_flat_delay(%opt); } -if ( driver_name eq 'Pg' ) { - dbh->{AutoCommit} = 1; #so we can vacuum - foreach my $statement ( 'vacuum', 'vacuum analyze' ) { - my $sth = dbh->prepare($statement) or die dbh->errstr; - $sth->execute or die $sth->errstr; - } +#debian Pg 8.1+ auto-vaccums, 7.4 w/postgresql-contrib +if ( $opt{u} ) { + use FS::Cron::vacuum qw(vacuum); + vacuum(); } -#local hack -my $conf = new FS::Conf; -my $dest = $conf->config('dump-scpdest'); -if ( $dest ) { - datasrc =~ /dbname=([\w\.]+)$/ or die "unparsable datasrc ". datasrc; - my $database = $1; - eval "use Net::SCP qw(scp);"; - if ( driver_name eq 'Pg' ) { - system("pg_dump $database >/var/tmp/$database.sql") - } else { - die "database dumps not yet supported for ". driver_name; - } - scp("/var/tmp/$database.sql", $dest); - unlink "/var/tmp/$database.sql" or die $!; -} +#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 @@ -89,34 +64,62 @@ 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 ] user [ custnum custnum ... ]\n"; } +### +# documentation +### + =head1 NAME freeside-daily - Run daily billing and invoice collection events. =head1 SYNOPSIS - freeside-daily [ -d 'date' ] [ -p 'payby' ] [ -v ] user [ custnum custnum ... ] + freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum,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. - -p: Only process customers with the specified payby (I, I, I, I, I, I, I) + -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 -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 + + -u: Do a vacuum (starting with version 1.9, this is not run by default). + user: From the mapsecrets file - see config.html from the base documentation custnum: if one or more customer numbers are specified, only bills those