event refactor, landing on HEAD!

[freeside.git] / FS / bin / freeside-daily

diff --git a/FS/bin/freeside-daily b/FS/bin/freeside-daily
index 579d071..f0ec9f0 100755 (executable)
--- a/FS/bin/freeside-daily
+++ b/FS/bin/freeside-daily
@@ -1,83 +1,36 @@
 #!/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::Conf;
-use FS::cust_main;
+use FS::UID qw(adminsuidsetup);
 
 &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:n", \%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;
+use FS::Cron::bill qw(bill);
+bill(%opt);
 
-my @cust_main = @ARGV
-  ? map { qsearchs('cust_main', { custnum => $_, %search } ) } @ARGV
-  : qsearch('cust_main', \%search )
-;
+#what to do about the below when using -m?  that is the question.
 
-#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;
-  }
+use FS::Cron::notify qw(notify_flat_delay);
+notify_flat_delay(%opt);
 
-  my $error = $cust_main->bill( 'time' => $time );
-  warn "Error billing, custnum ". $cust_main->custnum. ": $error" if $error;
+use FS::Cron::expire_user_pref qw(expire_user_pref);
+expire_user_pref();
 
-  $cust_main->apply_payments;
-  $cust_main->apply_credits;
-
-  $error = $cust_main->collect( 'invoice_time' => $time );
-  warn "Error collecting, custnum". $cust_main->custnum. ": $error" if $error;
-
-}
-
-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;
-  }
-}
+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 $!;
-}
+use FS::Cron::backup qw(backup_scp);
+backup_scp();
 
+###
 # subroutines
+###
 
 sub untaint_argv {
   foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
@@ -92,31 +45,50 @@ sub usage {
   die "Usage:\n\n  freeside-daily [ -d 'date' ] 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 ] [ -s ] [ -v ] [ -l level ] 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<FS::cust_main>.
 
   -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 (CARD, CHEK, BILL, COMP, LECB)
+  -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<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)
+
+  -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.
+
 user: From the mapsecrets file - see config.html from the base documentation
 
 custnum: if one or more customer numbers are specified, only bills those