X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2Fbin%2Ffreeside-daily;h=6d4182b79ba02a17fe0561138df77997dd10a3f4;hp=589af8998b2fb0fc12c31e3175b573df2bd85dad;hb=HEAD;hpb=ff0258d05484670831222da23427606f719cc009 diff --git a/FS/bin/freeside-daily b/FS/bin/freeside-daily index 589af8998..6d4182b79 100755 --- a/FS/bin/freeside-daily +++ b/FS/bin/freeside-daily @@ -1,144 +1,109 @@ #!/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 dbdef); +use FS::UID qw(adminsuidsetup); use FS::Conf; -use FS::cust_main; +use FS::Log; &untaint_argv; #what it sounds like (eww) -use vars qw($opt_d $opt_v $opt_p $opt_a $opt_s $opt_y); -getopts("p:a:d:vsy:"); -my $user = shift or die &usage; +use vars qw(%opt); +getopts("p:a:d:vl:sy:nmqrkg:ox", \%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; -$search{'agentnum'} = $opt_a if $opt_a; - -#we're at now now (and later). -my($time)= $opt_d ? str2time($opt_d) : $^T; -$time += $opt_y * 86400 if $opt_y; - -# 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 ) - ) - ) -END - -# or -my $where_bill_event = <<"END"; - 0 < ( select count(*) from cust_bill - where cust_main.custnum = cust_bill.custnum - and 0 < charged - - coalesce( - ( select sum(amount) from cust_bill_pay - where cust_bill.invnum = cust_bill_pay.invnum ) - ,0 - ) - - coalesce( - ( select sum(amount) from cust_credit_bill - where cust_bill.invnum = cust_credit_bill.invnum ) - ,0 - ) - and 0 < ( select count(*) from part_bill_event - where payby = cust_main.payby - and ( disabled is null or disabled = '' ) - and seconds <= $time - cust_bill._date - and 0 = ( select count(*) from cust_bill_event - where cust_bill.invnum = cust_bill_event.invnum - and part_bill_event.eventpart = cust_bill_event.eventpart - and status = 'done' - ) - - ) - ) -END - -my $extra_sql = ( scalar(%search) ? ' AND ' : ' WHERE ' ). "( $where_pkg OR $where_bill_event )"; - -my @cust_main; -if ( @ARGV ) { - @cust_main = map { qsearchs('cust_main', { custnum => $_, %search } ) } @ARGV -} else { - @cust_main = qsearch('cust_main', \%search, '', $extra_sql ); -} -; - -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; - } +die "The -p option has been removed in version 4 -- customers no longer have ". + "a single, specific payment type\n" + if $opt{'p'}; - my $error = $cust_main->bill( 'time' => $time, - 'resetup' => $opt_s, ); - warn "Error billing, custnum ". $cust_main->custnum. ": $error" if $error; +my $log = FS::Log->new('daily'); +$log->info('start'); - $cust_main->apply_payments; - $cust_main->apply_credits; +#you can skip this by not having a NetworkMonitoringSystem configured +use FS::Cron::nms_report qw(nms_report); +nms_report(%opt); - $error = $cust_main->collect( 'invoice_time' => $time ); - warn "Error collecting, custnum". $cust_main->custnum. ": $error" if $error; +#you can skip this by not having any vitelity exports configured +use FS::Cron::lnp_vitelity qw(lnp_vitelity); +lnp_vitelity(%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); -if ( driver_name eq 'Pg' ) { - dbh->{AutoCommit} = 1; #so we can vacuum - foreach my $table ( dbdef->tables ) { - my $sth = dbh->prepare("VACUUM ANALYZE $table") or die dbh->errstr; - $sth->execute or die $sth->errstr; - } -} +#you can skip this by setting the disable_cron_billing config +use FS::Cron::bill qw(bill); +bill(%opt); -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; - } - if ( $conf->config('dump-pgpid') ) { - eval 'use GnuPG'; - my $gpg = new GnuPG; - $gpg->encrypt( plaintext => "/var/tmp/$database.sql", - output => "/var/tmp/$database.gpg", - recipient => $conf->config('dump-pgpid'), - ); - chmod 0600, '/var/tmp/$database.gpg'; - scp("/var/tmp/$database.gpg", $dest); - unlink "/var/tmp/$database.gpg" or die $!; - } else { - chmod 0600, '/var/tmp/$database.sql'; - scp("/var/tmp/$database.sql", $dest); - } - unlink "/var/tmp/$database.sql" or die $!; +#you can skip this by not setting enable_taxproducts to 'billsoft' +use FS::Cron::tax_batch qw(process_tax_batch); +process_tax_batch(%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); + +#what to do about the below when using -m? that is the question. + +#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); } +#same +use FS::Cron::rt_tasks qw(rt_daily); +rt_daily(%opt); + +#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); + +#does nothing unless there are batch-style exports with batches +use FS::Cron::export_batch qw(export_batch_submit); +export_batch_submit(%opt); + +#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(); + +#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( quiet => !$opt{'v'} ); + +$log->info('finish'); + +### # subroutines +### sub untaint_argv { foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV @@ -150,24 +115,26 @@ 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 ] [ -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' ] [ -y days ] [ -p 'payby' ] [ -a agentnum ] [ -s ] [ -v ] user [ custnum custnum ... ] + freeside-daily [ -d 'date' ] [ -y days ] [ -a agentnum,agentnum,... ] [ -s ] [ -o ] [ -v ] [ -l level ] [ -m [ -q ] [ -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. @@ -179,15 +146,36 @@ the bill and collect methods of a cust_main object. See L. "pretend date" 15 days from whatever was specified by the -d switch (or now, if no -d switch was given). - -p: Only process customers with the specified payby (I, I, I, I, I, I, I) + -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. - -a: Only process customers with the specified agentnum + -p: Deprecated, will produce a fatal error (formerly was: 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 -user: From the mapsecrets file - see config.html from the base documentation + -l: debugging level + + -m: Multi-process mode uses the job queue for multi-process and/or multi-machine billing. + + -q: When using multi-process mode, queue a additional billing job even if ones for the customer are already in the queue + + -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.