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.
8 use FS::UID qw( dbh driver_name );
9 use FS::Record qw( qsearch qsearchs );
10 use FS::Misc::DateTime qw( day_end );
14 use FS::part_event_condition;
16 @ISA = qw( Exporter );
17 @EXPORT_OK = qw ( bill bill_where );
20 # -s: re-charge setup fees
21 # -v: enable debugging
23 # -m: Experimental multi-process mode uses the job queue for multi-process and/or multi-machine billing.
24 # -r: Multi-process mode dry run option
25 # -g: Don't bill these pkgparts
30 my $check_freq = $opt{'check_freq'} || '1d';
33 $debug = 1 if $opt{'v'};
34 $debug = $opt{'l'} if $opt{'l'};
35 $FS::cust_main::DEBUG = $debug;
36 #$FS::cust_event::DEBUG = $opt{'l'} if $opt{'l'};
38 my $conf = new FS::Conf;
39 if ( $conf->exists('disable_cron_billing') ) {
40 warn "disable_cron_billing set, skipping billing\n" if $debug;
44 #we're at now now (and later).
45 $opt{'time'} = $opt{'d'} ? str2time($opt{'d'}) : $^T;
46 $opt{'time'} += $opt{'y'} * 86400 if $opt{'y'};
48 $opt{'invoice_time'} = $opt{'n'} ? $^T : $opt{'time'};
50 #hashref here doesn't work with -m
51 #my $not_pkgpart = $opt{g} ? { map { $_=>1 } split(/,\s*/, $opt{g}) }
55 # get a list of custnums
58 my $cursor_dbh = dbh->clone;
60 my $select = 'SELECT custnum FROM cust_main WHERE '. bill_where( %opt );
62 unless ( driver_name =~ /^mysql/ ) {
63 $cursor_dbh->do( "DECLARE cron_bill_cursor CURSOR FOR $select" )
64 or die $cursor_dbh->errstr;
69 my $sql = (driver_name =~ /^mysql/)
71 : 'FETCH 100 FROM cron_bill_cursor';
73 my $sth = $cursor_dbh->prepare($sql);
75 $sth->execute or die $sth->errstr;
77 my @custnums = map { $_->[0] } @{ $sth->fetchall_arrayref };
79 last unless scalar(@custnums);
82 # for each custnum, queue or make one customer object and bill
83 # (one at a time, to reduce memory footprint with large #s of customers)
86 foreach my $custnum ( @custnums ) {
89 'time' => $opt{'time'},
90 'invoice_time' => $opt{'invoice_time'},
91 'actual_time' => $^T, #when freeside-bill was started
92 #(not, when using -m, freeside-queued)
93 'check_freq' => $check_freq,
94 'resetup' => ( $opt{'s'} ? $opt{'s'} : 0 ),
95 'not_pkgpart' => $opt{'g'}, #$not_pkgpart,
96 'one_recur' => $opt{'o'},
102 warn "DRY RUN: would add custnum $custnum for queued_bill\n";
105 #avoid queuing another job if there's one still waiting to run
106 next if qsearch( 'queue', { 'job' => 'FS::cust_main::queued_bill',
107 'custnum' => $custnum,
112 #add job to queue that calls bill_and_collect with options
113 my $queue = new FS::queue {
114 'job' => 'FS::cust_main::queued_bill',
116 'priority' => 99, #don't get in the way of provisioning jobs
118 my $error = $queue->insert( 'custnum'=>$custnum, %args );
124 my $cust_main = qsearchs( 'cust_main', { 'custnum' => $custnum } );
125 $cust_main->bill_and_collect( %args, 'debug' => $debug );
131 last if driver_name =~ /^mysql/;
135 $cursor_dbh->commit or die $cursor_dbh->errstr;
139 # freeside-daily %opt:
140 # -d: Pretend it's 'date'. Date is in any format Date::Parse is happy with,
143 # -y: In addition to -d, which specifies an absolute date, the -y switch
144 # specifies an offset, in days. For example, "-y 15" would increment the
145 # "pretend date" 15 days from whatever was specified by the -d switch
146 # (or now, if no -d switch was given).
148 # -n: When used with "-d" and/or "-y", specifies that invoices should be dated
149 # with today's date, regardless of the pretend date used to pre-generate
152 # -p: Only process customers with the specified payby (I<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)
154 # -a: Only process customers with the specified agentnum
156 # -v: enable debugging
158 # -l: debugging level
162 Internal function. Returns a WHERE clause to select the set of customers who
163 have actionable packages (no setup date, or bill date in the past, or expire
164 or adjourn dates in the past) or events (does a complete where_conditions_sql
172 my $time = $opt{'time'};
173 my $invoice_time = $opt{'invoice_time'};
175 my $check_freq = $opt{'check_freq'} || '1d';
179 push @search, "( cust_main.archived != 'Y' OR archived IS NULL )"; #disable?
181 push @search, "cust_main.payby = '". $opt{'p'}. "'"
183 push @search, "cust_main.agentnum IN ( ". $opt{'a'}. " ) "
186 #it would be useful if i recognized $opt{g} / $not_pkgpart...
190 join(' OR ', map "cust_main.custnum = $_", @ARGV ).
195 # generate where_pkg/where_event search clause
198 my $billtime = day_end($time);
200 # select * from cust_main where
201 my $where_pkg = <<"END";
203 SELECT 1 FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
204 WHERE cust_main.custnum = cust_pkg.custnum
205 AND ( cancel IS NULL OR cancel = 0 )
206 AND ( ( ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
207 AND ( start_date IS NULL OR start_date = 0
208 OR ( start_date IS NOT NULL AND start_date <= $^T )
211 OR ( freq != '0' AND ( bill IS NULL OR bill <= $billtime ) )
212 OR ( expire IS NOT NULL AND expire <= $^T )
213 OR ( adjourn IS NOT NULL AND adjourn <= $^T )
214 OR ( resume IS NOT NULL AND resume <= $^T )
219 #some false laziness w/cust_main::Billing due_cust_event
220 my $where_event = join(' OR ', map {
223 # joins and where clauses to test event conditions
224 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
225 my $where = FS::part_event_condition->where_conditions_sql( $eventtable,
228 $where = $where ? "AND $where" : '';
230 # test to return all applicable part_events (defined on this eventtable,
231 # not disabled, check_freq correct, and all event conditions true)
233 "EXISTS ( SELECT 1 FROM part_event $join
234 WHERE check_freq = '$check_freq'
235 AND eventtable = '$eventtable'
236 AND ( disabled = '' OR disabled IS NULL )
241 if ( $eventtable eq 'cust_main' ) {
244 my $cust_join = FS::part_event->eventtables_cust_join->{$eventtable}
246 my $custnum = FS::part_event->eventtables_custnum->{$eventtable};
247 "EXISTS ( SELECT 1 FROM $eventtable $cust_join
248 WHERE cust_main.custnum = $custnum
254 } FS::part_event->eventtables);
256 push @search, "( $where_pkg OR $where_event )";
258 warn "searching for customers:\n". join("\n", @search). "\n"
259 if $opt{'v'} || $opt{'l'};
261 join(' AND ', @search);