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 startdate - Start of call (UNIX-style integer timestamp)
97 =item answerdate - Answer time of call (UNIX-style integer timestamp)
99 =item enddate - End time of call (UNIX-style integer timestamp)
101 =item duration - Total time in system, in seconds
103 =item billsec - Total time call is up, in seconds
105 =item disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
107 =item amaflags - What flags to use: BILL, IGNORE etc, specified on a per channel basis like accountcode.
111 #ignore the "omit" and "documentation" AMAs??
112 #AMA = Automated Message Accounting.
113 #default: Sets the system default.
114 #omit: Do not record calls.
115 #billing: Mark the entry for billing
116 #documentation: Mark the entry for documentation.
118 =item accountcode - CDR account number to use: account
120 =item uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID)
122 =item userfield - CDR user-defined field
124 =item cdr_type - CDR type - see L<FS::cdr_type> (Usage = 1, S&E = 7, OC&C = 8)
126 =item charged_party - Service number to be billed
128 =item upstream_currency - Wholesale currency from upstream
130 =item upstream_price - Wholesale price from upstream
132 =item upstream_rateplanid - Upstream rate plan ID
134 =item rated_price - Rated (or re-rated) price
136 =item distance - km (need units field?)
138 =item islocal - Local - 1, Non Local = 0
140 =item calltypenum - Type of call - see L<FS::cdr_calltype>
142 =item description - Description (cdr_type 7&8 only) (used for cust_bill_pkg.itemdesc)
144 =item quantity - Number of items (cdr_type 7&8 only)
146 =item carrierid - Upstream Carrier ID (see L<FS::cdr_carrier>)
150 #Telstra =1, Optus = 2, RSL COM = 3
152 =item upstream_rateid - Upstream Rate ID
154 =item svcnum - Link to customer service (see L<FS::cust_svc>)
156 =item freesidestatus - NULL, processing-tiered, rated, done, skipped, no-charge, failed
158 =item freesiderewritestatus - NULL, done, skipped
170 Creates a new CDR. To add the CDR to the database, see L<"insert">.
172 Note that this stores the hash reference, not a distinct copy of the hash it
173 points to. You can ask the object for a copy with the I<hash> method.
177 # the new method can be inherited from FS::Record, if a table method is defined
184 #XXX fill in some (more) nice names
186 'calldate' => 'Call date',
187 'clid' => 'Caller ID',
189 'dst' => 'Destination',
190 'dcontext' => 'Dest. context',
191 'channel' => 'Channel',
192 'dstchannel' => 'Destination channel',
195 'src_ip_addr' => 'Source IP',
196 'dst_ip_addr' => 'Dest. IP',
197 'startdate' => 'Start date',
198 'answerdate' => 'Answer date',
199 'enddate' => 'End date',
200 'duration' => 'Duration',
201 'billsec' => 'Billable seconds',
202 'disposition' => 'Disposition',
203 'amaflags' => 'AMA flags',
204 'accountcode' => 'Account code',
206 'userfield' => 'User field',
208 'charged_party' => 'Charged party',
209 #'upstream_currency' => '',
210 'upstream_price' => 'Upstream price',
211 #'upstream_rateplanid' => '',
212 #'ratedetailnum' => '',
213 'rated_price' => 'Rated price',
216 #'calltypenum' => '',
217 #'description' => '',
219 'carrierid' => 'Carrier ID',
220 #'upstream_rateid' => '',
221 'svcnum' => 'Freeside service',
222 'freesidestatus' => 'Freeside status',
223 'freesiderewritestatus' => 'Freeside rewrite status',
224 'cdrbatch' => 'Legacy batch',
225 'cdrbatchnum' => 'Batch',
234 Adds this record to the database. If there is an error, returns the error,
235 otherwise returns false.
239 # the insert method can be inherited from FS::Record
243 Delete this record from the database.
247 # the delete method can be inherited from FS::Record
249 =item replace OLD_RECORD
251 Replaces the OLD_RECORD with this one in the database. If there is an error,
252 returns the error, otherwise returns false.
256 # the replace method can be inherited from FS::Record
260 Checks all fields to make sure this is a valid CDR. If there is
261 an error, returns the error, otherwise returns false. Called by the insert
264 Note: Unlike most types of records, we don't want to "reject" a CDR and we want
265 to process them as quickly as possible, so we allow the database to check most
273 # we don't want to "reject" a CDR like other sorts of input...
275 # $self->ut_numbern('acctid')
276 ## || $self->ut_('calldate')
277 # || $self->ut_text('clid')
278 # || $self->ut_text('src')
279 # || $self->ut_text('dst')
280 # || $self->ut_text('dcontext')
281 # || $self->ut_text('channel')
282 # || $self->ut_text('dstchannel')
283 # || $self->ut_text('lastapp')
284 # || $self->ut_text('lastdata')
285 # || $self->ut_numbern('startdate')
286 # || $self->ut_numbern('answerdate')
287 # || $self->ut_numbern('enddate')
288 # || $self->ut_number('duration')
289 # || $self->ut_number('billsec')
290 # || $self->ut_text('disposition')
291 # || $self->ut_number('amaflags')
292 # || $self->ut_text('accountcode')
293 # || $self->ut_text('uniqueid')
294 # || $self->ut_text('userfield')
295 # || $self->ut_numbern('cdrtypenum')
296 # || $self->ut_textn('charged_party')
297 ## || $self->ut_n('upstream_currency')
298 ## || $self->ut_n('upstream_price')
299 # || $self->ut_numbern('upstream_rateplanid')
300 ## || $self->ut_n('distance')
301 # || $self->ut_numbern('islocal')
302 # || $self->ut_numbern('calltypenum')
303 # || $self->ut_textn('description')
304 # || $self->ut_numbern('quantity')
305 # || $self->ut_numbern('carrierid')
306 # || $self->ut_numbern('upstream_rateid')
307 # || $self->ut_numbern('svcnum')
308 # || $self->ut_textn('freesidestatus')
309 # || $self->ut_textn('freesiderewritestatus')
311 # return $error if $error;
313 for my $f ( grep { $self->$_ =~ /\D/ } qw(startdate answerdate enddate)){
314 $self->$f( str2time($self->$f) );
317 $self->calldate( $self->startdate_sql )
318 if !$self->calldate && $self->startdate;
320 #was just for $format eq 'taqua' but can't see the harm... add something to
321 #disable if it becomes a problem
322 if ( $self->duration eq '' && $self->enddate && $self->startdate ) {
323 $self->duration( $self->enddate - $self->startdate );
325 if ( $self->billsec eq '' && $self->enddate && $self->answerdate ) {
326 $self->billsec( $self->enddate - $self->answerdate );
329 if ( ! $self->enddate && $self->startdate && $self->duration ) {
330 $self->enddate( $self->startdate + $self->duration );
333 $self->set_charged_party;
335 #check the foreign keys even?
336 #do we want to outright *reject* the CDR?
338 $self->ut_numbern('acctid')
340 #add a config option to turn these back on if someone needs 'em
342 # #Usage = 1, S&E = 7, OC&C = 8
343 # || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
345 # #the big list in appendix 2
346 # || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' )
348 # # Telstra =1, Optus = 2, RSL COM = 3
349 # || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
351 return $error if $error;
356 =item is_tollfree [ COLUMN ]
358 Returns true when the cdr represents a toll free number and false otherwise.
360 By default, inspects the dst field, but an optional column name can be passed
361 to inspect other field.
367 my $field = scalar(@_) ? shift : 'dst';
368 ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0;
371 =item set_charged_party
373 If the charged_party field is already set, does nothing. Otherwise:
375 If the cdr-charged_party-accountcode config option is enabled, sets the
376 charged_party to the accountcode.
378 Otherwise sets the charged_party normally: to the src field in most cases,
379 or to the dst field if it is a toll free number.
383 sub set_charged_party {
386 my $conf = new FS::Conf;
388 unless ( $self->charged_party ) {
390 if ( $conf->exists('cdr-charged_party-accountcode') && $self->accountcode ){
392 my $charged_party = $self->accountcode;
393 $charged_party =~ s/^0+//
394 if $conf->exists('cdr-charged_party-accountcode-trim_leading_0s');
395 $self->charged_party( $charged_party );
397 } elsif ( $conf->exists('cdr-charged_party-field') ) {
399 my $field = $conf->config('cdr-charged_party-field');
400 $self->charged_party( $self->$field() );
404 if ( $self->is_tollfree ) {
405 $self->charged_party($self->dst);
407 $self->charged_party($self->src);
414 # my $prefix = $conf->config('cdr-charged_party-truncate_prefix');
415 # my $prefix_len = length($prefix);
416 # my $trunc_len = $conf->config('cdr-charged_party-truncate_length');
418 # $self->charged_party( substr($self->charged_party, 0, $trunc_len) )
419 # if $prefix_len && $trunc_len
420 # && substr($self->charged_party, 0, $prefix_len) eq $prefix;
424 =item set_status STATUS
426 Sets the status to the provided string. If there is an error, returns the
427 error, otherwise returns false.
429 If status is being changed from 'rated' to some other status, also removes
430 any usage allocations to this CDR.
435 my($self, $status) = @_;
436 my $old_status = $self->freesidestatus;
437 $self->freesidestatus($status);
438 my $error = $self->replace;
439 if ( $old_status eq 'rated' and $status ne 'done' ) {
440 # deallocate any usage
441 foreach (qsearch('cdr_cust_pkg_usage', {acctid => $self->acctid})) {
442 my $cust_pkg_usage = $_->cust_pkg_usage;
443 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $_->minutes);
444 $error ||= $cust_pkg_usage->replace || $_->delete;
450 =item set_status_and_rated_price STATUS RATED_PRICE [ SVCNUM [ OPTION => VALUE ... ] ]
452 Sets the status and rated price.
454 Available options are: inbound, rated_pretty_dst, rated_regionname,
455 rated_seconds, rated_minutes, rated_granularity, rated_ratedetailnum,
456 rated_classnum, rated_ratename.
458 If there is an error, returns the error, otherwise returns false.
462 sub set_status_and_rated_price {
463 my($self, $status, $rated_price, $svcnum, %opt) = @_;
465 if ($opt{'inbound'}) {
467 my $term = $self->cdr_termination( 1 ); #1: inbound
470 warn "replacing existing cdr status (".$self->acctid.")\n" if $term;
471 $error = $term->delete;
472 return $error if $error;
474 $term = FS::cdr_termination->new({
475 acctid => $self->acctid,
477 rated_price => $rated_price,
480 $term->rated_seconds($opt{rated_seconds}) if exists($opt{rated_seconds});
481 $term->rated_minutes($opt{rated_minutes}) if exists($opt{rated_minutes});
482 $term->svcnum($svcnum) if $svcnum;
483 return $term->insert;
487 $self->freesidestatus($status);
488 $self->rated_price($rated_price);
490 foreach grep exists($opt{$_}), map "rated_$_",
491 qw( pretty_dst regionname seconds minutes granularity
492 ratedetailnum classnum ratename );
493 $self->svcnum($svcnum) if $svcnum;
494 return $self->replace();
499 =item parse_number [ OPTION => VALUE ... ]
501 Returns two scalars, the countrycode and the rest of the number.
503 Options are passed as name-value pairs. Currently available options are:
509 The column containing the number to be parsed. Defaults to dst.
511 =item international_prefix
513 The digits for international dialing. Defaults to '011' The value '+' is
516 =item domestic_prefix
518 The digits for domestic long distance dialing. Defaults to '1'
525 my ($self, %options) = @_;
527 my $field = $options{column} || 'dst';
528 my $intl = $options{international_prefix} || '011';
529 my $countrycode = '';
530 my $number = $self->$field();
532 my $to_or_from = 'concerning';
533 $to_or_from = 'from' if $field eq 'src';
534 $to_or_from = 'to' if $field eq 'dst';
535 warn "parsing call $to_or_from $number\n" if $DEBUG;
537 #remove non-phone# stuff and whitespace
540 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
542 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
544 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
545 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
549 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
550 #first look for 1 digit country code
551 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
553 $number = $u1.$u2.$rest;
554 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
557 } else { #3 digit country code
558 $countrycode = $three;
563 my $domestic_prefix =
564 exists($options{domestic_prefix}) ? $options{domestic_prefix} : '';
565 $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
566 $number =~ s/^$countrycode//;# if length($number) > 10;
569 return($countrycode, $number);
573 =item rate [ OPTION => VALUE ... ]
575 Rates this CDR according and sets the status to 'rated'.
577 Available options are: part_pkg, svcnum, single_price_included_minutes, region_group, region_group_included_minutes.
579 part_pkg is required.
581 If svcnum is specified, will also associate this CDR with the specified svcnum.
583 single_price_included_minutes is requried for single_price price plans
584 (otherwise unused/ignored). It should be set to a scalar reference of the
585 number of included minutes and will be decremented by the rated minutes of this
588 region_group_included_minutes is required for prefix price plans which have
589 included minutes (otherwise unused/ignored). It should be set to a scalar
590 reference of the number of included minutes and will be decremented by the
591 rated minutes of this CDR.
593 region_group_included_minutes_hashref is required for prefix price plans which
594 have included minues (otherwise unused/ignored). It should be set to an empty
595 hashref at the start of a month's rating and then preserved across CDRs.
600 my( $self, %opt ) = @_;
601 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
604 warn "rating CDR $self\n".
605 join('', map { " $_ => ". $self->{$_}. "\n" } keys %$self );
608 my $rating_method = $part_pkg->option_cacheable('rating_method') || 'prefix';
609 my $method = "rate_$rating_method";
610 $self->$method(%opt);
614 our %interval_cache = (); # for timed rates
617 my( $self, %opt ) = @_;
618 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
619 my $cust_pkg = $opt{'cust_pkg'};
622 # this will result in those CDRs being marked as done... is that
625 if ( $part_pkg->option_cacheable('411_rewrite') ) {
626 my $dirass = $part_pkg->option_cacheable('411_rewrite');
628 @dirass = split(',', $dirass);
631 if ( length($self->dst) && grep { $self->dst eq $_ } @dirass ) {
636 my $reason = $part_pkg->check_chargable( $self,
637 'da_rewrote' => $da_rewrote,
640 warn "not charging for CDR ($reason)\n" if $DEBUG;
641 return $self->set_status_and_rated_price( 'skipped',
647 if ( $part_pkg->option_cacheable('skip_same_customer')
648 and ! $self->is_tollfree ) {
649 my ($dst_countrycode, $dst_number) = $self->parse_number(
651 international_prefix => $part_pkg->option_cacheable('international_prefix'),
652 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
654 my $dst_same_cust = FS::Record->scalar_sql(
655 'SELECT COUNT(svc_phone.svcnum) AS count '.
657 'JOIN cust_svc USING (pkgnum) ' .
658 'JOIN svc_phone USING (svcnum) ' .
659 'WHERE svc_phone.countrycode = ' . dbh->quote($dst_countrycode) .
660 ' AND svc_phone.phonenum = ' . dbh->quote($dst_number) .
661 ' AND cust_pkg.custnum = ' . $cust_pkg->custnum,
663 if ( $dst_same_cust > 0 ) {
664 warn "not charging for CDR (same source and destination customer)\n" if $DEBUG;
665 return $self->set_status_and_rated_price( 'skipped',
676 # look up rate details based on called station id
677 # (or calling station id for toll free calls)
680 my( $to_or_from, $column );
681 if ( $self->is_tollfree && ! $part_pkg->option_cacheable('disable_tollfree') )
683 $to_or_from = 'from';
685 } else { #regular call
690 #determine the country code
691 my ($countrycode, $number) = $self->parse_number(
693 international_prefix => $part_pkg->option_cacheable('international_prefix'),
694 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
697 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
698 my $pretty_dst = "+$countrycode $number";
699 #asterisks here causes inserting the detail to barf, so:
700 $pretty_dst =~ s/\*//g;
702 my $eff_ratenum = $self->is_tollfree('accountcode')
703 ? $part_pkg->option_cacheable('accountcode_tollfree_ratenum')
707 my $intrastate_ratenum = $part_pkg->option_cacheable('intrastate_ratenum');
708 if ( $intrastate_ratenum && !$self->is_tollfree ) {
709 $ratename = 'Interstate'; #until proven otherwise
710 # this is relatively easy only because:
711 # -assume all numbers are valid NANP numbers NOT in a fully-qualified format
712 # -disregard toll-free
713 # -disregard private or unknown numbers
714 # -there is exactly one record in rate_prefix for a given NPANXX
715 # -default to interstate if we can't find one or both of the prefixes
716 my (undef, $dstprefix) = $self->parse_number(
718 international_prefix => $part_pkg->option_cacheable('international_prefix'),
719 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
721 $dstprefix =~ /^(\d{6})/;
722 $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
725 my (undef, $srcprefix) = $self->parse_number(
727 international_prefix => $part_pkg->option_cacheable('international_prefix'),
728 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
730 $srcprefix =~ /^(\d{6})/;
731 $srcprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
734 if ($srcprefix && $dstprefix
735 && $srcprefix->state && $dstprefix->state
736 && $srcprefix->state eq $dstprefix->state) {
737 $eff_ratenum = $intrastate_ratenum;
738 $ratename = 'Intrastate'; # XXX possibly just use the ratename?
742 $eff_ratenum ||= $part_pkg->option_cacheable('ratenum');
743 my $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
744 or die "ratenum $eff_ratenum not found!";
746 my @ltime = localtime($self->startdate);
747 my $weektime = $ltime[0] +
748 $ltime[1]*60 + #minutes
749 $ltime[2]*3600 + #hours
750 $ltime[6]*86400; #days since sunday
751 # if there's no timed rate_detail for this time/region combination,
752 # dest_detail returns the default. There may still be a timed rate
753 # that applies after the starttime of the call, so be careful...
754 my $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
755 'phonenum' => $number,
756 'weektime' => $weektime,
757 'cdrtypenum' => $self->cdrtypenum,
760 unless ( $rate_detail ) {
762 if ( $part_pkg->option_cacheable('ignore_unrateable') ) {
764 if ( $part_pkg->option_cacheable('ignore_unrateable') == 2 ) {
765 # mark the CDR as unrateable
766 return $self->set_status_and_rated_price(
771 } elsif ( $part_pkg->option_cacheable('ignore_unrateable') == 1 ) {
773 warn "no rate_detail found for CDR.acctid: ". $self->acctid.
778 die "unknown ignore_unrateable, pkgpart ". $part_pkg->pkgpart;
783 die "FATAL: no rate_detail found in ".
784 $rate->ratenum. ":". $rate->ratename. " rate plan ".
785 "for +$countrycode $number (CDR acctid ". $self->acctid. "); ".
786 "add a rate or set ignore_unrateable flag on the package def\n";
791 my $rate_region = $rate_detail->dest_region;
792 my $regionnum = $rate_region->regionnum;
793 warn " found rate for regionnum $regionnum ".
794 "and rate detail $rate_detail\n"
797 if ( !exists($interval_cache{$regionnum}) ) {
799 sort { $a->stime <=> $b->stime }
800 map { $_->rate_time->intervals }
801 qsearch({ 'table' => 'rate_detail',
802 'hashref' => { 'ratenum' => $rate->ratenum },
803 'extra_sql' => 'AND ratetimenum IS NOT NULL',
806 $interval_cache{$regionnum} = \@intervals;
807 warn " cached ".scalar(@intervals)." interval(s)\n"
812 # find the price and add detail to the invoice
815 # About this section:
816 # We don't round _anything_ (except granularizing)
817 # until the final $charge = sprintf("%.2f"...).
819 my $seconds_left = $part_pkg->option_cacheable('use_duration')
823 #no, do this later so it respects (group) included minutes
824 # # charge for the first (conn_sec) seconds
825 # my $seconds = min($seconds_left, $rate_detail->conn_sec);
826 # $seconds_left -= $seconds;
827 # $weektime += $seconds;
828 # my $charge = $rate_detail->conn_charge;
831 my $connection_charged = 0;
834 while($seconds_left) {
835 my $ratetimenum = $rate_detail->ratetimenum; # may be empty
837 # find the end of the current rate interval
838 if(@{ $interval_cache{$regionnum} } == 0) {
839 # There are no timed rates in this group, so just stay
840 # in the default rate_detail for the entire duration.
841 # Set an "end" of 1 past the end of the current call.
842 $etime = $weektime + $seconds_left + 1;
844 elsif($ratetimenum) {
845 # This is a timed rate, so go to the etime of this interval.
846 # If it's followed by another timed rate, the stime of that
847 # interval should match the etime of this one.
848 my $interval = $rate_detail->rate_time->contains($weektime);
849 $etime = $interval->etime;
852 # This is a default rate, so use the stime of the next
853 # interval in the sequence.
854 my $next_int = first { $_->stime > $weektime }
855 @{ $interval_cache{$regionnum} };
857 $etime = $next_int->stime;
860 # weektime is near the end of the week, so decrement
861 # it by a full week and use the stime of the first
863 $weektime -= (3600*24*7);
864 $etime = $interval_cache{$regionnum}->[0]->stime;
868 my $charge_sec = min($seconds_left, $etime - $weektime);
870 $seconds_left -= $charge_sec;
872 my $granularity = $rate_detail->sec_granularity;
875 if ( $granularity ) { # charge per minute
876 # Round up to the nearest $granularity
877 if ( $charge_sec and $charge_sec % $granularity ) {
878 $charge_sec += $granularity - ($charge_sec % $granularity);
880 $minutes = $charge_sec / 60; #don't round this
887 $seconds += $charge_sec;
889 if ( $rate_detail->min_included ) {
890 # the old, kind of deprecated way to do this
891 my $included_min = $opt{'region_group_included_min_hashref'} || {};
893 # by default, set the included minutes for this region/time to
894 # what's in the rate_detail
895 $included_min->{$regionnum}{$ratetimenum} = $rate_detail->min_included
896 unless exists $included_min->{$regionnum}{$ratetimenum};
898 # the way that doesn't work
899 #my $region_group = ($part_pkg->option_cacheable('min_included') || 0) > 0;
901 #${$opt{region_group_included_min}} -= $minutes
902 # if $region_group && $rate_detail->region_group;
904 if ( $included_min->{$regionnum}{$ratetimenum} > $minutes ) {
906 $included_min->{$regionnum}{$ratetimenum} -= $minutes;
908 $charge_sec -= ($included_min->{$regionnum}{$ratetimenum} * 60);
909 $included_min->{$regionnum}{$ratetimenum} = 0;
913 my $applied_min = $cust_pkg->apply_usage(
915 'rate_detail' => $rate_detail,
916 'minutes' => $minutes
918 # for now, usage pools deal only in whole minutes
919 $charge_sec -= $applied_min * 60;
922 if ( $charge_sec > 0 ) {
924 #NOW do connection charges here... right?
925 #my $conn_seconds = min($seconds_left, $rate_detail->conn_sec);
926 my $conn_seconds = 0;
927 unless ( $connection_charged++ ) { #only one connection charge
928 $conn_seconds = min($charge_sec, $rate_detail->conn_sec);
929 $seconds_left -= $conn_seconds;
930 $weektime += $conn_seconds;
931 $charge += $rate_detail->conn_charge;
934 #should preserve (display?) this
935 my $charge_min = ( $charge_sec - $conn_seconds ) / 60;
936 $charge += ($rate_detail->min_charge * $charge_min) if $charge_min > 0; #still not rounded
940 # choose next rate_detail
941 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
942 'phonenum' => $number,
943 'weektime' => $etime,
944 'cdrtypenum' => $self->cdrtypenum })
946 # we have now moved forward to $etime
949 } #while $seconds_left
951 # this is why we need regionnum/rate_region....
952 warn " (rate region $rate_region)\n" if $DEBUG;
954 $self->set_status_and_rated_price(
956 sprintf('%.2f', $charge + 0.000001), # NOW round it.
958 'rated_pretty_dst' => $pretty_dst,
959 'rated_regionname' => $rate_region->regionname,
960 'rated_seconds' => $seconds,
961 'rated_granularity' => $rate_detail->sec_granularity, #$granularity
962 'rated_ratedetailnum' => $rate_detail->ratedetailnum,
963 'rated_classnum' => $rate_detail->classnum, #rated_ratedetailnum?
964 'rated_ratename' => $ratename, #not rate_detail - Intrastate/Interstate
969 sub rate_upstream_simple {
970 my( $self, %opt ) = @_;
972 $self->set_status_and_rated_price(
974 sprintf('%.3f', $self->upstream_price),
976 'rated_classnum' => $self->calltypenum,
980 sub rate_single_price {
981 my( $self, %opt ) = @_;
982 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
984 # a little false laziness w/abov
985 # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
987 my $granularity = length($part_pkg->option_cacheable('sec_granularity'))
988 ? $part_pkg->option_cacheable('sec_granularity')
991 my $seconds = $part_pkg->option_cacheable('use_duration')
995 $seconds += $granularity - ( $seconds % $granularity )
996 if $seconds # don't granular-ize 0 billsec calls (bills them)
997 && $granularity # 0 is per call
998 && $seconds % $granularity;
999 my $minutes = $granularity ? ($seconds / 60) : 1;
1001 my $charge_min = $minutes;
1003 ${$opt{single_price_included_min}} -= $minutes;
1004 if ( ${$opt{single_price_included_min}} > 0 ) {
1007 $charge_min = 0 - ${$opt{single_price_included_min}};
1008 ${$opt{single_price_included_min}} = 0;
1012 sprintf('%.4f', ( $part_pkg->option_cacheable('min_charge') * $charge_min )
1013 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
1015 $self->set_status_and_rated_price(
1019 'rated_granularity' => $granularity,
1020 'rated_seconds' => $seconds,
1025 =item cdr_termination [ TERMPART ]
1029 sub cdr_termination {
1032 if ( scalar(@_) && $_[0] ) {
1033 my $termpart = shift;
1035 qsearchs('cdr_termination', { acctid => $self->acctid,
1036 termpart => $termpart,
1042 qsearch('cdr_termination', { acctid => $self->acctid, } );
1050 Parses the calldate in SQL string format and returns a UNIX timestamp.
1055 str2time(shift->calldate);
1060 Parses the startdate in UNIX timestamp format and returns a string in SQL
1066 my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate);
1069 "$year-$mon-$mday $hour:$min:$sec";
1074 Returns the FS::cdr_carrier object associated with this CDR, or false if no
1075 carrierid is defined.
1079 my %carrier_cache = ();
1083 return '' unless $self->carrierid;
1084 $carrier_cache{$self->carrierid} ||=
1085 qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } );
1090 Returns the carrier name (see L<FS::cdr_carrier>), or the empty string if
1091 no FS::cdr_carrier object is assocated with this CDR.
1097 my $cdr_carrier = $self->cdr_carrier;
1098 $cdr_carrier ? $cdr_carrier->carriername : '';
1103 Returns the FS::cdr_calltype object associated with this CDR, or false if no
1104 calltypenum is defined.
1108 my %calltype_cache = ();
1112 return '' unless $self->calltypenum;
1113 $calltype_cache{$self->calltypenum} ||=
1114 qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } );
1119 Returns the call type name (see L<FS::cdr_calltype>), or the empty string if
1120 no FS::cdr_calltype object is assocated with this CDR.
1126 my $cdr_calltype = $self->cdr_calltype;
1127 $cdr_calltype ? $cdr_calltype->calltypename : '';
1130 =item downstream_csv [ OPTION => VALUE, ... ]
1134 my %export_names = (
1137 'invoice_header' => "Date,Time,Name,Destination,Duration,Price",
1140 'name' => 'Simple with source',
1141 'invoice_header' => "Date,Time,Called From,Destination,Duration,Price",
1142 #"Date,Time,Name,Called From,Destination,Duration,Price",
1144 'accountcode_simple' => {
1145 'name' => 'Simple with accountcode',
1146 'invoice_header' => "Date,Time,Called From,Account,Duration,Price",
1150 'invoice_header' => "Date/Time,Called Number,Min/Sec,Price",
1153 'name' => 'Default',
1154 'invoice_header' => 'Date,Time,Number,Destination,Duration,Price',
1156 'source_default' => {
1157 'name' => 'Default with source',
1158 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1160 'accountcode_default' => {
1161 'name' => 'Default plus accountcode',
1162 'invoice_header' => 'Date,Time,Account,Number,Destination,Duration,Price',
1164 'description_default' => {
1165 'name' => 'Default with description field as destination',
1166 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1169 'name' => 'Summary, one line per service',
1170 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1173 'name' => 'Number of calls, one line per service',
1174 'invoice_header' => 'Caller,Rate,Messages,Price',
1176 'sum_duration_prefix' => {
1177 'name' => 'Summary, one line per destination prefix',
1178 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1182 my %export_formats = ();
1183 sub export_formats {
1186 return %export_formats if keys %export_formats;
1188 my $conf = new FS::Conf;
1189 my $date_format = $conf->config('date_format') || '%m/%d/%Y';
1191 # call duration in the largest units that accurately reflect the granularity
1192 my $duration_sub = sub {
1193 my($cdr, %opt) = @_;
1194 my $sec = $opt{seconds} || $cdr->billsec;
1195 if ( defined $opt{granularity} &&
1196 $opt{granularity} == 0 ) { #per call
1199 elsif ( defined $opt{granularity} && $opt{granularity} == 60 ) {#full minutes
1200 my $min = int($sec/60);
1204 else { #anything else
1205 return sprintf("%dm %ds", $sec/60, $sec%60);
1209 my $price_sub = sub {
1210 my ($cdr, %opt) = @_;
1212 if ( defined($opt{charge}) ) {
1213 $price = $opt{charge};
1215 elsif ( $opt{inbound} ) {
1216 my $term = $cdr->cdr_termination(1); # 1 = inbound
1217 $price = $term->rated_price if defined $term;
1220 $price = $cdr->rated_price;
1222 length($price) ? ($opt{money_char} . $price) : '';
1225 my $src_sub = sub { $_[0]->clid || $_[0]->src };
1229 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1230 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1232 'dst', #NUMBER_DIALED
1233 $duration_sub, #DURATION
1234 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1238 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1239 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1241 $src_sub, #called from
1242 'dst', #NUMBER_DIALED
1243 $duration_sub, #DURATION
1244 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1247 'accountcode_simple' => [
1248 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1249 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1250 $src_sub, #called from
1251 'accountcode', #NUMBER_DIALED
1252 $duration_sub, #DURATION
1256 # for summary formats, the CDR is a fictitious object containing the
1257 # total billsec and the phone number of the service
1259 sub { my($cdr, %opt) = @_; $opt{ratename} },
1260 sub { my($cdr, %opt) = @_; $opt{count} },
1261 sub { my($cdr, %opt) = @_; int($opt{seconds}/60).'m' },
1266 sub { my($cdr, %opt) = @_; $opt{ratename} },
1267 sub { my($cdr, %opt) = @_; $opt{count} },
1271 sub { time2str('%d %b - %I:%M %p', shift->calldate_unix) },
1279 sub { time2str($date_format, shift->calldate_unix ) },
1280 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
1283 sub { time2str('%r', shift->calldate_unix ) },
1284 # 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
1287 sub { my($cdr, %opt) = @_; $opt{pretty_dst} || $cdr->dst; },
1289 #REGIONNAME ("Destination")
1290 sub { my($cdr, %opt) = @_; $opt{dst_regionname}; },
1299 $export_formats{'source_default'} = [ $src_sub, @{ $export_formats{'default'} }, ];
1300 $export_formats{'accountcode_default'} =
1301 [ @{ $export_formats{'default'} }[0,1],
1303 @{ $export_formats{'default'} }[2..5],
1305 my @default = @{ $export_formats{'default'} };
1306 $export_formats{'description_default'} =
1307 [ $src_sub, @default[0..2],
1308 sub { my($cdr, %opt) = @_; $cdr->description },
1311 return %export_formats;
1314 =item downstream_csv OPTION => VALUE ...
1316 Returns a string of formatted call details for display on an invoice.
1322 charge - override the 'rated_price' field of the CDR
1324 seconds - override the 'billsec' field of the CDR
1326 count - number of usage events included in this record, for summary formats
1328 ratename - name of the rate table used to rate this call
1334 sub downstream_csv {
1335 my( $self, %opt ) = @_;
1337 my $format = $opt{'format'};
1338 my %formats = $self->export_formats;
1339 return "Unknown format $format" unless exists $formats{$format};
1341 #my $conf = new FS::Conf;
1342 #$opt{'money_char'} ||= $conf->config('money_char') || '$';
1343 $opt{'money_char'} ||= FS::Conf->new->config('money_char') || '$';
1345 my $csv = new Text::CSV_XS;
1349 ref($_) ? &{$_}($self, %opt) : $self->$_();
1351 @{ $formats{$format} };
1353 return @columns if defined $opt{'keeparray'};
1355 my $status = $csv->combine(@columns);
1356 die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV"
1365 =head1 CLASS METHODS
1369 =item invoice_formats
1371 Returns an ordered list of key value pairs containing invoice format names
1372 as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values.
1376 # in the future, load this dynamically from detail_format classes
1378 sub invoice_formats {
1379 map { ($_ => $export_names{$_}->{'name'}) }
1380 grep { $export_names{$_}->{'invoice_header'} }
1384 =item invoice_header FORMAT
1386 Returns a scalar containing the CSV column header for invoice format FORMAT.
1390 sub invoice_header {
1392 $export_names{$format}->{'invoice_header'};
1397 Clears cdr and any associated cdr_termination statuses - used for
1406 local $SIG{HUP} = 'IGNORE';
1407 local $SIG{INT} = 'IGNORE';
1408 local $SIG{QUIT} = 'IGNORE';
1409 local $SIG{TERM} = 'IGNORE';
1410 local $SIG{TSTP} = 'IGNORE';
1411 local $SIG{PIPE} = 'IGNORE';
1413 my $oldAutoCommit = $FS::UID::AutoCommit;
1414 local $FS::UID::AutoCommit = 0;
1417 if ( $cdr_prerate && $cdr_prerate_cdrtypenums{$self->cdrtypenum}
1418 && $self->rated_ratedetailnum #avoid putting old CDRs back in "rated"
1419 && $self->freesidestatus eq 'done'
1423 $self->freesidestatus('rated');
1425 $self->freesidestatus('');
1428 my $error = $self->replace;
1430 $dbh->rollback if $oldAutoCommit;
1434 foreach my $cdr_termination ( $self->cdr_termination ) {
1435 #$cdr_termination->status('');
1436 #$error = $cdr_termination->replace;
1437 $error = $cdr_termination->delete;
1439 $dbh->rollback if $oldAutoCommit;
1444 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1449 =item import_formats
1451 Returns an ordered list of key value pairs containing import format names
1452 as keys (for use with batch_import) and "pretty" format names as values.
1456 #false laziness w/part_pkg & part_export
1459 foreach my $INC ( @INC ) {
1460 warn "globbing $INC/FS/cdr/*.pm\n" if $DEBUG;
1461 foreach my $file ( glob("$INC/FS/cdr/*.pm") ) {
1462 warn "attempting to load CDR format info from $file\n" if $DEBUG;
1463 $file =~ /\/(\w+)\.pm$/ or do {
1464 warn "unrecognized file in $INC/FS/cdr/: $file\n";
1468 my $info = eval "use FS::cdr::$mod; ".
1469 "\\%FS::cdr::$mod\::info;";
1471 die "error using FS::cdr::$mod (skipping): $@\n" if $@;
1474 unless ( keys %$info ) {
1475 warn "no %info hash found in FS::cdr::$mod, skipping\n";
1478 warn "got CDR format info from FS::cdr::$mod: $info\n" if $DEBUG;
1479 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1480 warn "skipping disabled CDR format FS::cdr::$mod" if $DEBUG;
1483 $cdr_info{$mod} = $info;
1487 tie my %import_formats, 'Tie::IxHash',
1488 map { $_ => $cdr_info{$_}->{'name'} }
1489 sort { $cdr_info{$a}->{'weight'} <=> $cdr_info{$b}->{'weight'} }
1490 grep { exists($cdr_info{$_}->{'import_fields'}) }
1493 sub import_formats {
1497 sub _cdr_min_parser_maker {
1499 my @fields = ref($field) ? @$field : ($field);
1500 @fields = qw( billsec duration ) unless scalar(@fields) && $fields[0];
1502 my( $cdr, $min ) = @_;
1503 my $sec = eval { _cdr_min_parse($min) };
1504 die "error parsing seconds for @fields from $min minutes: $@\n" if $@;
1505 $cdr->$_($sec) foreach @fields;
1509 sub _cdr_min_parse {
1511 sprintf('%.0f', $min * 60 );
1514 sub _cdr_date_parser_maker {
1517 my @fields = ref($field) ? @$field : ($field);
1519 my( $cdr, $datestring ) = @_;
1520 my $unixdate = eval { _cdr_date_parse($datestring, %options) };
1521 die "error parsing date for @fields from $datestring: $@\n" if $@;
1522 $cdr->$_($unixdate) foreach @fields;
1526 sub _cdr_date_parse {
1530 return '' unless length($date); #that's okay, it becomes NULL
1531 return '' if $date eq 'NA'; #sansay
1533 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 ) {
1534 my $time = str2time($date);
1535 return $time if $time > 100000; #just in case
1538 my($year, $mon, $day, $hour, $min, $sec);
1540 #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/
1541 #taqua #2007-10-31 08:57:24.113000000
1543 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|$)/ ) {
1544 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1545 } 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|$)/ ) {
1546 # 8/26/2010 12:20:01
1547 # optionally without seconds
1548 ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1549 $sec = 0 if !defined($sec);
1550 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d+\.\d+)(\D|$)/ ) {
1551 # broadsoft: 20081223201938.314
1552 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1553 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\d+(\D|$)/ ) {
1554 # Taqua OM: 20050422203450943
1555 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1556 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/ ) {
1557 # WIP: 20100329121420
1558 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1559 } elsif ( $date =~ /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/) {
1561 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1564 die "unparsable date: $date"; #maybe we shouldn't die...
1567 return '' if ( $year == 1900 || $year == 1970 ) && $mon == 1 && $day == 1
1568 && $hour == 0 && $min == 0 && $sec == 0;
1570 if ($options{gmt}) {
1571 timegm($sec, $min, $hour, $day, $mon-1, $year);
1573 timelocal($sec, $min, $hour, $day, $mon-1, $year);
1577 =item batch_import HASHREF
1579 Imports CDR records. Available options are:
1591 Hash reference of preset fields, typically cdrbatch
1595 Set true to prevent throwing an error on empty imports
1601 my %import_options = (
1604 'batch_keycol' => 'cdrbatchnum',
1605 'batch_table' => 'cdr_batch',
1606 'batch_namecol' => 'cdrbatch',
1608 'formats' => { map { $_ => $cdr_info{$_}->{'import_fields'}; }
1612 #drop the || 'csv' to allow auto xls for csv types?
1613 'format_types' => { map { $_ => lc($cdr_info{$_}->{'type'} || 'csv'); }
1617 'format_headers' => { map { $_ => ( $cdr_info{$_}->{'header'} || 0 ); }
1621 'format_sep_chars' => { map { $_ => $cdr_info{$_}->{'sep_char'}; }
1625 'format_fixedlength_formats' =>
1626 { map { $_ => $cdr_info{$_}->{'fixedlength_format'}; }
1630 'format_xml_formats' =>
1631 { map { $_ => $cdr_info{$_}->{'xml_format'}; }
1635 'format_asn_formats' =>
1636 { map { $_ => $cdr_info{$_}->{'asn_format'}; }
1640 'format_row_callbacks' => { map { $_ => $cdr_info{$_}->{'row_callback'}; }
1645 sub _import_options {
1652 my $iopt = _import_options;
1653 $opt->{$_} = $iopt->{$_} foreach keys %$iopt;
1655 if ( defined $opt->{'cdrtypenum'} ) {
1656 $opt->{'preinsert_callback'} = sub {
1657 my($record,$param) = (shift,shift);
1658 $record->cdrtypenum($opt->{'cdrtypenum'});
1663 FS::Record::batch_import( $opt );
1667 =item process_batch_import
1671 sub process_batch_import {
1674 my $opt = _import_options;
1675 # $opt->{'params'} = [ 'format', 'cdrbatch' ];
1677 FS::Record::process_batch_import( $job, $opt, @_ );
1680 # if ( $format eq 'simple' ) { #should be a callback or opt in FS::cdr::simple
1681 # @columns = map { s/^ +//; $_; } @columns;
1686 # Used by FS::Upgrade to migrate to a new database.
1689 my ($class, %opts) = @_;
1691 warn "$me upgrading $class\n" if $DEBUG;
1693 my $sth = dbh->prepare(
1694 'SELECT DISTINCT(cdrbatch) FROM cdr WHERE cdrbatch IS NOT NULL'
1695 ) or die dbh->errstr;
1697 $sth->execute or die $sth->errstr;
1699 my %cdrbatchnum = ();
1700 while (my $row = $sth->fetchrow_arrayref) {
1702 my $cdr_batch = qsearchs( 'cdr_batch', { 'cdrbatch' => $row->[0] } );
1703 unless ( $cdr_batch ) {
1704 $cdr_batch = new FS::cdr_batch { 'cdrbatch' => $row->[0] };
1705 my $error = $cdr_batch->insert;
1706 die $error if $error;
1709 $cdrbatchnum{$row->[0]} = $cdr_batch->cdrbatchnum;
1712 $sth = dbh->prepare('UPDATE cdr SET cdrbatch = NULL, cdrbatchnum = ? WHERE cdrbatch IS NOT NULL AND cdrbatch = ?') or die dbh->errstr;
1714 foreach my $cdrbatch (keys %cdrbatchnum) {
1715 $sth->execute($cdrbatchnum{$cdrbatch}, $cdrbatch) or die $sth->errstr;
1720 =item ip_addr_sql FIELD RANGE
1722 Returns an SQL condition to search for CDRs with an IP address
1723 within RANGE. FIELD is either 'src_ip_addr' or 'dst_ip_addr'. RANGE
1724 should be in the form "a.b.c.d-e.f.g.h' (dotted quads), where any of
1725 the leftmost octets of the second address can be omitted if they're
1726 the same as the first address.
1732 my ($field, $range) = @_;
1733 $range =~ /^[\d\.-]+$/ or die "bad ip address range '$range'";
1734 my @r = split('-', $range);
1735 my @saddr = split('\.', $r[0] || '');
1736 my @eaddr = split('\.', $r[1] || '');
1737 unshift @eaddr, (undef) x (4 - scalar @eaddr);
1739 $eaddr[$_] = $saddr[$_] if !defined $eaddr[$_];
1741 "$field >= '".sprintf('%03d.%03d.%03d.%03d', @saddr) . "' AND ".
1742 "$field <= '".sprintf('%03d.%03d.%03d.%03d', @eaddr) . "'";
1751 L<FS::Record>, schema.html from the base documentation.