4 use vars qw( @ISA @EXPORT_OK $DEBUG $me
5 $conf $cdr_prerate %cdr_prerate_cdrtypenums
8 use List::Util qw(first min);
13 use List::Util qw( first min );
15 use FS::UID qw( dbh );
17 use FS::Record qw( qsearch qsearchs );
22 use FS::cdr_termination;
27 @ISA = qw(FS::Record);
28 @EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker );
33 #ask FS::UID to run this stuff for us later
34 FS::UID->install_callback( sub {
37 my @cdr_prerate_cdrtypenums;
38 $cdr_prerate = $conf->exists('cdr-prerate');
39 @cdr_prerate_cdrtypenums = $conf->config('cdr-prerate-cdrtypenums')
41 %cdr_prerate_cdrtypenums = map { $_=>1 } @cdr_prerate_cdrtypenums;
46 FS::cdr - Object methods for cdr records
52 $record = new FS::cdr \%hash;
53 $record = new FS::cdr { 'column' => 'value' };
55 $error = $record->insert;
57 $error = $new_record->replace($old_record);
59 $error = $record->delete;
61 $error = $record->check;
65 An FS::cdr object represents an Call Data Record, typically from a telephony
66 system or provider of some sort. FS::cdr inherits from FS::Record. The
67 following fields are currently supported:
71 =item acctid - primary key
73 =item calldate - Call timestamp (SQL timestamp)
75 =item clid - Caller*ID with text
77 =item src - Caller*ID number / Source number
79 =item dst - Destination extension
81 =item dcontext - Destination context
83 =item channel - Channel used
85 =item dstchannel - Destination channel if appropriate
87 =item lastapp - Last application if appropriate
89 =item lastdata - Last application data
91 =item src_ip_addr - Source IP address (dotted quad, zero-filled)
93 =item dst_ip_addr - Destination IP address (same)
95 =item dst_term - Terminating destination number (if different from dst)
97 =item startdate - Start of call (UNIX-style integer timestamp)
99 =item answerdate - Answer time of call (UNIX-style integer timestamp)
101 =item enddate - End time of call (UNIX-style integer timestamp)
103 =item duration - Total time in system, in seconds
105 =item billsec - Total time call is up, in seconds
107 =item disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
109 =item amaflags - What flags to use: BILL, IGNORE etc, specified on a per channel basis like accountcode.
113 #ignore the "omit" and "documentation" AMAs??
114 #AMA = Automated Message Accounting.
115 #default: Sets the system default.
116 #omit: Do not record calls.
117 #billing: Mark the entry for billing
118 #documentation: Mark the entry for documentation.
120 =item accountcode - CDR account number to use: account
122 =item uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID)
124 =item userfield - CDR user-defined field
126 =item cdr_type - CDR type - see L<FS::cdr_type> (Usage = 1, S&E = 7, OC&C = 8)
128 =item charged_party - Service number to be billed
130 =item upstream_currency - Wholesale currency from upstream
132 =item upstream_price - Wholesale price from upstream
134 =item upstream_rateplanid - Upstream rate plan ID
136 =item rated_price - Rated (or re-rated) price
138 =item distance - km (need units field?)
140 =item islocal - Local - 1, Non Local = 0
142 =item calltypenum - Type of call - see L<FS::cdr_calltype>
144 =item description - Description (cdr_type 7&8 only) (used for cust_bill_pkg.itemdesc)
146 =item quantity - Number of items (cdr_type 7&8 only)
148 =item carrierid - Upstream Carrier ID (see L<FS::cdr_carrier>)
152 #Telstra =1, Optus = 2, RSL COM = 3
154 =item upstream_rateid - Upstream Rate ID
156 =item svcnum - Link to customer service (see L<FS::cust_svc>)
158 =item freesidestatus - NULL, processing-tiered, rated, done, skipped, no-charge, failed
160 =item freesiderewritestatus - NULL, done, skipped
164 =item detailnum - Link to invoice detail (L<FS::cust_bill_pkg_detail>)
174 Creates a new CDR. To add the CDR to the database, see L<"insert">.
176 Note that this stores the hash reference, not a distinct copy of the hash it
177 points to. You can ask the object for a copy with the I<hash> method.
181 # the new method can be inherited from FS::Record, if a table method is defined
188 #XXX fill in some (more) nice names
190 'calldate' => 'Call date',
191 'clid' => 'Caller ID',
193 'dst' => 'Destination',
194 'dcontext' => 'Dest. context',
195 'channel' => 'Channel',
196 'dstchannel' => 'Destination channel',
199 'src_ip_addr' => 'Source IP',
200 'dst_ip_addr' => 'Dest. IP',
201 'dst_term' => 'Termination dest.',
202 'startdate' => 'Start date',
203 'answerdate' => 'Answer date',
204 'enddate' => 'End date',
205 'duration' => 'Duration',
206 'billsec' => 'Billable seconds',
207 'disposition' => 'Disposition',
208 'amaflags' => 'AMA flags',
209 'accountcode' => 'Account code',
211 'userfield' => 'User field',
213 'charged_party' => 'Charged party',
214 #'upstream_currency' => '',
215 'upstream_price' => 'Upstream price',
216 #'upstream_rateplanid' => '',
217 #'ratedetailnum' => '',
218 'rated_price' => 'Rated price',
219 'rated_cost' => 'Rated cost',
222 #'calltypenum' => '',
223 #'description' => '',
225 'carrierid' => 'Carrier ID',
226 #'upstream_rateid' => '',
227 'svcnum' => 'Freeside service',
228 'freesidestatus' => 'Freeside status',
229 'freesiderewritestatus' => 'Freeside rewrite status',
230 'cdrbatch' => 'Legacy batch',
231 'cdrbatchnum' => 'Batch',
232 'detailnum' => 'Freeside invoice detail line',
241 Adds this record to the database. If there is an error, returns the error,
242 otherwise returns false.
246 # the insert method can be inherited from FS::Record
250 Delete this record from the database.
254 # the delete method can be inherited from FS::Record
256 =item replace OLD_RECORD
258 Replaces the OLD_RECORD with this one in the database. If there is an error,
259 returns the error, otherwise returns false.
263 # the replace method can be inherited from FS::Record
267 Checks all fields to make sure this is a valid CDR. If there is
268 an error, returns the error, otherwise returns false. Called by the insert
271 Note: Unlike most types of records, we don't want to "reject" a CDR and we want
272 to process them as quickly as possible, so we allow the database to check most
280 # we don't want to "reject" a CDR like other sorts of input...
282 # $self->ut_numbern('acctid')
283 ## || $self->ut_('calldate')
284 # || $self->ut_text('clid')
285 # || $self->ut_text('src')
286 # || $self->ut_text('dst')
287 # || $self->ut_text('dcontext')
288 # || $self->ut_text('channel')
289 # || $self->ut_text('dstchannel')
290 # || $self->ut_text('lastapp')
291 # || $self->ut_text('lastdata')
292 # || $self->ut_numbern('startdate')
293 # || $self->ut_numbern('answerdate')
294 # || $self->ut_numbern('enddate')
295 # || $self->ut_number('duration')
296 # || $self->ut_number('billsec')
297 # || $self->ut_text('disposition')
298 # || $self->ut_number('amaflags')
299 # || $self->ut_text('accountcode')
300 # || $self->ut_text('uniqueid')
301 # || $self->ut_text('userfield')
302 # || $self->ut_numbern('cdrtypenum')
303 # || $self->ut_textn('charged_party')
304 ## || $self->ut_n('upstream_currency')
305 ## || $self->ut_n('upstream_price')
306 # || $self->ut_numbern('upstream_rateplanid')
307 ## || $self->ut_n('distance')
308 # || $self->ut_numbern('islocal')
309 # || $self->ut_numbern('calltypenum')
310 # || $self->ut_textn('description')
311 # || $self->ut_numbern('quantity')
312 # || $self->ut_numbern('carrierid')
313 # || $self->ut_numbern('upstream_rateid')
314 # || $self->ut_numbern('svcnum')
315 # || $self->ut_textn('freesidestatus')
316 # || $self->ut_textn('freesiderewritestatus')
318 # return $error if $error;
320 for my $f ( grep { $self->$_ =~ /\D/ } qw(startdate answerdate enddate)){
321 $self->$f( str2time($self->$f) );
324 $self->calldate( $self->startdate_sql )
325 if !$self->calldate && $self->startdate;
327 #was just for $format eq 'taqua' but can't see the harm... add something to
328 #disable if it becomes a problem
329 if ( $self->duration eq '' && $self->enddate && $self->startdate ) {
330 $self->duration( $self->enddate - $self->startdate );
332 if ( $self->billsec eq '' && $self->enddate && $self->answerdate ) {
333 $self->billsec( $self->enddate - $self->answerdate );
336 if ( ! $self->enddate && $self->startdate && $self->duration ) {
337 $self->enddate( $self->startdate + $self->duration );
340 $self->set_charged_party;
342 #check the foreign keys even?
343 #do we want to outright *reject* the CDR?
344 my $error = $self->ut_numbern('acctid');
345 return $error if $error;
347 if ( $self->freesidestatus ne 'done' ) {
348 $self->set('detailnum', ''); # can't have this on an unbilled call
351 #add a config option to turn these back on if someone needs 'em
353 # #Usage = 1, S&E = 7, OC&C = 8
354 # || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
356 # #the big list in appendix 2
357 # || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' )
359 # # Telstra =1, Optus = 2, RSL COM = 3
360 # || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
365 =item is_tollfree [ COLUMN ]
367 Returns true when the cdr represents a toll free number and false otherwise.
369 By default, inspects the dst field, but an optional column name can be passed
370 to inspect other field.
376 my $field = scalar(@_) ? shift : 'dst';
377 my $country = $conf->config('tollfree-country') || '';
378 if ( $country eq 'AU' ) {
379 ( $self->$field() =~ /^(\+?61)?(1800|1300)/ ) ? 1 : 0;
380 } elsif ( $country eq 'NZ' ) {
381 ( $self->$field() =~ /^(\+?64)?(800|508)/ ) ? 1 : 0;
382 } else { #NANPA (US/Canaada)
383 ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0;
387 =item set_charged_party
389 If the charged_party field is already set, does nothing. Otherwise:
391 If the cdr-charged_party-accountcode config option is enabled, sets the
392 charged_party to the accountcode.
394 Otherwise sets the charged_party normally: to the src field in most cases,
395 or to the dst field if it is a toll free number.
399 sub set_charged_party {
402 my $conf = new FS::Conf;
404 unless ( $self->charged_party ) {
406 if ( $conf->exists('cdr-charged_party-accountcode') && $self->accountcode ){
408 my $charged_party = $self->accountcode;
409 $charged_party =~ s/^0+//
410 if $conf->exists('cdr-charged_party-accountcode-trim_leading_0s');
411 $self->charged_party( $charged_party );
413 } elsif ( $conf->exists('cdr-charged_party-field') ) {
415 my $field = $conf->config('cdr-charged_party-field');
416 $self->charged_party( $self->$field() );
420 if ( $self->is_tollfree ) {
421 $self->charged_party($self->dst);
423 $self->charged_party($self->src);
430 # my $prefix = $conf->config('cdr-charged_party-truncate_prefix');
431 # my $prefix_len = length($prefix);
432 # my $trunc_len = $conf->config('cdr-charged_party-truncate_length');
434 # $self->charged_party( substr($self->charged_party, 0, $trunc_len) )
435 # if $prefix_len && $trunc_len
436 # && substr($self->charged_party, 0, $prefix_len) eq $prefix;
440 =item set_status STATUS
442 Sets the status to the provided string. If there is an error, returns the
443 error, otherwise returns false.
445 If status is being changed from 'rated' to some other status, also removes
446 any usage allocations to this CDR.
451 my($self, $status) = @_;
452 my $old_status = $self->freesidestatus;
453 $self->freesidestatus($status);
454 my $error = $self->replace;
455 if ( $old_status eq 'rated' and $status ne 'done' ) {
456 # deallocate any usage
457 foreach (qsearch('cdr_cust_pkg_usage', {acctid => $self->acctid})) {
458 my $cust_pkg_usage = $_->cust_pkg_usage;
459 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $_->minutes);
460 $error ||= $cust_pkg_usage->replace || $_->delete;
466 =item set_status_and_rated_price STATUS RATED_PRICE [ SVCNUM [ OPTION => VALUE ... ] ]
468 Sets the status and rated price.
470 Available options are: inbound, rated_pretty_dst, rated_regionname,
471 rated_seconds, rated_minutes, rated_granularity, rated_ratedetailnum,
472 rated_classnum, rated_ratename. If rated_ratedetailnum is provided,
473 will also set a recalculated L</rate_cost> in the rated_cost field
474 after the other fields are set (does not work with inbound.)
476 If there is an error, returns the error, otherwise returns false.
480 sub set_status_and_rated_price {
481 my($self, $status, $rated_price, $svcnum, %opt) = @_;
483 if ($opt{'inbound'}) {
485 my $term = $self->cdr_termination( 1 ); #1: inbound
488 warn "replacing existing cdr status (".$self->acctid.")\n" if $term;
489 $error = $term->delete;
490 return $error if $error;
492 $term = FS::cdr_termination->new({
493 acctid => $self->acctid,
495 rated_price => $rated_price,
498 foreach (qw(rated_seconds rated_minutes rated_granularity)) {
499 $term->set($_, $opt{$_}) if exists($opt{$_});
501 $term->svcnum($svcnum) if $svcnum;
502 return $term->insert;
506 $self->freesidestatus($status);
507 $self->rated_price($rated_price);
509 foreach grep exists($opt{$_}), map "rated_$_",
510 qw( pretty_dst regionname seconds minutes granularity
511 ratedetailnum classnum ratename );
512 $self->svcnum($svcnum) if $svcnum;
513 $self->rated_cost($self->rate_cost) if $opt{'rated_ratedetailnum'};
515 return $self->replace();
520 =item parse_number [ OPTION => VALUE ... ]
522 Returns two scalars, the countrycode and the rest of the number.
524 Options are passed as name-value pairs. Currently available options are:
530 The column containing the number to be parsed. Defaults to dst.
532 =item international_prefix
534 The digits for international dialing. Defaults to '011' The value '+' is
537 =item domestic_prefix
539 The digits for domestic long distance dialing. Defaults to '1'
546 my ($self, %options) = @_;
548 my $field = $options{column} || 'dst';
549 my $intl = $options{international_prefix} || '011';
550 # Still, don't break anyone's CDR rating if they have an empty string in
551 # there. Require an explicit statement that there's no prefix.
552 $intl = '' if lc($intl) eq 'none';
553 my $countrycode = '';
554 my $number = $self->$field();
556 my $to_or_from = 'concerning';
557 $to_or_from = 'from' if $field eq 'src';
558 $to_or_from = 'to' if $field eq 'dst';
559 warn "parsing call $to_or_from $number\n" if $DEBUG;
561 #remove non-phone# stuff and whitespace
564 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
566 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
568 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
569 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
573 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
574 #first look for 1 digit country code
575 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
577 $number = $u1.$u2.$rest;
578 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
581 } else { #3 digit country code
582 $countrycode = $three;
587 my $domestic_prefix =
588 exists($options{domestic_prefix}) ? $options{domestic_prefix} : '';
589 $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
590 $number =~ s/^$countrycode//;# if length($number) > 10;
593 return($countrycode, $number);
597 =item rate [ OPTION => VALUE ... ]
599 Rates this CDR according and sets the status to 'rated'.
601 Available options are: part_pkg, svcnum, plan_included_min,
602 detail_included_min_hashref.
604 part_pkg is required.
606 If svcnum is specified, will also associate this CDR with the specified svcnum.
608 plan_included_min should be set to a scalar reference of the number of
609 included minutes and will be decremented by the rated minutes of this
612 detail_included_min_hashref should be set to an empty hashref at the
613 start of a month's rating and then preserved across CDRs.
618 my( $self, %opt ) = @_;
619 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
622 warn "rating CDR $self\n".
623 join('', map { " $_ => ". $self->{$_}. "\n" } keys %$self );
626 my $rating_method = $part_pkg->option_cacheable('rating_method') || 'prefix';
627 my $method = "rate_$rating_method";
628 $self->$method(%opt);
632 our %interval_cache = (); # for timed rates
635 my( $self, %opt ) = @_;
636 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
637 my $cust_pkg = $opt{'cust_pkg'};
640 # this will result in those CDRs being marked as done... is that
643 if ( $part_pkg->option_cacheable('411_rewrite') ) {
644 my $dirass = $part_pkg->option_cacheable('411_rewrite');
646 @dirass = split(',', $dirass);
649 if ( length($self->dst) && grep { $self->dst eq $_ } @dirass ) {
654 my $reason = $part_pkg->check_chargable( $self,
655 'da_rewrote' => $da_rewrote,
658 warn "not charging for CDR ($reason)\n" if $DEBUG;
659 return $self->set_status_and_rated_price( 'skipped',
665 if ( $part_pkg->option_cacheable('skip_same_customer')
666 and ! $self->is_tollfree ) {
667 my ($dst_countrycode, $dst_number) = $self->parse_number(
669 international_prefix => $part_pkg->option_cacheable('international_prefix'),
670 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
672 my $dst_same_cust = FS::Record->scalar_sql(
673 'SELECT COUNT(svc_phone.svcnum) AS count '.
675 'JOIN cust_svc USING (pkgnum) ' .
676 'JOIN svc_phone USING (svcnum) ' .
677 'WHERE svc_phone.countrycode = ' . dbh->quote($dst_countrycode) .
678 ' AND svc_phone.phonenum = ' . dbh->quote($dst_number) .
679 ' AND cust_pkg.custnum = ' . $cust_pkg->custnum,
681 if ( $dst_same_cust > 0 ) {
682 warn "not charging for CDR (same source and destination customer)\n" if $DEBUG;
683 return $self->set_status_and_rated_price( 'skipped',
694 # look up rate details based on called station id
695 # (or calling station id for toll free calls)
698 my $eff_ratenum = $self->is_tollfree('accountcode')
699 ? $part_pkg->option_cacheable('accountcode_tollfree_ratenum')
702 my( $to_or_from, $column );
705 && ! $part_pkg->option_cacheable('disable_tollfree')
708 && $part_pkg->option_cacheable('accountcode_tollfree_field') eq 'src'
712 $to_or_from = 'from';
714 } else { #regular call
719 #determine the country code
720 my ($countrycode, $number) = $self->parse_number(
722 international_prefix => $part_pkg->option_cacheable('international_prefix'),
723 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
726 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
727 my $pretty_dst = "+$countrycode $number";
728 #asterisks here causes inserting the detail to barf, so:
729 $pretty_dst =~ s/\*//g;
732 my $intrastate_ratenum = $part_pkg->option_cacheable('intrastate_ratenum');
733 if ( $intrastate_ratenum && !$self->is_tollfree ) {
734 $ratename = 'Interstate'; #until proven otherwise
735 # this is relatively easy only because:
736 # -assume all numbers are valid NANP numbers NOT in a fully-qualified format
737 # -disregard toll-free
738 # -disregard private or unknown numbers
739 # -there is exactly one record in rate_prefix for a given NPANXX
740 # -default to interstate if we can't find one or both of the prefixes
741 my (undef, $dstprefix) = $self->parse_number(
743 international_prefix => $part_pkg->option_cacheable('international_prefix'),
744 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
746 $dstprefix =~ /^(\d{6})/;
747 $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
750 my (undef, $srcprefix) = $self->parse_number(
752 international_prefix => $part_pkg->option_cacheable('international_prefix'),
753 domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
755 $srcprefix =~ /^(\d{6})/;
756 $srcprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
759 if ($srcprefix && $dstprefix
760 && $srcprefix->state && $dstprefix->state
761 && $srcprefix->state eq $dstprefix->state) {
762 $eff_ratenum = $intrastate_ratenum;
763 $ratename = 'Intrastate'; # XXX possibly just use the ratename?
767 $eff_ratenum ||= $part_pkg->option_cacheable('ratenum');
768 my $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
769 or die "ratenum $eff_ratenum not found!";
771 my @ltime = localtime($self->startdate);
772 my $weektime = $ltime[0] +
773 $ltime[1]*60 + #minutes
774 $ltime[2]*3600 + #hours
775 $ltime[6]*86400; #days since sunday
776 # if there's no timed rate_detail for this time/region combination,
777 # dest_detail returns the default. There may still be a timed rate
778 # that applies after the starttime of the call, so be careful...
779 my $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
780 'phonenum' => $number,
781 'weektime' => $weektime,
782 'cdrtypenum' => $self->cdrtypenum,
785 unless ( $rate_detail ) {
787 if ( $part_pkg->option_cacheable('ignore_unrateable') ) {
789 if ( $part_pkg->option_cacheable('ignore_unrateable') == 2 ) {
790 # mark the CDR as unrateable
791 return $self->set_status_and_rated_price(
796 } elsif ( $part_pkg->option_cacheable('ignore_unrateable') == 1 ) {
798 warn "no rate_detail found for CDR.acctid: ". $self->acctid.
803 die "unknown ignore_unrateable, pkgpart ". $part_pkg->pkgpart;
808 die "FATAL: no rate_detail found in ".
809 $rate->ratenum. ":". $rate->ratename. " rate plan ".
810 "for +$countrycode $number (CDR acctid ". $self->acctid. "); ".
811 "add a rate or set ignore_unrateable flag on the package def\n";
816 my $regionnum = $rate_detail->dest_regionnum;
817 my $rate_region = $rate_detail->dest_region;
818 warn " found rate for regionnum $regionnum ".
819 "and rate detail $rate_detail\n"
822 if ( !exists($interval_cache{$regionnum}) ) {
824 sort { $a->stime <=> $b->stime }
825 map { $_->rate_time->intervals }
826 qsearch({ 'table' => 'rate_detail',
827 'hashref' => { 'ratenum' => $rate->ratenum },
828 'extra_sql' => 'AND ratetimenum IS NOT NULL',
831 $interval_cache{$regionnum} = \@intervals;
832 warn " cached ".scalar(@intervals)." interval(s)\n"
837 # find the price and add detail to the invoice
840 # About this section:
841 # We don't round _anything_ (except granularizing)
842 # until the final $charge = sprintf("%.2f"...).
844 my $rated_seconds = $part_pkg->option_cacheable('use_duration')
847 my $seconds_left = $rated_seconds;
849 #no, do this later so it respects (group) included minutes
850 # # charge for the first (conn_sec) seconds
851 # my $seconds = min($seconds_left, $rate_detail->conn_sec);
852 # $seconds_left -= $seconds;
853 # $weektime += $seconds;
854 # my $charge = $rate_detail->conn_charge;
857 my $connection_charged = 0;
859 # before doing anything else, if there's an upstream multiplier and
860 # an upstream price, add that to the charge. (usually the rate detail
861 # will then have a minute charge of zero, but not necessarily.)
862 $charge += ($self->upstream_price || 0) * $rate_detail->upstream_mult_charge;
865 while($seconds_left) {
866 my $ratetimenum = $rate_detail->ratetimenum; # may be empty
868 # find the end of the current rate interval
869 if(@{ $interval_cache{$regionnum} } == 0) {
870 # There are no timed rates in this group, so just stay
871 # in the default rate_detail for the entire duration.
872 # Set an "end" of 1 past the end of the current call.
873 $etime = $weektime + $seconds_left + 1;
875 elsif($ratetimenum) {
876 # This is a timed rate, so go to the etime of this interval.
877 # If it's followed by another timed rate, the stime of that
878 # interval should match the etime of this one.
879 my $interval = $rate_detail->rate_time->contains($weektime);
880 $etime = $interval->etime;
883 # This is a default rate, so use the stime of the next
884 # interval in the sequence.
885 my $next_int = first { $_->stime > $weektime }
886 @{ $interval_cache{$regionnum} };
888 $etime = $next_int->stime;
891 # weektime is near the end of the week, so decrement
892 # it by a full week and use the stime of the first
894 $weektime -= (3600*24*7);
895 $etime = $interval_cache{$regionnum}->[0]->stime;
899 my $charge_sec = min($seconds_left, $etime - $weektime);
901 $seconds_left -= $charge_sec;
903 my $granularity = $rate_detail->sec_granularity;
906 if ( $granularity ) { # charge per minute
907 # Round up to the nearest $granularity
908 if ( $charge_sec and $charge_sec % $granularity ) {
909 $charge_sec += $granularity - ($charge_sec % $granularity);
911 $minutes = $charge_sec / 60; #don't round this
918 #$seconds += $charge_sec;
920 if ( $rate_detail->min_included ) {
921 # the old, kind of deprecated way to do this:
923 # The rate detail itself has included minutes. We MUST have a place
925 my $included_min = $opt{'detail_included_min_hashref'}
926 or return "unable to rate CDR: rate detail has included minutes, but ".
927 "no detail_included_min_hashref provided.\n";
929 # by default, set the included minutes for this region/time to
930 # what's in the rate_detail
931 if (!exists( $included_min->{$regionnum}{$ratetimenum} )) {
932 $included_min->{$regionnum}{$ratetimenum} =
933 ($rate_detail->min_included * $cust_pkg->quantity || 1);
936 if ( $included_min->{$regionnum}{$ratetimenum} >= $minutes ) {
938 $included_min->{$regionnum}{$ratetimenum} -= $minutes;
940 $charge_sec -= ($included_min->{$regionnum}{$ratetimenum} * 60);
941 $included_min->{$regionnum}{$ratetimenum} = 0;
943 } elsif ( $opt{plan_included_min} && ${ $opt{plan_included_min} } > 0 ) {
944 # The package definition has included minutes, but only for in-group
945 # rate details. Decrement them if this is an in-group call.
946 if ( $rate_detail->region_group ) {
947 if ( ${ $opt{'plan_included_min'} } >= $minutes ) {
949 ${ $opt{'plan_included_min'} } -= $minutes;
951 $charge_sec -= (${ $opt{'plan_included_min'} } * 60);
952 ${ $opt{'plan_included_min'} } = 0;
957 my $applied_min = $cust_pkg->apply_usage(
959 'rate_detail' => $rate_detail,
960 'minutes' => $minutes
962 # for now, usage pools deal only in whole minutes
963 $charge_sec -= $applied_min * 60;
966 if ( $charge_sec > 0 ) {
968 #NOW do connection charges here... right?
969 #my $conn_seconds = min($seconds_left, $rate_detail->conn_sec);
970 my $conn_seconds = 0;
971 unless ( $connection_charged++ ) { #only one connection charge
972 $conn_seconds = min($charge_sec, $rate_detail->conn_sec);
973 $seconds_left -= $conn_seconds;
974 $weektime += $conn_seconds;
975 $charge += $rate_detail->conn_charge;
978 #should preserve (display?) this
979 if ( $granularity == 0 ) { # per call rate
980 $charge += $rate_detail->min_charge;
982 my $charge_min = ( $charge_sec - $conn_seconds ) / 60;
983 $charge += ($rate_detail->min_charge * $charge_min) if $charge_min > 0; #still not rounded
988 # choose next rate_detail
989 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
990 'phonenum' => $number,
991 'weektime' => $etime,
992 'cdrtypenum' => $self->cdrtypenum })
994 # we have now moved forward to $etime
997 } #while $seconds_left
999 # this is why we need regionnum/rate_region....
1000 warn " (rate region $rate_region)\n" if $DEBUG;
1003 my $rounding = $part_pkg->option_cacheable('rounding') || 2;
1004 my $sprintformat = '%.'. $rounding. 'f';
1005 my $roundup = 10**(-3-$rounding);
1006 my $price = sprintf($sprintformat, $charge + $roundup);
1008 $self->set_status_and_rated_price(
1012 'rated_pretty_dst' => $pretty_dst,
1013 'rated_regionname' => ($rate_region ? $rate_region->regionname : ''),
1014 'rated_seconds' => $rated_seconds, #$seconds,
1015 'rated_granularity' => $rate_detail->sec_granularity, #$granularity
1016 'rated_ratedetailnum' => $rate_detail->ratedetailnum,
1017 'rated_classnum' => $rate_detail->classnum, #rated_ratedetailnum?
1018 'rated_ratename' => $ratename, #not rate_detail - Intrastate/Interstate
1023 sub rate_upstream_simple {
1024 my( $self, %opt ) = @_;
1026 $self->set_status_and_rated_price(
1028 sprintf('%.3f', $self->upstream_price),
1030 'rated_classnum' => $self->calltypenum,
1031 'rated_seconds' => $self->billsec,
1032 # others? upstream_*_regionname => rated_regionname is possible
1036 sub rate_single_price {
1037 my( $self, %opt ) = @_;
1038 my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified";
1040 # a little false laziness w/abov
1041 # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
1043 my $granularity = length($part_pkg->option_cacheable('sec_granularity'))
1044 ? $part_pkg->option_cacheable('sec_granularity')
1047 my $seconds = $part_pkg->option_cacheable('use_duration')
1051 $seconds += $granularity - ( $seconds % $granularity )
1052 if $seconds # don't granular-ize 0 billsec calls (bills them)
1053 && $granularity # 0 is per call
1054 && $seconds % $granularity;
1055 my $minutes = $granularity ? ($seconds / 60) : 1;
1057 my $charge_min = $minutes;
1059 ${$opt{plan_included_min}} -= $minutes;
1060 if ( ${$opt{plan_included_min}} > 0 ) {
1063 $charge_min = 0 - ${$opt{plan_included_min}};
1064 ${$opt{plan_included_min}} = 0;
1068 sprintf('%.4f', ( $part_pkg->option_cacheable('min_charge') * $charge_min )
1069 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
1071 $self->set_status_and_rated_price(
1075 'rated_granularity' => $granularity,
1076 'rated_seconds' => $seconds,
1083 Rates an already-rated CDR according to the cost fields from the rate plan.
1092 return 0 unless $self->rated_ratedetailnum;
1095 qsearchs('rate_detail', { 'ratedetailnum' => $self->rated_ratedetailnum } );
1098 $charge += ($self->upstream_price || 0) * ($rate_detail->upstream_mult_cost);
1100 if ( $self->rated_granularity == 0 ) {
1101 $charge += $rate_detail->min_cost;
1103 my $minutes = $self->rated_seconds / 60;
1104 $charge += $rate_detail->conn_cost + $minutes * $rate_detail->min_cost;
1107 sprintf('%.2f', $charge + .00001 );
1111 =item cdr_termination [ TERMPART ]
1115 sub cdr_termination {
1118 if ( scalar(@_) && $_[0] ) {
1119 my $termpart = shift;
1121 qsearchs('cdr_termination', { acctid => $self->acctid,
1122 termpart => $termpart,
1128 qsearch('cdr_termination', { acctid => $self->acctid, } );
1136 Parses the calldate in SQL string format and returns a UNIX timestamp.
1141 str2time(shift->calldate);
1146 Parses the startdate in UNIX timestamp format and returns a string in SQL
1152 my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate);
1155 "$year-$mon-$mday $hour:$min:$sec";
1160 Returns the FS::cdr_carrier object associated with this CDR, or false if no
1161 carrierid is defined.
1165 my %carrier_cache = ();
1169 return '' unless $self->carrierid;
1170 $carrier_cache{$self->carrierid} ||=
1171 qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } );
1176 Returns the carrier name (see L<FS::cdr_carrier>), or the empty string if
1177 no FS::cdr_carrier object is assocated with this CDR.
1183 my $cdr_carrier = $self->cdr_carrier;
1184 $cdr_carrier ? $cdr_carrier->carriername : '';
1189 Returns the FS::cdr_calltype object associated with this CDR, or false if no
1190 calltypenum is defined.
1194 my %calltype_cache = ();
1198 return '' unless $self->calltypenum;
1199 $calltype_cache{$self->calltypenum} ||=
1200 qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } );
1205 Returns the call type name (see L<FS::cdr_calltype>), or the empty string if
1206 no FS::cdr_calltype object is assocated with this CDR.
1212 my $cdr_calltype = $self->cdr_calltype;
1213 $cdr_calltype ? $cdr_calltype->calltypename : '';
1216 =item downstream_csv [ OPTION => VALUE, ... ]
1220 # in the future, load this dynamically from detail_format classes
1222 my %export_names = (
1225 'invoice_header' => "Date,Time,Name,Destination,Duration,Price",
1228 'name' => 'Simple with source',
1229 'invoice_header' => "Date,Time,Called From,Destination,Duration,Price",
1230 #"Date,Time,Name,Called From,Destination,Duration,Price",
1232 'accountcode_simple' => {
1233 'name' => 'Simple with accountcode',
1234 'invoice_header' => "Date,Time,Called From,Account,Duration,Price",
1238 'invoice_header' => "Date/Time,Called Number,Min/Sec,Price",
1240 'basic_upstream_dst_regionname' => {
1241 'name' => 'Basic with upstream destination name',
1242 'invoice_header' => "Date/Time,Called Number,Destination,Min/Sec,Price",
1245 'name' => 'Default',
1246 'invoice_header' => 'Date,Time,Number,Destination,Duration,Price',
1248 'source_default' => {
1249 'name' => 'Default with source',
1250 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1252 'accountcode_default' => {
1253 'name' => 'Default plus accountcode',
1254 'invoice_header' => 'Date,Time,Account,Number,Destination,Duration,Price',
1256 'description_default' => {
1257 'name' => 'Default with description field as destination',
1258 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
1261 'name' => 'Summary, one line per service',
1262 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1265 'name' => 'Number of calls, one line per service',
1266 'invoice_header' => 'Caller,Rate,Messages,Price',
1269 'name' => 'Summary, one line per service',
1270 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1272 'sum_duration_prefix' => {
1273 'name' => 'Summary, one line per destination prefix',
1274 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1276 'sum_count_class' => {
1277 'name' => 'Summary, one line per usage class',
1278 'invoice_header' => 'Caller,Class,Calls,Price',
1280 'sum_duration_accountcode' => {
1281 'name' => 'Summary, one line per accountcode',
1282 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
1286 my %export_formats = ();
1287 sub export_formats {
1290 return %export_formats if keys %export_formats;
1292 my $conf = new FS::Conf;
1293 my $date_format = $conf->config('date_format') || '%m/%d/%Y';
1295 # call duration in the largest units that accurately reflect the granularity
1296 my $duration_sub = sub {
1297 my($cdr, %opt) = @_;
1298 my $sec = $opt{seconds} || $cdr->billsec;
1299 if ( defined $opt{granularity} &&
1300 $opt{granularity} == 0 ) { #per call
1303 elsif ( defined $opt{granularity} && $opt{granularity} == 60 ) {#full minutes
1304 my $min = int($sec/60);
1308 else { #anything else
1309 return sprintf("%dm %ds", $sec/60, $sec%60);
1313 my $price_sub = sub {
1314 my ($cdr, %opt) = @_;
1316 if ( defined($opt{charge}) ) {
1317 $price = $opt{charge};
1319 elsif ( $opt{inbound} ) {
1320 my $term = $cdr->cdr_termination(1); # 1 = inbound
1321 $price = $term->rated_price if defined $term;
1324 $price = $cdr->rated_price;
1326 length($price) ? ($opt{money_char} . $price) : '';
1329 my $src_sub = sub { $_[0]->clid || $_[0]->src };
1333 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1334 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1336 'dst', #NUMBER_DIALED
1337 $duration_sub, #DURATION
1338 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1342 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1343 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1345 $src_sub, #called from
1346 'dst', #NUMBER_DIALED
1347 $duration_sub, #DURATION
1348 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
1351 'accountcode_simple' => [
1352 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
1353 sub { time2str('%r', shift->calldate_unix ) }, #TIME
1354 $src_sub, #called from
1355 'accountcode', #NUMBER_DIALED
1356 $duration_sub, #DURATION
1360 # for summary formats, the CDR is a fictitious object containing the
1361 # total billsec and the phone number of the service
1363 sub { my($cdr, %opt) = @_; $opt{ratename} },
1364 sub { my($cdr, %opt) = @_; $opt{count} },
1365 sub { my($cdr, %opt) = @_; int($opt{seconds}/60).'m' },
1370 sub { my($cdr, %opt) = @_; $opt{ratename} },
1371 sub { my($cdr, %opt) = @_; $opt{count} },
1375 sub { time2str('%d %b - %I:%M %p', shift->calldate_unix) },
1383 sub { time2str($date_format, shift->calldate_unix ) },
1384 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
1387 sub { time2str('%r', shift->calldate_unix ) },
1388 # 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
1391 sub { my($cdr, %opt) = @_; $opt{pretty_dst} || $cdr->dst; },
1393 #REGIONNAME ("Destination")
1394 sub { my($cdr, %opt) = @_; $opt{dst_regionname}; },
1403 $export_formats{'source_default'} = [ $src_sub, @{ $export_formats{'default'} }, ];
1404 $export_formats{'accountcode_default'} =
1405 [ @{ $export_formats{'default'} }[0,1],
1407 @{ $export_formats{'default'} }[2..5],
1409 my @default = @{ $export_formats{'default'} };
1410 $export_formats{'description_default'} =
1411 [ $src_sub, @default[0..2],
1412 sub { my($cdr, %opt) = @_; $cdr->description },
1415 return %export_formats;
1418 =item downstream_csv OPTION => VALUE ...
1420 Returns a string of formatted call details for display on an invoice.
1426 charge - override the 'rated_price' field of the CDR
1428 seconds - override the 'billsec' field of the CDR
1430 count - number of usage events included in this record, for summary formats
1432 ratename - name of the rate table used to rate this call
1438 sub downstream_csv {
1439 my( $self, %opt ) = @_;
1441 my $format = $opt{'format'};
1442 my %formats = $self->export_formats;
1443 return "Unknown format $format" unless exists $formats{$format};
1445 #my $conf = new FS::Conf;
1446 #$opt{'money_char'} ||= $conf->config('money_char') || '$';
1447 $opt{'money_char'} ||= FS::Conf->new->config('money_char') || '$';
1449 my $csv = new Text::CSV_XS;
1453 ref($_) ? &{$_}($self, %opt) : $self->$_();
1455 @{ $formats{$format} };
1457 return @columns if defined $opt{'keeparray'};
1459 my $status = $csv->combine(@columns);
1460 die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV"
1469 =head1 CLASS METHODS
1473 =item invoice_formats
1475 Returns an ordered list of key value pairs containing invoice format names
1476 as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values.
1480 # in the future, load this dynamically from detail_format classes
1482 sub invoice_formats {
1483 map { ($_ => $export_names{$_}->{'name'}) }
1484 grep { $export_names{$_}->{'invoice_header'} }
1485 sort keys %export_names;
1488 =item invoice_header FORMAT
1490 Returns a scalar containing the CSV column header for invoice format FORMAT.
1494 sub invoice_header {
1496 $export_names{$format}->{'invoice_header'};
1501 Clears cdr and any associated cdr_termination statuses - used for
1510 local $SIG{HUP} = 'IGNORE';
1511 local $SIG{INT} = 'IGNORE';
1512 local $SIG{QUIT} = 'IGNORE';
1513 local $SIG{TERM} = 'IGNORE';
1514 local $SIG{TSTP} = 'IGNORE';
1515 local $SIG{PIPE} = 'IGNORE';
1517 my $oldAutoCommit = $FS::UID::AutoCommit;
1518 local $FS::UID::AutoCommit = 0;
1521 if ( $cdr_prerate && $cdr_prerate_cdrtypenums{$self->cdrtypenum}
1522 && $self->rated_ratedetailnum #avoid putting old CDRs back in "rated"
1523 && $self->freesidestatus eq 'done'
1527 $self->freesidestatus('rated');
1529 $self->freesidestatus('');
1532 my $error = $self->replace;
1534 $dbh->rollback if $oldAutoCommit;
1538 foreach my $cdr_termination ( $self->cdr_termination ) {
1539 #$cdr_termination->status('');
1540 #$error = $cdr_termination->replace;
1541 $error = $cdr_termination->delete;
1543 $dbh->rollback if $oldAutoCommit;
1548 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1553 =item import_formats
1555 Returns an ordered list of key value pairs containing import format names
1556 as keys (for use with batch_import) and "pretty" format names as values.
1560 #false laziness w/part_pkg & part_export
1563 foreach my $INC ( @INC ) {
1564 warn "globbing $INC/FS/cdr/[a-z]*.pm\n" if $DEBUG;
1565 foreach my $file ( glob("$INC/FS/cdr/[a-z]*.pm") ) {
1566 warn "attempting to load CDR format info from $file\n" if $DEBUG;
1567 $file =~ /\/(\w+)\.pm$/ or do {
1568 warn "unrecognized file in $INC/FS/cdr/: $file\n";
1572 my $info = eval "use FS::cdr::$mod; ".
1573 "\\%FS::cdr::$mod\::info;";
1575 die "error using FS::cdr::$mod (skipping): $@\n" if $@;
1578 unless ( keys %$info ) {
1579 warn "no %info hash found in FS::cdr::$mod, skipping\n";
1582 warn "got CDR format info from FS::cdr::$mod: $info\n" if $DEBUG;
1583 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1584 warn "skipping disabled CDR format FS::cdr::$mod" if $DEBUG;
1587 $cdr_info{$mod} = $info;
1591 tie my %import_formats, 'Tie::IxHash',
1592 map { $_ => $cdr_info{$_}->{'name'} }
1593 sort { $cdr_info{$a}->{'weight'} <=> $cdr_info{$b}->{'weight'} }
1594 grep { exists($cdr_info{$_}->{'import_fields'}) }
1597 sub import_formats {
1601 sub _cdr_min_parser_maker {
1603 my @fields = ref($field) ? @$field : ($field);
1604 @fields = qw( billsec duration ) unless scalar(@fields) && $fields[0];
1606 my( $cdr, $min ) = @_;
1607 my $sec = eval { _cdr_min_parse($min) };
1608 die "error parsing seconds for @fields from $min minutes: $@\n" if $@;
1609 $cdr->$_($sec) foreach @fields;
1613 sub _cdr_min_parse {
1615 sprintf('%.0f', $min * 60 );
1618 sub _cdr_date_parser_maker {
1621 my @fields = ref($field) ? @$field : ($field);
1623 my( $cdr, $datestring ) = @_;
1624 my $unixdate = eval { _cdr_date_parse($datestring, %options) };
1625 die "error parsing date for @fields from $datestring: $@\n" if $@;
1626 $cdr->$_($unixdate) foreach @fields;
1630 sub _cdr_date_parse {
1634 return '' unless length($date); #that's okay, it becomes NULL
1635 return '' if $date eq 'NA'; #sansay
1637 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 ) {
1638 my $time = str2time($date);
1639 return $time if $time > 100000; #just in case
1642 my($year, $mon, $day, $hour, $min, $sec);
1644 #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/
1645 #taqua #2007-10-31 08:57:24.113000000
1647 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|$)/ ) {
1648 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1649 } 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|$)/ ) {
1650 # 8/26/2010 12:20:01
1651 # optionally without seconds
1652 ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1653 $sec = 0 if !defined($sec);
1654 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\.\d+)$/ ) {
1655 # broadsoft: 20081223201938.314
1656 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1657 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\d+(\D|$)/ ) {
1658 # Taqua OM: 20050422203450943
1659 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1660 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/ ) {
1661 # WIP: 20100329121420
1662 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1663 } elsif ( $date =~ /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/) {
1664 # Telos 2014-10-10T05:30:33Z
1665 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
1668 die "unparsable date: $date"; #maybe we shouldn't die...
1671 return '' if ( $year == 1900 || $year == 1970 ) && $mon == 1 && $day == 1
1672 && $hour == 0 && $min == 0 && $sec == 0;
1674 if ($options{gmt}) {
1675 timegm($sec, $min, $hour, $day, $mon-1, $year);
1677 timelocal($sec, $min, $hour, $day, $mon-1, $year);
1681 =item batch_import HASHREF
1683 Imports CDR records. Available options are:
1695 Hash reference of preset fields, typically cdrbatch
1699 Set true to prevent throwing an error on empty imports
1705 my %import_options = (
1708 'batch_keycol' => 'cdrbatchnum',
1709 'batch_table' => 'cdr_batch',
1710 'batch_namecol' => 'cdrbatch',
1712 'formats' => { map { $_ => $cdr_info{$_}->{'import_fields'}; }
1716 #drop the || 'csv' to allow auto xls for csv types?
1717 'format_types' => { map { $_ => lc($cdr_info{$_}->{'type'} || 'csv'); }
1721 'format_headers' => { map { $_ => ( $cdr_info{$_}->{'header'} || 0 ); }
1725 'format_sep_chars' => { map { $_ => $cdr_info{$_}->{'sep_char'}; }
1729 'format_fixedlength_formats' =>
1730 { map { $_ => $cdr_info{$_}->{'fixedlength_format'}; }
1734 'format_xml_formats' =>
1735 { map { $_ => $cdr_info{$_}->{'xml_format'}; }
1739 'format_asn_formats' =>
1740 { map { $_ => $cdr_info{$_}->{'asn_format'}; }
1744 'format_row_callbacks' =>
1745 { map { $_ => $cdr_info{$_}->{'row_callback'}; }
1749 'format_parser_opts' =>
1750 { map { $_ => $cdr_info{$_}->{'parser_opt'}; }
1755 sub _import_options {
1762 my $iopt = _import_options;
1763 $opt->{$_} = $iopt->{$_} foreach keys %$iopt;
1765 if ( defined $opt->{'cdrtypenum'} ) {
1766 $opt->{'preinsert_callback'} = sub {
1767 my($record,$param) = (shift,shift);
1768 $record->cdrtypenum($opt->{'cdrtypenum'});
1773 FS::Record::batch_import( $opt );
1777 =item process_batch_import
1781 sub process_batch_import {
1784 my $opt = _import_options;
1785 # $opt->{'params'} = [ 'format', 'cdrbatch' ];
1787 FS::Record::process_batch_import( $job, $opt, @_ );
1790 # if ( $format eq 'simple' ) { #should be a callback or opt in FS::cdr::simple
1791 # @columns = map { s/^ +//; $_; } @columns;
1796 # Used by FS::Upgrade to migrate to a new database.
1799 my ($class, %opts) = @_;
1801 warn "$me upgrading $class\n" if $DEBUG;
1803 my $sth = dbh->prepare(
1804 'SELECT DISTINCT(cdrbatch) FROM cdr WHERE cdrbatch IS NOT NULL'
1805 ) or die dbh->errstr;
1807 $sth->execute or die $sth->errstr;
1809 my %cdrbatchnum = ();
1810 while (my $row = $sth->fetchrow_arrayref) {
1812 my $cdr_batch = qsearchs( 'cdr_batch', { 'cdrbatch' => $row->[0] } );
1813 unless ( $cdr_batch ) {
1814 $cdr_batch = new FS::cdr_batch { 'cdrbatch' => $row->[0] };
1815 my $error = $cdr_batch->insert;
1816 die $error if $error;
1819 $cdrbatchnum{$row->[0]} = $cdr_batch->cdrbatchnum;
1822 $sth = dbh->prepare('UPDATE cdr SET cdrbatch = NULL, cdrbatchnum = ? WHERE cdrbatch IS NOT NULL AND cdrbatch = ?') or die dbh->errstr;
1824 foreach my $cdrbatch (keys %cdrbatchnum) {
1825 $sth->execute($cdrbatchnum{$cdrbatch}, $cdrbatch) or die $sth->errstr;
1830 =item ip_addr_sql FIELD RANGE
1832 Returns an SQL condition to search for CDRs with an IP address
1833 within RANGE. FIELD is either 'src_ip_addr' or 'dst_ip_addr'. RANGE
1834 should be in the form "a.b.c.d-e.f.g.h' (dotted quads), where any of
1835 the leftmost octets of the second address can be omitted if they're
1836 the same as the first address.
1842 my ($field, $range) = @_;
1843 $range =~ /^[\d\.-]+$/ or die "bad ip address range '$range'";
1844 my @r = split('-', $range);
1845 my @saddr = split('\.', $r[0] || '');
1846 my @eaddr = split('\.', $r[1] || '');
1847 unshift @eaddr, (undef) x (4 - scalar @eaddr);
1849 $eaddr[$_] = $saddr[$_] if !defined $eaddr[$_];
1851 "$field >= '".sprintf('%03d.%03d.%03d.%03d', @saddr) . "' AND ".
1852 "$field <= '".sprintf('%03d.%03d.%03d.%03d', @eaddr) . "'";
1861 L<FS::Record>, schema.html from the base documentation.