4 use vars qw( @ISA @EXPORT_OK $DEBUG $me
5 $conf $cdr_prerate %cdr_prerate_cdrtypenums
6 $use_lrn $support_key $max_duration
7 $cp_accountcode $cp_accountcode_trim0s $cp_field
11 use List::Util qw(first min);
16 use List::Util qw( first min );
18 use FS::UID qw( dbh );
20 use FS::Record qw( qsearch qsearchs );
25 use FS::cdr_termination;
32 use HTTP::Request::Common qw(POST);
34 use Cpanel::JSON::XS qw(decode_json);
36 @ISA = qw(FS::Record);
37 @EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker _cdr_date_parse );
42 #ask FS::UID to run this stuff for us later
43 FS::UID->install_callback( sub {
46 my @cdr_prerate_cdrtypenums;
47 $cdr_prerate = $conf->exists('cdr-prerate');
48 @cdr_prerate_cdrtypenums = $conf->config('cdr-prerate-cdrtypenums')
50 %cdr_prerate_cdrtypenums = map { $_=>1 } @cdr_prerate_cdrtypenums;
52 $support_key = $conf->config('support-key');
53 $use_lrn = $conf->exists('cdr-lrn_lookup');
55 $max_duration = $conf->config('cdr-max_duration') || 0;
57 $cp_accountcode = $conf->exists('cdr-charged_party-accountcode');
58 $cp_accountcode_trim0s = $conf->exists('cdr-charged_party-accountcode-trim_leading_0s');
60 $cp_field = $conf->config('cdr-charged_party-field');
62 $tollfree_country = $conf->config('tollfree-country') || '';
68 FS::cdr - Object methods for cdr records
74 $record = new FS::cdr \%hash;
75 $record = new FS::cdr { 'column' => 'value' };
77 $error = $record->insert;
79 $error = $new_record->replace($old_record);
81 $error = $record->delete;
83 $error = $record->check;
87 An FS::cdr object represents an Call Data Record, typically from a telephony
88 system or provider of some sort. FS::cdr inherits from FS::Record. The
89 following fields are currently supported:
93 =item acctid - primary key
95 =item calldate - Call timestamp (SQL timestamp)
97 =item clid - Caller*ID with text
99 =item src - Caller*ID number / Source number
101 =item dst - Destination extension
103 =item dcontext - Destination context
105 =item channel - Channel used
107 =item dstchannel - Destination channel if appropriate
109 =item lastapp - Last application if appropriate
111 =item lastdata - Last application data
113 =item src_ip_addr - Source IP address (dotted quad, zero-filled)
115 =item dst_ip_addr - Destination IP address (same)
117 =item dst_term - Terminating destination number (if different from dst)
119 =item startdate - Start of call (UNIX-style integer timestamp)
121 =item answerdate - Answer time of call (UNIX-style integer timestamp)
123 =item enddate - End time of call (UNIX-style integer timestamp)
125 =item duration - Total time in system, in seconds
127 =item billsec - Total time call is up, in seconds
129 =item disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
131 =item amaflags - What flags to use: BILL, IGNORE etc, specified on a per channel basis like accountcode.
135 #ignore the "omit" and "documentation" AMAs??
136 #AMA = Automated Message Accounting.
137 #default: Sets the system default.
138 #omit: Do not record calls.
139 #billing: Mark the entry for billing
140 #documentation: Mark the entry for documentation.
142 =item accountcode - CDR account number to use: account
144 =item uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID)
146 =item userfield - CDR user-defined field
148 =item cdr_type - CDR type - see L<FS::cdr_type> (Usage = 1, S&E = 7, OC&C = 8)
150 =item charged_party - Service number to be billed
152 =item upstream_currency - Wholesale currency from upstream
154 =item upstream_price - Wholesale price from upstream
156 =item upstream_rateplanid - Upstream rate plan ID
158 =item rated_price - Rated (or re-rated) price
160 =item distance - km (need units field?)
162 =item islocal - Local - 1, Non Local = 0
164 =item calltypenum - Type of call - see L<FS::cdr_calltype>
166 =item description - Description (cdr_type 7&8 only) (used for cust_bill_pkg.itemdesc)
168 =item quantity - Number of items (cdr_type 7&8 only)
170 =item carrierid - Upstream Carrier ID (see L<FS::cdr_carrier>)
174 #Telstra =1, Optus = 2, RSL COM = 3
176 =item upstream_rateid - Upstream Rate ID
178 =item svcnum - Link to customer service (see L<FS::cust_svc>)
180 =item freesidestatus - NULL, processing-tiered, rated, done, skipped, no-charge, failed
182 =item freesiderewritestatus - NULL, done, skipped
186 =item detailnum - Link to invoice detail (L<FS::cust_bill_pkg_detail>)
188 =item sipcallid - SIP Call-ID
198 Creates a new CDR. To add the CDR to the database, see L<"insert">.
200 Note that this stores the hash reference, not a distinct copy of the hash it
201 points to. You can ask the object for a copy with the I<hash> method.
205 # the new method can be inherited from FS::Record, if a table method is defined
212 #XXX fill in some (more) nice names
214 'calldate' => 'Call date',
215 'clid' => 'Caller ID',
217 'dst' => 'Destination',
218 'dcontext' => 'Dest. context',
219 'channel' => 'Channel',
220 'dstchannel' => 'Destination channel',
223 'src_ip_addr' => 'Source IP',
224 'dst_ip_addr' => 'Dest. IP',
225 'dst_term' => 'Termination dest.',
226 'startdate' => 'Start date',
227 'answerdate' => 'Answer date',
228 'enddate' => 'End date',
229 'duration' => 'Duration',
230 'billsec' => 'Billable seconds',
231 'disposition' => 'Disposition',
232 'amaflags' => 'AMA flags',
233 'accountcode' => 'Account code',
235 'userfield' => 'User field',
237 'charged_party' => 'Charged party',
238 #'upstream_currency' => '',
239 'upstream_price' => 'Upstream price',
240 #'upstream_rateplanid' => '',
241 #'ratedetailnum' => '',
242 'src_lrn' => 'Source LRN',
243 'dst_lrn' => 'Dest. LRN',
244 'rated_price' => 'Rated price',
245 'rated_cost' => 'Rated cost',
248 #'calltypenum' => '',
249 #'description' => '',
251 'carrierid' => 'Carrier ID',
252 #'upstream_rateid' => '',
253 'svcnum' => 'Freeside service',
254 'freesidestatus' => 'Freeside status',
255 'freesiderewritestatus' => 'Freeside rewrite status',
256 'cdrbatchnum' => 'Batch',
257 'detailnum' => 'Freeside invoice detail line',
266 Adds this record to the database. If there is an error, returns the error,
267 otherwise returns false.
271 # the insert method can be inherited from FS::Record
275 Delete this record from the database.
279 # the delete method can be inherited from FS::Record
281 =item replace OLD_RECORD
283 Replaces the OLD_RECORD with this one in the database. If there is an error,
284 returns the error, otherwise returns false.
288 # the replace method can be inherited from FS::Record
292 Checks all fields to make sure this is a valid CDR. If there is
293 an error, returns the error, otherwise returns false. Called by the insert
296 Note: Unlike most types of records, we don't want to "reject" a CDR and we want
297 to process them as quickly as possible, so we allow the database to check most
305 # we don't want to "reject" a CDR like other sorts of input...
307 # $self->ut_numbern('acctid')
308 ## || $self->ut_('calldate')
309 # || $self->ut_text('clid')
310 # || $self->ut_text('src')
311 # || $self->ut_text('dst')
312 # || $self->ut_text('dcontext')
313 # || $self->ut_text('channel')
314 # || $self->ut_text('dstchannel')
315 # || $self->ut_text('lastapp')
316 # || $self->ut_text('lastdata')
317 # || $self->ut_numbern('startdate')
318 # || $self->ut_numbern('answerdate')
319 # || $self->ut_numbern('enddate')
320 # || $self->ut_number('duration')
321 # || $self->ut_number('billsec')
322 # || $self->ut_text('disposition')
323 # || $self->ut_number('amaflags')
324 # || $self->ut_text('accountcode')
325 # || $self->ut_text('uniqueid')
326 # || $self->ut_text('userfield')
327 # || $self->ut_numbern('cdrtypenum')
328 # || $self->ut_textn('charged_party')
329 ## || $self->ut_n('upstream_currency')
330 ## || $self->ut_n('upstream_price')
331 # || $self->ut_numbern('upstream_rateplanid')
332 ## || $self->ut_n('distance')
333 # || $self->ut_numbern('islocal')
334 # || $self->ut_numbern('calltypenum')
335 # || $self->ut_textn('description')
336 # || $self->ut_numbern('quantity')
337 # || $self->ut_numbern('carrierid')
338 # || $self->ut_numbern('upstream_rateid')
339 # || $self->ut_numbern('svcnum')
340 # || $self->ut_textn('freesidestatus')
341 # || $self->ut_textn('freesiderewritestatus')
343 # return $error if $error;
345 for my $f ( grep { $self->$_ =~ /\D/ } qw(startdate answerdate enddate)){
346 $self->$f( str2time($self->$f) );
349 $self->calldate( $self->startdate_sql )
350 if !$self->calldate && $self->startdate;
352 #was just for $format eq 'taqua' but can't see the harm... add something to
353 #disable if it becomes a problem
354 if ( $self->duration eq '' && $self->enddate && $self->startdate ) {
355 $self->duration( $self->enddate - $self->startdate );
357 if ( $self->billsec eq '' && $self->enddate && $self->answerdate ) {
358 $self->billsec( $self->enddate - $self->answerdate );
361 if ( ! $self->enddate && $self->startdate && $self->duration ) {
362 $self->enddate( $self->startdate + $self->duration );
365 $self->set_charged_party;
367 #check the foreign keys even?
368 #do we want to outright *reject* the CDR?
369 my $error = $self->ut_numbern('acctid');
370 return $error if $error;
372 if ( $self->freesidestatus ne 'done' ) {
373 $self->set('detailnum', ''); # can't have this on an unbilled call
376 #add a config option to turn these back on if someone needs 'em
378 # #Usage = 1, S&E = 7, OC&C = 8
379 # || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
381 # #the big list in appendix 2
382 # || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' )
384 # # Telstra =1, Optus = 2, RSL COM = 3
385 # || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
390 =item is_tollfree [ COLUMN ]
392 Returns true when the cdr represents a toll free number and false otherwise.
394 By default, inspects the dst field, but an optional column name can be passed
395 to inspect other field.
401 my $field = scalar(@_) ? shift : 'dst';
402 if ( $tollfree_country eq 'AU' ) {
403 ( $self->$field() =~ /^(\+?61)?(1800|1300)/ ) ? 1 : 0;
404 } elsif ( $tollfree_country eq 'NZ' ) {
405 ( $self->$field() =~ /^(\+?64)?(800|508)/ ) ? 1 : 0;
406 } else { #NANPA (US/Canaada)
407 ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0;
411 =item set_charged_party
413 If the charged_party field is already set, does nothing. Otherwise:
415 If the cdr-charged_party-accountcode config option is enabled, sets the
416 charged_party to the accountcode.
418 Otherwise sets the charged_party normally: to the src field in most cases,
419 or to the dst field if it is a toll free number.
423 sub set_charged_party {
426 my $conf = new FS::Conf;
428 unless ( $self->charged_party ) {
430 if ( $cp_accountcode && $self->accountcode ) {
432 my $charged_party = $self->accountcode;
433 $charged_party =~ s/^0+//
434 if $cp_accountcode_trim0s;
435 $self->charged_party( $charged_party );
437 } elsif ( $cp_field ) {
439 $self->charged_party( $self->$cp_field() );
443 if ( $self->is_tollfree ) {
444 $self->charged_party($self->dst);
446 $self->charged_party($self->src);
453 # my $prefix = $conf->config('cdr-charged_party-truncate_prefix');
454 # my $prefix_len = length($prefix);
455 # my $trunc_len = $conf->config('cdr-charged_party-truncate_length');
457 # $self->charged_party( substr($self->charged_party, 0, $trunc_len) )
458 # if $prefix_len && $trunc_len
459 # && substr($self->charged_party, 0, $prefix_len) eq $prefix;
463 =item set_status STATUS
465 Sets the status to the provided string. If there is an error, returns the
466 error, otherwise returns false.
468 If status is being changed from 'rated' to some other status, also removes
469 any usage allocations to this CDR.
474 my($self, $status) = @_;
475 my $old_status = $self->freesidestatus;
476 $self->freesidestatus($status);
477 my $error = $self->replace;
478 if ( $old_status eq 'rated' and $status ne 'done' ) {
479 # deallocate any usage
480 foreach (qsearch('cdr_cust_pkg_usage', {acctid => $self->acctid})) {
481 my $cust_pkg_usage = $_->cust_pkg_usage;
482 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $_->minutes);
483 $error ||= $cust_pkg_usage->replace || $_->delete;
489 =item set_status_and_rated_price STATUS RATED_PRICE [ SVCNUM [ OPTION => VALUE ... ] ]
491 Sets the status and rated price.
493 Available options are: inbound, rated_pretty_dst, rated_regionname,
494 rated_seconds, rated_minutes, rated_granularity, rated_ratedetailnum,
495 rated_classnum, rated_ratename. If rated_ratedetailnum is provided,
496 will also set a recalculated L</rate_cost> in the rated_cost field
497 after the other fields are set (does not work with inbound.)
499 If there is an error, returns the error, otherwise returns false.
503 sub set_status_and_rated_price {
504 my($self, $status, $rated_price, $svcnum, %opt) = @_;
506 if ($opt{'inbound'}) {
508 my $term = $self->cdr_termination( 1 ); #1: inbound
511 warn "replacing existing cdr status (".$self->acctid.")\n" if $term;
512 $error = $term->delete;
513 return $error if $error;
515 $term = FS::cdr_termination->new({
516 acctid => $self->acctid,
518 rated_price => $rated_price,
521 foreach (qw(rated_seconds rated_minutes rated_granularity)) {
522 $term->set($_, $opt{$_}) if exists($opt{$_});
524 $term->svcnum($svcnum) if $svcnum;
525 return $term->insert;
529 $self->freesidestatus($status);
530 $self->freesidestatustext($opt{'statustext'}) if exists($opt{'statustext'});
531 $self->rated_price($rated_price);
533 foreach grep exists($opt{$_}), map "rated_$_",
534 qw( pretty_dst regionname seconds minutes granularity
535 ratedetailnum classnum ratename );
536 $self->svcnum($svcnum) if $svcnum;
537 $self->rated_cost($self->rate_cost) if $opt{'rated_ratedetailnum'};
539 return $self->replace();
544 =item parse_number [ OPTION => VALUE ... ]
546 Returns two scalars, the countrycode and the rest of the number.
548 Options are passed as name-value pairs. Currently available options are:
554 The column containing the number to be parsed. Defaults to dst.
556 =item international_prefix
558 The digits for international dialing. Defaults to '011' The value '+' is
561 =item domestic_prefix
563 The digits for domestic long distance dialing. Defaults to '1'
570 my ($self, %options) = @_;
572 my $field = $options{column} || 'dst';
573 my $intl = $options{international_prefix} || '011';
574 # Still, don't break anyone's CDR rating if they have an empty string in
575 # there. Require an explicit statement that there's no prefix.
576 $intl = '' if lc($intl) eq 'none';
577 my $countrycode = '';
578 my $number = $self->$field();
580 my $to_or_from = 'concerning';
581 $to_or_from = 'from' if $field eq 'src';
582 $to_or_from = 'to' if $field eq 'dst';
583 warn "parsing call $to_or_from $number\n" if $DEBUG;
585 #remove non-phone# stuff and whitespace
588 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
590 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
592 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
593 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
597 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
598 #first look for 1 digit country code
599 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
601 $number = $u1.$u2.$rest;
602 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
605 } else { #3 digit country code
606 $countrycode = $three;
611 my $domestic_prefix =
612 exists($options{domestic_prefix}) ? $options{domestic_prefix} : '';
613 $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
614 $number =~ s/^$countrycode//;# if length($number) > 10;
617 return($countrycode, $number);
621 =item rate [ OPTION => VALUE ... ]
623 Rates this CDR according and sets the status to 'rated'.
625 Available options are: part_pkg, svcnum, plan_included_min,
626 detail_included_min_hashref.
628 part_pkg is required.
630 If svcnum is specified, will also associate this CDR with the specified svcnum.
632 plan_included_min should be set to a scalar reference of the number of
633 included minutes and will be decremented by the rated minutes of this
636 detail_included_min_hashref should be set to an empty hashref at the
637 start of a month's rating and then preserved across CDRs.
642 my( $self, %opt ) = @_;
643 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
646 warn "rating CDR $self\n".
647 join('', map { " $_ => ". $self->{$_}. "\n" } keys %$self );
650 my $rating_method = $part_pkg->option_cacheable('rating_method') || 'prefix';
651 my $method = "rate_$rating_method";
652 $self->$method(%opt);
656 our %interval_cache = (); # for timed rates
659 my( $self, %opt ) = @_;
660 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
661 my $cust_pkg = $opt{'cust_pkg'};
664 # (Directory assistance) rewriting
668 # this will result in those CDRs being marked as done... is that
671 if ( $part_pkg->option_cacheable('411_rewrite') ) {
672 my $dirass = $part_pkg->option_cacheable('411_rewrite');
674 @dirass = split(',', $dirass);
677 if ( length($self->dst) && grep { $self->dst eq $_ } @dirass ) {
683 # Checks to see if the CDR is chargeable
686 my $reason = $part_pkg->check_chargable( $self,
687 'da_rewrote' => $da_rewrote,
690 warn "not charging for CDR ($reason)\n" if $DEBUG;
691 return $self->set_status_and_rated_price( 'skipped',
694 'statustext' => $reason,
698 if ( $part_pkg->option_cacheable('skip_same_customer')
699 and ! $self->is_tollfree ) {
700 my ($dst_countrycode, $dst_number) = $self->parse_number(
702 international_prefix => $part_pkg->option_cacheable('international_prefix'),
703 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
705 my $dst_same_cust = FS::Record->scalar_sql(
706 'SELECT COUNT(svc_phone.svcnum) AS count '.
708 'JOIN cust_svc USING (pkgnum) ' .
709 'JOIN svc_phone USING (svcnum) ' .
710 'WHERE svc_phone.countrycode = ' . dbh->quote($dst_countrycode) .
711 ' AND svc_phone.phonenum = ' . dbh->quote($dst_number) .
712 ' AND cust_pkg.custnum = ' . $cust_pkg->custnum,
714 if ( $dst_same_cust > 0 ) {
715 warn "not charging for CDR (same source and destination customer)\n" if $DEBUG;
716 return $self->set_status_and_rated_price( 'skipped',
723 my $rated_seconds = $part_pkg->option_cacheable('use_duration')
726 if ( $max_duration > 0 && $rated_seconds > $max_duration ) {
727 return $self->set_status_and_rated_price(
735 # look up rate details based on called station id
736 # (or calling station id for toll free calls)
739 my $eff_ratenum = $self->is_tollfree('accountcode')
740 ? $part_pkg->option_cacheable('accountcode_tollfree_ratenum')
743 my( $to_or_from, $column );
746 && ! $part_pkg->option_cacheable('disable_tollfree')
749 && $part_pkg->option_cacheable('accountcode_tollfree_field') eq 'src'
753 $to_or_from = 'from';
755 } else { #regular call
760 #determine the country code
761 my ($countrycode, $number) = $self->parse_number(
763 international_prefix => $part_pkg->option_cacheable('international_prefix'),
764 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
768 my $intrastate_ratenum = $part_pkg->option_cacheable('intrastate_ratenum');
770 if ( $use_lrn and $countrycode eq '1' ) {
772 # then ask about the number
773 foreach my $field ('src', 'dst') {
775 $self->get_lrn($field);
776 if ( $field eq $column ) {
777 # then we are rating on this number
778 $number = $self->get($field.'_lrn');
780 # is this ever meaningful? can the LRN be outside NANP space?
787 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
788 my $pretty_dst = "+$countrycode $number";
789 #asterisks here causes inserting the detail to barf, so:
790 $pretty_dst =~ s/\*//g;
792 # should check $countrycode eq '1' here?
793 if ( $intrastate_ratenum && !$self->is_tollfree ) {
794 $ratename = 'Interstate'; #until proven otherwise
795 # this is relatively easy only because:
796 # -assume all numbers are valid NANP numbers NOT in a fully-qualified format
797 # -disregard toll-free
798 # -disregard private or unknown numbers
799 # -there is exactly one record in rate_prefix for a given NPANXX
800 # -default to interstate if we can't find one or both of the prefixes
801 my $dst_col = $use_lrn ? 'dst_lrn' : 'dst';
802 my $src_col = $use_lrn ? 'src_lrn' : 'src';
803 my (undef, $dstprefix) = $self->parse_number(
805 international_prefix => $part_pkg->option_cacheable('international_prefix'),
806 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
808 $dstprefix =~ /^(\d{6})/;
809 $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
812 my (undef, $srcprefix) = $self->parse_number(
814 international_prefix => $part_pkg->option_cacheable('international_prefix'),
815 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
817 $srcprefix =~ /^(\d{6})/;
818 $srcprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
821 if ($srcprefix && $dstprefix
822 && $srcprefix->state && $dstprefix->state
823 && $srcprefix->state eq $dstprefix->state) {
824 $eff_ratenum = $intrastate_ratenum;
825 $ratename = 'Intrastate'; # XXX possibly just use the ratename?
829 $eff_ratenum ||= $part_pkg->option_cacheable('ratenum');
830 my $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
831 or die "ratenum $eff_ratenum not found!";
833 my @ltime = localtime($self->startdate);
834 my $weektime = $ltime[0] +
835 $ltime[1]*60 + #minutes
836 $ltime[2]*3600 + #hours
837 $ltime[6]*86400; #days since sunday
838 # if there's no timed rate_detail for this time/region combination,
839 # dest_detail returns the default. There may still be a timed rate
840 # that applies after the starttime of the call, so be careful...
841 my $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
842 'phonenum' => $number,
843 'weektime' => $weektime,
844 'cdrtypenum' => $self->cdrtypenum,
847 unless ( $rate_detail ) {
849 if ( $part_pkg->option_cacheable('ignore_unrateable') ) {
851 if ( $part_pkg->option_cacheable('ignore_unrateable') == 2 ) {
852 # mark the CDR as unrateable
853 return $self->set_status_and_rated_price(
858 } elsif ( $part_pkg->option_cacheable('ignore_unrateable') == 1 ) {
860 warn "no rate_detail found for CDR.acctid: ". $self->acctid.
865 die "unknown ignore_unrateable, pkgpart ". $part_pkg->pkgpart;
870 die "FATAL: no rate_detail found in ".
871 $rate->ratenum. ":". $rate->ratename. " rate plan ".
872 "for +$countrycode $number (CDR acctid ". $self->acctid. "); ".
873 "add a rate or set ignore_unrateable flag on the package def\n";
878 my $regionnum = $rate_detail->dest_regionnum;
879 my $rate_region = $rate_detail->dest_region;
880 warn " found rate for regionnum $regionnum ".
881 "and rate detail $rate_detail\n"
884 if ( !exists($interval_cache{$regionnum}) ) {
886 sort { $a->stime <=> $b->stime }
887 map { $_->rate_time->intervals }
888 qsearch({ 'table' => 'rate_detail',
889 'hashref' => { 'ratenum' => $rate->ratenum },
890 'extra_sql' => 'AND ratetimenum IS NOT NULL',
893 $interval_cache{$regionnum} = \@intervals;
894 warn " cached ".scalar(@intervals)." interval(s)\n"
899 # find the price and add detail to the invoice
902 # About this section:
903 # We don't round _anything_ (except granularizing)
904 # until the final $charge = sprintf("%.2f"...).
906 my $seconds_left = $rated_seconds;
908 #no, do this later so it respects (group) included minutes
909 # # charge for the first (conn_sec) seconds
910 # my $seconds = min($seconds_left, $rate_detail->conn_sec);
911 # $seconds_left -= $seconds;
912 # $weektime += $seconds;
913 # my $charge = $rate_detail->conn_charge;
916 my $connection_charged = 0;
918 # before doing anything else, if there's an upstream multiplier and
919 # an upstream price, add that to the charge. (usually the rate detail
920 # will then have a minute charge of zero, but not necessarily.)
921 $charge += ($self->upstream_price || 0) * $rate_detail->upstream_mult_charge;
924 while($seconds_left) {
925 my $ratetimenum = $rate_detail->ratetimenum; # may be empty
927 # find the end of the current rate interval
928 if(@{ $interval_cache{$regionnum} } == 0) {
929 # There are no timed rates in this group, so just stay
930 # in the default rate_detail for the entire duration.
931 # Set an "end" of 1 past the end of the current call.
932 $etime = $weektime + $seconds_left + 1;
934 elsif($ratetimenum) {
935 # This is a timed rate, so go to the etime of this interval.
936 # If it's followed by another timed rate, the stime of that
937 # interval should match the etime of this one.
938 my $interval = $rate_detail->rate_time->contains($weektime);
939 $etime = $interval->etime;
942 # This is a default rate, so use the stime of the next
943 # interval in the sequence.
944 my $next_int = first { $_->stime > $weektime }
945 @{ $interval_cache{$regionnum} };
947 $etime = $next_int->stime;
950 # weektime is near the end of the week, so decrement
951 # it by a full week and use the stime of the first
953 $weektime -= (3600*24*7);
954 $etime = $interval_cache{$regionnum}->[0]->stime;
958 my $charge_sec = min($seconds_left, $etime - $weektime);
960 $seconds_left -= $charge_sec;
962 my $granularity = $rate_detail->sec_granularity;
965 if ( $granularity ) { # charge per minute
966 # Round up to the nearest $granularity
967 if ( $charge_sec and $charge_sec % $granularity ) {
968 $charge_sec += $granularity - ($charge_sec % $granularity);
970 $minutes = $charge_sec / 60; #don't round this
977 #$seconds += $charge_sec;
979 if ( $rate_detail->min_included ) {
980 # the old, kind of deprecated way to do this:
982 # The rate detail itself has included minutes. We MUST have a place
984 my $included_min = $opt{'detail_included_min_hashref'}
985 or return "unable to rate CDR: rate detail has included minutes, but ".
986 "no detail_included_min_hashref provided.\n";
988 # by default, set the included minutes for this region/time to
989 # what's in the rate_detail
990 if (!exists( $included_min->{$regionnum}{$ratetimenum} )) {
991 $included_min->{$regionnum}{$ratetimenum} =
992 ($rate_detail->min_included * $cust_pkg->quantity || 1);
995 if ( $included_min->{$regionnum}{$ratetimenum} >= $minutes ) {
997 $included_min->{$regionnum}{$ratetimenum} -= $minutes;
999 $charge_sec -= ($included_min->{$regionnum}{$ratetimenum} * 60);
1000 $included_min->{$regionnum}{$ratetimenum} = 0;
1002 } elsif ( $opt{plan_included_min} && ${ $opt{plan_included_min} } > 0 ) {
1003 # The package definition has included minutes, but only for in-group
1004 # rate details. Decrement them if this is an in-group call.
1005 if ( $rate_detail->region_group ) {
1006 if ( ${ $opt{'plan_included_min'} } >= $minutes ) {
1008 ${ $opt{'plan_included_min'} } -= $minutes;
1010 $charge_sec -= (${ $opt{'plan_included_min'} } * 60);
1011 ${ $opt{'plan_included_min'} } = 0;
1016 my $applied_min = $cust_pkg->apply_usage(
1018 'rate_detail' => $rate_detail,
1019 'minutes' => $minutes
1021 # for now, usage pools deal only in whole minutes
1022 $charge_sec -= $applied_min * 60;
1025 if ( $charge_sec > 0 ) {
1027 #NOW do connection charges here... right?
1028 #my $conn_seconds = min($seconds_left, $rate_detail->conn_sec);
1029 my $conn_seconds = 0;
1030 unless ( $connection_charged++ ) { #only one connection charge
1031 $conn_seconds = min($charge_sec, $rate_detail->conn_sec);
1032 $seconds_left -= $conn_seconds;
1033 $weektime += $conn_seconds;
1034 $charge += $rate_detail->conn_charge;
1037 #should preserve (display?) this
1038 if ( $granularity == 0 ) { # per call rate
1039 $charge += $rate_detail->min_charge;
1041 my $charge_min = ( $charge_sec - $conn_seconds ) / 60;
1042 $charge += ($rate_detail->min_charge * $charge_min) if $charge_min > 0; #still not rounded
1047 # choose next rate_detail
1048 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
1049 'phonenum' => $number,
1050 'weektime' => $etime,
1051 'cdrtypenum' => $self->cdrtypenum })
1053 # we have now moved forward to $etime
1056 } #while $seconds_left
1058 # this is why we need regionnum/rate_region....
1059 warn " (rate region $rate_region)\n" if $DEBUG;
1062 my $rounding = $part_pkg->option_cacheable('rounding') || 2;
1063 my $sprintformat = '%.'. $rounding. 'f';
1064 my $roundup = 10**(-3-$rounding);
1065 my $price = sprintf($sprintformat, $charge + $roundup);
1067 $self->set_status_and_rated_price(
1071 'rated_pretty_dst' => $pretty_dst,
1072 'rated_regionname' => ($rate_region ? $rate_region->regionname : ''),
1073 'rated_seconds' => $rated_seconds, #$seconds,
1074 'rated_granularity' => $rate_detail->sec_granularity, #$granularity
1075 'rated_ratedetailnum' => $rate_detail->ratedetailnum,
1076 'rated_classnum' => $rate_detail->classnum, #rated_ratedetailnum?
1077 'rated_ratename' => $ratename, #not rate_detail - Intrastate/Interstate
1082 sub rate_upstream_simple {
1083 my( $self, %opt ) = @_;
1085 $self->set_status_and_rated_price(
1087 sprintf('%.3f', $self->upstream_price),
1089 'rated_classnum' => $self->calltypenum,
1090 'rated_seconds' => $self->billsec,
1091 # others? upstream_*_regionname => rated_regionname is possible
1095 sub rate_single_price {
1096 my( $self, %opt ) = @_;
1097 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
1099 # a little false laziness w/abov
1100 # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
1102 my $granularity = length($part_pkg->option_cacheable('sec_granularity'))
1103 ? $part_pkg->option_cacheable('sec_granularity')
1106 my $seconds = $part_pkg->option_cacheable('use_duration')
1110 $seconds += $granularity - ( $seconds % $granularity )
1111 if $seconds # don't granular-ize 0 billsec calls (bills them)
1112 && $granularity # 0 is per call
1113 && $seconds % $granularity;
1114 my $minutes = $granularity ? ($seconds / 60) : 1;
1116 my $charge_min = $minutes;
1118 ${$opt{plan_included_min}} -= $minutes;
1119 if ( ${$opt{plan_included_min}} > 0 ) {
1122 $charge_min = 0 - ${$opt{plan_included_min}};
1123 ${$opt{plan_included_min}} = 0;
1127 sprintf('%.4f', ( $part_pkg->option_cacheable('min_charge') * $charge_min )
1128 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
1130 $self->set_status_and_rated_price(
1134 'rated_granularity' => $granularity,
1135 'rated_seconds' => $seconds,
1142 Rates an already-rated CDR according to the cost fields from the rate plan.
1151 return 0 unless $self->rated_ratedetailnum;
1154 qsearchs('rate_detail', { 'ratedetailnum' => $self->rated_ratedetailnum } );
1157 $charge += ($self->upstream_price || 0) * ($rate_detail->upstream_mult_cost);
1159 if ( $self->rated_granularity == 0 ) {
1160 $charge += $rate_detail->min_cost;
1162 my $minutes = $self->rated_seconds / 60;
1163 $charge += $rate_detail->conn_cost + $minutes * $rate_detail->min_cost;
1166 sprintf('%.2f', $charge + .00001 );
1170 =item cdr_termination [ TERMPART ]
1174 sub cdr_termination {
1177 if ( scalar(@_) && $_[0] ) {
1178 my $termpart = shift;
1180 qsearchs('cdr_termination', { acctid => $self->acctid,
1181 termpart => $termpart,
1187 qsearch('cdr_termination', { acctid => $self->acctid, } );
1195 Parses the calldate in SQL string format and returns a UNIX timestamp.
1200 str2time(shift->calldate);
1205 Parses the startdate in UNIX timestamp format and returns a string in SQL
1211 my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate);
1214 "$year-$mon-$mday $hour:$min:$sec";
1219 Returns the FS::cdr_carrier object associated with this CDR, or false if no
1220 carrierid is defined.
1224 my %carrier_cache = ();
1228 return '' unless $self->carrierid;
1229 $carrier_cache{$self->carrierid} ||=
1230 qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } );
1235 Returns the carrier name (see L<FS::cdr_carrier>), or the empty string if
1236 no FS::cdr_carrier object is assocated with this CDR.
1242 my $cdr_carrier = $self->cdr_carrier;
1243 $cdr_carrier ? $cdr_carrier->carriername : '';
1248 Returns the FS::cdr_calltype object associated with this CDR, or false if no
1249 calltypenum is defined.
1253 my %calltype_cache = ();
1257 return '' unless $self->calltypenum;
1258 $calltype_cache{$self->calltypenum} ||=
1259 qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } );
1264 Returns the call type name (see L<FS::cdr_calltype>), or the empty string if
1265 no FS::cdr_calltype object is assocated with this CDR.
1271 my $cdr_calltype = $self->cdr_calltype;
1272 $cdr_calltype ? $cdr_calltype->calltypename : '';
1275 =item downstream_csv [ OPTION => VALUE, ... ]
1279 # in the future, load this dynamically from detail_format classes
1281 my %export_names = (
1284 'invoice_header' => "Date,Time,Name,Destination,Duration,Price",
1287 'name' => 'Simple with source',
1288 'invoice_header' => "Date,Time,Called From,Destination,Duration,Price",
1289 #"Date,Time,Name,Called From,Destination,Duration,Price",
1291 'accountcode_simple' => {
1292 'name' => 'Simple with accountcode',
1293 'invoice_header' => "Date,Time,Called From,Account,Duration,Price",
1297 'invoice_header' => "Date/Time,Called Number,Min/Sec,Price",
1299 'basic_upstream_dst_regionname' => {
1300 'name' => 'Basic with upstream destination name',
1301 'invoice_header' => "Date/Time,Called Number,Destination,Min/Sec,Price",
1304 'name' => 'Default',
1305 'invoice_header' => 'Date,Time,Number,Destination,Duration,Price',
1307 'source_default' => {
1308 'name' => 'Default with source',
1309 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1311 'accountcode_default' => {
1312 'name' => 'Default plus accountcode',
1313 'invoice_header' => 'Date,Time,Account,Number,Destination,Duration,Price',
1315 'description_default' => {
1316 'name' => 'Default with description field as destination',
1317 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1320 'name' => 'Summary, one line per service',
1321 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1324 'name' => 'Number of calls, one line per service',
1325 'invoice_header' => 'Caller,Rate,Messages,Price',
1328 'name' => 'Summary, one line per service',
1329 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1331 'sum_duration_prefix' => {
1332 'name' => 'Summary, one line per destination prefix',
1333 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1335 'sum_count_class' => {
1336 'name' => 'Summary, one line per usage class',
1337 'invoice_header' => 'Caller,Class,Calls,Price',
1339 'sum_duration_accountcode' => {
1340 'name' => 'Summary, one line per accountcode',
1341 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1345 my %export_formats = ();
1346 sub export_formats {
1349 return %export_formats if keys %export_formats;
1351 my $conf = new FS::Conf;
1352 my $date_format = $conf->config('date_format') || '%m/%d/%Y';
1354 # call duration in the largest units that accurately reflect the granularity
1355 my $duration_sub = sub {
1356 my($cdr, %opt) = @_;
1357 my $sec = $opt{seconds} || $cdr->billsec;
1358 if ( defined $opt{granularity} &&
1359 $opt{granularity} == 0 ) { #per call
1362 elsif ( defined $opt{granularity} && $opt{granularity} == 60 ) {#full minutes
1363 my $min = int($sec/60);
1367 else { #anything else
1368 return sprintf("%dm %ds", $sec/60, $sec%60);
1372 my $price_sub = sub {
1373 my ($cdr, %opt) = @_;
1375 if ( defined($opt{charge}) ) {
1376 $price = $opt{charge};
1378 elsif ( $opt{inbound} ) {
1379 my $term = $cdr->cdr_termination(1); # 1 = inbound
1380 $price = $term->rated_price if defined $term;
1383 $price = $cdr->rated_price;
1385 length($price) ? ($opt{money_char} . $price) : '';
1388 my $src_sub = sub { $_[0]->clid || $_[0]->src };
1392 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1393 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1395 'dst', #NUMBER_DIALED
1396 $duration_sub, #DURATION
1397 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1401 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1402 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1404 $src_sub, #called from
1405 'dst', #NUMBER_DIALED
1406 $duration_sub, #DURATION
1407 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1410 'accountcode_simple' => [
1411 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1412 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1413 $src_sub, #called from
1414 'accountcode', #NUMBER_DIALED
1415 $duration_sub, #DURATION
1419 # for summary formats, the CDR is a fictitious object containing the
1420 # total billsec and the phone number of the service
1422 sub { my($cdr, %opt) = @_; $opt{ratename} },
1423 sub { my($cdr, %opt) = @_; $opt{count} },
1424 sub { my($cdr, %opt) = @_; int($opt{seconds}/60).'m' },
1429 sub { my($cdr, %opt) = @_; $opt{ratename} },
1430 sub { my($cdr, %opt) = @_; $opt{count} },
1434 sub { time2str('%d %b - %I:%M %p', shift->calldate_unix) },
1442 sub { time2str($date_format, shift->calldate_unix ) },
1443 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
1446 sub { time2str('%r', shift->calldate_unix ) },
1447 # 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
1450 sub { my($cdr, %opt) = @_; $opt{pretty_dst} || $cdr->dst; },
1452 #REGIONNAME ("Destination")
1453 sub { my($cdr, %opt) = @_; $opt{dst_regionname}; },
1462 $export_formats{'source_default'} = [ $src_sub, @{ $export_formats{'default'} }, ];
1463 $export_formats{'accountcode_default'} =
1464 [ @{ $export_formats{'default'} }[0,1],
1466 @{ $export_formats{'default'} }[2..5],
1468 my @default = @{ $export_formats{'default'} };
1469 $export_formats{'description_default'} =
1470 [ $src_sub, @default[0..2],
1471 sub { my($cdr, %opt) = @_; $cdr->description },
1474 return %export_formats;
1477 =item downstream_csv OPTION => VALUE ...
1479 Returns a string of formatted call details for display on an invoice.
1485 charge - override the 'rated_price' field of the CDR
1487 seconds - override the 'billsec' field of the CDR
1489 count - number of usage events included in this record, for summary formats
1491 ratename - name of the rate table used to rate this call
1497 sub downstream_csv {
1498 my( $self, %opt ) = @_;
1500 my $format = $opt{'format'};
1501 my %formats = $self->export_formats;
1502 return "Unknown format $format" unless exists $formats{$format};
1504 #my $conf = new FS::Conf;
1505 #$opt{'money_char'} ||= $conf->config('money_char') || '$';
1506 $opt{'money_char'} ||= FS::Conf->new->config('money_char') || '$';
1508 my $csv = new Text::CSV_XS;
1512 ref($_) ? &{$_}($self, %opt) : $self->$_();
1514 @{ $formats{$format} };
1516 return @columns if defined $opt{'keeparray'};
1518 my $status = $csv->combine(@columns);
1519 die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV"
1530 my $ua = LWP::UserAgent->new(
1532 verify_hostname => 0,
1533 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
1537 my $url = 'https://ws.freeside.biz/get_lrn';
1539 my %content = ( 'support-key' => $support_key,
1540 'tn' => $self->get($field),
1542 my $response = $ua->request( POST $url, \%content );
1544 die "LRN service error: ". $response->message. "\n"
1545 unless $response->is_success;
1548 my $data = eval { decode_json($response->content) };
1549 die "LRN service JSON error : $@\n" if $@;
1551 if ($data->{error}) {
1552 die "acctid ".$self->acctid." $field LRN lookup failed:\n$data->{error}";
1553 # for testing; later we should respect ignore_unrateable
1554 } elsif ($data->{lrn}) {
1556 $self->set($field.'_lrn', $data->{lrn});
1558 die "acctid ".$self->acctid." $field LRN lookup returned no number.\n";
1561 return $data; # in case it's interesting somehow
1566 =head1 CLASS METHODS
1570 =item invoice_formats
1572 Returns an ordered list of key value pairs containing invoice format names
1573 as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values.
1577 # in the future, load this dynamically from detail_format classes
1579 sub invoice_formats {
1580 map { ($_ => $export_names{$_}->{'name'}) }
1581 grep { $export_names{$_}->{'invoice_header'} }
1582 sort keys %export_names;
1585 =item invoice_header FORMAT
1587 Returns a scalar containing the CSV column header for invoice format FORMAT.
1591 sub invoice_header {
1593 $export_names{$format}->{'invoice_header'};
1598 Clears cdr and any associated cdr_termination statuses - used for
1607 local $SIG{HUP} = 'IGNORE';
1608 local $SIG{INT} = 'IGNORE';
1609 local $SIG{QUIT} = 'IGNORE';
1610 local $SIG{TERM} = 'IGNORE';
1611 local $SIG{TSTP} = 'IGNORE';
1612 local $SIG{PIPE} = 'IGNORE';
1614 my $oldAutoCommit = $FS::UID::AutoCommit;
1615 local $FS::UID::AutoCommit = 0;
1618 if ( $cdr_prerate && $cdr_prerate_cdrtypenums{$self->cdrtypenum}
1619 && $self->rated_ratedetailnum #avoid putting old CDRs back in "rated"
1620 && $self->freesidestatus eq 'done'
1624 $self->freesidestatus('rated');
1626 $self->freesidestatus('');
1629 my $error = $self->replace;
1631 $dbh->rollback if $oldAutoCommit;
1635 foreach my $cdr_termination ( $self->cdr_termination ) {
1636 #$cdr_termination->status('');
1637 #$error = $cdr_termination->replace;
1638 $error = $cdr_termination->delete;
1640 $dbh->rollback if $oldAutoCommit;
1645 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1650 =item import_formats
1652 Returns an ordered list of key value pairs containing import format names
1653 as keys (for use with batch_import) and "pretty" format names as values.
1657 #false laziness w/part_pkg & part_export
1660 foreach my $INC ( @INC ) {
1661 warn "globbing $INC/FS/cdr/[a-z]*.pm\n" if $DEBUG;
1662 foreach my $file ( glob("$INC/FS/cdr/[a-z]*.pm") ) {
1663 warn "attempting to load CDR format info from $file\n" if $DEBUG;
1664 $file =~ /\/(\w+)\.pm$/ or do {
1665 warn "unrecognized file in $INC/FS/cdr/: $file\n";
1669 my $info = eval "use FS::cdr::$mod; ".
1670 "\\%FS::cdr::$mod\::info;";
1672 die "error using FS::cdr::$mod (skipping): $@\n" if $@;
1675 unless ( keys %$info ) {
1676 warn "no %info hash found in FS::cdr::$mod, skipping\n";
1679 warn "got CDR format info from FS::cdr::$mod: $info\n" if $DEBUG;
1680 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1681 warn "skipping disabled CDR format FS::cdr::$mod" if $DEBUG;
1684 $cdr_info{$mod} = $info;
1688 tie my %import_formats, 'Tie::IxHash',
1689 map { $_ => $cdr_info{$_}->{'name'} }
1691 #this is not doing anything useful anymore
1692 #sort { $cdr_info{$a}->{'weight'} <=> $cdr_info{$b}->{'weight'} }
1694 sort { lc($cdr_info{$a}->{'name'}) cmp lc($cdr_info{$b}->{'name'}) }
1696 grep { exists($cdr_info{$_}->{'import_fields'}) }
1699 sub import_formats {
1703 sub _cdr_min_parser_maker {
1705 my @fields = ref($field) ? @$field : ($field);
1706 @fields = qw( billsec duration ) unless scalar(@fields) && $fields[0];
1708 my( $cdr, $min ) = @_;
1709 my $sec = eval { _cdr_min_parse($min) };
1710 die "error parsing seconds for @fields from $min minutes: $@\n" if $@;
1711 $cdr->$_($sec) foreach @fields;
1715 sub _cdr_min_parse {
1717 sprintf('%.0f', $min * 60 );
1720 sub _cdr_date_parser_maker {
1723 my @fields = ref($field) ? @$field : ($field);
1725 my( $cdr, $datestring ) = @_;
1726 my $unixdate = eval { _cdr_date_parse($datestring, %options) };
1727 die "error parsing date for @fields from $datestring: $@\n" if $@;
1728 $cdr->$_($unixdate) foreach @fields;
1732 sub _cdr_date_parse {
1736 return '' unless length($date); #that's okay, it becomes NULL
1737 return '' if $date eq 'NA'; #sansay
1739 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 ) {
1740 my $time = str2time($date);
1741 return $time if $time > 100000; #just in case
1744 my($year, $mon, $day, $hour, $min, $sec);
1746 #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/
1747 #taqua #2007-10-31 08:57:24.113000000
1749 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|$)/ ) {
1750 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1751 } 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|$)/ ) {
1752 # 8/26/2010 12:20:01
1753 # optionally without seconds
1754 ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1755 $sec = 0 if !defined($sec);
1756 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\.\d+)$/ ) {
1757 # broadsoft: 20081223201938.314
1758 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1759 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\d+(\D|$)/ ) {
1760 # Taqua OM: 20050422203450943
1761 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1762 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/ ) {
1763 # WIP: 20100329121420
1764 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1765 } elsif ( $date =~ /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/) {
1766 # Telos 2014-10-10T05:30:33Z
1767 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1769 } elsif ( $date =~ /^(\d+):(\d+):(\d+)\.\d+ \w+ (\w+) (\d+) (\d+)$/ ) {
1770 ($hour, $min, $sec, $mon, $day, $year) = ( $1, $2, $3, $4, $5, $6 );
1771 $mon = { # Acme Packet: 15:54:56.868 PST DEC 18 2017
1772 # My best guess of month abbv they may use
1773 JAN => '01', FEB => '02', MAR => '03', APR => '04',
1774 MAY => '05', JUN => '06', JUL => '07', AUG => '08',
1775 SEP => '09', OCT => '10', NOV => '11', DEC => '12'
1778 die "unparsable date: $date"; #maybe we shouldn't die...
1781 return '' if ( $year == 1900 || $year == 1970 ) && $mon == 1 && $day == 1
1782 && $hour == 0 && $min == 0 && $sec == 0;
1784 if ($options{gmt}) {
1785 timegm($sec, $min, $hour, $day, $mon-1, $year);
1787 timelocal($sec, $min, $hour, $day, $mon-1, $year);
1791 =item batch_import HASHREF
1793 Imports CDR records. Available options are:
1805 Hash reference of preset fields, typically cdrbatch
1809 Set true to prevent throwing an error on empty imports
1815 my %import_options = (
1818 'batch_keycol' => 'cdrbatchnum',
1819 'batch_table' => 'cdr_batch',
1820 'batch_namecol' => 'cdrbatch',
1822 'formats' => { map { $_ => $cdr_info{$_}->{'import_fields'}; }
1826 #drop the || 'csv' to allow auto xls for csv types?
1827 'format_types' => { map { $_ => lc($cdr_info{$_}->{'type'} || 'csv'); }
1831 'format_headers' => { map { $_ => ( $cdr_info{$_}->{'header'} || 0 ); }
1835 'format_sep_chars' => { map { $_ => $cdr_info{$_}->{'sep_char'}; }
1839 'format_fixedlength_formats' =>
1840 { map { $_ => $cdr_info{$_}->{'fixedlength_format'}; }
1844 'format_xml_formats' =>
1845 { map { $_ => $cdr_info{$_}->{'xml_format'}; }
1849 'format_asn_formats' =>
1850 { map { $_ => $cdr_info{$_}->{'asn_format'}; }
1854 'format_row_callbacks' =>
1855 { map { $_ => $cdr_info{$_}->{'row_callback'}; }
1859 'format_parser_opts' =>
1860 { map { $_ => $cdr_info{$_}->{'parser_opt'}; }
1865 sub _import_options {
1872 my $iopt = _import_options;
1873 $opt->{$_} = $iopt->{$_} foreach keys %$iopt;
1875 if ( grep defined $opt->{$_}, qw(cdrtypenum carrierid) ) {
1876 $opt->{preinsert_callback} = sub {
1877 my($record, $param) = @_;
1878 $record->$_($opt->{$_})
1879 foreach grep defined $opt->{$_}, qw(cdrtypenum carrierid);
1884 FS::Record::batch_import( $opt );
1888 =item process_batch_import
1892 sub process_batch_import {
1895 my $opt = _import_options;
1896 # $opt->{'params'} = [ 'format', 'cdrbatch' ];
1898 FS::Record::process_batch_import( $job, $opt, @_ );
1901 # if ( $format eq 'simple' ) { #should be a callback or opt in FS::cdr::simple
1902 # @columns = map { s/^ +//; $_; } @columns;
1906 =item ip_addr_sql FIELD RANGE
1908 Returns an SQL condition to search for CDRs with an IP address
1909 within RANGE. FIELD is either 'src_ip_addr' or 'dst_ip_addr'. RANGE
1910 should be in the form "a.b.c.d-e.f.g.h' (dotted quads), where any of
1911 the leftmost octets of the second address can be omitted if they're
1912 the same as the first address.
1918 my ($field, $range) = @_;
1919 $range =~ /^[\d\.-]+$/ or die "bad ip address range '$range'";
1920 my @r = split('-', $range);
1921 my @saddr = split('\.', $r[0] || '');
1922 my @eaddr = split('\.', $r[1] || '');
1923 unshift @eaddr, (undef) x (4 - scalar @eaddr);
1925 $eaddr[$_] = $saddr[$_] if !defined $eaddr[$_];
1927 "$field >= '".sprintf('%03d.%03d.%03d.%03d', @saddr) . "' AND ".
1928 "$field <= '".sprintf('%03d.%03d.%03d.%03d', @eaddr) . "'";
1937 L<FS::Record>, schema.html from the base documentation.