9 use FS::Record qw( qsearch qsearchs );
13 use FS::cdr_upstream_rate;
15 @ISA = qw(FS::Record);
19 FS::cdr - Object methods for cdr records
25 $record = new FS::cdr \%hash;
26 $record = new FS::cdr { 'column' => 'value' };
28 $error = $record->insert;
30 $error = $new_record->replace($old_record);
32 $error = $record->delete;
34 $error = $record->check;
38 An FS::cdr object represents an Call Data Record, typically from a telephony
39 system or provider of some sort. FS::cdr inherits from FS::Record. The
40 following fields are currently supported:
44 =item acctid - primary key
46 =item calldate - Call timestamp (SQL timestamp)
48 =item clid - Caller*ID with text
50 =item src - Caller*ID number / Source number
52 =item dst - Destination extension
54 =item dcontext - Destination context
56 =item channel - Channel used
58 =item dstchannel - Destination channel if appropriate
60 =item lastapp - Last application if appropriate
62 =item lastdata - Last application data
64 =item startdate - Start of call (UNIX-style integer timestamp)
66 =item answerdate - Answer time of call (UNIX-style integer timestamp)
68 =item enddate - End time of call (UNIX-style integer timestamp)
70 =item duration - Total time in system, in seconds
72 =item billsec - Total time call is up, in seconds
74 =item disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
76 =item amaflags - What flags to use: BILL, IGNORE etc, specified on a per channel basis like accountcode.
80 #ignore the "omit" and "documentation" AMAs??
81 #AMA = Automated Message Accounting.
82 #default: Sets the system default.
83 #omit: Do not record calls.
84 #billing: Mark the entry for billing
85 #documentation: Mark the entry for documentation.
87 =item accountcode - CDR account number to use: account
89 =item uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID)
91 =item userfield - CDR user-defined field
93 =item cdr_type - CDR type - see L<FS::cdr_type> (Usage = 1, S&E = 7, OC&C = 8)
95 =item charged_party - Service number to be billed
97 =item upstream_currency - Wholesale currency from upstream
99 =item upstream_price - Wholesale price from upstream
101 =item upstream_rateplanid - Upstream rate plan ID
103 =item rated_price - Rated (or re-rated) price
105 =item distance - km (need units field?)
107 =item islocal - Local - 1, Non Local = 0
109 =item calltypenum - Type of call - see L<FS::cdr_calltype>
111 =item description - Description (cdr_type 7&8 only) (used for cust_bill_pkg.itemdesc)
113 =item quantity - Number of items (cdr_type 7&8 only)
115 =item carrierid - Upstream Carrier ID (see L<FS::cdr_carrier>)
119 #Telstra =1, Optus = 2, RSL COM = 3
121 =item upstream_rateid - Upstream Rate ID
123 =item svcnum - Link to customer service (see L<FS::cust_svc>)
125 =item freesidestatus - NULL, done (or something)
135 Creates a new CDR. To add the CDR to the database, see L<"insert">.
137 Note that this stores the hash reference, not a distinct copy of the hash it
138 points to. You can ask the object for a copy with the I<hash> method.
142 # the new method can be inherited from FS::Record, if a table method is defined
148 Adds this record to the database. If there is an error, returns the error,
149 otherwise returns false.
153 # the insert method can be inherited from FS::Record
157 Delete this record from the database.
161 # the delete method can be inherited from FS::Record
163 =item replace OLD_RECORD
165 Replaces the OLD_RECORD with this one in the database. If there is an error,
166 returns the error, otherwise returns false.
170 # the replace method can be inherited from FS::Record
174 Checks all fields to make sure this is a valid CDR. If there is
175 an error, returns the error, otherwise returns false. Called by the insert
178 Note: Unlike most types of records, we don't want to "reject" a CDR and we want
179 to process them as quickly as possible, so we allow the database to check most
187 # we don't want to "reject" a CDR like other sorts of input...
189 # $self->ut_numbern('acctid')
190 ## || $self->ut_('calldate')
191 # || $self->ut_text('clid')
192 # || $self->ut_text('src')
193 # || $self->ut_text('dst')
194 # || $self->ut_text('dcontext')
195 # || $self->ut_text('channel')
196 # || $self->ut_text('dstchannel')
197 # || $self->ut_text('lastapp')
198 # || $self->ut_text('lastdata')
199 # || $self->ut_numbern('startdate')
200 # || $self->ut_numbern('answerdate')
201 # || $self->ut_numbern('enddate')
202 # || $self->ut_number('duration')
203 # || $self->ut_number('billsec')
204 # || $self->ut_text('disposition')
205 # || $self->ut_number('amaflags')
206 # || $self->ut_text('accountcode')
207 # || $self->ut_text('uniqueid')
208 # || $self->ut_text('userfield')
209 # || $self->ut_numbern('cdrtypenum')
210 # || $self->ut_textn('charged_party')
211 ## || $self->ut_n('upstream_currency')
212 ## || $self->ut_n('upstream_price')
213 # || $self->ut_numbern('upstream_rateplanid')
214 ## || $self->ut_n('distance')
215 # || $self->ut_numbern('islocal')
216 # || $self->ut_numbern('calltypenum')
217 # || $self->ut_textn('description')
218 # || $self->ut_numbern('quantity')
219 # || $self->ut_numbern('carrierid')
220 # || $self->ut_numbern('upstream_rateid')
221 # || $self->ut_numbern('svcnum')
222 # || $self->ut_textn('freesidestatus')
224 # return $error if $error;
226 $self->calldate( $self->startdate_sql )
227 if !$self->calldate && $self->startdate;
229 unless ( $self->charged_party ) {
230 if ( $self->dst =~ /^(\+?1)?8[02-8]{2}/ ) {
231 $self->charged_party($self->dst);
233 $self->charged_party($self->src);
237 #check the foreign keys even?
238 #do we want to outright *reject* the CDR?
240 $self->ut_numbern('acctid')
242 #Usage = 1, S&E = 7, OC&C = 8
243 || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
245 #the big list in appendix 2
246 || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' )
248 # Telstra =1, Optus = 2, RSL COM = 3
249 || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
251 return $error if $error;
256 =item set_status_and_rated_price STATUS [ RATED_PRICE ]
258 Sets the status to the provided string. If there is an error, returns the
259 error, otherwise returns false.
263 sub set_status_and_rated_price {
264 my($self, $status, $rated_price) = @_;
265 $self->freesidestatus($status);
266 $self->rated_price($rated_price);
272 Parses the calldate in SQL string format and returns a UNIX timestamp.
277 str2time(shift->calldate);
282 Parses the startdate in UNIX timestamp format and returns a string in SQL
288 my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate);
291 "$year-$mon-$mday $hour:$min:$sec";
296 Returns the FS::cdr_carrier object associated with this CDR, or false if no
297 carrierid is defined.
301 my %carrier_cache = ();
305 return '' unless $self->carrierid;
306 $carrier_cache{$self->carrierid} ||=
307 qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } );
312 Returns the carrier name (see L<FS::cdr_carrier>), or the empty string if
313 no FS::cdr_carrier object is assocated with this CDR.
319 my $cdr_carrier = $self->cdr_carrier;
320 $cdr_carrier ? $cdr_carrier->carriername : '';
325 Returns the FS::cdr_calltype object associated with this CDR, or false if no
326 calltypenum is defined.
330 my %calltype_cache = ();
334 return '' unless $self->calltypenum;
335 $calltype_cache{$self->calltypenum} ||=
336 qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } );
341 Returns the call type name (see L<FS::cdr_calltype>), or the empty string if
342 no FS::cdr_calltype object is assocated with this CDR.
348 my $cdr_calltype = $self->cdr_calltype;
349 $cdr_calltype ? $cdr_calltype->calltypename : '';
352 =item cdr_upstream_rate
354 Returns the upstream rate mapping (see L<FS::cdr_upstream_rate>), or the empty
355 string if no FS::cdr_upstream_rate object is associated with this CDR.
359 sub cdr_upstream_rate {
361 return '' unless $self->upstream_rateid;
362 qsearchs('cdr_upstream_rate', { 'upstream_rateid' => $self->upstream_rateid })
366 =item _convergent_format COLUMN [ COUNTRYCODE ]
368 Returns the number in COLUMN formatted as follows:
370 If the country code does not match COUNTRYCODE (default "61"), it is returned
373 If the country code does match COUNTRYCODE (default "61"), it is removed. In
374 addiiton, "0" is prepended unless the number starts with 13, 18 or 19. (???)
378 sub _convergent_format {
379 my( $self, $field ) = ( shift, shift );
380 my $countrycode = scalar(@_) ? shift : '61'; #+61 = australia
381 #my $number = $self->$field();
382 my $number = $self->get($field);
383 #if ( $number =~ s/^(\+|011)$countrycode// ) {
384 if ( $number =~ s/^\+$countrycode// ) {
386 unless $number =~ /^1[389]/; #???
391 =item downstream_csv [ OPTION => VALUE, ... ]
395 my %export_formats = (
397 'carriername', #CARRIER
398 sub { shift->_convergent_format('src') }, #SERVICE_NUMBER
399 sub { shift->_convergent_format('charged_party') }, #CHARGED_NUMBER
400 sub { time2str('%Y-%m-%d', shift->calldate_unix ) }, #DATE
401 sub { time2str('%T', shift->calldate_unix ) }, #TIME
402 'billsec', #'duration', #DURATION
403 sub { shift->_convergent_format('dst') }, #NUMBER_DIALED
404 '', #XXX add (from prefixes in most recent email) #FROM_DESC
405 '', #XXX add (from prefixes in most recent email) #TO_DESC
406 'calltypename', #CLASS_CODE
407 'rated_price', #PRICE
408 sub { shift->rated_price ? 'Y' : 'N' }, #RATED
414 my( $self, %opt ) = @_;
416 my $format = $opt{'format'}; # 'convergent';
417 return "Unknown format $format" unless exists $export_formats{$format};
419 eval "use Text::CSV_XS;";
421 my $csv = new Text::CSV_XS;
425 ref($_) ? &{$_}($self) : $self->$_();
427 @{ $export_formats{$format} };
429 my $status = $csv->combine(@columns);
430 die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV"
445 Returns an ordered list of key value pairs containing import format names
446 as keys (for use with batch_import) and "pretty" format names as values.
452 'asterisk' => 'Asterisk',
454 'unitel' => 'Unitel/RSLCOM',
455 'simple' => 'Simple',
459 my($tmp_mday, $tmp_mon, $tmp_year);
461 sub _cdr_date_parser_maker {
464 my( $cdr, $date ) = @_;
465 #$cdr->$field( _cdr_date_parse($date) );
466 eval { $cdr->$field( _cdr_date_parse($date) ); };
467 die "error parsing date for $field from $date: $@\n" if $@;
471 sub _cdr_date_parse {
474 return '' unless length($date); #that's okay, it becomes NULL
476 #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/
477 $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|$)/
478 or die "unparsable date: $date"; #maybe we shouldn't die...
479 my($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
481 return '' if $year == 1900 && $mon == 1 && $day == 1
482 && $hour == 0 && $min == 0 && $sec == 0;
484 timelocal($sec, $min, $hour, $day, $mon-1, $year);
487 #taqua #2007-10-31 08:57:24.113000000
489 #http://www.the-asterisk-book.com/unstable/funktionen-cdr.html
492 OMIT => 1, #asterisk 1.4+
493 IGNORE => 1, #asterisk 1.2
494 BILLING => 2, #asterisk 1.4+
495 BILL => 2, #asterisk 1.2
500 my %import_formats = (
511 _cdr_date_parser_maker('startdate'),
512 _cdr_date_parser_maker('answerdate'),
513 _cdr_date_parser_maker('enddate'),
517 sub { my($cdr, $amaflags) = @_; $cdr->amaflags($amaflags{$amaflags}); },
521 'taqua' => [ #some of these are kind arbitrary...
523 sub { my($cdr, $field) = @_; }, #XXX interesting RecordType
524 # easy to fix: Can't find cdr.cdrtypenum 1 in cdr_type.cdrtypenum
526 sub { my($cdr, $field) = @_; }, #all10#RecordVersion
527 sub { my($cdr, $field) = @_; }, #OrigShelfNumber
528 sub { my($cdr, $field) = @_; }, #OrigCardNumber
529 sub { my($cdr, $field) = @_; }, #OrigCircuit
530 sub { my($cdr, $field) = @_; }, #OrigCircuitType
531 'uniqueid', #SequenceNumber
532 'accountcode', #SessionNumber
533 'src', #CallingPartyNumber
534 'dst', #CalledPartyNumber
535 _cdr_date_parser_maker('startdate'), #CallArrivalTime
536 _cdr_date_parser_maker('enddate'), #CallCompletionTime
539 #sub { my($cdr, $d ) = @_; $cdr->disposition( $disposition{$d}): },
552 _cdr_date_parser_maker('answerdate'), #DispositionTime
553 sub { my($cdr, $field) = @_; }, #TCAP
554 sub { my($cdr, $field) = @_; }, #OutboundCarrierConnectTime
555 sub { my($cdr, $field) = @_; }, #OutboundCarrierDisconnectTime
558 #it appears channels are actually part of trunk groups, but this data
559 #is interesting and we need a source and destination place to put it
560 'dstchannel', #TermTrunkGroup
563 sub { my($cdr, $field) = @_; }, #TermShelfNumber
564 sub { my($cdr, $field) = @_; }, #TermCardNumber
565 sub { my($cdr, $field) = @_; }, #TermCircuit
566 sub { my($cdr, $field) = @_; }, #TermCircuitType
567 sub { my($cdr, $field) = @_; }, #OutboundCarrierId
568 'charged_party', #BillingNumber
569 sub { my($cdr, $field) = @_; }, #SubscriberNumber
570 'lastapp', #ServiceName
571 sub { my($cdr, $field) = @_; }, #some weirdness #ChargeTime
572 'lastdata', #ServiceInformation
573 sub { my($cdr, $field) = @_; }, #FacilityInfo
574 sub { my($cdr, $field) = @_; }, #all 1900-01-01 0#CallTraceTime
575 sub { my($cdr, $field) = @_; }, #all-1#UniqueIndicator
576 sub { my($cdr, $field) = @_; }, #all-1#PresentationIndicator
577 sub { my($cdr, $field) = @_; }, #empty#Pin
578 sub { my($cdr, $field) = @_; }, #CallType
579 sub { my($cdr, $field) = @_; }, #Balt/empty #OrigRateCenter
580 sub { my($cdr, $field) = @_; }, #Balt/empty #TermRateCenter
583 #it appears channels are actually part of trunk groups, but this data
584 #is interesting and we need a source and destination place to put it
585 'channel', #OrigTrunkGroup
587 'userfield', #empty#UserDefined
588 sub { my($cdr, $field) = @_; }, #empty#PseudoDestinationNumber
589 sub { my($cdr, $field) = @_; }, #all-1#PseudoCarrierCode
590 sub { my($cdr, $field) = @_; }, #empty#PseudoANI
591 sub { my($cdr, $field) = @_; }, #all-1#PseudoFacilityInfo
592 sub { my($cdr, $field) = @_; }, #OrigDialedDigits
593 sub { my($cdr, $field) = @_; }, #all-1#OrigOutboundCarrier
594 sub { my($cdr, $field) = @_; }, #IncomingCarrierID
595 'dcontext', #JurisdictionInfo
596 sub { my($cdr, $field) = @_; }, #OrigDestDigits
597 sub { my($cdr, $field) = @_; }, #huh?#InsertTime
598 sub { my($cdr, $field) = @_; }, #key
599 sub { my($cdr, $field) = @_; }, #empty#AMALineNumber
600 sub { my($cdr, $field) = @_; }, #empty#AMAslpID
601 sub { my($cdr, $field) = @_; }, #empty#AMADigitsDialedWC
602 sub { my($cdr, $field) = @_; }, #OpxOffHook
603 sub { my($cdr, $field) = @_; }, #OpxOnHook
605 #acctid - primary key
606 #AUTO #calldate - Call timestamp (SQL timestamp)
607 #clid - Caller*ID with text
608 #XXX src - Caller*ID number / Source number
609 #XXX dst - Destination extension
610 #dcontext - Destination context
611 #channel - Channel used
612 #dstchannel - Destination channel if appropriate
613 #lastapp - Last application if appropriate
614 #lastdata - Last application data
615 #startdate - Start of call (UNIX-style integer timestamp)
616 #answerdate - Answer time of call (UNIX-style integer timestamp)
617 #enddate - End time of call (UNIX-style integer timestamp)
618 #HACK#duration - Total time in system, in seconds
619 #HACK#XXX billsec - Total time call is up, in seconds
620 #disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
621 #INT amaflags - What flags to use: BILL, IGNORE etc, specified on a per channel basis like accountcode.
622 #accountcode - CDR account number to use: account
624 #uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID)
625 #userfield - CDR user-defined field
627 #X cdrtypenum - CDR type - see FS::cdr_type (Usage = 1, S&E = 7, OC&C = 8)
628 #XXX charged_party - Service number to be billed
629 #upstream_currency - Wholesale currency from upstream
630 #X upstream_price - Wholesale price from upstream
631 #upstream_rateplanid - Upstream rate plan ID
632 #rated_price - Rated (or re-rated) price
633 #distance - km (need units field?)
634 #islocal - Local - 1, Non Local = 0
635 #calltypenum - Type of call - see FS::cdr_calltype
636 #X description - Description (cdr_type 7&8 only) (used for cust_bill_pkg.itemdesc)
637 #quantity - Number of items (cdr_type 7&8 only)
638 #carrierid - Upstream Carrier ID (see FS::cdr_carrier)
639 #upstream_rateid - Upstream Rate ID
641 #svcnum - Link to customer service (see FS::cust_svc)
642 #freesidestatus - NULL, done (or something)
649 'calldate', # may need massaging? huh maybe not...
650 #'billsec', #XXX duration and billsec?
651 sub { $_[0]->billsec( $_[1] );
652 $_[0]->duration( $_[1] );
655 'dst', # XXX needs to have "+61" prepended unless /^\+/ ???
659 'upstream_rateplanid',
663 'startdate', #XXX needs massaging
673 sub { my($cdr, $date) = @_;
674 $date =~ /^(\d{1,2})\/(\d{1,2})\/(\d\d(\d\d)?)$/
675 or die "unparsable date: $date"; #maybe we shouldn't die...
676 #$cdr->startdate( timelocal(0, 0, 0 ,$2, $1-1, $3) );
677 ($tmp_mday, $tmp_mon, $tmp_year) = ( $2, $1-1, $3 );
681 sub { my($cdr, $time) = @_;
682 #my($sec, $min, $hour, $mday, $mon, $year)= localtime($cdr->startdate);
683 $time =~ /^(\d{1,2}):(\d{1,2}):(\d{1,2})$/
684 or die "unparsable time: $time"; #maybe we shouldn't die...
685 #$cdr->startdate( timelocal($3, $2, $1 ,$mday, $mon, $year) );
687 timelocal($3, $2, $1 ,$tmp_mday, $tmp_mon, $tmp_year)
698 sub { my($cdr, $min) = @_;
699 my $sec = sprintf('%.0f', $min * 60 );
700 $cdr->billsec( $sec );
701 $cdr->duration( $sec );
707 my %import_header = (
712 =item batch_import HASHREF
714 Imports CDR records. Available options are:
729 my $fh = $param->{filehandle};
730 my $format = $param->{format};
732 return "Unknown format $format" unless exists $import_formats{$format};
734 eval "use Text::CSV_XS;";
737 my $csv = new Text::CSV_XS;
742 local $SIG{HUP} = 'IGNORE';
743 local $SIG{INT} = 'IGNORE';
744 local $SIG{QUIT} = 'IGNORE';
745 local $SIG{TERM} = 'IGNORE';
746 local $SIG{TSTP} = 'IGNORE';
747 local $SIG{PIPE} = 'IGNORE';
749 my $oldAutoCommit = $FS::UID::AutoCommit;
750 local $FS::UID::AutoCommit = 0;
755 while ( defined($line=<$fh>) ) {
758 if ( ! $body++ && $import_header{$format} ) { #&& $line =~ /^[\w, "]+$/ ) {
762 $csv->parse($line) or do {
763 $dbh->rollback if $oldAutoCommit;
764 return "can't parse: ". $csv->error_input();
767 my @columns = $csv->fields();
768 #warn join('-',@columns);
770 if ( $format eq 'simple' ) {
771 @columns = map { s/^ +//; $_; } @columns;
778 my $field_or_sub = $_;
779 if ( ref($field_or_sub) ) {
780 push @later, $field_or_sub, shift(@columns);
783 ( $field_or_sub => shift @columns );
787 @{ $import_formats{$format} }
790 my $cdr = new FS::cdr ( \%cdr );
792 while ( scalar(@later) ) {
793 my $sub = shift @later;
794 my $data = shift @later;
795 &{$sub}($cdr, $data); # $cdr->&{$sub}($data);
798 if ( $format eq 'taqua' ) {
799 if ( $cdr->enddate && $cdr->startdate ) { #a bit more?
800 $cdr->duration( $cdr->enddate - $cdr->startdate );
802 if ( $cdr->enddate && $cdr->answerdate ) { #a bit more?
803 $cdr->billsec( $cdr->enddate - $cdr->answerdate );
807 my $error = $cdr->insert;
809 $dbh->rollback if $oldAutoCommit;
819 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
821 #might want to disable this if we skip records for any reason...
822 return "Empty file!" unless $imported;
834 L<FS::Record>, schema.html from the base documentation.