1 package FS::Cron::bill;
4 use vars qw( @ISA @EXPORT_OK );
7 use DBI 1.33; #The "clone" method was added in DBI 1.33.
9 use FS::Record qw( qsearch qsearchs );
13 use FS::part_event_condition;
15 @ISA = qw( Exporter );
16 @EXPORT_OK = qw ( bill bill_where );
19 # -s: re-charge setup fees
20 # -v: enable debugging
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
29 my $check_freq = $opt{'check_freq'} || '1d';
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'};
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'};
41 $opt{'invoice_time'} = $opt{'n'} ? $^T : $opt{'time'};
43 my $not_pkgpart = $opt{g} ? { map { $_=>1 } split(/,\s*/, $opt{g}) }
47 # get a list of custnums
50 my $cursor_dbh = dbh->clone;
53 "DECLARE cron_bill_cursor CURSOR FOR ".
54 " SELECT custnum FROM cust_main WHERE ". bill_where( %opt )
55 ) or die $cursor_dbh->errstr;
59 my $sth = $cursor_dbh->prepare('FETCH 100 FROM cron_bill_cursor'); #mysql?
61 $sth->execute or die $sth->errstr;
63 my @custnums = map { $_->[0] } @{ $sth->fetchall_arrayref };
65 last unless scalar(@custnums);
68 # for each custnum, queue or make one customer object and bill
69 # (one at a time, to reduce memory footprint with large #s of customers)
72 foreach my $custnum ( @custnums ) {
75 'time' => $opt{'time'},
76 'invoice_time' => $opt{'invoice_time'},
77 'actual_time' => $^T, #when freeside-bill was started
78 #(not, when using -m, freeside-queued)
79 'check_freq' => $check_freq,
80 'resetup' => ( $opt{'s'} ? $opt{'s'} : 0 ),
81 'not_pkgpart' => $not_pkgpart,
87 warn "DRY RUN: would add custnum $custnum for queued_bill\n";
90 #avoid queuing another job if there's one still waiting to run
91 next if qsearch( 'queue', { 'job' => 'FS::cust_main::queued_bill',
92 'custnum' => $custnum,
97 #add job to queue that calls bill_and_collect with options
98 my $queue = new FS::queue {
99 'job' => 'FS::cust_main::queued_bill',
101 'priority' => 99, #don't get in the way of provisioning jobs
103 my $error = $queue->insert( 'custnum'=>$custnum, %args );
109 my $cust_main = qsearchs( 'cust_main', { 'custnum' => $custnum } );
110 $cust_main->bill_and_collect( %args, 'debug' => $debug );
118 $cursor_dbh->commit or die $cursor_dbh->errstr;
122 # freeside-daily %opt:
123 # -d: Pretend it's 'date'. Date is in any format Date::Parse is happy with,
126 # -y: In addition to -d, which specifies an absolute date, the -y switch
127 # specifies an offset, in days. For example, "-y 15" would increment the
128 # "pretend date" 15 days from whatever was specified by the -d switch
129 # (or now, if no -d switch was given).
131 # -n: When used with "-d" and/or "-y", specifies that invoices should be dated
132 # with today's date, irregardless of the pretend date used to pre-generate
135 # -p: Only process customers with the specified payby (I<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)
137 # -a: Only process customers with the specified agentnum
139 # -v: enable debugging
141 # -l: debugging level
146 my $time = $opt{'time'};
147 my $invoice_time = $opt{'invoice_time'};
149 my $check_freq = $opt{'check_freq'} || '1d';
153 push @search, "( cust_main.archived != 'Y' OR archived IS NULL )"; #disable?
155 push @search, "cust_main.payby = '". $opt{'p'}. "'"
157 push @search, "cust_main.agentnum = ". $opt{'a'}
160 #it would be useful if i recognized $opt{g} / $not_pkgpart...
164 join(' OR ', map "cust_main.custnum = $_", @ARGV ).
169 # generate where_pkg/where_event search clause
172 # select * from cust_main where
173 my $where_pkg = <<"END";
175 SELECT 1 FROM cust_pkg
176 WHERE cust_main.custnum = cust_pkg.custnum
177 AND ( cancel IS NULL OR cancel = 0 )
178 AND ( ( ( setup IS NULL OR setup = 0 )
179 AND ( start_date IS NULL OR start_date = 0
180 OR ( start_date IS NOT NULL AND start_date <= $^T )
183 OR bill IS NULL OR bill <= $time
184 OR ( expire IS NOT NULL AND expire <= $^T )
185 OR ( adjourn IS NOT NULL AND adjourn <= $^T )
190 my $where_event = join(' OR ', map {
193 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
194 my $where = FS::part_event_condition->where_conditions_sql( $eventtable,
197 $where = $where ? "AND $where" : '';
200 "EXISTS ( SELECT 1 FROM part_event $join
201 WHERE check_freq = '$check_freq'
202 AND eventtable = '$eventtable'
203 AND ( disabled = '' OR disabled IS NULL )
208 if ( $eventtable eq 'cust_main' ) {
211 "EXISTS ( SELECT 1 FROM $eventtable
212 WHERE cust_main.custnum = $eventtable.custnum
218 } FS::part_event->eventtables);
220 push @search, "( $where_pkg OR $where_event )";
222 warn "searching for customers:\n". join("\n", @search). "\n"
223 if $opt{'v'} || $opt{'l'};
225 join(' AND ', @search);