X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcdr.pm;h=850f797bcd3fb2b39c2056e1d5319bb08f49c4ee;hp=b640bc63e3e3bf138e570e07c630d2b81ebc03ef;hb=bda8c33f9b346ba6cd7aa4174ce0d3e37db7bd49;hpb=aea149aa0ee7d7cae6e0c701ac6d105d615bb4e6 diff --git a/FS/FS/cdr.pm b/FS/FS/cdr.pm index b640bc63e..850f797bc 100644 --- a/FS/FS/cdr.pm +++ b/FS/FS/cdr.pm @@ -1,7 +1,7 @@ package FS::cdr; use strict; -use vars qw( @ISA @EXPORT_OK $DEBUG ); +use vars qw( @ISA @EXPORT_OK $DEBUG $me ); use Exporter; use Tie::IxHash; use Date::Parse; @@ -13,12 +13,14 @@ use FS::Record qw( qsearch qsearchs ); use FS::cdr_type; use FS::cdr_calltype; use FS::cdr_carrier; -use FS::cdr_upstream_rate; +use FS::cdr_batch; +use FS::cdr_termination; @ISA = qw(FS::Record); @EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker ); $DEBUG = 0; +$me = '[FS::cdr]'; =head1 NAME @@ -153,6 +155,55 @@ points to. You can ask the object for a copy with the I method. sub table { 'cdr'; } +sub table_info { + { + 'fields' => { +#XXX fill in some (more) nice names + #'acctid' => '', + 'calldate' => 'Call date', + 'clid' => 'Caller ID', + 'src' => 'Source', + 'dst' => 'Destination', + 'dcontext' => 'Dest. context', + 'channel' => 'Channel', + 'dstchannel' => 'Destination channel', + #'lastapp' => '', + #'lastdata' => '', + 'startdate' => 'Start date', + 'answerdate' => 'Answer date', + 'enddate' => 'End date', + 'duration' => 'Duration', + 'billsec' => 'Billable seconds', + 'disposition' => 'Disposition', + 'amaflags' => 'AMA flags', + 'accountcode' => 'Account code', + #'uniqueid' => '', + 'userfield' => 'User field', + #'cdrtypenum' => '', + 'charged_party' => 'Charged party', + #'upstream_currency' => '', + 'upstream_price' => 'Upstream price', + #'upstream_rateplanid' => '', + #'ratedetailnum' => '', + 'rated_price' => 'Rated price', + #'distance' => '', + #'islocal' => '', + #'calltypenum' => '', + #'description' => '', + #'quantity' => '', + 'carrierid' => 'Carrier ID', + #'upstream_rateid' => '', + 'svcnum' => 'Freeside service', + 'freesidestatus' => 'Freeside status', + 'freesiderewritestatus' => 'Freeside rewrite status', + 'cdrbatch' => 'Legacy batch', + 'cdrbatchnum' => 'Batch', + }, + + }; + +} + =item insert Adds this record to the database. If there is an error, returns the error, @@ -234,6 +285,10 @@ sub check { # ; # return $error if $error; + for my $f ( grep { $self->$_ =~ /\D/ } qw(startdate answerdate enddate)){ + $self->$f( str2time($self->$f) ); + } + $self->calldate( $self->startdate_sql ) if !$self->calldate && $self->startdate; @@ -269,15 +324,19 @@ sub check { $self->SUPER::check; } -=item is_tollfree +=item is_tollfree [ COLUMN ] + +Returns true when the cdr represents a toll free number and false otherwise. - Returns true when the cdr represents a toll free number and false otherwise. +By default, inspects the dst field, but an optional column name can be passed +to inspect other field. =cut sub is_tollfree { my $self = shift; - ( $self->dst =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0; + my $field = scalar(@_) ? shift : 'dst'; + ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0; } =item set_charged_party @@ -295,13 +354,21 @@ or to the dst field if it is a toll free number. sub set_charged_party { my $self = shift; - unless ( $self->charged_party ) { + my $conf = new FS::Conf; - my $conf = new FS::Conf; + unless ( $self->charged_party ) { if ( $conf->exists('cdr-charged_party-accountcode') && $self->accountcode ){ - $self->charged_party( $self->accountcode ); + my $charged_party = $self->accountcode; + $charged_party =~ s/^0+// + if $conf->exists('cdr-charged_party-accountcode-trim_leading_0s'); + $self->charged_party( $charged_party ); + + } elsif ( $conf->exists('cdr-charged_party-field') ) { + + my $field = $conf->config('cdr-charged_party-field'); + $self->charged_party( $self->$field() ); } else { @@ -315,9 +382,17 @@ sub set_charged_party { } +# my $prefix = $conf->config('cdr-charged_party-truncate_prefix'); +# my $prefix_len = length($prefix); +# my $trunc_len = $conf->config('cdr-charged_party-truncate_length'); +# +# $self->charged_party( substr($self->charged_party, 0, $trunc_len) ) +# if $prefix_len && $trunc_len +# && substr($self->charged_party, 0, $prefix_len) eq $prefix; + } -=item set_status_and_rated_price STATUS [ RATED_PRICE ] +=item set_status_and_rated_price STATUS [ RATED_PRICE [ SVCNUM ] ] Sets the status to the provided string. If there is an error, returns the error, otherwise returns false. @@ -325,10 +400,41 @@ 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(); + my($self, $status, $rated_price, $svcnum, %opt) = @_; + + if ($opt{'inbound'}) { + + my $term = qsearchs('cdr_termination', { + acctid => $self->acctid, + termpart => 1 # inbound + }); + my $error; + if ( $term ) { + warn "replacing existing cdr status (".$self->acctid.")\n" if $term; + $error = $term->delete; + return $error if $error; + } + $term = FS::cdr_termination->new({ + acctid => $self->acctid, + termpart => 1, + rated_price => $rated_price, + status => $status, + svcnum => $svcnum, + }); + $term->rated_seconds($opt{rated_seconds}) if exists($opt{rated_seconds}); + $term->rated_minutes($opt{rated_minutes}) if exists($opt{rated_minutes}); + return $term->insert; + + } else { + + $self->freesidestatus($status); + $self->rated_price($rated_price); + $self->rated_seconds($opt{rated_seconds}) if exists($opt{rated_seconds}); + $self->rated_minutes($opt{rated_minutes}) if exists($opt{rated_minutes}); + $self->svcnum($svcnum) if $svcnum; + return $self->replace(); + + } } =item calldate_unix @@ -413,51 +519,11 @@ sub calltypename { $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", @@ -467,6 +533,10 @@ my %export_names = ( 'invoice_header' => "Date,Time,Called From,Destination,Duration,Price", #"Date,Time,Name,Called From,Destination,Duration,Price", }, + 'basic' => { + 'name' => 'Basic', + 'invoice_header' => "Date/Time,Called Number,Min/Sec,Price", + }, 'default' => { 'name' => 'Default', 'invoice_header' => 'Date,Time,Number,Destination,Duration,Price', @@ -479,88 +549,127 @@ my %export_names = ( 'name' => 'Default plus accountcode', 'invoice_header' => 'Date,Time,Account,Number,Destination,Duration,Price', }, + 'description_default' => { + 'name' => 'Default with description field as destination', + 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price', + }, ); -my $duration_sub = sub { - my($cdr, %opt) = @_; - if ( $opt{minutes} ) { - $opt{minutes}. ( $opt{granularity} ? 'm' : ' call' ); - } else { - sprintf('%.2fm', $cdr->billsec / 60 ); - } -}; - -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 - $duration_sub, #DURATION - #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE - sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE - ], - 'simple2' => [ - sub { time2str('%D', shift->calldate_unix ) }, #DATE - sub { time2str('%r', shift->calldate_unix ) }, #TIME - #'userfield', #USER - 'dst', #NUMBER_DIALED - 'src', #called from - $duration_sub, #DURATION - #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE - sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE - ], - 'default' => [ - - #DATE - sub { time2str('%D', shift->calldate_unix ) }, - # #time2str("%Y %b %d - %r", $cdr->calldate_unix ), - - #TIME - sub { time2str('%r', shift->calldate_unix ) }, - # 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 - - #DEST ("Number") - sub { my($cdr, %opt) = @_; $opt{pretty_dst} || $cdr->dst; }, - - #REGIONNAME ("Destination") - sub { my($cdr, %opt) = @_; $opt{dst_regionname}; }, - - #DURATION - $duration_sub, - - #PRICE - sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, - - ], -); -$export_formats{'source_default'} = [ 'src', @{ $export_formats{'default'} }, ]; -$export_formats{'accountcode_default'} = - [ @{ $export_formats{'default'} }[0,1], - 'accountcode', - @{ $export_formats{'default'} }[2..5], - ]; +my %export_formats = (); +sub export_formats { + #my $self = shift; + + return %export_formats if keys %export_formats; + + my $conf = new FS::Conf; + my $date_format = $conf->config('date_format') || '%m/%d/%Y'; + + # call duration in the largest units that accurately reflect the granularity + my $duration_sub = sub { + my($cdr, %opt) = @_; + my $sec = $opt{seconds} || $cdr->billsec; + if ( defined $opt{granularity} && + $opt{granularity} == 0 ) { #per call + return '1 call'; + } + elsif ( defined $opt{granularity} && $opt{granularity} == 60 ) {#full minutes + my $min = int($sec/60); + $min++ if $sec%60; + return $min.'m'; + } + else { #anything else + return sprintf("%dm %ds", $sec/60, $sec%60); + } + }; + + %export_formats = ( + 'simple' => [ + sub { time2str($date_format, shift->calldate_unix ) }, #DATE + sub { time2str('%r', shift->calldate_unix ) }, #TIME + 'userfield', #USER + 'dst', #NUMBER_DIALED + $duration_sub, #DURATION + #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE + sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE + ], + 'simple2' => [ + sub { time2str($date_format, shift->calldate_unix ) }, #DATE + sub { time2str('%r', shift->calldate_unix ) }, #TIME + #'userfield', #USER + 'src', #called from + 'dst', #NUMBER_DIALED + $duration_sub, #DURATION + #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE + sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE + ], + 'basic' => [ + sub { time2str('%d %b - %I:%M %p', shift->calldate_unix) }, + 'dst', + $duration_sub, + sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE + ], + 'default' => [ + + #DATE + sub { time2str($date_format, shift->calldate_unix ) }, + # #time2str("%Y %b %d - %r", $cdr->calldate_unix ), + + #TIME + sub { time2str('%r', shift->calldate_unix ) }, + # 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 + + #DEST ("Number") + sub { my($cdr, %opt) = @_; $opt{pretty_dst} || $cdr->dst; }, + + #REGIONNAME ("Destination") + sub { my($cdr, %opt) = @_; $opt{dst_regionname}; }, + + #DURATION + $duration_sub, + + #PRICE + sub { my($cdr, %opt) = @_; + $opt{charge} = '0.00' unless defined $opt{charge}; + $opt{money_char}.$opt{charge}; + }, + + ], + ); + $export_formats{'source_default'} = [ 'src', @{ $export_formats{'default'} }, ]; + $export_formats{'accountcode_default'} = + [ @{ $export_formats{'default'} }[0,1], + 'accountcode', + @{ $export_formats{'default'} }[2..5], + ]; + my @default = @{ $export_formats{'default'} }; + $export_formats{'description_default'} = + [ 'src', @default[0..2], + sub { my($cdr, %opt) = @_; $cdr->description }, + @default[4,5] ]; + + return %export_formats; +} + +=item downstream_csv OPTION => VALUE ... + +Options: + +format + +charge + +seconds + +granularity + +=cut sub downstream_csv { my( $self, %opt ) = @_; - my $format = $opt{'format'}; # 'convergent'; - return "Unknown format $format" unless exists $export_formats{$format}; + my $format = $opt{'format'}; + my %formats = $self->export_formats; + return "Unknown format $format" unless exists $formats{$format}; #my $conf = new FS::Conf; #$opt{'money_char'} ||= $conf->config('money_char') || '$'; @@ -574,7 +683,9 @@ sub downstream_csv { map { ref($_) ? &{$_}($self, %opt) : $self->$_(); } - @{ $export_formats{$format} }; + @{ $formats{$format} }; + + return @columns if defined $opt{'keeparray'}; my $status = $csv->combine(@columns); die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV" @@ -614,6 +725,50 @@ sub invoice_header { $export_names{$format}->{'invoice_header'}; } +=item clear_status + +Clears cdr and any associated cdr_termination statuses - used for +CDR reprocessing. + +=cut + +sub clear_status { + my $self = shift; + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + $self->freesidestatus(''); + my $error = $self->replace; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + my @cdr_termination = qsearch('cdr_termination', + { 'acctid' => $self->acctid } ); + foreach my $cdr_termination ( @cdr_termination ) { + $cdr_termination->status(''); + $error = $cdr_termination->replace; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + ''; +} + =item import_formats Returns an ordered list of key value pairs containing import format names @@ -696,22 +851,44 @@ sub _cdr_date_parse { my %options = @_; return '' unless length($date); #that's okay, it becomes NULL + return '' if $date eq 'NA'; #sansay + + 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 ) { + my $time = str2time($date); + return $time if $time > 100000; #just in case + } 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|$)/ ) { + 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|$)/ ) { ($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|$)/ ) { + } 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|$)/ ) { + # 8/26/2010 12:20:01 + # optionally without seconds ($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 ); + $sec = 0 if !defined($sec); + } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d+\.\d+)(\D|$)/ ) { + # broadsoft: 20081223201938.314 + ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 ); + } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\d+(\D|$)/ ) { + # Taqua OM: 20050422203450943 + ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 ); + } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})$/ ) { + # WIP: 20100329121420 + ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 ); + } elsif ( $date =~ /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/) { + # Telos + ($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 ); + $options{gmt} = 1; } else { die "unparsable date: $date"; #maybe we shouldn't die... } - return '' if $year == 1900 && $mon == 1 && $day == 1 - && $hour == 0 && $min == 0 && $sec == 0; + return '' if ( $year == 1900 || $year == 1970 ) && $mon == 1 && $day == 1 + && $hour == 0 && $min == 0 && $sec == 0; if ($options{gmt}) { timegm($sec, $min, $hour, $day, $mon-1, $year); @@ -745,14 +922,18 @@ Set true to prevent throwing an error on empty imports =cut my %import_options = ( - 'table' => 'cdr', + 'table' => 'cdr', + + 'batch_keycol' => 'cdrbatchnum', + 'batch_table' => 'cdr_batch', + 'batch_namecol' => 'cdrbatch', 'formats' => { map { $_ => $cdr_info{$_}->{'import_fields'}; } keys %cdr_info }, #drop the || 'csv' to allow auto xls for csv types? - 'format_types' => { map { $_ => ( lc($cdr_info{$_}->{'type'}) || 'csv' ); } + 'format_types' => { map { $_ => lc($cdr_info{$_}->{'type'} || 'csv'); } keys %cdr_info }, @@ -768,6 +949,15 @@ my %import_options = ( { map { $_ => $cdr_info{$_}->{'fixedlength_format'}; } keys %cdr_info }, + + 'format_xml_formats' => + { map { $_ => $cdr_info{$_}->{'xml_format'}; } + keys %cdr_info + }, + + 'format_row_callbacks' => { map { $_ => $cdr_info{$_}->{'row_callback'}; } + keys %cdr_info + }, ); sub _import_options { @@ -780,6 +970,14 @@ sub batch_import { my $iopt = _import_options; $opt->{$_} = $iopt->{$_} foreach keys %$iopt; + if ( defined $opt->{'cdrtypenum'} ) { + $opt->{'preinsert_callback'} = sub { + my($record,$param) = (shift,shift); + $record->cdrtypenum($opt->{'cdrtypenum'}); + ''; + }; + } + FS::Record::batch_import( $opt ); } @@ -792,7 +990,7 @@ sub process_batch_import { my $job = shift; my $opt = _import_options; - $opt->{'params'} = [ 'format', 'cdrbatch' ]; +# $opt->{'params'} = [ 'format', 'cdrbatch' ]; FS::Record::process_batch_import( $job, $opt, @_ ); @@ -801,6 +999,42 @@ sub process_batch_import { # @columns = map { s/^ +//; $_; } @columns; # } +# _ upgrade_data +# +# Used by FS::Upgrade to migrate to a new database. + +sub _upgrade_data { + my ($class, %opts) = @_; + + warn "$me upgrading $class\n" if $DEBUG; + + my $sth = dbh->prepare( + 'SELECT DISTINCT(cdrbatch) FROM cdr WHERE cdrbatch IS NOT NULL' + ) or die dbh->errstr; + + $sth->execute or die $sth->errstr; + + my %cdrbatchnum = (); + while (my $row = $sth->fetchrow_arrayref) { + + my $cdr_batch = qsearchs( 'cdr_batch', { 'cdrbatch' => $row->[0] } ); + unless ( $cdr_batch ) { + $cdr_batch = new FS::cdr_batch { 'cdrbatch' => $row->[0] }; + my $error = $cdr_batch->insert; + die $error if $error; + } + + $cdrbatchnum{$row->[0]} = $cdr_batch->cdrbatchnum; + } + + $sth = dbh->prepare('UPDATE cdr SET cdrbatch = NULL, cdrbatchnum = ? WHERE cdrbatch IS NOT NULL AND cdrbatch = ?') or die dbh->errstr; + + foreach my $cdrbatch (keys %cdrbatchnum) { + $sth->execute($cdrbatchnum{$cdrbatch}, $cdrbatch) or die $sth->errstr; + } + +} + =back =head1 BUGS