4 use vars qw( @ISA @EXPORT_OK $DEBUG $me );
10 use FS::UID qw( dbh );
12 use FS::Record qw( qsearch qsearchs );
17 use FS::cdr_termination;
19 @ISA = qw(FS::Record);
20 @EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker );
27 FS::cdr - Object methods for cdr records
33 $record = new FS::cdr \%hash;
34 $record = new FS::cdr { 'column' => 'value' };
36 $error = $record->insert;
38 $error = $new_record->replace($old_record);
40 $error = $record->delete;
42 $error = $record->check;
46 An FS::cdr object represents an Call Data Record, typically from a telephony
47 system or provider of some sort. FS::cdr inherits from FS::Record. The
48 following fields are currently supported:
52 =item acctid - primary key
54 =item calldate - Call timestamp (SQL timestamp)
56 =item clid - Caller*ID with text
58 =item src - Caller*ID number / Source number
60 =item dst - Destination extension
62 =item dcontext - Destination context
64 =item channel - Channel used
66 =item dstchannel - Destination channel if appropriate
68 =item lastapp - Last application if appropriate
70 =item lastdata - Last application data
72 =item startdate - Start of call (UNIX-style integer timestamp)
74 =item answerdate - Answer time of call (UNIX-style integer timestamp)
76 =item enddate - End time of call (UNIX-style integer timestamp)
78 =item duration - Total time in system, in seconds
80 =item billsec - Total time call is up, in seconds
82 =item disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
84 =item amaflags - What flags to use: BILL, IGNORE etc, specified on a per channel basis like accountcode.
88 #ignore the "omit" and "documentation" AMAs??
89 #AMA = Automated Message Accounting.
90 #default: Sets the system default.
91 #omit: Do not record calls.
92 #billing: Mark the entry for billing
93 #documentation: Mark the entry for documentation.
95 =item accountcode - CDR account number to use: account
97 =item uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID)
99 =item userfield - CDR user-defined field
101 =item cdr_type - CDR type - see L<FS::cdr_type> (Usage = 1, S&E = 7, OC&C = 8)
103 =item charged_party - Service number to be billed
105 =item upstream_currency - Wholesale currency from upstream
107 =item upstream_price - Wholesale price from upstream
109 =item upstream_rateplanid - Upstream rate plan ID
111 =item rated_price - Rated (or re-rated) price
113 =item distance - km (need units field?)
115 =item islocal - Local - 1, Non Local = 0
117 =item calltypenum - Type of call - see L<FS::cdr_calltype>
119 =item description - Description (cdr_type 7&8 only) (used for cust_bill_pkg.itemdesc)
121 =item quantity - Number of items (cdr_type 7&8 only)
123 =item carrierid - Upstream Carrier ID (see L<FS::cdr_carrier>)
127 #Telstra =1, Optus = 2, RSL COM = 3
129 =item upstream_rateid - Upstream Rate ID
131 =item svcnum - Link to customer service (see L<FS::cust_svc>)
133 =item freesidestatus - NULL, done (or something)
135 =item freesiderewritestatus - NULL, done (or something)
147 Creates a new CDR. To add the CDR to the database, see L<"insert">.
149 Note that this stores the hash reference, not a distinct copy of the hash it
150 points to. You can ask the object for a copy with the I<hash> method.
154 # the new method can be inherited from FS::Record, if a table method is defined
161 #XXX fill in some (more) nice names
163 'calldate' => 'Call date',
164 'clid' => 'Caller ID',
166 'dst' => 'Destination',
167 'dcontext' => 'Dest. context',
168 'channel' => 'Channel',
169 'dstchannel' => 'Destination channel',
172 'startdate' => 'Start date',
173 'answerdate' => 'Answer date',
174 'enddate' => 'End date',
175 'duration' => 'Duration',
176 'billsec' => 'Billable seconds',
177 'disposition' => 'Disposition',
178 'amaflags' => 'AMA flags',
179 'accountcode' => 'Account code',
181 'userfield' => 'User field',
183 'charged_party' => 'Charged party',
184 #'upstream_currency' => '',
185 'upstream_price' => 'Upstream price',
186 #'upstream_rateplanid' => '',
187 #'ratedetailnum' => '',
188 'rated_price' => 'Rated price',
191 #'calltypenum' => '',
192 #'description' => '',
194 'carrierid' => 'Carrier ID',
195 #'upstream_rateid' => '',
196 'svcnum' => 'Freeside service',
197 'freesidestatus' => 'Freeside status',
198 'freesiderewritestatus' => 'Freeside rewrite status',
199 'cdrbatch' => 'Legacy batch',
200 'cdrbatchnum' => 'Batch',
209 Adds this record to the database. If there is an error, returns the error,
210 otherwise returns false.
214 # the insert method can be inherited from FS::Record
218 Delete this record from the database.
222 # the delete method can be inherited from FS::Record
224 =item replace OLD_RECORD
226 Replaces the OLD_RECORD with this one in the database. If there is an error,
227 returns the error, otherwise returns false.
231 # the replace method can be inherited from FS::Record
235 Checks all fields to make sure this is a valid CDR. If there is
236 an error, returns the error, otherwise returns false. Called by the insert
239 Note: Unlike most types of records, we don't want to "reject" a CDR and we want
240 to process them as quickly as possible, so we allow the database to check most
248 # we don't want to "reject" a CDR like other sorts of input...
250 # $self->ut_numbern('acctid')
251 ## || $self->ut_('calldate')
252 # || $self->ut_text('clid')
253 # || $self->ut_text('src')
254 # || $self->ut_text('dst')
255 # || $self->ut_text('dcontext')
256 # || $self->ut_text('channel')
257 # || $self->ut_text('dstchannel')
258 # || $self->ut_text('lastapp')
259 # || $self->ut_text('lastdata')
260 # || $self->ut_numbern('startdate')
261 # || $self->ut_numbern('answerdate')
262 # || $self->ut_numbern('enddate')
263 # || $self->ut_number('duration')
264 # || $self->ut_number('billsec')
265 # || $self->ut_text('disposition')
266 # || $self->ut_number('amaflags')
267 # || $self->ut_text('accountcode')
268 # || $self->ut_text('uniqueid')
269 # || $self->ut_text('userfield')
270 # || $self->ut_numbern('cdrtypenum')
271 # || $self->ut_textn('charged_party')
272 ## || $self->ut_n('upstream_currency')
273 ## || $self->ut_n('upstream_price')
274 # || $self->ut_numbern('upstream_rateplanid')
275 ## || $self->ut_n('distance')
276 # || $self->ut_numbern('islocal')
277 # || $self->ut_numbern('calltypenum')
278 # || $self->ut_textn('description')
279 # || $self->ut_numbern('quantity')
280 # || $self->ut_numbern('carrierid')
281 # || $self->ut_numbern('upstream_rateid')
282 # || $self->ut_numbern('svcnum')
283 # || $self->ut_textn('freesidestatus')
284 # || $self->ut_textn('freesiderewritestatus')
286 # return $error if $error;
288 for my $f ( grep { $self->$_ =~ /[a-z ]/i } qw( startdate enddate ) ) {
289 $self->$f( str2time($self->$f) );
292 $self->calldate( $self->startdate_sql )
293 if !$self->calldate && $self->startdate;
295 #was just for $format eq 'taqua' but can't see the harm... add something to
296 #disable if it becomes a problem
297 if ( $self->duration eq '' && $self->enddate && $self->startdate ) {
298 $self->duration( $self->enddate - $self->startdate );
300 if ( $self->billsec eq '' && $self->enddate && $self->answerdate ) {
301 $self->billsec( $self->enddate - $self->answerdate );
304 $self->set_charged_party;
306 #check the foreign keys even?
307 #do we want to outright *reject* the CDR?
309 $self->ut_numbern('acctid')
311 #add a config option to turn these back on if someone needs 'em
313 # #Usage = 1, S&E = 7, OC&C = 8
314 # || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
316 # #the big list in appendix 2
317 # || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' )
319 # # Telstra =1, Optus = 2, RSL COM = 3
320 # || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
322 return $error if $error;
327 =item is_tollfree [ COLUMN ]
329 Returns true when the cdr represents a toll free number and false otherwise.
331 By default, inspects the dst field, but an optional column name can be passed
332 to inspect other field.
338 my $field = scalar(@_) ? shift : 'dst';
339 ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0;
342 =item set_charged_party
344 If the charged_party field is already set, does nothing. Otherwise:
346 If the cdr-charged_party-accountcode config option is enabled, sets the
347 charged_party to the accountcode.
349 Otherwise sets the charged_party normally: to the src field in most cases,
350 or to the dst field if it is a toll free number.
354 sub set_charged_party {
357 my $conf = new FS::Conf;
359 unless ( $self->charged_party ) {
361 if ( $conf->exists('cdr-charged_party-accountcode') && $self->accountcode ){
363 my $charged_party = $self->accountcode;
364 $charged_party =~ s/^0+//
365 if $conf->exists('cdr-charged_party-accountcode-trim_leading_0s');
366 $self->charged_party( $charged_party );
368 } elsif ( $conf->exists('cdr-charged_party-field') ) {
370 my $field = $conf->config('cdr-charged_party-field');
371 $self->charged_party( $self->$field() );
375 if ( $self->is_tollfree ) {
376 $self->charged_party($self->dst);
378 $self->charged_party($self->src);
385 # my $prefix = $conf->config('cdr-charged_party-truncate_prefix');
386 # my $prefix_len = length($prefix);
387 # my $trunc_len = $conf->config('cdr-charged_party-truncate_length');
389 # $self->charged_party( substr($self->charged_party, 0, $trunc_len) )
390 # if $prefix_len && $trunc_len
391 # && substr($self->charged_party, 0, $prefix_len) eq $prefix;
395 =item set_status_and_rated_price STATUS [ RATED_PRICE [ SVCNUM ] ]
397 Sets the status to the provided string. If there is an error, returns the
398 error, otherwise returns false.
402 sub set_status_and_rated_price {
403 my($self, $status, $rated_price, $svcnum, %opt) = @_;
404 if($opt{'inbound'}) {
405 my $term = qsearchs('cdr_termination', {
406 acctid => $self->acctid,
407 termpart => 1 # inbound
411 warn "replacing existing cdr status (".$self->acctid.")\n" if $term;
412 $error = $term->delete;
413 return $error if $error;
415 $term = FS::cdr_termination->new({
416 acctid => $self->acctid,
418 rated_price => $rated_price,
422 return $term->insert;
425 $self->freesidestatus($status);
426 $self->rated_price($rated_price);
427 $self->svcnum($svcnum) if $svcnum;
428 return $self->replace();
434 Parses the calldate in SQL string format and returns a UNIX timestamp.
439 str2time(shift->calldate);
444 Parses the startdate in UNIX timestamp format and returns a string in SQL
450 my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate);
453 "$year-$mon-$mday $hour:$min:$sec";
458 Returns the FS::cdr_carrier object associated with this CDR, or false if no
459 carrierid is defined.
463 my %carrier_cache = ();
467 return '' unless $self->carrierid;
468 $carrier_cache{$self->carrierid} ||=
469 qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } );
474 Returns the carrier name (see L<FS::cdr_carrier>), or the empty string if
475 no FS::cdr_carrier object is assocated with this CDR.
481 my $cdr_carrier = $self->cdr_carrier;
482 $cdr_carrier ? $cdr_carrier->carriername : '';
487 Returns the FS::cdr_calltype object associated with this CDR, or false if no
488 calltypenum is defined.
492 my %calltype_cache = ();
496 return '' unless $self->calltypenum;
497 $calltype_cache{$self->calltypenum} ||=
498 qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } );
503 Returns the call type name (see L<FS::cdr_calltype>), or the empty string if
504 no FS::cdr_calltype object is assocated with this CDR.
510 my $cdr_calltype = $self->cdr_calltype;
511 $cdr_calltype ? $cdr_calltype->calltypename : '';
514 =item downstream_csv [ OPTION => VALUE, ... ]
521 'invoice_header' => "Date,Time,Name,Destination,Duration,Price",
524 'name' => 'Simple with source',
525 'invoice_header' => "Date,Time,Called From,Destination,Duration,Price",
526 #"Date,Time,Name,Called From,Destination,Duration,Price",
530 'invoice_header' => 'Date,Time,Number,Destination,Duration,Price',
532 'source_default' => {
533 'name' => 'Default with source',
534 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price',
536 'accountcode_default' => {
537 'name' => 'Default plus accountcode',
538 'invoice_header' => 'Date,Time,Account,Number,Destination,Duration,Price',
542 my %export_formats = ();
546 return %export_formats if keys %export_formats;
548 my $conf = new FS::Conf;
549 my $date_format = $conf->config('date_format') || '%m/%d/%Y';
551 my $duration_sub = sub {
553 if ( $opt{minutes} ) {
554 $opt{minutes}. ( $opt{granularity} ? 'm' : ' call' );
556 #config if anyone really wants decimal minutes back
557 #sprintf('%.2fm', $cdr->billsec / 60 );
558 int($cdr->billsec / 60).'m '. ($cdr->billsec % 60).'s';
564 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
565 sub { time2str('%r', shift->calldate_unix ) }, #TIME
567 'dst', #NUMBER_DIALED
568 $duration_sub, #DURATION
569 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
570 sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE
573 sub { time2str($date_format, shift->calldate_unix ) }, #DATE
574 sub { time2str('%r', shift->calldate_unix ) }, #TIME
577 'dst', #NUMBER_DIALED
578 $duration_sub, #DURATION
579 #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
580 sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE
585 sub { time2str($date_format, shift->calldate_unix ) },
586 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
589 sub { time2str('%r', shift->calldate_unix ) },
590 # 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
593 sub { my($cdr, %opt) = @_; $opt{pretty_dst} || $cdr->dst; },
595 #REGIONNAME ("Destination")
596 sub { my($cdr, %opt) = @_; $opt{dst_regionname}; },
602 sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; },
606 $export_formats{'source_default'} = [ 'src', @{ $export_formats{'default'} }, ];
607 $export_formats{'accountcode_default'} =
608 [ @{ $export_formats{'default'} }[0,1],
610 @{ $export_formats{'default'} }[2..5],
617 my( $self, %opt ) = @_;
619 my $format = $opt{'format'};
620 my %formats = $self->export_formats;
621 return "Unknown format $format" unless exists $formats{$format};
623 #my $conf = new FS::Conf;
624 #$opt{'money_char'} ||= $conf->config('money_char') || '$';
625 $opt{'money_char'} ||= FS::Conf->new->config('money_char') || '$';
627 eval "use Text::CSV_XS;";
629 my $csv = new Text::CSV_XS;
633 ref($_) ? &{$_}($self, %opt) : $self->$_();
635 @{ $formats{$format} };
637 my $status = $csv->combine(@columns);
638 die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV"
651 =item invoice_formats
653 Returns an ordered list of key value pairs containing invoice format names
654 as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values.
658 sub invoice_formats {
659 map { ($_ => $export_names{$_}->{'name'}) }
660 grep { $export_names{$_}->{'invoice_header'} }
664 =item invoice_header FORMAT
666 Returns a scalar containing the CSV column header for invoice format FORMAT.
672 $export_names{$format}->{'invoice_header'};
677 Returns an ordered list of key value pairs containing import format names
678 as keys (for use with batch_import) and "pretty" format names as values.
682 #false laziness w/part_pkg & part_export
685 foreach my $INC ( @INC ) {
686 warn "globbing $INC/FS/cdr/*.pm\n" if $DEBUG;
687 foreach my $file ( glob("$INC/FS/cdr/*.pm") ) {
688 warn "attempting to load CDR format info from $file\n" if $DEBUG;
689 $file =~ /\/(\w+)\.pm$/ or do {
690 warn "unrecognized file in $INC/FS/cdr/: $file\n";
694 my $info = eval "use FS::cdr::$mod; ".
695 "\\%FS::cdr::$mod\::info;";
697 die "error using FS::cdr::$mod (skipping): $@\n" if $@;
700 unless ( keys %$info ) {
701 warn "no %info hash found in FS::cdr::$mod, skipping\n";
704 warn "got CDR format info from FS::cdr::$mod: $info\n" if $DEBUG;
705 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
706 warn "skipping disabled CDR format FS::cdr::$mod" if $DEBUG;
709 $cdr_info{$mod} = $info;
713 tie my %import_formats, 'Tie::IxHash',
714 map { $_ => $cdr_info{$_}->{'name'} }
715 sort { $cdr_info{$a}->{'weight'} <=> $cdr_info{$b}->{'weight'} }
716 grep { exists($cdr_info{$_}->{'import_fields'}) }
723 sub _cdr_min_parser_maker {
725 my @fields = ref($field) ? @$field : ($field);
726 @fields = qw( billsec duration ) unless scalar(@fields) && $fields[0];
728 my( $cdr, $min ) = @_;
729 my $sec = eval { _cdr_min_parse($min) };
730 die "error parsing seconds for @fields from $min minutes: $@\n" if $@;
731 $cdr->$_($sec) foreach @fields;
737 sprintf('%.0f', $min * 60 );
740 sub _cdr_date_parser_maker {
743 my @fields = ref($field) ? @$field : ($field);
745 my( $cdr, $datestring ) = @_;
746 my $unixdate = eval { _cdr_date_parse($datestring, %options) };
747 die "error parsing date for @fields from $datestring: $@\n" if $@;
748 $cdr->$_($unixdate) foreach @fields;
752 sub _cdr_date_parse {
756 return '' unless length($date); #that's okay, it becomes NULL
757 return '' if $date eq 'NA'; #sansay
759 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 ) {
760 my $time = str2time($date);
761 return $time if $time > 100000; #just in case
764 my($year, $mon, $day, $hour, $min, $sec);
766 #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/
767 #taqua #2007-10-31 08:57:24.113000000
769 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|$)/ ) {
770 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
771 } 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|$)/ ) {
773 # optionally without seconds
774 ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
775 $sec = 0 if !defined($sec);
776 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d+\.\d+)(\D|$)/ ) {
777 # broadsoft: 20081223201938.314
778 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
779 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\d+(\D|$)/ ) {
780 # Taqua OM: 20050422203450943
781 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
782 } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/ ) {
783 # WIP: 20100329121420
784 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
786 die "unparsable date: $date"; #maybe we shouldn't die...
789 return '' if ( $year == 1900 || $year == 1970 ) && $mon == 1 && $day == 1
790 && $hour == 0 && $min == 0 && $sec == 0;
793 timegm($sec, $min, $hour, $day, $mon-1, $year);
795 timelocal($sec, $min, $hour, $day, $mon-1, $year);
799 =item batch_import HASHREF
801 Imports CDR records. Available options are:
813 Hash reference of preset fields, typically cdrbatch
817 Set true to prevent throwing an error on empty imports
823 my %import_options = (
826 'batch_keycol' => 'cdrbatchnum',
827 'batch_table' => 'cdr_batch',
828 'batch_namecol' => 'cdrbatch',
830 'formats' => { map { $_ => $cdr_info{$_}->{'import_fields'}; }
834 #drop the || 'csv' to allow auto xls for csv types?
835 'format_types' => { map { $_ => ( lc($cdr_info{$_}->{'type'}) || 'csv' ); }
839 'format_headers' => { map { $_ => ( $cdr_info{$_}->{'header'} || 0 ); }
843 'format_sep_chars' => { map { $_ => $cdr_info{$_}->{'sep_char'}; }
847 'format_fixedlength_formats' =>
848 { map { $_ => $cdr_info{$_}->{'fixedlength_format'}; }
852 'format_row_callbacks' => { map { $_ => $cdr_info{$_}->{'row_callback'}; }
857 sub _import_options {
864 my $iopt = _import_options;
865 $opt->{$_} = $iopt->{$_} foreach keys %$iopt;
867 FS::Record::batch_import( $opt );
871 =item process_batch_import
875 sub process_batch_import {
878 my $opt = _import_options;
879 # $opt->{'params'} = [ 'format', 'cdrbatch' ];
881 FS::Record::process_batch_import( $job, $opt, @_ );
884 # if ( $format eq 'simple' ) { #should be a callback or opt in FS::cdr::simple
885 # @columns = map { s/^ +//; $_; } @columns;
890 # Used by FS::Upgrade to migrate to a new database.
893 my ($class, %opts) = @_;
895 warn "$me upgrading $class\n" if $DEBUG;
897 my $sth = dbh->prepare(
898 'SELECT DISTINCT(cdrbatch) FROM cdr WHERE cdrbatch IS NOT NULL'
899 ) or die dbh->errstr;
901 $sth->execute or die $sth->errstr;
903 my %cdrbatchnum = ();
904 while (my $row = $sth->fetchrow_arrayref) {
906 my $cdr_batch = qsearchs( 'cdr_batch', { 'cdrbatch' => $row->[0] } );
907 unless ( $cdr_batch ) {
908 $cdr_batch = new FS::cdr_batch { 'cdrbatch' => $row->[0] };
909 my $error = $cdr_batch->insert;
910 die $error if $error;
913 $cdrbatchnum{$row->[0]} = $cdr_batch->cdrbatchnum;
916 $sth = dbh->prepare('UPDATE cdr SET cdrbatch = NULL, cdrbatchnum = ? WHERE cdrbatch IS NOT NULL AND cdrbatch = ?') or die dbh->errstr;
918 foreach my $cdrbatch (keys %cdrbatchnum) {
919 $sth->execute($cdrbatchnum{$cdrbatch}, $cdrbatch) or die $sth->errstr;
930 L<FS::Record>, schema.html from the base documentation.