FS/FS/Cron/bill.pm

   1 package FS::Cron::bill;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK );
   5 use Exporter;
   6 use Date::Parse;
   7 use DBI 1.33; #The "clone" method was added in DBI 1.33.
   8 use FS::UID qw(dbh);
   9 use FS::Record qw( qsearch qsearchs );
  10 use FS::queue;
  11 use FS::cust_main;
  12 use FS::part_event;
  13 use FS::part_event_condition;
  14
  15 @ISA = qw( Exporter );
  16 @EXPORT_OK = qw ( bill bill_where );
  17
  18 #freeside-daily %opt:
  19 #  -s: re-charge setup fees
  20 #  -v: enable debugging
  21 #  -l: debugging level
  22 #  -m: Experimental multi-process mode uses the job queue for multi-process and/or multi-machine billing.
  23 #  -r: Multi-process mode dry run option
  24 #  -g: Don't bill these pkgparts
  25
  26 sub bill {
  27   my %opt = @_;
  28
  29   my $check_freq = $opt{'check_freq'} || '1d';
  30
  31   my $debug = 0;
  32   $debug = 1 if $opt{'v'};
  33   $debug = $opt{'l'} if $opt{'l'};
  34   $FS::cust_main::DEBUG = $debug;
  35   #$FS::cust_event::DEBUG = $opt{'l'} if $opt{'l'};
  36
  37   #we're at now now (and later).
  38   $opt{'time'} = $opt{'d'} ? str2time($opt{'d'}) : $^T;
  39   $opt{'time'} += $opt{'y'} * 86400 if $opt{'y'};
  40
  41   $opt{'invoice_time'} = $opt{'n'} ? $^T : $opt{'time'};
  42
  43   #hashref here doesn't work with -m
  44   #my $not_pkgpart = $opt{g} ? { map { $_=>1 } split(/,\s*/, $opt{g}) }
  45   #                          : {};
  46
  47   ###
  48   # get a list of custnums
  49   ###
  50
  51   my $cursor_dbh = dbh->clone;
  52
  53   $cursor_dbh->do(
  54     "DECLARE cron_bill_cursor CURSOR FOR ".
  55     "  SELECT custnum FROM cust_main WHERE ". bill_where( %opt )
  56   ) or die $cursor_dbh->errstr;
  57
  58   while ( 1 ) {
  59
  60     my $sth = $cursor_dbh->prepare('FETCH 100 FROM cron_bill_cursor'); #mysql?
  61
  62     $sth->execute or die $sth->errstr;
  63
  64     my @custnums = map { $_->[0] } @{ $sth->fetchall_arrayref };
  65
  66     last unless scalar(@custnums);
  67
  68     ###
  69     # for each custnum, queue or make one customer object and bill
  70     # (one at a time, to reduce memory footprint with large #s of customers)
  71     ###
  72
  73     foreach my $custnum ( @custnums ) {
  74
  75       my %args = (
  76           'time'         => $opt{'time'},
  77           'invoice_time' => $opt{'invoice_time'},
  78           'actual_time'  => $^T, #when freeside-bill was started
  79                                  #(not, when using -m, freeside-queued)
  80           'check_freq'   => $check_freq,
  81           'resetup'      => ( $opt{'s'} ? $opt{'s'} : 0 ),
  82           'not_pkgpart'  => $opt{'g'}, #$not_pkgpart,
  83       );
  84
  85       if ( $opt{'m'} ) {
  86
  87         if ( $opt{'r'} ) {
  88           warn "DRY RUN: would add custnum $custnum for queued_bill\n";
  89         } else {
  90
  91           #avoid queuing another job if there's one still waiting to run
  92           next if qsearch( 'queue', { 'job'     => 'FS::cust_main::queued_bill',
  93                                       'custnum' => $custnum,
  94                                       'status'  => 'new',
  95                                     }
  96                          );
  97
  98           #add job to queue that calls bill_and_collect with options
  99           my $queue = new FS::queue {
 100             'job'      => 'FS::cust_main::queued_bill',
 101             'secure'   => 'Y',
 102             'priority' => 99, #don't get in the way of provisioning jobs
 103           };
 104           my $error = $queue->insert( 'custnum'=>$custnum, %args );
 105
 106         }
 107
 108       } else {
 109
 110         my $cust_main = qsearchs( 'cust_main', { 'custnum' => $custnum } );
 111         $cust_main->bill_and_collect( %args, 'debug' => $debug );
 112
 113       }
 114
 115     }
 116
 117   }
 118
 119   $cursor_dbh->commit or die $cursor_dbh->errstr;
 120
 121 }
 122
 123 # freeside-daily %opt:
 124 #  -d: Pretend it's 'date'.  Date is in any format Date::Parse is happy with,
 125 #      but be careful.
 126 #
 127 #  -y: In addition to -d, which specifies an absolute date, the -y switch
 128 #      specifies an offset, in days.  For example, "-y 15" would increment the
 129 #      "pretend date" 15 days from whatever was specified by the -d switch
 130 #      (or now, if no -d switch was given).
 131 #
 132 #  -n: When used with "-d" and/or "-y", specifies that invoices should be dated
 133 #      with today's date, irregardless of the pretend date used to pre-generate
 134 #      the invoices.
 135 #
 136 #  -p: Only process customers with the specified payby (I<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)
 137 #
 138 #  -a: Only process customers with the specified agentnum
 139 #
 140 #  -v: enable debugging
 141 #
 142 #  -l: debugging level
 143
 144 sub bill_where {
 145   my( %opt ) = @_;
 146
 147   my $time = $opt{'time'};
 148   my $invoice_time = $opt{'invoice_time'};
 149
 150   my $check_freq = $opt{'check_freq'} || '1d';
 151
 152   my @search = ();
 153
 154   push @search, "( cust_main.archived != 'Y' OR archived IS NULL )"; #disable?
 155
 156   push @search, "cust_main.payby    = '". $opt{'p'}. "'"
 157     if $opt{'p'};
 158   push @search, "cust_main.agentnum =  ". $opt{'a'}
 159     if $opt{'a'};
 160
 161   #it would be useful if i recognized $opt{g} / $not_pkgpart...
 162
 163   if ( @ARGV ) {
 164     push @search, "( ".
 165       join(' OR ', map "cust_main.custnum = $_", @ARGV ).
 166     " )";
 167   }
 168
 169   ###
 170   # generate where_pkg/where_event search clause
 171   ###
 172
 173   # select * from cust_main where
 174   my $where_pkg = <<"END";
 175     EXISTS(
 176       SELECT 1 FROM cust_pkg
 177         WHERE cust_main.custnum = cust_pkg.custnum
 178           AND ( cancel IS NULL OR cancel = 0 )
 179           AND (    ( ( setup IS NULL OR setup =  0 )
 180                      AND ( start_date IS NULL OR start_date = 0
 181                            OR ( start_date IS NOT NULL AND start_date <= $^T )
 182                          )
 183                    )
 184                 OR bill  IS NULL OR bill  <= $time
 185                 OR ( expire  IS NOT NULL AND expire  <= $^T )
 186                 OR ( adjourn IS NOT NULL AND adjourn <= $^T )
 187               )
 188     )
 189 END
 190
 191   my $where_event = join(' OR ', map {
 192     my $eventtable = $_;
 193
 194     my $join  = FS::part_event_condition->join_conditions_sql(  $eventtable );
 195     my $where = FS::part_event_condition->where_conditions_sql( $eventtable,
 196                                                                 'time'=>$time,
 197                                                               );
 198     $where = $where ? "AND $where" : '';
 199
 200     my $are_part_event =
 201       "EXISTS ( SELECT 1 FROM part_event $join
 202                   WHERE check_freq = '$check_freq'
 203                     AND eventtable = '$eventtable'
 204                     AND ( disabled = '' OR disabled IS NULL )
 205                     $where
 206               )
 207       ";
 208
 209     if ( $eventtable eq 'cust_main' ) {
 210       $are_part_event;
 211     } else {
 212       "EXISTS ( SELECT 1 FROM $eventtable
 213                   WHERE cust_main.custnum = $eventtable.custnum
 214                     AND $are_part_event
 215               )
 216       ";
 217     }
 218
 219   } FS::part_event->eventtables);
 220
 221   push @search, "( $where_pkg OR $where_event )";
 222
 223   warn "searching for customers:\n". join("\n", @search). "\n"
 224     if $opt{'v'} || $opt{'l'};
 225
 226   join(' AND ', @search);
 227
 228 }
 229
 230 1;