X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2FCron%2Fbill.pm;h=30eb1ab281d9d21ac2deebc3467ac6df7cb9e997;hp=1a6c4a7f5c1782475f48ce10c12668236d661e30;hb=2cdb0b3f9e3b778fd914d847fc7851948a9930e4;hpb=0cd9e13c265f6acc6b2cccf58af54c445100e4d0 diff --git a/FS/FS/Cron/bill.pm b/FS/FS/Cron/bill.pm index 1a6c4a7f5..30eb1ab28 100644 --- a/FS/FS/Cron/bill.pm +++ b/FS/FS/Cron/bill.pm @@ -4,115 +4,279 @@ use strict; use vars qw( @ISA @EXPORT_OK ); use Exporter; use Date::Parse; -use FS::Record qw(qsearch qsearchs); +use DBI 1.33; #The "clone" method was added in DBI 1.33. +use FS::UID qw( dbh driver_name ); +use FS::Record qw( qsearch qsearchs ); +use FS::Misc::DateTime qw( day_end ); +use FS::queue; use FS::cust_main; use FS::part_event; use FS::part_event_condition; +use FS::Log; + @ISA = qw( Exporter ); -@EXPORT_OK = qw ( bill ); +@EXPORT_OK = qw ( bill bill_where ); -sub bill { +#freeside-daily %opt: +# -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 +# -g: Don't bill these pkgparts +sub bill { my %opt = @_; + my $log = FS::Log->new('Cron::bill'); + $log->info('start'); + my $check_freq = $opt{'check_freq'} || '1d'; - $FS::cust_main::DEBUG = 1 if $opt{'v'}; - $FS::cust_main::DEBUG = $opt{'l'} if $opt{'l'}; + my $debug = 0; + $debug = 1 if $opt{'v'}; + $debug = $opt{'l'} if $opt{'l'}; + $FS::cust_main::DEBUG = $debug; #$FS::cust_event::DEBUG = $opt{'l'} if $opt{'l'}; - - my %search = (); - $search{'payby'} = $opt{'p'} if $opt{'p'}; - $search{'agentnum'} = $opt{'a'} if $opt{'a'}; - + + my $conf = new FS::Conf; + my $disable_bill = 0; + if ( $conf->exists('disable_cron_billing') ) { + warn "disable_cron_billing set, skipping billing\n" if $debug; + $disable_bill = 1; + } + #we're at now now (and later). - my($time)= $opt{'d'} ? str2time($opt{'d'}) : $^T; - $time += $opt{'y'} * 86400 if $opt{'y'}; + $opt{'time'} = $opt{'d'} ? str2time($opt{'d'}) : $^T; + $opt{'time'} += $opt{'y'} * 86400 if $opt{'y'}; + + $opt{'invoice_time'} = $opt{'n'} ? $^T : $opt{'time'}; + + #hashref here doesn't work with -m + #my $not_pkgpart = $opt{g} ? { map { $_=>1 } split(/,\s*/, $opt{g}) } + # : {}; + + ### + # get a list of custnums + ### + + my $cursor_dbh = dbh->clone; + + my $select = 'SELECT custnum FROM cust_main WHERE '. bill_where( %opt ); + + unless ( driver_name =~ /^mysql/ ) { + $cursor_dbh->do( "DECLARE cron_bill_cursor CURSOR FOR $select" ) + or die $cursor_dbh->errstr; + } + + while ( 1 ) { + + my $sql = (driver_name =~ /^mysql/) + ? $select + : 'FETCH 100 FROM cron_bill_cursor'; + + my $sth = $cursor_dbh->prepare($sql); + + $sth->execute or die $sth->errstr; + + my @custnums = map { $_->[0] } @{ $sth->fetchall_arrayref }; + + last unless scalar(@custnums); + + ### + # for each custnum, queue or make one customer object and bill + # (one at a time, to reduce memory footprint with large #s of customers) + ### + + foreach my $custnum ( @custnums ) { + + my %args = ( + 'time' => $opt{'time'}, + 'invoice_time' => $opt{'invoice_time'}, + 'actual_time' => $^T, #when freeside-bill was started + #(not, when using -m, freeside-queued) + 'check_freq' => $check_freq, + 'resetup' => ( $opt{'s'} ? $opt{'s'} : 0 ), + 'not_pkgpart' => $opt{'g'}, #$not_pkgpart, + 'one_recur' => $opt{'o'}, + 'no_prepaid' => 1, + ); + + if ( $opt{'m'} ) { + + if ( $opt{'r'} ) { + warn "DRY RUN: would add custnum $custnum for queued_bill\n"; + } else { + + #avoid queuing another job if there's one still waiting to run + next if qsearch( 'queue', { 'job' => 'FS::cust_main::queued_bill', + 'custnum' => $custnum, + 'status' => 'new', + } + ); + + #add job to queue that calls bill_and_collect with options + my $queue = new FS::queue { + 'job' => 'FS::cust_main::queued_bill', + 'secure' => 'Y', + 'priority' => 99, #don't get in the way of provisioning jobs + }; + my $error = $queue->insert( 'custnum'=>$custnum, %args ); + die $error if $error; + } + + } else { + + my $cust_main = qsearchs( 'cust_main', { 'custnum' => $custnum } ); + if ( $disable_bill ) { + $cust_main->collect( %args, 'debug' => $debug ); + } else { + my $error = $cust_main->bill_and_collect( %args, 'fatal' => 'return', + 'debug' => $debug, ); + if ( $error ) { + $log->error($error); + warn $error; #die $error; + } + } + + } + + } + + last if driver_name =~ /^mysql/; + + } - my $invoice_time = $opt{'n'} ? $^T : $time; + $cursor_dbh->commit or die $cursor_dbh->errstr; + $log->info('finish'); +} + +# freeside-daily %opt: +# -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, regardless of the pretend date used to pre-generate +# the invoices. +# +# -a: Only process customers with the specified agentnum +# +# -v: enable debugging +# +# -l: debugging level + +=item bill_where + +Internal function. Returns a WHERE clause to select the set of customers who +have actionable packages (no setup date, or bill date in the past, or expire +or adjourn dates in the past) or events (does a complete where_conditions_sql +scan). + +=cut + +sub bill_where { + my( %opt ) = @_; + + my $time = $opt{'time'}; + my $invoice_time = $opt{'invoice_time'}; + + my $check_freq = $opt{'check_freq'} || '1d'; + + my @search = (); + + push @search, "( cust_main.archived != 'Y' OR archived IS NULL )"; #disable? + + push @search, "cust_main.agentnum IN ( ". $opt{'a'}. " ) " + if $opt{'a'}; + + #it would be useful if i recognized $opt{g} / $not_pkgpart... + + if ( @ARGV ) { + push @search, "( ". + join(' OR ', map "cust_main.custnum = $_", @ARGV ). + " )"; + } + + ### + # generate where_pkg/where_event search clause + ### + + my $conf = new FS::Conf; + my $billtime = $conf->exists('next-bill-ignore-time') ? day_end($time) : $time; + + # corresponds to perl checks in FS::cust_main::Billing sub bill + # ("bill setup" and "bill recurring fee") # select * from cust_main where my $where_pkg = <<"END"; - 0 < ( select count(*) from cust_pkg - where cust_main.custnum = cust_pkg.custnum - and ( cancel is null or cancel = 0 ) - and ( setup is null or setup = 0 - or bill is null or bill <= $time - or ( expire is not null and expire <= $^T ) - or ( adjourn is not null and adjourn <= $^T ) - ) - ) + EXISTS( + SELECT 1 FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart ) + WHERE cust_main.custnum = cust_pkg.custnum + AND ( cancel IS NULL OR cancel = 0 ) + AND ( ( ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 ) + AND ( start_date IS NULL OR start_date = 0 + OR ( start_date IS NOT NULL AND start_date <= $billtime ) + ) + ) + OR ( freq != '0' AND ( bill IS NULL OR bill <= $billtime ) ) + OR ( expire IS NOT NULL AND expire <= $^T ) + OR ( adjourn IS NOT NULL AND adjourn <= $^T ) + OR ( resume IS NOT NULL AND resume <= $^T ) + ) + ) END + #some false laziness w/cust_main::Billing due_cust_event my $where_event = join(' OR ', map { my $eventtable = $_; - my $join = FS::part_event_condition->join_conditions_sql( $eventtable ); + # joins and where clauses to test event conditions + my $join = FS::part_event_condition->join_conditions_sql( $eventtable, + 'time'=>$time ); my $where = FS::part_event_condition->where_conditions_sql( $eventtable, 'time'=>$time, ); + $where = $where ? "AND $where" : ''; + # test to return all applicable part_events (defined on this eventtable, + # not disabled, check_freq correct, and all event conditions true) my $are_part_event = - "0 < ( SELECT COUNT(*) FROM part_event $join - WHERE check_freq = '$check_freq' - AND eventtable = '$eventtable' - AND ( disabled = '' OR disabled IS NULL ) - AND $where - ) + "EXISTS ( SELECT 1 FROM part_event $join + WHERE check_freq = '$check_freq' + AND eventtable = '$eventtable' + AND ( disabled = '' OR disabled IS NULL ) + $where + ) "; if ( $eventtable eq 'cust_main' ) { $are_part_event; } else { - "0 < ( SELECT COUNT(*) FROM $eventtable - WHERE cust_main.custnum = $eventtable.custnum - AND $are_part_event - ) + my $cust_join = FS::part_event->eventtables_cust_join->{$eventtable} + || ''; + my $custnum = FS::part_event->eventtables_custnum->{$eventtable}; + "EXISTS ( SELECT 1 FROM $eventtable $cust_join + WHERE cust_main.custnum = $custnum + AND $are_part_event + ) "; } } FS::part_event->eventtables); - my $extra_sql = ( scalar(%search) ? ' AND ' : ' WHERE ' ). - "( $where_pkg OR $where_event )"; + push @search, "( $where_pkg OR $where_event )"; - my @cust_main; - if ( @ARGV ) { - @cust_main = map { qsearchs('cust_main', { custnum => $_, %search } ) } @ARGV - } else { + warn "searching for customers:\n". join("\n", @search). "\n" + if $opt{'v'} || $opt{'l'}; - warn "searching for customers:\n". - join("\n", map " $_ => ".$search{$_}, keys %search). "\n". - " $extra_sql\n" - if $opt{'v'} || $opt{'l'}; - - @cust_main = qsearch({ - 'table' => 'cust_main', - 'hashref' => \%search, - 'extra_sql' => $extra_sql, - }); - - } - - foreach my $cust_main ( @cust_main ) { - - if ( $opt{'m'} ) { - - die "XXX multi-process mode not yet completed"; - #add job to queue that calls bill_and_collect with options - - } else { - - $cust_main->bill_and_collect( - 'time' => $time, - 'invoice_time' => $invoice_time, - 'check_freq' => $check_freq, - 'resetup' => $opt{'s'}, - ); - - } - - } + join(' AND ', @search); } + +1;