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);
   8 use FS::Record qw(qsearch qsearchs);
   9 use FS::cust_main;
  10
  11 &untaint_argv;  #what it sounds like  (eww)
  12 use vars qw($opt_d $opt_v);
  13 getopts("d:v");
  14 my $user = shift or die &usage;
  15
  16 adminsuidsetup $user;
  17
  18 $FS::cust_main::Debug = 1 if $opt_v;
  19
  20 my @cust_main = @ARGV
  21   ? map { qsearchs('cust_main', { custnum => $_ } ) } @ARGV
  22   : qsearch('cust_main', {} )
  23 ;
  24
  25 #we're at now now (and later).
  26 my($time)= $opt_d ? str2time($opt_d) : $^T;
  27
  28 my($cust_main,%saw);
  29 foreach $cust_main ( @cust_main ) {
  30
  31   my $error;
  32
  33   $error = $cust_main->bill( 'time' => $time );
  34   warn "Error billing, custnum ". $cust_main->custnum. ": $error" if $error;
  35
  36   $cust_main->apply_payments;
  37   $cust_main->apply_credits;
  38
  39   $error=$cust_main->collect( 'invoice_time' => $time );
  40   warn "Error collecting, custnum". $cust_main->custnum. ": $error" if $error;
  41
  42 }
  43
  44 # subroutines
  45
  46 sub untaint_argv {
  47   foreach $_ ( $[ .. $#ARGV ) { #untaint @ARGV
  48     #$ARGV[$_] =~ /^([\w\-\/]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
  49     # Date::Parse
  50     $ARGV[$_] =~ /^(.*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
  51     $ARGV[$_]=$1;
  52   }
  53 }
  54
  55 sub usage {
  56   die "Usage:\n\n  freeside-daily [ -d 'date' ] user [ custnum custnum ... ]\n";
  57 }
  58
  59 =head1 NAME
  60
  61 freeside-daily - Run daily billing and invoice collection events.
  62
  63 =head1 SYNOPSIS
  64
  65   freeside-daily [ -d 'date' ] user [ custnum custnum ... ]
  66
  67 =head1 DESCRIPTION
  68
  69 Bills customers and runs invoice collection events.  Should be run from
  70 crontab daily.
  71
  72 This script replaces freeside-bill from 1.3.1.
  73
  74 Bills customers.  Searches for customers who are due for billing and calls
  75 the bill and collect methods of a cust_main object.  See L<FS::cust_main>.
  76
  77   -d: Pretend it's 'date'.  Date is in any format Date::Parse is happy with,
  78       but be careful.
  79
  80 user: From the mapsecrets file - see config.html from the base documentation
  81
  82 custnum: if one or more customer numbers are specified, only bills those
  83 customers.  Otherwise, bills all customers.
  84
  85 =head1 BUGS
  86
  87 =head1 SEE ALSO
  88
  89 L<FS::cust_main>, config.html from the base documentation
  90
  91 =cut
  92