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>)
196 Creates a new CDR. To add the CDR to the database, see L<"insert">.
198 Note that this stores the hash reference, not a distinct copy of the hash it
199 points to. You can ask the object for a copy with the I<hash> method.
203 # the new method can be inherited from FS::Record, if a table method is defined
210 #XXX fill in some (more) nice names
212 'calldate' => 'Call date',
213 'clid' => 'Caller ID',
215 'dst' => 'Destination',
216 'dcontext' => 'Dest. context',
217 'channel' => 'Channel',
218 'dstchannel' => 'Destination channel',
221 'src_ip_addr' => 'Source IP',
222 'dst_ip_addr' => 'Dest. IP',
223 'dst_term' => 'Termination dest.',
224 'startdate' => 'Start date',
225 'answerdate' => 'Answer date',
226 'enddate' => 'End date',
227 'duration' => 'Duration',
228 'billsec' => 'Billable seconds',
229 'disposition' => 'Disposition',
230 'amaflags' => 'AMA flags',
231 'accountcode' => 'Account code',
233 'userfield' => 'User field',
235 'charged_party' => 'Charged party',
236 #'upstream_currency' => '',
237 'upstream_price' => 'Upstream price',
238 #'upstream_rateplanid' => '',
239 #'ratedetailnum' => '',
240 'src_lrn' => 'Source LRN',
241 'dst_lrn' => 'Dest. LRN',
242 'rated_price' => 'Rated price',
243 'rated_cost' => 'Rated cost',
246 #'calltypenum' => '',
247 #'description' => '',
249 'carrierid' => 'Carrier ID',
250 #'upstream_rateid' => '',
251 'svcnum' => 'Freeside service',
252 'freesidestatus' => 'Freeside status',
253 'freesiderewritestatus' => 'Freeside rewrite status',
254 'cdrbatchnum' => 'Batch',
255 'detailnum' => 'Freeside invoice detail line',
264 Adds this record to the database. If there is an error, returns the error,
265 otherwise returns false.
269 # the insert method can be inherited from FS::Record
273 Delete this record from the database.
277 # the delete method can be inherited from FS::Record
279 =item replace OLD_RECORD
281 Replaces the OLD_RECORD with this one in the database. If there is an error,
282 returns the error, otherwise returns false.
286 # the replace method can be inherited from FS::Record
290 Checks all fields to make sure this is a valid CDR. If there is
291 an error, returns the error, otherwise returns false. Called by the insert
294 Note: Unlike most types of records, we don't want to "reject" a CDR and we want
295 to process them as quickly as possible, so we allow the database to check most
303 # we don't want to "reject" a CDR like other sorts of input...
305 # $self->ut_numbern('acctid')
306 ## || $self->ut_('calldate')
307 # || $self->ut_text('clid')
308 # || $self->ut_text('src')
309 # || $self->ut_text('dst')
310 # || $self->ut_text('dcontext')
311 # || $self->ut_text('channel')
312 # || $self->ut_text('dstchannel')
313 # || $self->ut_text('lastapp')
314 # || $self->ut_text('lastdata')
315 # || $self->ut_numbern('startdate')
316 # || $self->ut_numbern('answerdate')
317 # || $self->ut_numbern('enddate')
318 # || $self->ut_number('duration')
319 # || $self->ut_number('billsec')
320 # || $self->ut_text('disposition')
321 # || $self->ut_number('amaflags')
322 # || $self->ut_text('accountcode')
323 # || $self->ut_text('uniqueid')
324 # || $self->ut_text('userfield')
325 # || $self->ut_numbern('cdrtypenum')
326 # || $self->ut_textn('charged_party')
327 ## || $self->ut_n('upstream_currency')
328 ## || $self->ut_n('upstream_price')
329 # || $self->ut_numbern('upstream_rateplanid')
330 ## || $self->ut_n('distance')
331 # || $self->ut_numbern('islocal')
332 # || $self->ut_numbern('calltypenum')
333 # || $self->ut_textn('description')
334 # || $self->ut_numbern('quantity')
335 # || $self->ut_numbern('carrierid')
336 # || $self->ut_numbern('upstream_rateid')
337 # || $self->ut_numbern('svcnum')
338 # || $self->ut_textn('freesidestatus')
339 # || $self->ut_textn('freesiderewritestatus')
341 # return $error if $error;
343 for my $f ( grep { $self->$_ =~ /\D/ } qw(startdate answerdate enddate)){
344 $self->$f( str2time($self->$f) );
347 $self->calldate( $self->startdate_sql )
348 if !$self->calldate && $self->startdate;
350 #was just for $format eq 'taqua' but can't see the harm... add something to
351 #disable if it becomes a problem
352 if ( $self->duration eq '' && $self->enddate && $self->startdate ) {
353 $self->duration( $self->enddate - $self->startdate );
355 if ( $self->billsec eq '' && $self->enddate && $self->answerdate ) {
356 $self->billsec( $self->enddate - $self->answerdate );
359 if ( ! $self->enddate && $self->startdate && $self->duration ) {
360 $self->enddate( $self->startdate + $self->duration );
363 $self->set_charged_party;
365 #check the foreign keys even?
366 #do we want to outright *reject* the CDR?
367 my $error = $self->ut_numbern('acctid');
368 return $error if $error;
370 if ( $self->freesidestatus ne 'done' ) {
371 $self->set('detailnum', ''); # can't have this on an unbilled call
374 #add a config option to turn these back on if someone needs 'em
376 # #Usage = 1, S&E = 7, OC&C = 8
377 # || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
379 # #the big list in appendix 2
380 # || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' )
382 # # Telstra =1, Optus = 2, RSL COM = 3
383 # || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
388 =item is_tollfree [ COLUMN ]
390 Returns true when the cdr represents a toll free number and false otherwise.
392 By default, inspects the dst field, but an optional column name can be passed
393 to inspect other field.
399 my $field = scalar(@_) ? shift : 'dst';
400 if ( $tollfree_country eq 'AU' ) {
401 ( $self->$field() =~ /^(\+?61)?(1800|1300)/ ) ? 1 : 0;
402 } elsif ( $tollfree_country eq 'NZ' ) {
403 ( $self->$field() =~ /^(\+?64)?(800|508)/ ) ? 1 : 0;
404 } else { #NANPA (US/Canaada)
405 ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0;
409 =item set_charged_party
411 If the charged_party field is already set, does nothing. Otherwise:
413 If the cdr-charged_party-accountcode config option is enabled, sets the
414 charged_party to the accountcode.
416 Otherwise sets the charged_party normally: to the src field in most cases,
417 or to the dst field if it is a toll free number.
421 sub set_charged_party {
424 my $conf = new FS::Conf;
426 unless ( $self->charged_party ) {
428 if ( $cp_accountcode && $self->accountcode ) {
430 my $charged_party = $self->accountcode;
431 $charged_party =~ s/^0+//
432 if $cp_accountcode_trim0s;
433 $self->charged_party( $charged_party );
435 } elsif ( $cp_field ) {
437 $self->charged_party( $self->$cp_field() );
441 if ( $self->is_tollfree ) {
442 $self->charged_party($self->dst);
444 $self->charged_party($self->src);
451 # my $prefix = $conf->config('cdr-charged_party-truncate_prefix');
452 # my $prefix_len = length($prefix);
453 # my $trunc_len = $conf->config('cdr-charged_party-truncate_length');
455 # $self->charged_party( substr($self->charged_party, 0, $trunc_len) )
456 # if $prefix_len && $trunc_len
457 # && substr($self->charged_party, 0, $prefix_len) eq $prefix;
461 =item set_status STATUS
463 Sets the status to the provided string. If there is an error, returns the
464 error, otherwise returns false.
466 If status is being changed from 'rated' to some other status, also removes
467 any usage allocations to this CDR.
472 my($self, $status) = @_;
473 my $old_status = $self->freesidestatus;
474 $self->freesidestatus($status);
475 my $error = $self->replace;
476 if ( $old_status eq 'rated' and $status ne 'done' ) {
477 # deallocate any usage
478 foreach (qsearch('cdr_cust_pkg_usage', {acctid => $self->acctid})) {
479 my $cust_pkg_usage = $_->cust_pkg_usage;
480 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $_->minutes);
481 $error ||= $cust_pkg_usage->replace || $_->delete;
487 =item set_status_and_rated_price STATUS RATED_PRICE [ SVCNUM [ OPTION => VALUE ... ] ]
489 Sets the status and rated price.
491 Available options are: inbound, rated_pretty_dst, rated_regionname,
492 rated_seconds, rated_minutes, rated_granularity, rated_ratedetailnum,
493 rated_classnum, rated_ratename. If rated_ratedetailnum is provided,
494 will also set a recalculated L</rate_cost> in the rated_cost field
495 after the other fields are set (does not work with inbound.)
497 If there is an error, returns the error, otherwise returns false.
501 sub set_status_and_rated_price {
502 my($self, $status, $rated_price, $svcnum, %opt) = @_;
504 if ($opt{'inbound'}) {
506 my $term = $self->cdr_termination( 1 ); #1: inbound
509 warn "replacing existing cdr status (".$self->acctid.")\n" if $term;
510 $error = $term->delete;
511 return $error if $error;
513 $term = FS::cdr_termination->new({
514 acctid => $self->acctid,
516 rated_price => $rated_price,
519 foreach (qw(rated_seconds rated_minutes rated_granularity)) {
520 $term->set($_, $opt{$_}) if exists($opt{$_});
522 $term->svcnum($svcnum) if $svcnum;
523 return $term->insert;
527 $self->freesidestatus($status);
528 $self->freesidestatustext($opt{'statustext'}) if exists($opt{'statustext'});
529 $self->rated_price($rated_price);
531 foreach grep exists($opt{$_}), map "rated_$_",
532 qw( pretty_dst regionname seconds minutes granularity
533 ratedetailnum classnum ratename );
534 $self->svcnum($svcnum) if $svcnum;
535 $self->rated_cost($self->rate_cost) if $opt{'rated_ratedetailnum'};
537 return $self->replace();
542 =item parse_number [ OPTION => VALUE ... ]
544 Returns two scalars, the countrycode and the rest of the number.
546 Options are passed as name-value pairs. Currently available options are:
552 The column containing the number to be parsed. Defaults to dst.
554 =item international_prefix
556 The digits for international dialing. Defaults to '011' The value '+' is
559 =item domestic_prefix
561 The digits for domestic long distance dialing. Defaults to '1'
568 my ($self, %options) = @_;
570 my $field = $options{column} || 'dst';
571 my $intl = $options{international_prefix} || '011';
572 # Still, don't break anyone's CDR rating if they have an empty string in
573 # there. Require an explicit statement that there's no prefix.
574 $intl = '' if lc($intl) eq 'none';
575 my $countrycode = '';
576 my $number = $self->$field();
578 my $to_or_from = 'concerning';
579 $to_or_from = 'from' if $field eq 'src';
580 $to_or_from = 'to' if $field eq 'dst';
581 warn "parsing call $to_or_from $number\n" if $DEBUG;
583 #remove non-phone# stuff and whitespace
586 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
588 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
590 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
591 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
595 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
596 #first look for 1 digit country code
597 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
599 $number = $u1.$u2.$rest;
600 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
603 } else { #3 digit country code
604 $countrycode = $three;
609 my $domestic_prefix =
610 exists($options{domestic_prefix}) ? $options{domestic_prefix} : '';
611 $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
612 $number =~ s/^$countrycode//;# if length($number) > 10;
615 return($countrycode, $number);
619 =item rate [ OPTION => VALUE ... ]
621 Rates this CDR according and sets the status to 'rated'.
623 Available options are: part_pkg, svcnum, plan_included_min,
624 detail_included_min_hashref.
626 part_pkg is required.
628 If svcnum is specified, will also associate this CDR with the specified svcnum.
630 plan_included_min should be set to a scalar reference of the number of
631 included minutes and will be decremented by the rated minutes of this
634 detail_included_min_hashref should be set to an empty hashref at the
635 start of a month's rating and then preserved across CDRs.
640 my( $self, %opt ) = @_;
641 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
644 warn "rating CDR $self\n".
645 join('', map { " $_ => ". $self->{$_}. "\n" } keys %$self );
648 my $rating_method = $part_pkg->option_cacheable('rating_method') || 'prefix';
649 my $method = "rate_$rating_method";
650 $self->$method(%opt);
654 our %interval_cache = (); # for timed rates
657 my( $self, %opt ) = @_;
658 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
659 my $cust_pkg = $opt{'cust_pkg'};
662 # (Directory assistance) rewriting
666 # this will result in those CDRs being marked as done... is that
669 if ( $part_pkg->option_cacheable('411_rewrite') ) {
670 my $dirass = $part_pkg->option_cacheable('411_rewrite');
672 @dirass = split(',', $dirass);
675 if ( length($self->dst) && grep { $self->dst eq $_ } @dirass ) {
681 # Checks to see if the CDR is chargeable
684 my $reason = $part_pkg->check_chargable( $self,
685 'da_rewrote' => $da_rewrote,
688 warn "not charging for CDR ($reason)\n" if $DEBUG;
689 return $self->set_status_and_rated_price( 'skipped',
692 'statustext' => $reason,
696 if ( $part_pkg->option_cacheable('skip_same_customer')
697 and ! $self->is_tollfree ) {
698 my ($dst_countrycode, $dst_number) = $self->parse_number(
700 international_prefix => $part_pkg->option_cacheable('international_prefix'),
701 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
703 my $dst_same_cust = FS::Record->scalar_sql(
704 'SELECT COUNT(svc_phone.svcnum) AS count '.
706 'JOIN cust_svc USING (pkgnum) ' .
707 'JOIN svc_phone USING (svcnum) ' .
708 'WHERE svc_phone.countrycode = ' . dbh->quote($dst_countrycode) .
709 ' AND svc_phone.phonenum = ' . dbh->quote($dst_number) .
710 ' AND cust_pkg.custnum = ' . $cust_pkg->custnum,
712 if ( $dst_same_cust > 0 ) {
713 warn "not charging for CDR (same source and destination customer)\n" if $DEBUG;
714 return $self->set_status_and_rated_price( 'skipped',
721 my $rated_seconds = $part_pkg->option_cacheable('use_duration')
724 if ( $max_duration > 0 && $rated_seconds > $max_duration ) {
725 return $self->set_status_and_rated_price(
733 # look up rate details based on called station id
734 # (or calling station id for toll free calls)
737 my $eff_ratenum = $self->is_tollfree('accountcode')
738 ? $part_pkg->option_cacheable('accountcode_tollfree_ratenum')
741 my( $to_or_from, $column );
744 && ! $part_pkg->option_cacheable('disable_tollfree')
747 && $part_pkg->option_cacheable('accountcode_tollfree_field') eq 'src'
751 $to_or_from = 'from';
753 } else { #regular call
758 #determine the country code
759 my ($countrycode, $number) = $self->parse_number(
761 international_prefix => $part_pkg->option_cacheable('international_prefix'),
762 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
766 my $intrastate_ratenum = $part_pkg->option_cacheable('intrastate_ratenum');
768 if ( $use_lrn and $countrycode eq '1' ) {
770 # then ask about the number
771 foreach my $field ('src', 'dst') {
773 $self->get_lrn($field);
774 if ( $field eq $column ) {
775 # then we are rating on this number
776 $number = $self->get($field.'_lrn');
778 # is this ever meaningful? can the LRN be outside NANP space?
785 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
786 my $pretty_dst = "+$countrycode $number";
787 #asterisks here causes inserting the detail to barf, so:
788 $pretty_dst =~ s/\*//g;
790 # should check $countrycode eq '1' here?
791 if ( $intrastate_ratenum && !$self->is_tollfree ) {
792 $ratename = 'Interstate'; #until proven otherwise
793 # this is relatively easy only because:
794 # -assume all numbers are valid NANP numbers NOT in a fully-qualified format
795 # -disregard toll-free
796 # -disregard private or unknown numbers
797 # -there is exactly one record in rate_prefix for a given NPANXX
798 # -default to interstate if we can't find one or both of the prefixes
799 my $dst_col = $use_lrn ? 'dst_lrn' : 'dst';
800 my $src_col = $use_lrn ? 'src_lrn' : 'src';
801 my (undef, $dstprefix) = $self->parse_number(
803 international_prefix => $part_pkg->option_cacheable('international_prefix'),
804 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
806 $dstprefix =~ /^(\d{6})/;
807 $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
810 my (undef, $srcprefix) = $self->parse_number(
812 international_prefix => $part_pkg->option_cacheable('international_prefix'),
813 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
815 $srcprefix =~ /^(\d{6})/;
816 $srcprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
819 if ($srcprefix && $dstprefix
820 && $srcprefix->state && $dstprefix->state
821 && $srcprefix->state eq $dstprefix->state) {
822 $eff_ratenum = $intrastate_ratenum;
823 $ratename = 'Intrastate'; # XXX possibly just use the ratename?
827 $eff_ratenum ||= $part_pkg->option_cacheable('ratenum');
828 my $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
829 or die "ratenum $eff_ratenum not found!";
831 my @ltime = localtime($self->startdate);
832 my $weektime = $ltime[0] +
833 $ltime[1]*60 + #minutes
834 $ltime[2]*3600 + #hours
835 $ltime[6]*86400; #days since sunday
836 # if there's no timed rate_detail for this time/region combination,
837 # dest_detail returns the default. There may still be a timed rate
838 # that applies after the starttime of the call, so be careful...
839 my $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
840 'phonenum' => $number,
841 'weektime' => $weektime,
842 'cdrtypenum' => $self->cdrtypenum,
845 unless ( $rate_detail ) {
847 if ( $part_pkg->option_cacheable('ignore_unrateable') ) {
849 if ( $part_pkg->option_cacheable('ignore_unrateable') == 2 ) {
850 # mark the CDR as unrateable
851 return $self->set_status_and_rated_price(
856 } elsif ( $part_pkg->option_cacheable('ignore_unrateable') == 1 ) {
858 warn "no rate_detail found for CDR.acctid: ". $self->acctid.
863 die "unknown ignore_unrateable, pkgpart ". $part_pkg->pkgpart;
868 die "FATAL: no rate_detail found in ".
869 $rate->ratenum. ":". $rate->ratename. " rate plan ".
870 "for +$countrycode $number (CDR acctid ". $self->acctid. "); ".
871 "add a rate or set ignore_unrateable flag on the package def\n";
876 my $regionnum = $rate_detail->dest_regionnum;
877 my $rate_region = $rate_detail->dest_region;
878 warn " found rate for regionnum $regionnum ".
879 "and rate detail $rate_detail\n"
882 if ( !exists($interval_cache{$regionnum}) ) {
884 sort { $a->stime <=> $b->stime }
885 map { $_->rate_time->intervals }
886 qsearch({ 'table' => 'rate_detail',
887 'hashref' => { 'ratenum' => $rate->ratenum },
888 'extra_sql' => 'AND ratetimenum IS NOT NULL',
891 $interval_cache{$regionnum} = \@intervals;
892 warn " cached ".scalar(@intervals)." interval(s)\n"
897 # find the price and add detail to the invoice
900 # About this section:
901 # We don't round _anything_ (except granularizing)
902 # until the final $charge = sprintf("%.2f"...).
904 my $seconds_left = $rated_seconds;
906 #no, do this later so it respects (group) included minutes
907 # # charge for the first (conn_sec) seconds
908 # my $seconds = min($seconds_left, $rate_detail->conn_sec);
909 # $seconds_left -= $seconds;
910 # $weektime += $seconds;
911 # my $charge = $rate_detail->conn_charge;
914 my $connection_charged = 0;
916 # before doing anything else, if there's an upstream multiplier and
917 # an upstream price, add that to the charge. (usually the rate detail
918 # will then have a minute charge of zero, but not necessarily.)
919 $charge += ($self->upstream_price || 0) * $rate_detail->upstream_mult_charge;
922 while($seconds_left) {
923 my $ratetimenum = $rate_detail->ratetimenum; # may be empty
925 # find the end of the current rate interval
926 if(@{ $interval_cache{$regionnum} } == 0) {
927 # There are no timed rates in this group, so just stay
928 # in the default rate_detail for the entire duration.
929 # Set an "end" of 1 past the end of the current call.
930 $etime = $weektime + $seconds_left + 1;
932 elsif($ratetimenum) {
933 # This is a timed rate, so go to the etime of this interval.
934 # If it's followed by another timed rate, the stime of that
935 # interval should match the etime of this one.
936 my $interval = $rate_detail->rate_time->contains($weektime);
937 $etime = $interval->etime;
940 # This is a default rate, so use the stime of the next
941 # interval in the sequence.
942 my $next_int = first { $_->stime > $weektime }
943 @{ $interval_cache{$regionnum} };
945 $etime = $next_int->stime;
948 # weektime is near the end of the week, so decrement
949 # it by a full week and use the stime of the first
951 $weektime -= (3600*24*7);
952 $etime = $interval_cache{$regionnum}->[0]->stime;
956 my $charge_sec = min($seconds_left, $etime - $weektime);
958 $seconds_left -= $charge_sec;
960 my $granularity = $rate_detail->sec_granularity;
963 if ( $granularity ) { # charge per minute
964 # Round up to the nearest $granularity
965 if ( $charge_sec and $charge_sec % $granularity ) {
966 $charge_sec += $granularity - ($charge_sec % $granularity);
968 $minutes = $charge_sec / 60; #don't round this
975 #$seconds += $charge_sec;
977 if ( $rate_detail->min_included ) {
978 # the old, kind of deprecated way to do this:
980 # The rate detail itself has included minutes. We MUST have a place
982 my $included_min = $opt{'detail_included_min_hashref'}
983 or return "unable to rate CDR: rate detail has included minutes, but ".
984 "no detail_included_min_hashref provided.\n";
986 # by default, set the included minutes for this region/time to
987 # what's in the rate_detail
988 if (!exists( $included_min->{$regionnum}{$ratetimenum} )) {
989 $included_min->{$regionnum}{$ratetimenum} =
990 ($rate_detail->min_included * $cust_pkg->quantity || 1);
993 if ( $included_min->{$regionnum}{$ratetimenum} >= $minutes ) {
995 $included_min->{$regionnum}{$ratetimenum} -= $minutes;
997 $charge_sec -= ($included_min->{$regionnum}{$ratetimenum} * 60);
998 $included_min->{$regionnum}{$ratetimenum} = 0;
1000 } elsif ( $opt{plan_included_min} && ${ $opt{plan_included_min} } > 0 ) {
1001 # The package definition has included minutes, but only for in-group
1002 # rate details. Decrement them if this is an in-group call.
1003 if ( $rate_detail->region_group ) {
1004 if ( ${ $opt{'plan_included_min'} } >= $minutes ) {
1006 ${ $opt{'plan_included_min'} } -= $minutes;
1008 $charge_sec -= (${ $opt{'plan_included_min'} } * 60);
1009 ${ $opt{'plan_included_min'} } = 0;
1014 my $applied_min = $cust_pkg->apply_usage(
1016 'rate_detail' => $rate_detail,
1017 'minutes' => $minutes
1019 # for now, usage pools deal only in whole minutes
1020 $charge_sec -= $applied_min * 60;
1023 if ( $charge_sec > 0 ) {
1025 #NOW do connection charges here... right?
1026 #my $conn_seconds = min($seconds_left, $rate_detail->conn_sec);
1027 my $conn_seconds = 0;
1028 unless ( $connection_charged++ ) { #only one connection charge
1029 $conn_seconds = min($charge_sec, $rate_detail->conn_sec);
1030 $seconds_left -= $conn_seconds;
1031 $weektime += $conn_seconds;
1032 $charge += $rate_detail->conn_charge;
1035 #should preserve (display?) this
1036 if ( $granularity == 0 ) { # per call rate
1037 $charge += $rate_detail->min_charge;
1039 my $charge_min = ( $charge_sec - $conn_seconds ) / 60;
1040 $charge += ($rate_detail->min_charge * $charge_min) if $charge_min > 0; #still not rounded
1045 # choose next rate_detail
1046 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
1047 'phonenum' => $number,
1048 'weektime' => $etime,
1049 'cdrtypenum' => $self->cdrtypenum })
1051 # we have now moved forward to $etime
1054 } #while $seconds_left
1056 # this is why we need regionnum/rate_region....
1057 warn " (rate region $rate_region)\n" if $DEBUG;
1060 my $rounding = $part_pkg->option_cacheable('rounding') || 2;
1061 my $sprintformat = '%.'. $rounding. 'f';
1062 my $roundup = 10**(-3-$rounding);
1063 my $price = sprintf($sprintformat, $charge + $roundup);
1065 $self->set_status_and_rated_price(
1069 'rated_pretty_dst' => $pretty_dst,
1070 'rated_regionname' => ($rate_region ? $rate_region->regionname : ''),
1071 'rated_seconds' => $rated_seconds, #$seconds,
1072 'rated_granularity' => $rate_detail->sec_granularity, #$granularity
1073 'rated_ratedetailnum' => $rate_detail->ratedetailnum,
1074 'rated_classnum' => $rate_detail->classnum, #rated_ratedetailnum?
1075 'rated_ratename' => $ratename, #not rate_detail - Intrastate/Interstate
1080 sub rate_upstream_simple {
1081 my( $self, %opt ) = @_;
1083 $self->set_status_and_rated_price(
1085 sprintf('%.3f', $self->upstream_price),
1087 'rated_classnum' => $self->calltypenum,
1088 'rated_seconds' => $self->billsec,
1089 # others? upstream_*_regionname => rated_regionname is possible
1093 sub rate_single_price {
1094 my( $self, %opt ) = @_;
1095 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
1097 # a little false laziness w/abov
1098 # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
1100 my $granularity = length($part_pkg->option_cacheable('sec_granularity'))
1101 ? $part_pkg->option_cacheable('sec_granularity')
1104 my $seconds = $part_pkg->option_cacheable('use_duration')
1108 $seconds += $granularity - ( $seconds % $granularity )
1109 if $seconds # don't granular-ize 0 billsec calls (bills them)
1110 && $granularity # 0 is per call
1111 && $seconds % $granularity;
1112 my $minutes = $granularity ? ($seconds / 60) : 1;
1114 my $charge_min = $minutes;
1116 ${$opt{plan_included_min}} -= $minutes;
1117 if ( ${$opt{plan_included_min}} > 0 ) {
1120 $charge_min = 0 - ${$opt{plan_included_min}};
1121 ${$opt{plan_included_min}} = 0;
1125 sprintf('%.4f', ( $part_pkg->option_cacheable('min_charge') * $charge_min )
1126 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
1128 $self->set_status_and_rated_price(
1132 'rated_granularity' => $granularity,
1133 'rated_seconds' => $seconds,
1140 Rates an already-rated CDR according to the cost fields from the rate plan.
1149 return 0 unless $self->rated_ratedetailnum;
1152 qsearchs('rate_detail', { 'ratedetailnum' => $self->rated_ratedetailnum } );
1155 $charge += ($self->upstream_price || 0) * ($rate_detail->upstream_mult_cost);
1157 if ( $self->rated_granularity == 0 ) {
1158 $charge += $rate_detail->min_cost;
1160 my $minutes = $self->rated_seconds / 60;
1161 $charge += $rate_detail->conn_cost + $minutes * $rate_detail->min_cost;
1164 sprintf('%.2f', $charge + .00001 );
1168 =item cdr_termination [ TERMPART ]
1172 sub cdr_termination {
1175 if ( scalar(@_) && $_[0] ) {
1176 my $termpart = shift;
1178 qsearchs('cdr_termination', { acctid => $self->acctid,
1179 termpart => $termpart,
1185 qsearch('cdr_termination', { acctid => $self->acctid, } );
1193 Parses the calldate in SQL string format and returns a UNIX timestamp.
1198 str2time(shift->calldate);
1203 Parses the startdate in UNIX timestamp format and returns a string in SQL
1209 my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate);
1212 "$year-$mon-$mday $hour:$min:$sec";
1217 Returns the FS::cdr_carrier object associated with this CDR, or false if no
1218 carrierid is defined.
1222 my %carrier_cache = ();
1226 return '' unless $self->carrierid;
1227 $carrier_cache{$self->carrierid} ||=
1228 qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } );
1233 Returns the carrier name (see L<FS::cdr_carrier>), or the empty string if
1234 no FS::cdr_carrier object is assocated with this CDR.
1240 my $cdr_carrier = $self->cdr_carrier;
1241 $cdr_carrier ? $cdr_carrier->carriername : '';
1246 Returns the FS::cdr_calltype object associated with this CDR, or false if no
1247 calltypenum is defined.
1251 my %calltype_cache = ();
1255 return '' unless $self->calltypenum;
1256 $calltype_cache{$self->calltypenum} ||=
1257 qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } );
1262 Returns the call type name (see L<FS::cdr_calltype>), or the empty string if
1263 no FS::cdr_calltype object is assocated with this CDR.
1269 my $cdr_calltype = $self->cdr_calltype;
1270 $cdr_calltype ? $cdr_calltype->calltypename : '';
1273 =item downstream_csv [ OPTION => VALUE, ... ]
1277 # in the future, load this dynamically from detail_format classes
1279 my %export_names = (
1282 'invoice_header' => "Date,Time,Name,Destination,Duration,Price",
1285 'name' => 'Simple with source',
1286 'invoice_header' => "Date,Time,Called From,Destination,Duration,Price",
1287 #"Date,Time,Name,Called From,Destination,Duration,Price",
1289 'accountcode_simple' => {
1290 'name' => 'Simple with accountcode',
1291 'invoice_header' => "Date,Time,Called From,Account,Duration,Price",
1295 'invoice_header' => "Date/Time,Called Number,Min/Sec,Price",
1297 'basic_upstream_dst_regionname' => {
1298 'name' => 'Basic with upstream destination name',
1299 'invoice_header' => "Date/Time,Called Number,Destination,Min/Sec,Price",
1302 'name' => 'Default',
1303 'invoice_header' => 'Date,Time,Number,Destination,Duration,Price',
1305 'source_default' => {
1306 'name' => 'Default with source',
1307 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1309 'accountcode_default' => {
1310 'name' => 'Default plus accountcode',
1311 'invoice_header' => 'Date,Time,Account,Number,Destination,Duration,Price',
1313 'description_default' => {
1314 'name' => 'Default with description field as destination',
1315 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1318 'name' => 'Summary, one line per service',
1319 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1322 'name' => 'Number of calls, one line per service',
1323 'invoice_header' => 'Caller,Rate,Messages,Price',
1326 'name' => 'Summary, one line per service',
1327 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1329 'sum_duration_prefix' => {
1330 'name' => 'Summary, one line per destination prefix',
1331 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1333 'sum_count_class' => {
1334 'name' => 'Summary, one line per usage class',
1335 'invoice_header' => 'Caller,Class,Calls,Price',
1337 'sum_duration_accountcode' => {
1338 'name' => 'Summary, one line per accountcode',
1339 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1343 my %export_formats = ();
1344 sub export_formats {
1347 return %export_formats if keys %export_formats;
1349 my $conf = new FS::Conf;
1350 my $date_format = $conf->config('date_format') || '%m/%d/%Y';
1352 # call duration in the largest units that accurately reflect the granularity
1353 my $duration_sub = sub {
1354 my($cdr, %opt) = @_;
1355 my $sec = $opt{seconds} || $cdr->billsec;
1356 if ( defined $opt{granularity} &&
1357 $opt{granularity} == 0 ) { #per call
1360 elsif ( defined $opt{granularity} && $opt{granularity} == 60 ) {#full minutes
1361 my $min = int($sec/60);
1365 else { #anything else
1366 return sprintf("%dm %ds", $sec/60, $sec%60);
1370 my $price_sub = sub {
1371 my ($cdr, %opt) = @_;
1373 if ( defined($opt{charge}) ) {
1374 $price = $opt{charge};
1376 elsif ( $opt{inbound} ) {
1377 my $term = $cdr->cdr_termination(1); # 1 = inbound
1378 $price = $term->rated_price if defined $term;
1381 $price = $cdr->rated_price;
1383 length($price) ? ($opt{money_char} . $price) : '';
1386 my $src_sub = sub { $_[0]->clid || $_[0]->src };
1390 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1391 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1393 'dst', #NUMBER_DIALED
1394 $duration_sub, #DURATION
1395 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1399 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1400 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1402 $src_sub, #called from
1403 'dst', #NUMBER_DIALED
1404 $duration_sub, #DURATION
1405 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1408 'accountcode_simple' => [
1409 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1410 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1411 $src_sub, #called from
1412 'accountcode', #NUMBER_DIALED
1413 $duration_sub, #DURATION
1417 # for summary formats, the CDR is a fictitious object containing the
1418 # total billsec and the phone number of the service
1420 sub { my($cdr, %opt) = @_; $opt{ratename} },
1421 sub { my($cdr, %opt) = @_; $opt{count} },
1422 sub { my($cdr, %opt) = @_; int($opt{seconds}/60).'m' },
1427 sub { my($cdr, %opt) = @_; $opt{ratename} },
1428 sub { my($cdr, %opt) = @_; $opt{count} },
1432 sub { time2str('%d %b - %I:%M %p', shift->calldate_unix) },
1440 sub { time2str($date_format, shift->calldate_unix ) },
1441 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
1444 sub { time2str('%r', shift->calldate_unix ) },
1445 # 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
1448 sub { my($cdr, %opt) = @_; $opt{pretty_dst} || $cdr->dst; },
1450 #REGIONNAME ("Destination")
1451 sub { my($cdr, %opt) = @_; $opt{dst_regionname}; },
1460 $export_formats{'source_default'} = [ $src_sub, @{ $export_formats{'default'} }, ];
1461 $export_formats{'accountcode_default'} =
1462 [ @{ $export_formats{'default'} }[0,1],
1464 @{ $export_formats{'default'} }[2..5],
1466 my @default = @{ $export_formats{'default'} };
1467 $export_formats{'description_default'} =
1468 [ $src_sub, @default[0..2],
1469 sub { my($cdr, %opt) = @_; $cdr->description },
1472 return %export_formats;
1475 =item downstream_csv OPTION => VALUE ...
1477 Returns a string of formatted call details for display on an invoice.
1483 charge - override the 'rated_price' field of the CDR
1485 seconds - override the 'billsec' field of the CDR
1487 count - number of usage events included in this record, for summary formats
1489 ratename - name of the rate table used to rate this call
1495 sub downstream_csv {
1496 my( $self, %opt ) = @_;
1498 my $format = $opt{'format'};
1499 my %formats = $self->export_formats;
1500 return "Unknown format $format" unless exists $formats{$format};
1502 #my $conf = new FS::Conf;
1503 #$opt{'money_char'} ||= $conf->config('money_char') || '$';
1504 $opt{'money_char'} ||= FS::Conf->new->config('money_char') || '$';
1506 my $csv = new Text::CSV_XS;
1510 ref($_) ? &{$_}($self, %opt) : $self->$_();
1512 @{ $formats{$format} };
1514 return @columns if defined $opt{'keeparray'};
1516 my $status = $csv->combine(@columns);
1517 die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV"
1528 my $ua = LWP::UserAgent->new(
1530 verify_hostname => 0,
1531 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
1535 my $url = 'https://ws.freeside.biz/get_lrn';
1537 my %content = ( 'support-key' => $support_key,
1538 'tn' => $self->get($field),
1540 my $response = $ua->request( POST $url, \%content );
1542 die "LRN service error: ". $response->message. "\n"
1543 unless $response->is_success;
1546 my $data = eval { decode_json($response->content) };
1547 die "LRN service JSON error : $@\n" if $@;
1549 if ($data->{error}) {
1550 die "acctid ".$self->acctid." $field LRN lookup failed:\n$data->{error}";
1551 # for testing; later we should respect ignore_unrateable
1552 } elsif ($data->{lrn}) {
1554 $self->set($field.'_lrn', $data->{lrn});
1556 die "acctid ".$self->acctid." $field LRN lookup returned no number.\n";
1559 return $data; # in case it's interesting somehow
1564 =head1 CLASS METHODS
1568 =item invoice_formats
1570 Returns an ordered list of key value pairs containing invoice format names
1571 as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values.
1575 # in the future, load this dynamically from detail_format classes
1577 sub invoice_formats {
1578 map { ($_ => $export_names{$_}->{'name'}) }
1579 grep { $export_names{$_}->{'invoice_header'} }
1580 sort keys %export_names;
1583 =item invoice_header FORMAT
1585 Returns a scalar containing the CSV column header for invoice format FORMAT.
1589 sub invoice_header {
1591 $export_names{$format}->{'invoice_header'};
1596 Clears cdr and any associated cdr_termination statuses - used for
1605 local $SIG{HUP} = 'IGNORE';
1606 local $SIG{INT} = 'IGNORE';
1607 local $SIG{QUIT} = 'IGNORE';
1608 local $SIG{TERM} = 'IGNORE';
1609 local $SIG{TSTP} = 'IGNORE';
1610 local $SIG{PIPE} = 'IGNORE';
1612 my $oldAutoCommit = $FS::UID::AutoCommit;
1613 local $FS::UID::AutoCommit = 0;
1616 if ( $cdr_prerate && $cdr_prerate_cdrtypenums{$self->cdrtypenum}
1617 && $self->rated_ratedetailnum #avoid putting old CDRs back in "rated"
1618 && $self->freesidestatus eq 'done'
1622 $self->freesidestatus('rated');
1624 $self->freesidestatus('');
1627 my $error = $self->replace;
1629 $dbh->rollback if $oldAutoCommit;
1633 foreach my $cdr_termination ( $self->cdr_termination ) {
1634 #$cdr_termination->status('');
1635 #$error = $cdr_termination->replace;
1636 $error = $cdr_termination->delete;
1638 $dbh->rollback if $oldAutoCommit;
1643 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1648 =item import_formats
1650 Returns an ordered list of key value pairs containing import format names
1651 as keys (for use with batch_import) and "pretty" format names as values.
1655 #false laziness w/part_pkg & part_export
1658 foreach my $INC ( @INC ) {
1659 warn "globbing $INC/FS/cdr/[a-z]*.pm\n" if $DEBUG;
1660 foreach my $file ( glob("$INC/FS/cdr/[a-z]*.pm") ) {
1661 warn "attempting to load CDR format info from $file\n" if $DEBUG;
1662 $file =~ /\/(\w+)\.pm$/ or do {
1663 warn "unrecognized file in $INC/FS/cdr/: $file\n";
1667 my $info = eval "use FS::cdr::$mod; ".
1668 "\\%FS::cdr::$mod\::info;";
1670 die "error using FS::cdr::$mod (skipping): $@\n" if $@;
1673 unless ( keys %$info ) {
1674 warn "no %info hash found in FS::cdr::$mod, skipping\n";
1677 warn "got CDR format info from FS::cdr::$mod: $info\n" if $DEBUG;
1678 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1679 warn "skipping disabled CDR format FS::cdr::$mod" if $DEBUG;
1682 $cdr_info{$mod} = $info;
1686 tie my %import_formats, 'Tie::IxHash',
1687 map { $_ => $cdr_info{$_}->{'name'} }
1689 #this is not doing anything useful anymore
1690 #sort { $cdr_info{$a}->{'weight'} <=> $cdr_info{$b}->{'weight'} }
1692 sort { lc($cdr_info{$a}->{'name'}) cmp lc($cdr_info{$b}->{'name'}) }
1694 grep { exists($cdr_info{$_}->{'import_fields'}) }
1697 sub import_formats {
1701 sub _cdr_min_parser_maker {
1703 my @fields = ref($field) ? @$field : ($field);
1704 @fields = qw( billsec duration ) unless scalar(@fields) && $fields[0];
1706 my( $cdr, $min ) = @_;
1707 my $sec = eval { _cdr_min_parse($min) };
1708 die "error parsing seconds for @fields from $min minutes: $@\n" if $@;
1709 $cdr->$_($sec) foreach @fields;
1713 sub _cdr_min_parse {
1715 sprintf('%.0f', $min * 60 );
1718 sub _cdr_date_parser_maker {
1721 my @fields = ref($field) ? @$field : ($field);
1723 my( $cdr, $datestring ) = @_;
1724 my $unixdate = eval { _cdr_date_parse($datestring, %options) };
1725 die "error parsing date for @fields from $datestring: $@\n" if $@;
1726 $cdr->$_($unixdate) foreach @fields;
1730 sub _cdr_date_parse {
1734 return '' unless length($date); #that's okay, it becomes NULL
1735 return '' if $date eq 'NA'; #sansay
1737 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 ) {
1738 my $time = str2time($date);
1739 return $time if $time > 100000; #just in case
1742 my($year, $mon, $day, $hour, $min, $sec);
1744 #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/
1745 #taqua #2007-10-31 08:57:24.113000000
1747 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|$)/ ) {
1748 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1749 } 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|$)/ ) {
1750 # 8/26/2010 12:20:01
1751 # optionally without seconds
1752 ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1753 $sec = 0 if !defined($sec);
1754 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\.\d+)$/ ) {
1755 # broadsoft: 20081223201938.314
1756 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1757 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\d+(\D|$)/ ) {
1758 # Taqua OM: 20050422203450943
1759 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1760 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/ ) {
1761 # WIP: 20100329121420
1762 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1763 } elsif ( $date =~ /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/) {
1764 # Telos 2014-10-10T05:30:33Z
1765 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1767 } elsif ( $date =~ /^(\d+):(\d+):(\d+)\.\d+ \w+ (\w+) (\d+) (\d+)$/ ) {
1768 ($hour, $min, $sec, $mon, $day, $year) = ( $1, $2, $3, $4, $5, $6 );
1769 $mon = { # Acme Packet: 15:54:56.868 PST DEC 18 2017
1770 # My best guess of month abbv they may use
1771 JAN => '01', FEB => '02', MAR => '03', APR => '04',
1772 MAY => '05', JUN => '06', JUL => '07', AUG => '08',
1773 SEP => '09', OCT => '10', NOV => '11', DEC => '12'
1776 die "unparsable date: $date"; #maybe we shouldn't die...
1779 return '' if ( $year == 1900 || $year == 1970 ) && $mon == 1 && $day == 1
1780 && $hour == 0 && $min == 0 && $sec == 0;
1782 if ($options{gmt}) {
1783 timegm($sec, $min, $hour, $day, $mon-1, $year);
1785 timelocal($sec, $min, $hour, $day, $mon-1, $year);
1789 =item batch_import HASHREF
1791 Imports CDR records. Available options are:
1803 Hash reference of preset fields, typically cdrbatch
1807 Set true to prevent throwing an error on empty imports
1813 my %import_options = (
1816 'batch_keycol' => 'cdrbatchnum',
1817 'batch_table' => 'cdr_batch',
1818 'batch_namecol' => 'cdrbatch',
1820 'formats' => { map { $_ => $cdr_info{$_}->{'import_fields'}; }
1824 #drop the || 'csv' to allow auto xls for csv types?
1825 'format_types' => { map { $_ => lc($cdr_info{$_}->{'type'} || 'csv'); }
1829 'format_headers' => { map { $_ => ( $cdr_info{$_}->{'header'} || 0 ); }
1833 'format_sep_chars' => { map { $_ => $cdr_info{$_}->{'sep_char'}; }
1837 'format_fixedlength_formats' =>
1838 { map { $_ => $cdr_info{$_}->{'fixedlength_format'}; }
1842 'format_xml_formats' =>
1843 { map { $_ => $cdr_info{$_}->{'xml_format'}; }
1847 'format_asn_formats' =>
1848 { map { $_ => $cdr_info{$_}->{'asn_format'}; }
1852 'format_row_callbacks' =>
1853 { map { $_ => $cdr_info{$_}->{'row_callback'}; }
1857 'format_parser_opts' =>
1858 { map { $_ => $cdr_info{$_}->{'parser_opt'}; }
1863 sub _import_options {
1870 my $iopt = _import_options;
1871 $opt->{$_} = $iopt->{$_} foreach keys %$iopt;
1873 if ( defined $opt->{'cdrtypenum'} ) {
1874 $opt->{'preinsert_callback'} = sub {
1875 my($record,$param) = (shift,shift);
1876 $record->cdrtypenum($opt->{'cdrtypenum'});
1881 FS::Record::batch_import( $opt );
1885 =item process_batch_import
1889 sub process_batch_import {
1892 my $opt = _import_options;
1893 # $opt->{'params'} = [ 'format', 'cdrbatch' ];
1895 FS::Record::process_batch_import( $job, $opt, @_ );
1898 # if ( $format eq 'simple' ) { #should be a callback or opt in FS::cdr::simple
1899 # @columns = map { s/^ +//; $_; } @columns;
1903 =item ip_addr_sql FIELD RANGE
1905 Returns an SQL condition to search for CDRs with an IP address
1906 within RANGE. FIELD is either 'src_ip_addr' or 'dst_ip_addr'. RANGE
1907 should be in the form "a.b.c.d-e.f.g.h' (dotted quads), where any of
1908 the leftmost octets of the second address can be omitted if they're
1909 the same as the first address.
1915 my ($field, $range) = @_;
1916 $range =~ /^[\d\.-]+$/ or die "bad ip address range '$range'";
1917 my @r = split('-', $range);
1918 my @saddr = split('\.', $r[0] || '');
1919 my @eaddr = split('\.', $r[1] || '');
1920 unshift @eaddr, (undef) x (4 - scalar @eaddr);
1922 $eaddr[$_] = $saddr[$_] if !defined $eaddr[$_];
1924 "$field >= '".sprintf('%03d.%03d.%03d.%03d', @saddr) . "' AND ".
1925 "$field <= '".sprintf('%03d.%03d.%03d.%03d', @eaddr) . "'";
1934 L<FS::Record>, schema.html from the base documentation.