4 use vars qw( @ISA @EXPORT_OK $DEBUG );
10 use FS::UID qw( dbh );
11 use FS::Record qw( qsearch qsearchs );
15 use FS::cdr_upstream_rate;
17 @ISA = qw(FS::Record);
18 @EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker );
24 FS::cdr - Object methods for cdr records
30 $record = new FS::cdr \%hash;
31 $record = new FS::cdr { 'column' => 'value' };
33 $error = $record->insert;
35 $error = $new_record->replace($old_record);
37 $error = $record->delete;
39 $error = $record->check;
43 An FS::cdr object represents an Call Data Record, typically from a telephony
44 system or provider of some sort. FS::cdr inherits from FS::Record. The
45 following fields are currently supported:
49 =item acctid - primary key
51 =item calldate - Call timestamp (SQL timestamp)
53 =item clid - Caller*ID with text
55 =item src - Caller*ID number / Source number
57 =item dst - Destination extension
59 =item dcontext - Destination context
61 =item channel - Channel used
63 =item dstchannel - Destination channel if appropriate
65 =item lastapp - Last application if appropriate
67 =item lastdata - Last application data
69 =item startdate - Start of call (UNIX-style integer timestamp)
71 =item answerdate - Answer time of call (UNIX-style integer timestamp)
73 =item enddate - End time of call (UNIX-style integer timestamp)
75 =item duration - Total time in system, in seconds
77 =item billsec - Total time call is up, in seconds
79 =item disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
81 =item amaflags - What flags to use: BILL, IGNORE etc, specified on a per channel basis like accountcode.
85 #ignore the "omit" and "documentation" AMAs??
86 #AMA = Automated Message Accounting.
87 #default: Sets the system default.
88 #omit: Do not record calls.
89 #billing: Mark the entry for billing
90 #documentation: Mark the entry for documentation.
92 =item accountcode - CDR account number to use: account
94 =item uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID)
96 =item userfield - CDR user-defined field
98 =item cdr_type - CDR type - see L<FS::cdr_type> (Usage = 1, S&E = 7, OC&C = 8)
100 =item charged_party - Service number to be billed
102 =item upstream_currency - Wholesale currency from upstream
104 =item upstream_price - Wholesale price from upstream
106 =item upstream_rateplanid - Upstream rate plan ID
108 =item rated_price - Rated (or re-rated) price
110 =item distance - km (need units field?)
112 =item islocal - Local - 1, Non Local = 0
114 =item calltypenum - Type of call - see L<FS::cdr_calltype>
116 =item description - Description (cdr_type 7&8 only) (used for cust_bill_pkg.itemdesc)
118 =item quantity - Number of items (cdr_type 7&8 only)
120 =item carrierid - Upstream Carrier ID (see L<FS::cdr_carrier>)
124 #Telstra =1, Optus = 2, RSL COM = 3
126 =item upstream_rateid - Upstream Rate ID
128 =item svcnum - Link to customer service (see L<FS::cust_svc>)
130 =item freesidestatus - NULL, done (or something)
142 Creates a new CDR. To add the CDR to the database, see L<"insert">.
144 Note that this stores the hash reference, not a distinct copy of the hash it
145 points to. You can ask the object for a copy with the I<hash> method.
149 # the new method can be inherited from FS::Record, if a table method is defined
155 Adds this record to the database. If there is an error, returns the error,
156 otherwise returns false.
160 # the insert method can be inherited from FS::Record
164 Delete this record from the database.
168 # the delete method can be inherited from FS::Record
170 =item replace OLD_RECORD
172 Replaces the OLD_RECORD with this one in the database. If there is an error,
173 returns the error, otherwise returns false.
177 # the replace method can be inherited from FS::Record
181 Checks all fields to make sure this is a valid CDR. If there is
182 an error, returns the error, otherwise returns false. Called by the insert
185 Note: Unlike most types of records, we don't want to "reject" a CDR and we want
186 to process them as quickly as possible, so we allow the database to check most
194 # we don't want to "reject" a CDR like other sorts of input...
196 # $self->ut_numbern('acctid')
197 ## || $self->ut_('calldate')
198 # || $self->ut_text('clid')
199 # || $self->ut_text('src')
200 # || $self->ut_text('dst')
201 # || $self->ut_text('dcontext')
202 # || $self->ut_text('channel')
203 # || $self->ut_text('dstchannel')
204 # || $self->ut_text('lastapp')
205 # || $self->ut_text('lastdata')
206 # || $self->ut_numbern('startdate')
207 # || $self->ut_numbern('answerdate')
208 # || $self->ut_numbern('enddate')
209 # || $self->ut_number('duration')
210 # || $self->ut_number('billsec')
211 # || $self->ut_text('disposition')
212 # || $self->ut_number('amaflags')
213 # || $self->ut_text('accountcode')
214 # || $self->ut_text('uniqueid')
215 # || $self->ut_text('userfield')
216 # || $self->ut_numbern('cdrtypenum')
217 # || $self->ut_textn('charged_party')
218 ## || $self->ut_n('upstream_currency')
219 ## || $self->ut_n('upstream_price')
220 # || $self->ut_numbern('upstream_rateplanid')
221 ## || $self->ut_n('distance')
222 # || $self->ut_numbern('islocal')
223 # || $self->ut_numbern('calltypenum')
224 # || $self->ut_textn('description')
225 # || $self->ut_numbern('quantity')
226 # || $self->ut_numbern('carrierid')
227 # || $self->ut_numbern('upstream_rateid')
228 # || $self->ut_numbern('svcnum')
229 # || $self->ut_textn('freesidestatus')
231 # return $error if $error;
233 $self->calldate( $self->startdate_sql )
234 if !$self->calldate && $self->startdate;
236 unless ( $self->charged_party ) {
237 if ( $self->dst =~ /^(\+?1)?8[02-8]{2}/ ) {
238 $self->charged_party($self->dst);
240 $self->charged_party($self->src);
244 #check the foreign keys even?
245 #do we want to outright *reject* the CDR?
247 $self->ut_numbern('acctid')
249 #Usage = 1, S&E = 7, OC&C = 8
250 || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
252 #the big list in appendix 2
253 || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' )
255 # Telstra =1, Optus = 2, RSL COM = 3
256 || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
258 return $error if $error;
263 =item set_status_and_rated_price STATUS [ RATED_PRICE ]
265 Sets the status to the provided string. If there is an error, returns the
266 error, otherwise returns false.
270 sub set_status_and_rated_price {
271 my($self, $status, $rated_price) = @_;
272 $self->freesidestatus($status);
273 $self->rated_price($rated_price);
279 Parses the calldate in SQL string format and returns a UNIX timestamp.
284 str2time(shift->calldate);
289 Parses the startdate in UNIX timestamp format and returns a string in SQL
295 my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate);
298 "$year-$mon-$mday $hour:$min:$sec";
303 Returns the FS::cdr_carrier object associated with this CDR, or false if no
304 carrierid is defined.
308 my %carrier_cache = ();
312 return '' unless $self->carrierid;
313 $carrier_cache{$self->carrierid} ||=
314 qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } );
319 Returns the carrier name (see L<FS::cdr_carrier>), or the empty string if
320 no FS::cdr_carrier object is assocated with this CDR.
326 my $cdr_carrier = $self->cdr_carrier;
327 $cdr_carrier ? $cdr_carrier->carriername : '';
332 Returns the FS::cdr_calltype object associated with this CDR, or false if no
333 calltypenum is defined.
337 my %calltype_cache = ();
341 return '' unless $self->calltypenum;
342 $calltype_cache{$self->calltypenum} ||=
343 qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } );
348 Returns the call type name (see L<FS::cdr_calltype>), or the empty string if
349 no FS::cdr_calltype object is assocated with this CDR.
355 my $cdr_calltype = $self->cdr_calltype;
356 $cdr_calltype ? $cdr_calltype->calltypename : '';
359 =item cdr_upstream_rate
361 Returns the upstream rate mapping (see L<FS::cdr_upstream_rate>), or the empty
362 string if no FS::cdr_upstream_rate object is associated with this CDR.
366 sub cdr_upstream_rate {
368 return '' unless $self->upstream_rateid;
369 qsearchs('cdr_upstream_rate', { 'upstream_rateid' => $self->upstream_rateid })
373 =item _convergent_format COLUMN [ COUNTRYCODE ]
375 Returns the number in COLUMN formatted as follows:
377 If the country code does not match COUNTRYCODE (default "61"), it is returned
380 If the country code does match COUNTRYCODE (default "61"), it is removed. In
381 addiiton, "0" is prepended unless the number starts with 13, 18 or 19. (???)
385 sub _convergent_format {
386 my( $self, $field ) = ( shift, shift );
387 my $countrycode = scalar(@_) ? shift : '61'; #+61 = australia
388 #my $number = $self->$field();
389 my $number = $self->get($field);
390 #if ( $number =~ s/^(\+|011)$countrycode// ) {
391 if ( $number =~ s/^\+$countrycode// ) {
393 unless $number =~ /^1[389]/; #???
398 =item downstream_csv [ OPTION => VALUE, ... ]
404 'simple' => { 'name' => 'Simple',
406 "Date,Time,Name,Destination,Duration,Price",
408 'simple2' => { 'name' => 'Simple with source',
410 #"Date,Time,Name,Called From,Destination,Duration,Price",
411 "Date,Time,Called From,Destination,Duration,Price",
415 my %export_formats = (
417 'carriername', #CARRIER
418 sub { shift->_convergent_format('src') }, #SERVICE_NUMBER
419 sub { shift->_convergent_format('charged_party') }, #CHARGED_NUMBER
420 sub { time2str('%Y-%m-%d', shift->calldate_unix ) }, #DATE
421 sub { time2str('%T', shift->calldate_unix ) }, #TIME
422 'billsec', #'duration', #DURATION
423 sub { shift->_convergent_format('dst') }, #NUMBER_DIALED
424 '', #XXX add (from prefixes in most recent email) #FROM_DESC
425 '', #XXX add (from prefixes in most recent email) #TO_DESC
426 'calltypename', #CLASS_CODE
427 'rated_price', #PRICE
428 sub { shift->rated_price ? 'Y' : 'N' }, #RATED
432 sub { time2str('%D', shift->calldate_unix ) }, #DATE
433 sub { time2str('%r', shift->calldate_unix ) }, #TIME
435 'dst', #NUMBER_DIALED
436 sub { sprintf('%.2fm', shift->billsec / 60 ) }, #DURATION
437 sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
440 sub { time2str('%D', shift->calldate_unix ) }, #DATE
441 sub { time2str('%r', shift->calldate_unix ) }, #TIME
443 'dst', #NUMBER_DIALED
445 sub { sprintf('%.2fm', shift->billsec / 60 ) }, #DURATION
446 sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE
451 my( $self, %opt ) = @_;
453 my $format = $opt{'format'}; # 'convergent';
454 return "Unknown format $format" unless exists $export_formats{$format};
456 eval "use Text::CSV_XS;";
458 my $csv = new Text::CSV_XS;
462 ref($_) ? &{$_}($self) : $self->$_();
464 @{ $export_formats{$format} };
466 my $status = $csv->combine(@columns);
467 die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV"
480 =item invoice_formats
482 Returns an ordered list of key value pairs containing invoice format names
483 as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values.
487 sub invoice_formats {
488 map { ($_ => $export_names{$_}->{'name'}) }
489 grep { $export_names{$_}->{'invoice_header'} }
493 =item invoice_header FORMAT
495 Returns a scalar containing the CSV column header for invoice format FORMAT.
501 $export_names{$format}->{'invoice_header'};
506 Returns an ordered list of key value pairs containing import format names
507 as keys (for use with batch_import) and "pretty" format names as values.
511 #false laziness w/part_pkg & part_export
514 foreach my $INC ( @INC ) {
515 warn "globbing $INC/FS/cdr/*.pm\n" if $DEBUG;
516 foreach my $file ( glob("$INC/FS/cdr/*.pm") ) {
517 warn "attempting to load CDR format info from $file\n" if $DEBUG;
518 $file =~ /\/(\w+)\.pm$/ or do {
519 warn "unrecognized file in $INC/FS/cdr/: $file\n";
523 my $info = eval "use FS::cdr::$mod; ".
524 "\\%FS::cdr::$mod\::info;";
526 die "error using FS::cdr::$mod (skipping): $@\n" if $@;
529 unless ( keys %$info ) {
530 warn "no %info hash found in FS::cdr::$mod, skipping\n";
533 warn "got CDR format info from FS::cdr::$mod: $info\n" if $DEBUG;
534 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
535 warn "skipping disabled CDR format FS::cdr::$mod" if $DEBUG;
538 $cdr_info{$mod} = $info;
542 tie my %import_formats, 'Tie::IxHash',
543 map { $_ => $cdr_info{$_}->{'name'} }
544 sort { $cdr_info{$a}->{'weight'} <=> $cdr_info{$b}->{'weight'} }
545 grep { exists($cdr_info{$_}->{'import_fields'}) }
552 sub _cdr_min_parser_maker {
554 my @fields = ref($field) ? @$field : ($field);
555 @fields = qw( billsec duration ) unless scalar(@fields);
557 my( $cdr, $min ) = @_;
558 my $sec = eval { _cdr_min_parse($min) };
559 die "error parsing seconds for @fields from $min minutes: $@\n" if $@;
560 $cdr->$_($sec) foreach @fields;
566 sprintf('%.0f', $min * 60 );
569 sub _cdr_date_parser_maker {
572 my( $cdr, $date ) = @_;
573 #$cdr->$field( _cdr_date_parse($date) );
574 eval { $cdr->$field( _cdr_date_parse($date) ); };
575 die "error parsing date for $field from $date: $@\n" if $@;
579 sub _cdr_date_parse {
582 return '' unless length($date); #that's okay, it becomes NULL
584 my($year, $mon, $day, $hour, $min, $sec);
586 #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/
587 #taqua #2007-10-31 08:57:24.113000000
589 if ( $date =~ /^\s*(\d{4})\D(\d{1,2})\D(\d{1,2})\s+(\d{1,2})\D(\d{1,2})\D(\d{1,2})(\D|$)/ ) {
590 ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
591 } 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|$)/ ) {
592 ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
594 die "unparsable date: $date"; #maybe we shouldn't die...
597 return '' if $year == 1900 && $mon == 1 && $day == 1
598 && $hour == 0 && $min == 0 && $sec == 0;
600 timelocal($sec, $min, $hour, $day, $mon-1, $year);
603 =item batch_import HASHREF
605 Imports CDR records. Available options are:
620 my $fh = $param->{filehandle};
621 my $format = $param->{format};
622 my $cdrbatch = $param->{cdrbatch};
624 return "Unknown format $format"
625 unless exists( $cdr_info{$format} )
626 && exists( $cdr_info{$format}->{'import_fields'} );
628 my $info = $cdr_info{$format};
630 my $type = exists($info->{'type'}) ? lc($info->{'type'}) : 'csv';
633 if ( $type eq 'csv' ) {
634 eval "use Text::CSV_XS;";
636 $parser = new Text::CSV_XS;
637 } elsif ( $type eq 'fixedlength' ) {
638 eval "use Parse::FixedLength;";
640 $parser = new Parse::FixedLength $info->{'fixedlength_format'};
642 die "Unknown CDR format type $type for format $format\n";
648 local $SIG{HUP} = 'IGNORE';
649 local $SIG{INT} = 'IGNORE';
650 local $SIG{QUIT} = 'IGNORE';
651 local $SIG{TERM} = 'IGNORE';
652 local $SIG{TSTP} = 'IGNORE';
653 local $SIG{PIPE} = 'IGNORE';
655 my $oldAutoCommit = $FS::UID::AutoCommit;
656 local $FS::UID::AutoCommit = 0;
659 my $header_lines = exists($info->{'header'}) ? $info->{'header'} : 0;
662 while ( defined($line=<$fh>) ) {
664 next if $header_lines-- > 0; #&& $line =~ /^[\w, "]+$/
667 if ( $type eq 'csv' ) {
669 $parser->parse($line) or do {
670 $dbh->rollback if $oldAutoCommit;
671 return "can't parse: ". $parser->error_input();
674 @columns = $parser->fields();
676 } elsif ( $type eq 'fixedlength' ) {
678 @columns = $parser->parse($line);
681 die "Unknown CDR format type $type for format $format\n";
684 #warn join('-',@columns);
686 if ( $format eq 'simple' ) { #should be a callback or opt in FS::cdr::simple
687 @columns = map { s/^ +//; $_; } @columns;
694 my $field_or_sub = $_;
695 if ( ref($field_or_sub) ) {
696 push @later, $field_or_sub, shift(@columns);
699 ( $field_or_sub => shift @columns );
703 @{ $info->{'import_fields'} }
706 $cdr{cdrbatch} = $cdrbatch;
708 my $cdr = new FS::cdr ( \%cdr );
710 while ( scalar(@later) ) {
711 my $sub = shift @later;
712 my $data = shift @later;
713 &{$sub}($cdr, $data); # $cdr->&{$sub}($data);
716 if ( $format eq 'taqua' ) { #should be a callback or opt in FS::cdr::taqua
717 if ( $cdr->enddate && $cdr->startdate ) { #a bit more?
718 $cdr->duration( $cdr->enddate - $cdr->startdate );
720 if ( $cdr->enddate && $cdr->answerdate ) { #a bit more?
721 $cdr->billsec( $cdr->enddate - $cdr->answerdate );
725 my $error = $cdr->insert;
727 $dbh->rollback if $oldAutoCommit;
737 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
739 #might want to disable this if we skip records for any reason...
740 return "Empty file!" unless $imported || $param->{empty_ok};
752 L<FS::Record>, schema.html from the base documentation.