X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcdr.pm;h=79a687e7ff0ef09b0c6e3a4a544c06d9668b80bd;hb=235173ad9493f90dba2842cd33aa886cacbbee15;hp=2d40177f59434ca40e1758c9379560b6105dac49;hpb=fadaa67e77ad8d5d966e252aba7f193e9e3840e3;p=freeside.git diff --git a/FS/FS/cdr.pm b/FS/FS/cdr.pm index 2d40177f5..79a687e7f 100644 --- a/FS/FS/cdr.pm +++ b/FS/FS/cdr.pm @@ -1,15 +1,23 @@ package FS::cdr; use strict; -use vars qw( @ISA ); +use vars qw( @ISA @EXPORT_OK $DEBUG ); +use Exporter; +use Tie::IxHash; use Date::Parse; +use Date::Format; +use Time::Local; use FS::UID qw( dbh ); use FS::Record qw( qsearch qsearchs ); use FS::cdr_type; use FS::cdr_calltype; use FS::cdr_carrier; +use FS::cdr_upstream_rate; @ISA = qw(FS::Record); +@EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker ); + +$DEBUG = 0; =head1 NAME @@ -81,8 +89,6 @@ following fields are currently supported: #billing: Mark the entry for billing #documentation: Mark the entry for documentation. -=back - =item accountcode - CDR account number to use: account =item uniqueid - Unique channel identifier (Unitel/RSLCOM Event ID) @@ -99,6 +105,8 @@ following fields are currently supported: =item upstream_rateplanid - Upstream rate plan ID +=item rated_price - Rated (or re-rated) price + =item distance - km (need units field?) =item islocal - Local - 1, Non Local = 0 @@ -115,13 +123,13 @@ following fields are currently supported: #Telstra =1, Optus = 2, RSL COM = 3 -=back - =item upstream_rateid - Upstream Rate ID =item svcnum - Link to customer service (see L) -=item freesidestatus - NULL, done, skipped, pushed_downstream (or something) +=item freesidestatus - NULL, done (or something) + +=item cdrbatch =back @@ -222,84 +230,423 @@ sub check { # ; # return $error if $error; + $self->calldate( $self->startdate_sql ) + if !$self->calldate && $self->startdate; + + unless ( $self->charged_party ) { + if ( $self->dst =~ /^(\+?1)?8[02-8]{2}/ ) { + $self->charged_party($self->dst); + } else { + $self->charged_party($self->src); + } + } + #check the foreign keys even? #do we want to outright *reject* the CDR? my $error = $self->ut_numbern('acctid') - #Usage = 1, S&E = 7, OC&C = 8 - || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' ) - - #the big list in appendix 2 - || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' ) - - # Telstra =1, Optus = 2, RSL COM = 3 - || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' ) + #add a config option to turn these back on if someone needs 'em + # + # #Usage = 1, S&E = 7, OC&C = 8 + # || $self->ut_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' ) + # + # #the big list in appendix 2 + # || $self->ut_foreign_keyn('calltypenum', 'cdr_calltype', 'calltypenum' ) + # + # # Telstra =1, Optus = 2, RSL COM = 3 + # || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' ) ; return $error if $error; $self->SUPER::check; } -my %formats = ( - 'asterisk' => [ - 'accountcode', - 'src', - 'dst', - 'dcontext', - 'clid', - 'channel', - 'dstchannel', - 'lastapp', - 'lastdata', - 'startdate', # XXX will need massaging - 'answer', # XXX same - 'end', # XXX same - 'duration', - 'billsec', - 'disposition', - 'amaflags', - 'uniqueid', - 'userfield', +=item set_status_and_rated_price STATUS [ RATED_PRICE ] + +Sets the status to the provided string. If there is an error, returns the +error, otherwise returns false. + +=cut + +sub set_status_and_rated_price { + my($self, $status, $rated_price) = @_; + $self->freesidestatus($status); + $self->rated_price($rated_price); + $self->replace(); +} + +=item calldate_unix + +Parses the calldate in SQL string format and returns a UNIX timestamp. + +=cut + +sub calldate_unix { + str2time(shift->calldate); +} + +=item startdate_sql + +Parses the startdate in UNIX timestamp format and returns a string in SQL +format. + +=cut + +sub startdate_sql { + my($sec,$min,$hour,$mday,$mon,$year) = localtime(shift->startdate); + $mon++; + $year += 1900; + "$year-$mon-$mday $hour:$min:$sec"; +} + +=item cdr_carrier + +Returns the FS::cdr_carrier object associated with this CDR, or false if no +carrierid is defined. + +=cut + +my %carrier_cache = (); + +sub cdr_carrier { + my $self = shift; + return '' unless $self->carrierid; + $carrier_cache{$self->carrierid} ||= + qsearchs('cdr_carrier', { 'carrierid' => $self->carrierid } ); +} + +=item carriername + +Returns the carrier name (see L), or the empty string if +no FS::cdr_carrier object is assocated with this CDR. + +=cut + +sub carriername { + my $self = shift; + my $cdr_carrier = $self->cdr_carrier; + $cdr_carrier ? $cdr_carrier->carriername : ''; +} + +=item cdr_calltype + +Returns the FS::cdr_calltype object associated with this CDR, or false if no +calltypenum is defined. + +=cut + +my %calltype_cache = (); + +sub cdr_calltype { + my $self = shift; + return '' unless $self->calltypenum; + $calltype_cache{$self->calltypenum} ||= + qsearchs('cdr_calltype', { 'calltypenum' => $self->calltypenum } ); +} + +=item calltypename + +Returns the call type name (see L), or the empty string if +no FS::cdr_calltype object is assocated with this CDR. + +=cut + +sub calltypename { + my $self = shift; + my $cdr_calltype = $self->cdr_calltype; + $cdr_calltype ? $cdr_calltype->calltypename : ''; +} + +=item cdr_upstream_rate + +Returns the upstream rate mapping (see L), or the empty +string if no FS::cdr_upstream_rate object is associated with this CDR. + +=cut + +sub cdr_upstream_rate { + my $self = shift; + return '' unless $self->upstream_rateid; + qsearchs('cdr_upstream_rate', { 'upstream_rateid' => $self->upstream_rateid }) + or ''; +} + +=item _convergent_format COLUMN [ COUNTRYCODE ] + +Returns the number in COLUMN formatted as follows: + +If the country code does not match COUNTRYCODE (default "61"), it is returned +unchanged. + +If the country code does match COUNTRYCODE (default "61"), it is removed. In +addiiton, "0" is prepended unless the number starts with 13, 18 or 19. (???) + +=cut + +sub _convergent_format { + my( $self, $field ) = ( shift, shift ); + my $countrycode = scalar(@_) ? shift : '61'; #+61 = australia + #my $number = $self->$field(); + my $number = $self->get($field); + #if ( $number =~ s/^(\+|011)$countrycode// ) { + if ( $number =~ s/^\+$countrycode// ) { + $number = "0$number" + unless $number =~ /^1[389]/; #??? + } + $number; +} + +=item downstream_csv [ OPTION => VALUE, ... ] + +=cut + +my %export_names = ( + 'convergent' => {}, + 'simple' => { 'name' => 'Simple', + 'invoice_header' => + "Date,Time,Name,Destination,Duration,Price", + }, + 'simple2' => { 'name' => 'Simple with source', + 'invoice_header' => + #"Date,Time,Name,Called From,Destination,Duration,Price", + "Date,Time,Called From,Destination,Duration,Price", + }, +); + +my %export_formats = ( + 'convergent' => [ + 'carriername', #CARRIER + sub { shift->_convergent_format('src') }, #SERVICE_NUMBER + sub { shift->_convergent_format('charged_party') }, #CHARGED_NUMBER + sub { time2str('%Y-%m-%d', shift->calldate_unix ) }, #DATE + sub { time2str('%T', shift->calldate_unix ) }, #TIME + 'billsec', #'duration', #DURATION + sub { shift->_convergent_format('dst') }, #NUMBER_DIALED + '', #XXX add (from prefixes in most recent email) #FROM_DESC + '', #XXX add (from prefixes in most recent email) #TO_DESC + 'calltypename', #CLASS_CODE + 'rated_price', #PRICE + sub { shift->rated_price ? 'Y' : 'N' }, #RATED + '', #OTHER_INFO + ], + 'simple' => [ + sub { time2str('%D', shift->calldate_unix ) }, #DATE + sub { time2str('%r', shift->calldate_unix ) }, #TIME + 'userfield', #USER + 'dst', #NUMBER_DIALED + sub { sprintf('%.2fm', shift->billsec / 60 ) }, #DURATION + sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE + ], + 'simple2' => [ + sub { time2str('%D', shift->calldate_unix ) }, #DATE + sub { time2str('%r', shift->calldate_unix ) }, #TIME + #'userfield', #USER + 'dst', #NUMBER_DIALED + 'src', #called from + sub { sprintf('%.2fm', shift->billsec / 60 ) }, #DURATION + sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE ], - 'unitel' => [ - 'uniqueid', - 'cdr_type', - 'calldate', # XXX may need massaging - 'billsec', #XXX duration and billsec? - # sub { $_[0]->billsec( $_[1] ); - # $_[0]->duration( $_[1] ); - # }, - 'src', - 'dst', - 'charged_party', - 'upstream_currency', - 'upstream_price', - 'upstream_rateplanid', - 'distance', - 'islocal', - 'calltypenum', - 'startdate', # XXX will definitely need massaging - 'enddate', # XXX same - 'description', - 'quantity', - 'carrierid', - 'upstream_rateid', - ] ); +sub downstream_csv { + my( $self, %opt ) = @_; + + my $format = $opt{'format'}; # 'convergent'; + return "Unknown format $format" unless exists $export_formats{$format}; + + eval "use Text::CSV_XS;"; + die $@ if $@; + my $csv = new Text::CSV_XS; + + my @columns = + map { + ref($_) ? &{$_}($self) : $self->$_(); + } + @{ $export_formats{$format} }; + + my $status = $csv->combine(@columns); + die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV" + unless $status; + + $csv->string; + +} + +=back + +=head1 CLASS METHODS + +=over 4 + +=item invoice_formats + +Returns an ordered list of key value pairs containing invoice format names +as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values. + +=cut + +sub invoice_formats { + map { ($_ => $export_names{$_}->{'name'}) } + grep { $export_names{$_}->{'invoice_header'} } + keys %export_names; +} + +=item invoice_header FORMAT + +Returns a scalar containing the CSV column header for invoice format FORMAT. + +=cut + +sub invoice_header { + my $format = shift; + $export_names{$format}->{'invoice_header'}; +} + +=item import_formats + +Returns an ordered list of key value pairs containing import format names +as keys (for use with batch_import) and "pretty" format names as values. + +=cut + +#false laziness w/part_pkg & part_export + +my %cdr_info; +foreach my $INC ( @INC ) { + warn "globbing $INC/FS/cdr/*.pm\n" if $DEBUG; + foreach my $file ( glob("$INC/FS/cdr/*.pm") ) { + warn "attempting to load CDR format info from $file\n" if $DEBUG; + $file =~ /\/(\w+)\.pm$/ or do { + warn "unrecognized file in $INC/FS/cdr/: $file\n"; + next; + }; + my $mod = $1; + my $info = eval "use FS::cdr::$mod; ". + "\\%FS::cdr::$mod\::info;"; + if ( $@ ) { + die "error using FS::cdr::$mod (skipping): $@\n" if $@; + next; + } + unless ( keys %$info ) { + warn "no %info hash found in FS::cdr::$mod, skipping\n"; + next; + } + warn "got CDR format info from FS::cdr::$mod: $info\n" if $DEBUG; + if ( exists($info->{'disabled'}) && $info->{'disabled'} ) { + warn "skipping disabled CDR format FS::cdr::$mod" if $DEBUG; + next; + } + $cdr_info{$mod} = $info; + } +} + +tie my %import_formats, 'Tie::IxHash', + map { $_ => $cdr_info{$_}->{'name'} } + sort { $cdr_info{$a}->{'weight'} <=> $cdr_info{$b}->{'weight'} } + grep { exists($cdr_info{$_}->{'import_fields'}) } + keys %cdr_info; + +sub import_formats { + %import_formats; +} + +sub _cdr_min_parser_maker { + my $field = shift; + my @fields = ref($field) ? @$field : ($field); + @fields = qw( billsec duration ) unless scalar(@fields); + return sub { + my( $cdr, $min ) = @_; + my $sec = eval { _cdr_min_parse($min) }; + die "error parsing seconds for @fields from $min minutes: $@\n" if $@; + $cdr->$_($sec) foreach @fields; + }; +} + +sub _cdr_min_parse { + my $min = shift; + sprintf('%.0f', $min * 60 ); +} + +sub _cdr_date_parser_maker { + my $field = shift; + return sub { + my( $cdr, $date ) = @_; + #$cdr->$field( _cdr_date_parse($date) ); + eval { $cdr->$field( _cdr_date_parse($date) ); }; + die "error parsing date for $field from $date: $@\n" if $@; + }; +} + +sub _cdr_date_parse { + my $date = shift; + + return '' unless length($date); #that's okay, it becomes NULL + + my($year, $mon, $day, $hour, $min, $sec); + + #$date =~ /^\s*(\d{4})[\-\/]\(\d{1,2})[\-\/](\d{1,2})\s+(\d{1,2}):(\d{1,2}):(\d{1,2})\s*$/ + #taqua #2007-10-31 08:57:24.113000000 + + 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|$)/ ) { + ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 ); + } 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|$)/ ) { + ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 ); + } else { + die "unparsable date: $date"; #maybe we shouldn't die... + } + + return '' if $year == 1900 && $mon == 1 && $day == 1 + && $hour == 0 && $min == 0 && $sec == 0; + + timelocal($sec, $min, $hour, $day, $mon-1, $year); +} + +=item batch_import HASHREF + +Imports CDR records. Available options are: + +=over 4 + +=item filehandle + +=item format + +=back + +=cut + sub batch_import { my $param = shift; my $fh = $param->{filehandle}; my $format = $param->{format}; + my $cdrbatch = $param->{cdrbatch}; - return "Unknown format $format" unless exists $formats{$format}; + return "Unknown format $format" + unless exists( $cdr_info{$format} ) + && exists( $cdr_info{$format}->{'import_fields'} ); - eval "use Text::CSV_XS;"; - die $@ if $@; + my $info = $cdr_info{$format}; - my $csv = new Text::CSV_XS; + my $type = exists($info->{'type'}) ? lc($info->{'type'}) : 'csv'; + + my $parser; + if ( $type eq 'csv' ) { + eval "use Text::CSV_XS;"; + die $@ if $@; + my %attr = (); + foreach ( grep exists($info->{$_}), qw( sep_char ) ) { + $attr{$_} = $info->{$_}; + } + $parser = new Text::CSV_XS \%attr; + } elsif ( $type eq 'fixedlength' ) { + eval "use Parse::FixedLength;"; + die $@ if $@; + $parser = new Parse::FixedLength $info->{'fixedlength_format'}; + } else { + die "Unknown CDR format type $type for format $format\n"; + } my $imported = 0; #my $columns; @@ -314,18 +661,38 @@ sub batch_import { my $oldAutoCommit = $FS::UID::AutoCommit; local $FS::UID::AutoCommit = 0; my $dbh = dbh; - + + my $header_lines = exists($info->{'header'}) ? $info->{'header'} : 0; + my $line; while ( defined($line=<$fh>) ) { - $csv->parse($line) or do { - $dbh->rollback if $oldAutoCommit; - return "can't parse: ". $csv->error_input(); - }; + next if $header_lines-- > 0; #&& $line =~ /^[\w, "]+$/ + + my @columns = (); + if ( $type eq 'csv' ) { + + $parser->parse($line) or do { + $dbh->rollback if $oldAutoCommit; + return "can't parse: ". $parser->error_input(); + }; + + @columns = $parser->fields(); + + } elsif ( $type eq 'fixedlength' ) { + + @columns = $parser->parse($line); + + } else { + die "Unknown CDR format type $type for format $format\n"; + } - my @columns = $csv->fields(); #warn join('-',@columns); + if ( $format eq 'simple' ) { #should be a callback or opt in FS::cdr::simple + @columns = map { s/^ +//; $_; } @columns; + } + my @later = (); my %cdr = map { @@ -339,8 +706,10 @@ sub batch_import { } } - @{ $formats{$format} } + @{ $info->{'import_fields'} } ; + + $cdr{cdrbatch} = $cdrbatch; my $cdr = new FS::cdr ( \%cdr ); @@ -350,6 +719,15 @@ sub batch_import { &{$sub}($cdr, $data); # $cdr->&{$sub}($data); } + if ( $format eq 'taqua' ) { #should be a callback or opt in FS::cdr::taqua + if ( $cdr->enddate && $cdr->startdate ) { #a bit more? + $cdr->duration( $cdr->enddate - $cdr->startdate ); + } + if ( $cdr->enddate && $cdr->answerdate ) { #a bit more? + $cdr->billsec( $cdr->enddate - $cdr->answerdate ); + } + } + my $error = $cdr->insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; @@ -365,7 +743,7 @@ sub batch_import { $dbh->commit or die $dbh->errstr if $oldAutoCommit; #might want to disable this if we skip records for any reason... - return "Empty file!" unless $imported; + return "Empty file!" unless $imported || $param->{empty_ok}; '';