4 use vars qw( @ISA @EXPORT_OK $DEBUG $me
5 $conf $cdr_prerate %cdr_prerate_cdrtypenums
8 use List::Util qw(first min);
13 use List::Util qw( first min );
15 use FS::UID qw( dbh );
17 use FS::Record qw( qsearch qsearchs );
22 use FS::cdr_termination;
27 @ISA = qw(FS::Record);
28 @EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker );
33 #ask FS::UID to run this stuff for us later
34 FS::UID->install_callback( sub {
37 my @cdr_prerate_cdrtypenums;
38 $cdr_prerate = $conf->exists('cdr-prerate');
39 @cdr_prerate_cdrtypenums = $conf->config('cdr-prerate-cdrtypenums')
41 %cdr_prerate_cdrtypenums = map { $_=>1 } @cdr_prerate_cdrtypenums;
46 FS::cdr - Object methods for cdr records
52 $record = new FS::cdr \%hash;
53 $record = new FS::cdr { 'column' => 'value' };
55 $error = $record->insert;
57 $error = $new_record->replace($old_record);
59 $error = $record->delete;
61 $error = $record->check;
65 An FS::cdr object represents an Call Data Record, typically from a telephony
66 system or provider of some sort. FS::cdr inherits from FS::Record. The
67 following fields are currently supported:
71 =item acctid - primary key
73 =item calldate - Call timestamp (SQL timestamp)
75 =item clid - Caller*ID with text
77 =item src - Caller*ID number / Source number
79 =item dst - Destination extension
81 =item dcontext - Destination context
83 =item channel - Channel used
85 =item dstchannel - Destination channel if appropriate
87 =item lastapp - Last application if appropriate
89 =item lastdata - Last application data
91 =item src_ip_addr - Source IP address (dotted quad, zero-filled)
93 =item dst_ip_addr - Destination IP address (same)
95 =item dst_term - Terminating destination number (if different from dst)
97 =item startdate - Start of call (UNIX-style integer timestamp)
99 =item answerdate - Answer time of call (UNIX-style integer timestamp)
101 =item enddate - End time of call (UNIX-style integer timestamp)
103 =item duration - Total time in system, in seconds
105 =item billsec - Total time call is up, in seconds
107 =item disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
109 =item amaflags - What flags to use: BILL, IGNORE etc, specified on a per channel basis like accountcode.
113 #ignore the "omit" and "documentation" AMAs??
114 #AMA = Automated Message Accounting.
115 #default: Sets the system default.
116 #omit: Do not record calls.
117 #billing: Mark the entry for billing
118 #documentation: Mark the entry for documentation.
120 =item accountcode - CDR account number to use: account
122 =item uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID)
124 =item userfield - CDR user-defined field
126 =item cdr_type - CDR type - see L<FS::cdr_type> (Usage = 1, S&E = 7, OC&C = 8)
128 =item charged_party - Service number to be billed
130 =item upstream_currency - Wholesale currency from upstream
132 =item upstream_price - Wholesale price from upstream
134 =item upstream_rateplanid - Upstream rate plan ID
136 =item rated_price - Rated (or re-rated) price
138 =item distance - km (need units field?)
140 =item islocal - Local - 1, Non Local = 0
142 =item calltypenum - Type of call - see L<FS::cdr_calltype>
144 =item description - Description (cdr_type 7&8 only) (used for cust_bill_pkg.itemdesc)
146 =item quantity - Number of items (cdr_type 7&8 only)
148 =item carrierid - Upstream Carrier ID (see L<FS::cdr_carrier>)
152 #Telstra =1, Optus = 2, RSL COM = 3
154 =item upstream_rateid - Upstream Rate ID
156 =item svcnum - Link to customer service (see L<FS::cust_svc>)
158 =item freesidestatus - NULL, processing-tiered, rated, done, skipped, no-charge, failed
160 =item freesiderewritestatus - NULL, done, skipped
172 Creates a new CDR. To add the CDR to the database, see L<"insert">.
174 Note that this stores the hash reference, not a distinct copy of the hash it
175 points to. You can ask the object for a copy with the I<hash> method.
179 # the new method can be inherited from FS::Record, if a table method is defined
186 #XXX fill in some (more) nice names
188 'calldate' => 'Call date',
189 'clid' => 'Caller ID',
191 'dst' => 'Destination',
192 'dcontext' => 'Dest. context',
193 'channel' => 'Channel',
194 'dstchannel' => 'Destination channel',
197 'src_ip_addr' => 'Source IP',
198 'dst_ip_addr' => 'Dest. IP',
199 'dst_term' => 'Termination dest.',
200 'startdate' => 'Start date',
201 'answerdate' => 'Answer date',
202 'enddate' => 'End date',
203 'duration' => 'Duration',
204 'billsec' => 'Billable seconds',
205 'disposition' => 'Disposition',
206 'amaflags' => 'AMA flags',
207 'accountcode' => 'Account code',
209 'userfield' => 'User field',
211 'charged_party' => 'Charged party',
212 #'upstream_currency' => '',
213 'upstream_price' => 'Upstream price',
214 #'upstream_rateplanid' => '',
215 #'ratedetailnum' => '',
216 'rated_price' => 'Rated price',
219 #'calltypenum' => '',
220 #'description' => '',
222 'carrierid' => 'Carrier ID',
223 #'upstream_rateid' => '',
224 'svcnum' => 'Freeside service',
225 'freesidestatus' => 'Freeside status',
226 'freesiderewritestatus' => 'Freeside rewrite status',
227 'cdrbatch' => 'Legacy batch',
228 'cdrbatchnum' => 'Batch',
237 Adds this record to the database. If there is an error, returns the error,
238 otherwise returns false.
242 # the insert method can be inherited from FS::Record
246 Delete this record from the database.
250 # the delete method can be inherited from FS::Record
252 =item replace OLD_RECORD
254 Replaces the OLD_RECORD with this one in the database. If there is an error,
255 returns the error, otherwise returns false.
259 # the replace method can be inherited from FS::Record
263 Checks all fields to make sure this is a valid CDR. If there is
264 an error, returns the error, otherwise returns false. Called by the insert
267 Note: Unlike most types of records, we don't want to "reject" a CDR and we want
268 to process them as quickly as possible, so we allow the database to check most
276 # we don't want to "reject" a CDR like other sorts of input...
278 # $self->ut_numbern('acctid')
279 ## || $self->ut_('calldate')
280 # || $self->ut_text('clid')
281 # || $self->ut_text('src')
282 # || $self->ut_text('dst')
283 # || $self->ut_text('dcontext')
284 # || $self->ut_text('channel')
285 # || $self->ut_text('dstchannel')
286 # || $self->ut_text('lastapp')
287 # || $self->ut_text('lastdata')
288 # || $self->ut_numbern('startdate')
289 # || $self->ut_numbern('answerdate')
290 # || $self->ut_numbern('enddate')
291 # || $self->ut_number('duration')
292 # || $self->ut_number('billsec')
293 # || $self->ut_text('disposition')
294 # || $self->ut_number('amaflags')
295 # || $self->ut_text('accountcode')
296 # || $self->ut_text('uniqueid')
297 # || $self->ut_text('userfield')
298 # || $self->ut_numbern('cdrtypenum')
299 # || $self->ut_textn('charged_party')
300 ## || $self->ut_n('upstream_currency')
301 ## || $self->ut_n('upstream_price')
302 # || $self->ut_numbern('upstream_rateplanid')
303 ## || $self->ut_n('distance')
304 # || $self->ut_numbern('islocal')
305 # || $self->ut_numbern('calltypenum')
306 # || $self->ut_textn('description')
307 # || $self->ut_numbern('quantity')
308 # || $self->ut_numbern('carrierid')
309 # || $self->ut_numbern('upstream_rateid')
310 # || $self->ut_numbern('svcnum')
311 # || $self->ut_textn('freesidestatus')
312 # || $self->ut_textn('freesiderewritestatus')
314 # return $error if $error;
316 for my $f ( grep { $self->$_ =~ /\D/ } qw(startdate answerdate enddate)){
317 $self->$f( str2time($self->$f) );
320 $self->calldate( $self->startdate_sql )
321 if !$self->calldate && $self->startdate;
323 #was just for $format eq 'taqua' but can't see the harm... add something to
324 #disable if it becomes a problem
325 if ( $self->duration eq '' && $self->enddate && $self->startdate ) {
326 $self->duration( $self->enddate - $self->startdate );
328 if ( $self->billsec eq '' && $self->enddate && $self->answerdate ) {
329 $self->billsec( $self->enddate - $self->answerdate );
332 if ( ! $self->enddate && $self->startdate && $self->duration ) {
333 $self->enddate( $self->startdate + $self->duration );
336 $self->set_charged_party;
338 #check the foreign keys even?
339 #do we want to outright *reject* the CDR?
341 $self->ut_numbern('acctid')
343 #add a config option to turn these back on if someone needs 'em
345 # #Usage = 1, S&E = 7, OC&C = 8
346 # || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
348 # #the big list in appendix 2
349 # || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' )
351 # # Telstra =1, Optus = 2, RSL COM = 3
352 # || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
354 return $error if $error;
359 =item is_tollfree [ COLUMN ]
361 Returns true when the cdr represents a toll free number and false otherwise.
363 By default, inspects the dst field, but an optional column name can be passed
364 to inspect other field.
370 my $field = scalar(@_) ? shift : 'dst';
371 ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0;
374 =item set_charged_party
376 If the charged_party field is already set, does nothing. Otherwise:
378 If the cdr-charged_party-accountcode config option is enabled, sets the
379 charged_party to the accountcode.
381 Otherwise sets the charged_party normally: to the src field in most cases,
382 or to the dst field if it is a toll free number.
386 sub set_charged_party {
389 my $conf = new FS::Conf;
391 unless ( $self->charged_party ) {
393 if ( $conf->exists('cdr-charged_party-accountcode') && $self->accountcode ){
395 my $charged_party = $self->accountcode;
396 $charged_party =~ s/^0+//
397 if $conf->exists('cdr-charged_party-accountcode-trim_leading_0s');
398 $self->charged_party( $charged_party );
400 } elsif ( $conf->exists('cdr-charged_party-field') ) {
402 my $field = $conf->config('cdr-charged_party-field');
403 $self->charged_party( $self->$field() );
407 if ( $self->is_tollfree ) {
408 $self->charged_party($self->dst);
410 $self->charged_party($self->src);
417 # my $prefix = $conf->config('cdr-charged_party-truncate_prefix');
418 # my $prefix_len = length($prefix);
419 # my $trunc_len = $conf->config('cdr-charged_party-truncate_length');
421 # $self->charged_party( substr($self->charged_party, 0, $trunc_len) )
422 # if $prefix_len && $trunc_len
423 # && substr($self->charged_party, 0, $prefix_len) eq $prefix;
427 =item set_status STATUS
429 Sets the status to the provided string. If there is an error, returns the
430 error, otherwise returns false.
432 If status is being changed from 'rated' to some other status, also removes
433 any usage allocations to this CDR.
438 my($self, $status) = @_;
439 my $old_status = $self->freesidestatus;
440 $self->freesidestatus($status);
441 my $error = $self->replace;
442 if ( $old_status eq 'rated' and $status ne 'done' ) {
443 # deallocate any usage
444 foreach (qsearch('cdr_cust_pkg_usage', {acctid => $self->acctid})) {
445 my $cust_pkg_usage = $_->cust_pkg_usage;
446 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $_->minutes);
447 $error ||= $cust_pkg_usage->replace || $_->delete;
453 =item set_status_and_rated_price STATUS RATED_PRICE [ SVCNUM [ OPTION => VALUE ... ] ]
455 Sets the status and rated price.
457 Available options are: inbound, rated_pretty_dst, rated_regionname,
458 rated_seconds, rated_minutes, rated_granularity, rated_ratedetailnum,
459 rated_classnum, rated_ratename.
461 If there is an error, returns the error, otherwise returns false.
465 sub set_status_and_rated_price {
466 my($self, $status, $rated_price, $svcnum, %opt) = @_;
468 if ($opt{'inbound'}) {
470 my $term = $self->cdr_termination( 1 ); #1: inbound
473 warn "replacing existing cdr status (".$self->acctid.")\n" if $term;
474 $error = $term->delete;
475 return $error if $error;
477 $term = FS::cdr_termination->new({
478 acctid => $self->acctid,
480 rated_price => $rated_price,
483 $term->rated_seconds($opt{rated_seconds}) if exists($opt{rated_seconds});
484 $term->rated_minutes($opt{rated_minutes}) if exists($opt{rated_minutes});
485 $term->svcnum($svcnum) if $svcnum;
486 return $term->insert;
490 $self->freesidestatus($status);
491 $self->rated_price($rated_price);
493 foreach grep exists($opt{$_}), map "rated_$_",
494 qw( pretty_dst regionname seconds minutes granularity
495 ratedetailnum classnum ratename );
496 $self->svcnum($svcnum) if $svcnum;
497 return $self->replace();
502 =item parse_number [ OPTION => VALUE ... ]
504 Returns two scalars, the countrycode and the rest of the number.
506 Options are passed as name-value pairs. Currently available options are:
512 The column containing the number to be parsed. Defaults to dst.
514 =item international_prefix
516 The digits for international dialing. Defaults to '011' The value '+' is
519 =item domestic_prefix
521 The digits for domestic long distance dialing. Defaults to '1'
528 my ($self, %options) = @_;
530 my $field = $options{column} || 'dst';
531 my $intl = $options{international_prefix} || '011';
532 my $countrycode = '';
533 my $number = $self->$field();
535 my $to_or_from = 'concerning';
536 $to_or_from = 'from' if $field eq 'src';
537 $to_or_from = 'to' if $field eq 'dst';
538 warn "parsing call $to_or_from $number\n" if $DEBUG;
540 #remove non-phone# stuff and whitespace
543 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
545 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
547 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
548 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
552 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
553 #first look for 1 digit country code
554 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
556 $number = $u1.$u2.$rest;
557 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
560 } else { #3 digit country code
561 $countrycode = $three;
566 my $domestic_prefix =
567 exists($options{domestic_prefix}) ? $options{domestic_prefix} : '';
568 $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
569 $number =~ s/^$countrycode//;# if length($number) > 10;
572 return($countrycode, $number);
576 =item rate [ OPTION => VALUE ... ]
578 Rates this CDR according and sets the status to 'rated'.
580 Available options are: part_pkg, svcnum, single_price_included_minutes, region_group, region_group_included_minutes.
582 part_pkg is required.
584 If svcnum is specified, will also associate this CDR with the specified svcnum.
586 single_price_included_minutes is requried for single_price price plans
587 (otherwise unused/ignored). It should be set to a scalar reference of the
588 number of included minutes and will be decremented by the rated minutes of this
591 region_group_included_minutes is required for prefix price plans which have
592 included minutes (otherwise unused/ignored). It should be set to a scalar
593 reference of the number of included minutes and will be decremented by the
594 rated minutes of this CDR.
596 region_group_included_minutes_hashref is required for prefix price plans which
597 have included minues (otherwise unused/ignored). It should be set to an empty
598 hashref at the start of a month's rating and then preserved across CDRs.
603 my( $self, %opt ) = @_;
604 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
607 warn "rating CDR $self\n".
608 join('', map { " $_ => ". $self->{$_}. "\n" } keys %$self );
611 my $rating_method = $part_pkg->option_cacheable('rating_method') || 'prefix';
612 my $method = "rate_$rating_method";
613 $self->$method(%opt);
617 our %interval_cache = (); # for timed rates
620 my( $self, %opt ) = @_;
621 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
622 my $cust_pkg = $opt{'cust_pkg'};
625 # this will result in those CDRs being marked as done... is that
628 if ( $part_pkg->option_cacheable('411_rewrite') ) {
629 my $dirass = $part_pkg->option_cacheable('411_rewrite');
631 @dirass = split(',', $dirass);
634 if ( length($self->dst) && grep { $self->dst eq $_ } @dirass ) {
639 my $reason = $part_pkg->check_chargable( $self,
640 'da_rewrote' => $da_rewrote,
643 warn "not charging for CDR ($reason)\n" if $DEBUG;
644 return $self->set_status_and_rated_price( 'skipped',
650 if ( $part_pkg->option_cacheable('skip_same_customer')
651 and ! $self->is_tollfree ) {
652 my ($dst_countrycode, $dst_number) = $self->parse_number(
654 international_prefix => $part_pkg->option_cacheable('international_prefix'),
655 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
657 my $dst_same_cust = FS::Record->scalar_sql(
658 'SELECT COUNT(svc_phone.svcnum) AS count '.
660 'JOIN cust_svc USING (pkgnum) ' .
661 'JOIN svc_phone USING (svcnum) ' .
662 'WHERE svc_phone.countrycode = ' . dbh->quote($dst_countrycode) .
663 ' AND svc_phone.phonenum = ' . dbh->quote($dst_number) .
664 ' AND cust_pkg.custnum = ' . $cust_pkg->custnum,
666 if ( $dst_same_cust > 0 ) {
667 warn "not charging for CDR (same source and destination customer)\n" if $DEBUG;
668 return $self->set_status_and_rated_price( 'skipped',
679 # look up rate details based on called station id
680 # (or calling station id for toll free calls)
683 my $eff_ratenum = $self->is_tollfree('accountcode')
684 ? $part_pkg->option_cacheable('accountcode_tollfree_ratenum')
687 my( $to_or_from, $column );
690 && ! $part_pkg->option_cacheable('disable_tollfree')
693 && $part_pkg->option_cacheable('accountcode_tollfree_field') eq 'src'
697 $to_or_from = 'from';
699 } else { #regular call
704 #determine the country code
705 my ($countrycode, $number) = $self->parse_number(
707 international_prefix => $part_pkg->option_cacheable('international_prefix'),
708 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
711 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
712 my $pretty_dst = "+$countrycode $number";
713 #asterisks here causes inserting the detail to barf, so:
714 $pretty_dst =~ s/\*//g;
717 my $intrastate_ratenum = $part_pkg->option_cacheable('intrastate_ratenum');
718 if ( $intrastate_ratenum && !$self->is_tollfree ) {
719 $ratename = 'Interstate'; #until proven otherwise
720 # this is relatively easy only because:
721 # -assume all numbers are valid NANP numbers NOT in a fully-qualified format
722 # -disregard toll-free
723 # -disregard private or unknown numbers
724 # -there is exactly one record in rate_prefix for a given NPANXX
725 # -default to interstate if we can't find one or both of the prefixes
726 my (undef, $dstprefix) = $self->parse_number(
728 international_prefix => $part_pkg->option_cacheable('international_prefix'),
729 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
731 $dstprefix =~ /^(\d{6})/;
732 $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
735 my (undef, $srcprefix) = $self->parse_number(
737 international_prefix => $part_pkg->option_cacheable('international_prefix'),
738 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
740 $srcprefix =~ /^(\d{6})/;
741 $srcprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
744 if ($srcprefix && $dstprefix
745 && $srcprefix->state && $dstprefix->state
746 && $srcprefix->state eq $dstprefix->state) {
747 $eff_ratenum = $intrastate_ratenum;
748 $ratename = 'Intrastate'; # XXX possibly just use the ratename?
752 $eff_ratenum ||= $part_pkg->option_cacheable('ratenum');
753 my $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
754 or die "ratenum $eff_ratenum not found!";
756 my @ltime = localtime($self->startdate);
757 my $weektime = $ltime[0] +
758 $ltime[1]*60 + #minutes
759 $ltime[2]*3600 + #hours
760 $ltime[6]*86400; #days since sunday
761 # if there's no timed rate_detail for this time/region combination,
762 # dest_detail returns the default. There may still be a timed rate
763 # that applies after the starttime of the call, so be careful...
764 my $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
765 'phonenum' => $number,
766 'weektime' => $weektime,
767 'cdrtypenum' => $self->cdrtypenum,
770 unless ( $rate_detail ) {
772 if ( $part_pkg->option_cacheable('ignore_unrateable') ) {
774 if ( $part_pkg->option_cacheable('ignore_unrateable') == 2 ) {
775 # mark the CDR as unrateable
776 return $self->set_status_and_rated_price(
781 } elsif ( $part_pkg->option_cacheable('ignore_unrateable') == 1 ) {
783 warn "no rate_detail found for CDR.acctid: ". $self->acctid.
788 die "unknown ignore_unrateable, pkgpart ". $part_pkg->pkgpart;
793 die "FATAL: no rate_detail found in ".
794 $rate->ratenum. ":". $rate->ratename. " rate plan ".
795 "for +$countrycode $number (CDR acctid ". $self->acctid. "); ".
796 "add a rate or set ignore_unrateable flag on the package def\n";
801 my $rate_region = $rate_detail->dest_region;
802 my $regionnum = $rate_region->regionnum;
803 warn " found rate for regionnum $regionnum ".
804 "and rate detail $rate_detail\n"
807 if ( !exists($interval_cache{$regionnum}) ) {
809 sort { $a->stime <=> $b->stime }
810 map { $_->rate_time->intervals }
811 qsearch({ 'table' => 'rate_detail',
812 'hashref' => { 'ratenum' => $rate->ratenum },
813 'extra_sql' => 'AND ratetimenum IS NOT NULL',
816 $interval_cache{$regionnum} = \@intervals;
817 warn " cached ".scalar(@intervals)." interval(s)\n"
822 # find the price and add detail to the invoice
825 # About this section:
826 # We don't round _anything_ (except granularizing)
827 # until the final $charge = sprintf("%.2f"...).
829 my $seconds_left = $part_pkg->option_cacheable('use_duration')
833 #no, do this later so it respects (group) included minutes
834 # # charge for the first (conn_sec) seconds
835 # my $seconds = min($seconds_left, $rate_detail->conn_sec);
836 # $seconds_left -= $seconds;
837 # $weektime += $seconds;
838 # my $charge = $rate_detail->conn_charge;
841 my $connection_charged = 0;
844 while($seconds_left) {
845 my $ratetimenum = $rate_detail->ratetimenum; # may be empty
847 # find the end of the current rate interval
848 if(@{ $interval_cache{$regionnum} } == 0) {
849 # There are no timed rates in this group, so just stay
850 # in the default rate_detail for the entire duration.
851 # Set an "end" of 1 past the end of the current call.
852 $etime = $weektime + $seconds_left + 1;
854 elsif($ratetimenum) {
855 # This is a timed rate, so go to the etime of this interval.
856 # If it's followed by another timed rate, the stime of that
857 # interval should match the etime of this one.
858 my $interval = $rate_detail->rate_time->contains($weektime);
859 $etime = $interval->etime;
862 # This is a default rate, so use the stime of the next
863 # interval in the sequence.
864 my $next_int = first { $_->stime > $weektime }
865 @{ $interval_cache{$regionnum} };
867 $etime = $next_int->stime;
870 # weektime is near the end of the week, so decrement
871 # it by a full week and use the stime of the first
873 $weektime -= (3600*24*7);
874 $etime = $interval_cache{$regionnum}->[0]->stime;
878 my $charge_sec = min($seconds_left, $etime - $weektime);
880 $seconds_left -= $charge_sec;
882 my $granularity = $rate_detail->sec_granularity;
885 if ( $granularity ) { # charge per minute
886 # Round up to the nearest $granularity
887 if ( $charge_sec and $charge_sec % $granularity ) {
888 $charge_sec += $granularity - ($charge_sec % $granularity);
890 $minutes = $charge_sec / 60; #don't round this
897 $seconds += $charge_sec;
899 if ( $rate_detail->min_included ) {
900 # the old, kind of deprecated way to do this
901 my $included_min = $opt{'region_group_included_min_hashref'} || {};
903 # by default, set the included minutes for this region/time to
904 # what's in the rate_detail
905 $included_min->{$regionnum}{$ratetimenum} = $rate_detail->min_included
906 unless exists $included_min->{$regionnum}{$ratetimenum};
908 # the way that doesn't work
909 #my $region_group = ($part_pkg->option_cacheable('min_included') || 0) > 0;
911 #${$opt{region_group_included_min}} -= $minutes
912 # if $region_group && $rate_detail->region_group;
914 if ( $included_min->{$regionnum}{$ratetimenum} >= $minutes ) {
916 $included_min->{$regionnum}{$ratetimenum} -= $minutes;
918 $charge_sec -= ($included_min->{$regionnum}{$ratetimenum} * 60);
919 $included_min->{$regionnum}{$ratetimenum} = 0;
923 my $applied_min = $cust_pkg->apply_usage(
925 'rate_detail' => $rate_detail,
926 'minutes' => $minutes
928 # for now, usage pools deal only in whole minutes
929 $charge_sec -= $applied_min * 60;
932 if ( $charge_sec > 0 ) {
934 #NOW do connection charges here... right?
935 #my $conn_seconds = min($seconds_left, $rate_detail->conn_sec);
936 my $conn_seconds = 0;
937 unless ( $connection_charged++ ) { #only one connection charge
938 $conn_seconds = min($charge_sec, $rate_detail->conn_sec);
939 $seconds_left -= $conn_seconds;
940 $weektime += $conn_seconds;
941 $charge += $rate_detail->conn_charge;
944 #should preserve (display?) this
945 if ( $granularity == 0 ) { # per call rate
946 $charge += $rate_detail->min_charge;
948 my $charge_min = ( $charge_sec - $conn_seconds ) / 60;
949 $charge += ($rate_detail->min_charge * $charge_min) if $charge_min > 0; #still not rounded
954 # choose next rate_detail
955 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
956 'phonenum' => $number,
957 'weektime' => $etime,
958 'cdrtypenum' => $self->cdrtypenum })
960 # we have now moved forward to $etime
963 } #while $seconds_left
965 # this is why we need regionnum/rate_region....
966 warn " (rate region $rate_region)\n" if $DEBUG;
969 my $rounding = $part_pkg->option_cacheable('rounding') || 2;
970 my $sprintformat = '%.'. $rounding. 'f';
971 my $roundup = 10**(-3-$rounding);
972 my $price = sprintf($sprintformat, $charge + $roundup);
974 $self->set_status_and_rated_price(
978 'rated_pretty_dst' => $pretty_dst,
979 'rated_regionname' => $rate_region->regionname,
980 'rated_seconds' => $seconds,
981 'rated_granularity' => $rate_detail->sec_granularity, #$granularity
982 'rated_ratedetailnum' => $rate_detail->ratedetailnum,
983 'rated_classnum' => $rate_detail->classnum, #rated_ratedetailnum?
984 'rated_ratename' => $ratename, #not rate_detail - Intrastate/Interstate
989 sub rate_upstream_simple {
990 my( $self, %opt ) = @_;
992 $self->set_status_and_rated_price(
994 sprintf('%.3f', $self->upstream_price),
996 'rated_classnum' => $self->calltypenum,
1000 sub rate_single_price {
1001 my( $self, %opt ) = @_;
1002 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
1004 # a little false laziness w/abov
1005 # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
1007 my $granularity = length($part_pkg->option_cacheable('sec_granularity'))
1008 ? $part_pkg->option_cacheable('sec_granularity')
1011 my $seconds = $part_pkg->option_cacheable('use_duration')
1015 $seconds += $granularity - ( $seconds % $granularity )
1016 if $seconds # don't granular-ize 0 billsec calls (bills them)
1017 && $granularity # 0 is per call
1018 && $seconds % $granularity;
1019 my $minutes = $granularity ? ($seconds / 60) : 1;
1021 my $charge_min = $minutes;
1023 ${$opt{single_price_included_min}} -= $minutes;
1024 if ( ${$opt{single_price_included_min}} > 0 ) {
1027 $charge_min = 0 - ${$opt{single_price_included_min}};
1028 ${$opt{single_price_included_min}} = 0;
1032 sprintf('%.4f', ( $part_pkg->option_cacheable('min_charge') * $charge_min )
1033 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
1035 $self->set_status_and_rated_price(
1039 'rated_granularity' => $granularity,
1040 'rated_seconds' => $seconds,
1045 =item cdr_termination [ TERMPART ]
1049 sub cdr_termination {
1052 if ( scalar(@_) && $_[0] ) {
1053 my $termpart = shift;
1055 qsearchs('cdr_termination', { acctid => $self->acctid,
1056 termpart => $termpart,
1062 qsearch('cdr_termination', { acctid => $self->acctid, } );
1070 Parses the calldate in SQL string format and returns a UNIX timestamp.
1075 str2time(shift->calldate);
1080 Parses the startdate in UNIX timestamp format and returns a string in SQL
1086 my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate);
1089 "$year-$mon-$mday $hour:$min:$sec";
1094 Returns the FS::cdr_carrier object associated with this CDR, or false if no
1095 carrierid is defined.
1099 my %carrier_cache = ();
1103 return '' unless $self->carrierid;
1104 $carrier_cache{$self->carrierid} ||=
1105 qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } );
1110 Returns the carrier name (see L<FS::cdr_carrier>), or the empty string if
1111 no FS::cdr_carrier object is assocated with this CDR.
1117 my $cdr_carrier = $self->cdr_carrier;
1118 $cdr_carrier ? $cdr_carrier->carriername : '';
1123 Returns the FS::cdr_calltype object associated with this CDR, or false if no
1124 calltypenum is defined.
1128 my %calltype_cache = ();
1132 return '' unless $self->calltypenum;
1133 $calltype_cache{$self->calltypenum} ||=
1134 qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } );
1139 Returns the call type name (see L<FS::cdr_calltype>), or the empty string if
1140 no FS::cdr_calltype object is assocated with this CDR.
1146 my $cdr_calltype = $self->cdr_calltype;
1147 $cdr_calltype ? $cdr_calltype->calltypename : '';
1150 =item downstream_csv [ OPTION => VALUE, ... ]
1154 my %export_names = (
1157 'invoice_header' => "Date,Time,Name,Destination,Duration,Price",
1160 'name' => 'Simple with source',
1161 'invoice_header' => "Date,Time,Called From,Destination,Duration,Price",
1162 #"Date,Time,Name,Called From,Destination,Duration,Price",
1164 'accountcode_simple' => {
1165 'name' => 'Simple with accountcode',
1166 'invoice_header' => "Date,Time,Called From,Account,Duration,Price",
1170 'invoice_header' => "Date/Time,Called Number,Min/Sec,Price",
1173 'name' => 'Default',
1174 'invoice_header' => 'Date,Time,Number,Destination,Duration,Price',
1176 'source_default' => {
1177 'name' => 'Default with source',
1178 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1180 'accountcode_default' => {
1181 'name' => 'Default plus accountcode',
1182 'invoice_header' => 'Date,Time,Account,Number,Destination,Duration,Price',
1184 'description_default' => {
1185 'name' => 'Default with description field as destination',
1186 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1189 'name' => 'Summary, one line per service',
1190 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1193 'name' => 'Number of calls, one line per service',
1194 'invoice_header' => 'Caller,Rate,Messages,Price',
1196 'sum_duration_prefix' => {
1197 'name' => 'Summary, one line per destination prefix',
1198 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1202 my %export_formats = ();
1203 sub export_formats {
1206 return %export_formats if keys %export_formats;
1208 my $conf = new FS::Conf;
1209 my $date_format = $conf->config('date_format') || '%m/%d/%Y';
1211 # call duration in the largest units that accurately reflect the granularity
1212 my $duration_sub = sub {
1213 my($cdr, %opt) = @_;
1214 my $sec = $opt{seconds} || $cdr->billsec;
1215 if ( defined $opt{granularity} &&
1216 $opt{granularity} == 0 ) { #per call
1219 elsif ( defined $opt{granularity} && $opt{granularity} == 60 ) {#full minutes
1220 my $min = int($sec/60);
1224 else { #anything else
1225 return sprintf("%dm %ds", $sec/60, $sec%60);
1229 my $price_sub = sub {
1230 my ($cdr, %opt) = @_;
1232 if ( defined($opt{charge}) ) {
1233 $price = $opt{charge};
1235 elsif ( $opt{inbound} ) {
1236 my $term = $cdr->cdr_termination(1); # 1 = inbound
1237 $price = $term->rated_price if defined $term;
1240 $price = $cdr->rated_price;
1242 length($price) ? ($opt{money_char} . $price) : '';
1245 my $src_sub = sub { $_[0]->clid || $_[0]->src };
1249 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1250 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1252 'dst', #NUMBER_DIALED
1253 $duration_sub, #DURATION
1254 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1258 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1259 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1261 $src_sub, #called from
1262 'dst', #NUMBER_DIALED
1263 $duration_sub, #DURATION
1264 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1267 'accountcode_simple' => [
1268 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1269 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1270 $src_sub, #called from
1271 'accountcode', #NUMBER_DIALED
1272 $duration_sub, #DURATION
1276 # for summary formats, the CDR is a fictitious object containing the
1277 # total billsec and the phone number of the service
1279 sub { my($cdr, %opt) = @_; $opt{ratename} },
1280 sub { my($cdr, %opt) = @_; $opt{count} },
1281 sub { my($cdr, %opt) = @_; int($opt{seconds}/60).'m' },
1286 sub { my($cdr, %opt) = @_; $opt{ratename} },
1287 sub { my($cdr, %opt) = @_; $opt{count} },
1291 sub { time2str('%d %b - %I:%M %p', shift->calldate_unix) },
1299 sub { time2str($date_format, shift->calldate_unix ) },
1300 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
1303 sub { time2str('%r', shift->calldate_unix ) },
1304 # time2str("%c", $cdr->calldate_unix), #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot
1307 sub { my($cdr, %opt) = @_; $opt{pretty_dst} || $cdr->dst; },
1309 #REGIONNAME ("Destination")
1310 sub { my($cdr, %opt) = @_; $opt{dst_regionname}; },
1319 $export_formats{'source_default'} = [ $src_sub, @{ $export_formats{'default'} }, ];
1320 $export_formats{'accountcode_default'} =
1321 [ @{ $export_formats{'default'} }[0,1],
1323 @{ $export_formats{'default'} }[2..5],
1325 my @default = @{ $export_formats{'default'} };
1326 $export_formats{'description_default'} =
1327 [ $src_sub, @default[0..2],
1328 sub { my($cdr, %opt) = @_; $cdr->description },
1331 return %export_formats;
1334 =item downstream_csv OPTION => VALUE ...
1336 Returns a string of formatted call details for display on an invoice.
1342 charge - override the 'rated_price' field of the CDR
1344 seconds - override the 'billsec' field of the CDR
1346 count - number of usage events included in this record, for summary formats
1348 ratename - name of the rate table used to rate this call
1354 sub downstream_csv {
1355 my( $self, %opt ) = @_;
1357 my $format = $opt{'format'};
1358 my %formats = $self->export_formats;
1359 return "Unknown format $format" unless exists $formats{$format};
1361 #my $conf = new FS::Conf;
1362 #$opt{'money_char'} ||= $conf->config('money_char') || '$';
1363 $opt{'money_char'} ||= FS::Conf->new->config('money_char') || '$';
1365 my $csv = new Text::CSV_XS;
1369 ref($_) ? &{$_}($self, %opt) : $self->$_();
1371 @{ $formats{$format} };
1373 return @columns if defined $opt{'keeparray'};
1375 my $status = $csv->combine(@columns);
1376 die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV"
1385 =head1 CLASS METHODS
1389 =item invoice_formats
1391 Returns an ordered list of key value pairs containing invoice format names
1392 as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values.
1396 # in the future, load this dynamically from detail_format classes
1398 sub invoice_formats {
1399 map { ($_ => $export_names{$_}->{'name'}) }
1400 grep { $export_names{$_}->{'invoice_header'} }
1404 =item invoice_header FORMAT
1406 Returns a scalar containing the CSV column header for invoice format FORMAT.
1410 sub invoice_header {
1412 $export_names{$format}->{'invoice_header'};
1417 Clears cdr and any associated cdr_termination statuses - used for
1426 local $SIG{HUP} = 'IGNORE';
1427 local $SIG{INT} = 'IGNORE';
1428 local $SIG{QUIT} = 'IGNORE';
1429 local $SIG{TERM} = 'IGNORE';
1430 local $SIG{TSTP} = 'IGNORE';
1431 local $SIG{PIPE} = 'IGNORE';
1433 my $oldAutoCommit = $FS::UID::AutoCommit;
1434 local $FS::UID::AutoCommit = 0;
1437 if ( $cdr_prerate && $cdr_prerate_cdrtypenums{$self->cdrtypenum}
1438 && $self->rated_ratedetailnum #avoid putting old CDRs back in "rated"
1439 && $self->freesidestatus eq 'done'
1443 $self->freesidestatus('rated');
1445 $self->freesidestatus('');
1448 my $error = $self->replace;
1450 $dbh->rollback if $oldAutoCommit;
1454 foreach my $cdr_termination ( $self->cdr_termination ) {
1455 #$cdr_termination->status('');
1456 #$error = $cdr_termination->replace;
1457 $error = $cdr_termination->delete;
1459 $dbh->rollback if $oldAutoCommit;
1464 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1469 =item import_formats
1471 Returns an ordered list of key value pairs containing import format names
1472 as keys (for use with batch_import) and "pretty" format names as values.
1476 #false laziness w/part_pkg & part_export
1479 foreach my $INC ( @INC ) {
1480 warn "globbing $INC/FS/cdr/*.pm\n" if $DEBUG;
1481 foreach my $file ( glob("$INC/FS/cdr/*.pm") ) {
1482 warn "attempting to load CDR format info from $file\n" if $DEBUG;
1483 $file =~ /\/(\w+)\.pm$/ or do {
1484 warn "unrecognized file in $INC/FS/cdr/: $file\n";
1488 my $info = eval "use FS::cdr::$mod; ".
1489 "\\%FS::cdr::$mod\::info;";
1491 die "error using FS::cdr::$mod (skipping): $@\n" if $@;
1494 unless ( keys %$info ) {
1495 warn "no %info hash found in FS::cdr::$mod, skipping\n";
1498 warn "got CDR format info from FS::cdr::$mod: $info\n" if $DEBUG;
1499 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1500 warn "skipping disabled CDR format FS::cdr::$mod" if $DEBUG;
1503 $cdr_info{$mod} = $info;
1507 tie my %import_formats, 'Tie::IxHash',
1508 map { $_ => $cdr_info{$_}->{'name'} }
1509 sort { $cdr_info{$a}->{'weight'} <=> $cdr_info{$b}->{'weight'} }
1510 grep { exists($cdr_info{$_}->{'import_fields'}) }
1513 sub import_formats {
1517 sub _cdr_min_parser_maker {
1519 my @fields = ref($field) ? @$field : ($field);
1520 @fields = qw( billsec duration ) unless scalar(@fields) && $fields[0];
1522 my( $cdr, $min ) = @_;
1523 my $sec = eval { _cdr_min_parse($min) };
1524 die "error parsing seconds for @fields from $min minutes: $@\n" if $@;
1525 $cdr->$_($sec) foreach @fields;
1529 sub _cdr_min_parse {
1531 sprintf('%.0f', $min * 60 );
1534 sub _cdr_date_parser_maker {
1537 my @fields = ref($field) ? @$field : ($field);
1539 my( $cdr, $datestring ) = @_;
1540 my $unixdate = eval { _cdr_date_parse($datestring, %options) };
1541 die "error parsing date for @fields from $datestring: $@\n" if $@;
1542 $cdr->$_($unixdate) foreach @fields;
1546 sub _cdr_date_parse {
1550 return '' unless length($date); #that's okay, it becomes NULL
1551 return '' if $date eq 'NA'; #sansay
1553 if ( $date =~ /^([a-z]{3})\s+([a-z]{3})\s+(\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s+(\d{4})$/i && $7 > 1970 ) {
1554 my $time = str2time($date);
1555 return $time if $time > 100000; #just in case
1558 my($year, $mon, $day, $hour, $min, $sec);
1560 #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/
1561 #taqua #2007-10-31 08:57:24.113000000
1563 if ( $date =~ /^\s*(\d{4})\D(\d{1,2})\D(\d{1,2})\D+(\d{1,2})\D(\d{1,2})\D(\d{1,2})(\D|$)/ ) {
1564 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1565 } elsif ( $date =~ /^\s*(\d{1,2})\D(\d{1,2})\D(\d{4})\s+(\d{1,2})\D(\d{1,2})(?:\D(\d{1,2}))?(\D|$)/ ) {
1566 # 8/26/2010 12:20:01
1567 # optionally without seconds
1568 ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1569 $sec = 0 if !defined($sec);
1570 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d+\.\d+)(\D|$)/ ) {
1571 # broadsoft: 20081223201938.314
1572 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1573 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\d+(\D|$)/ ) {
1574 # Taqua OM: 20050422203450943
1575 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1576 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/ ) {
1577 # WIP: 20100329121420
1578 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1579 } elsif ( $date =~ /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/) {
1581 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1584 die "unparsable date: $date"; #maybe we shouldn't die...
1587 return '' if ( $year == 1900 || $year == 1970 ) && $mon == 1 && $day == 1
1588 && $hour == 0 && $min == 0 && $sec == 0;
1590 if ($options{gmt}) {
1591 timegm($sec, $min, $hour, $day, $mon-1, $year);
1593 timelocal($sec, $min, $hour, $day, $mon-1, $year);
1597 =item batch_import HASHREF
1599 Imports CDR records. Available options are:
1611 Hash reference of preset fields, typically cdrbatch
1615 Set true to prevent throwing an error on empty imports
1621 my %import_options = (
1624 'batch_keycol' => 'cdrbatchnum',
1625 'batch_table' => 'cdr_batch',
1626 'batch_namecol' => 'cdrbatch',
1628 'formats' => { map { $_ => $cdr_info{$_}->{'import_fields'}; }
1632 #drop the || 'csv' to allow auto xls for csv types?
1633 'format_types' => { map { $_ => lc($cdr_info{$_}->{'type'} || 'csv'); }
1637 'format_headers' => { map { $_ => ( $cdr_info{$_}->{'header'} || 0 ); }
1641 'format_sep_chars' => { map { $_ => $cdr_info{$_}->{'sep_char'}; }
1645 'format_fixedlength_formats' =>
1646 { map { $_ => $cdr_info{$_}->{'fixedlength_format'}; }
1650 'format_xml_formats' =>
1651 { map { $_ => $cdr_info{$_}->{'xml_format'}; }
1655 'format_asn_formats' =>
1656 { map { $_ => $cdr_info{$_}->{'asn_format'}; }
1660 'format_row_callbacks' => { map { $_ => $cdr_info{$_}->{'row_callback'}; }
1665 sub _import_options {
1672 my $iopt = _import_options;
1673 $opt->{$_} = $iopt->{$_} foreach keys %$iopt;
1675 if ( defined $opt->{'cdrtypenum'} ) {
1676 $opt->{'preinsert_callback'} = sub {
1677 my($record,$param) = (shift,shift);
1678 $record->cdrtypenum($opt->{'cdrtypenum'});
1683 FS::Record::batch_import( $opt );
1687 =item process_batch_import
1691 sub process_batch_import {
1694 my $opt = _import_options;
1695 # $opt->{'params'} = [ 'format', 'cdrbatch' ];
1697 FS::Record::process_batch_import( $job, $opt, @_ );
1700 # if ( $format eq 'simple' ) { #should be a callback or opt in FS::cdr::simple
1701 # @columns = map { s/^ +//; $_; } @columns;
1706 # Used by FS::Upgrade to migrate to a new database.
1709 my ($class, %opts) = @_;
1711 warn "$me upgrading $class\n" if $DEBUG;
1713 my $sth = dbh->prepare(
1714 'SELECT DISTINCT(cdrbatch) FROM cdr WHERE cdrbatch IS NOT NULL'
1715 ) or die dbh->errstr;
1717 $sth->execute or die $sth->errstr;
1719 my %cdrbatchnum = ();
1720 while (my $row = $sth->fetchrow_arrayref) {
1722 my $cdr_batch = qsearchs( 'cdr_batch', { 'cdrbatch' => $row->[0] } );
1723 unless ( $cdr_batch ) {
1724 $cdr_batch = new FS::cdr_batch { 'cdrbatch' => $row->[0] };
1725 my $error = $cdr_batch->insert;
1726 die $error if $error;
1729 $cdrbatchnum{$row->[0]} = $cdr_batch->cdrbatchnum;
1732 $sth = dbh->prepare('UPDATE cdr SET cdrbatch = NULL, cdrbatchnum = ? WHERE cdrbatch IS NOT NULL AND cdrbatch = ?') or die dbh->errstr;
1734 foreach my $cdrbatch (keys %cdrbatchnum) {
1735 $sth->execute($cdrbatchnum{$cdrbatch}, $cdrbatch) or die $sth->errstr;
1740 =item ip_addr_sql FIELD RANGE
1742 Returns an SQL condition to search for CDRs with an IP address
1743 within RANGE. FIELD is either 'src_ip_addr' or 'dst_ip_addr'. RANGE
1744 should be in the form "a.b.c.d-e.f.g.h' (dotted quads), where any of
1745 the leftmost octets of the second address can be omitted if they're
1746 the same as the first address.
1752 my ($field, $range) = @_;
1753 $range =~ /^[\d\.-]+$/ or die "bad ip address range '$range'";
1754 my @r = split('-', $range);
1755 my @saddr = split('\.', $r[0] || '');
1756 my @eaddr = split('\.', $r[1] || '');
1757 unshift @eaddr, (undef) x (4 - scalar @eaddr);
1759 $eaddr[$_] = $saddr[$_] if !defined $eaddr[$_];
1761 "$field >= '".sprintf('%03d.%03d.%03d.%03d', @saddr) . "' AND ".
1762 "$field <= '".sprintf('%03d.%03d.%03d.%03d', @eaddr) . "'";
1771 L<FS::Record>, schema.html from the base documentation.