FS/bin/freeside-daily

   1 #!/usr/bin/perl -w
   2
   3 use strict;
   4 use Fcntl qw(:flock);
   5 use Date::Parse;
   6 use Getopt::Std;
   7 use FS::UID qw(adminsuidsetup driver_name dbh datasrc);
   8 use FS::Record qw(qsearch qsearchs);
   9 use FS::Conf;
  10 use FS::cust_main;
  11
  12 &untaint_argv;  #what it sounds like  (eww)
  13 use vars qw($opt_d $opt_v $opt_p $opt_s);
  14 getopts("p:d:vs");
  15 my $user = shift or die &usage;
  16
  17 adminsuidsetup $user;
  18
  19 $FS::cust_main::Debug = 1 if $opt_v;
  20
  21 my %search;
  22 $search{'payby'} = $opt_p if $opt_p;
  23
  24 my @cust_main = @ARGV
  25   ? map { qsearchs('cust_main', { custnum => $_, %search } ) } @ARGV
  26   : qsearch('cust_main', \%search )
  27 ;
  28
  29 #we're at now now (and later).
  30 my($time)= $opt_d ? str2time($opt_d) : $^T;
  31
  32 my($cust_main,%saw);
  33 foreach $cust_main ( @cust_main ) {
  34
  35   # $^T not $time because -d is for pre-printing invoices
  36   foreach my $cust_pkg (
  37     grep { $_->expire && $_->expire <= $^T } $cust_main->ncancelled_pkgs
  38   ) {
  39     my $error = $cust_pkg->cancel;
  40     warn "Error cancelling expired pkg ". $cust_pkg->pkgnum. " for custnum ".
  41          $cust_main->custnum. ": $error"
  42       if $error;
  43   }
  44
  45   my $error = $cust_main->bill( 'time'    => $time,
  46                                 'resetup' => $opt_s, );
  47   warn "Error billing, custnum ". $cust_main->custnum. ": $error" if $error;
  48
  49   $cust_main->apply_payments;
  50   $cust_main->apply_credits;
  51
  52   $error = $cust_main->collect( 'invoice_time' => $time );
  53   warn "Error collecting, custnum". $cust_main->custnum. ": $error" if $error;
  54
  55 }
  56
  57 if ( driver_name eq 'Pg' ) {
  58   dbh->{AutoCommit} = 1; #so we can vacuum
  59   foreach my $statement ( 'vacuum', 'vacuum analyze' ) {
  60     my $sth = dbh->prepare($statement) or die dbh->errstr;
  61     $sth->execute or die $sth->errstr;
  62   }
  63 }
  64
  65 #local hack
  66 my $conf = new FS::Conf;
  67 my $dest = $conf->config('dump-scpdest');
  68 if ( $dest ) {
  69   datasrc =~ /dbname=([\w\.]+)$/ or die "unparsable datasrc ". datasrc;
  70   my $database = $1;
  71   eval "use Net::SCP qw(scp);";
  72   if ( driver_name eq 'Pg' ) {
  73     system("pg_dump $database >/var/tmp/$database.sql")
  74   } else {
  75     die "database dumps not yet supported for ". driver_name;
  76   }
  77   scp("/var/tmp/$database.sql", $dest);
  78   unlink "/var/tmp/$database.sql" or die $!;
  79 }
  80
  81 # subroutines
  82
  83 sub untaint_argv {
  84   foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
  85     #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
  86     # Date::Parse
  87     $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
  88     $ARGV[$_]=$1;
  89   }
  90 }
  91
  92 sub usage {
  93   die "Usage:\n\n  freeside-daily [ -d 'date' ] user [ custnum custnum ... ]\n";
  94 }
  95
  96 =head1 NAME
  97
  98 freeside-daily - Run daily billing and invoice collection events.
  99
 100 =head1 SYNOPSIS
 101
 102   freeside-daily [ -d 'date' ] [ -p 'payby' ] [ -s ] [ -v ] user [ custnum custnum ... ]
 103
 104 =head1 DESCRIPTION
 105
 106 Bills customers and runs invoice collection events.  Should be run from
 107 crontab daily.
 108
 109 This script replaces freeside-bill from 1.3.1.
 110
 111 Bills customers.  Searches for customers who are due for billing and calls
 112 the bill and collect methods of a cust_main object.  See L<FS::cust_main>.
 113
 114   -d: Pretend it's 'date'.  Date is in any format Date::Parse is happy with,
 115       but be careful.
 116
 117   -p: Only process customers with the specified payby (I<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)
 118
 119   -s: re-charge setup fees
 120
 121   -v: enable debugging
 122
 123 user: From the mapsecrets file - see config.html from the base documentation
 124
 125 custnum: if one or more customer numbers are specified, only bills those
 126 customers.  Otherwise, bills all customers.
 127
 128 =head1 BUGS
 129
 130 =head1 SEE ALSO
 131
 132 L<FS::cust_main>, config.html from the base documentation
 133
 134 =cut
 135