1 package FS::part_pkg::voip_cdr;
4 use vars qw(@ISA $DEBUG %info);
8 use FS::Record qw(qsearchs qsearch);
9 use FS::part_pkg::flat;
13 @ISA = qw(FS::part_pkg::flat);
17 tie my %rating_method, 'Tie::IxHash',
18 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
19 'upstream' => 'Rate calls based on upstream data: If the call type is "1", map the upstream rate ID directly to an internal rate (rate_detail), otherwise, pass the upstream price through directly.',
22 #tie my %cdr_location, 'Tie::IxHash',
23 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
24 # 'external' => 'External: CDR records queried directly from an external '.
25 # 'Asterisk (or other?) CDR table',
29 'name' => 'VoIP rating by plan of CDR records in an internal (or external?) SQL table',
31 'setup_fee' => { 'name' => 'Setup fee for this package',
34 'recur_flat' => { 'name' => 'Base recurring fee for this package',
37 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
38 ' of service at cancellation',
41 'ratenum' => { 'name' => 'Rate plan',
43 'select_table' => 'rate',
44 'select_key' => 'ratenum',
45 'select_label' => 'ratename',
47 'rating_method' => { 'name' => 'Region rating method',
49 'select_options' => \%rating_method,
52 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
56 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
60 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
64 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
65 # 'type' => 'checkbox',
68 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
72 #XXX also have option for an external db??
73 # 'cdr_location' => { 'name' => 'CDR database location'
75 # 'select_options' => \%cdr_location,
76 # 'select_callback' => {
78 # 'enable' => [ 'datasrc', 'username', 'password' ],
81 # 'disable' => [ 'datasrc', 'username', 'password' ],
85 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
88 # 'username' => { 'name' => 'External database username',
91 # 'password' => { 'name' => 'External database password',
96 'fieldorder' => [qw( setup_fee recur_flat unused_credit ratenum rating_method default_prefix )],
101 my($self, $cust_pkg ) = @_;
102 $self->option('setup_fee');
105 #false laziness w/voip_sqlradacct... resolve it if that one ever gets used again
107 my($self, $cust_pkg, $sdate, $details, $param ) = @_;
109 my $last_bill = $cust_pkg->last_bill;
111 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
113 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
115 my %included_min = ();
119 my $downstream_cdr = '';
121 foreach my $cust_svc (
122 grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
126 $cust_svc->get_cdrs_for_update() # $last_bill, $$sdate )
129 warn "rating CDR $cdr\n".
130 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
134 my( $rate_region, $regionnum );
137 my @call_details = ();
138 if ( $self->option('rating_method') eq 'prefix'
139 || ! $self->option('rating_method')
144 # look up rate details based on called station id
145 # (or calling station id for toll free calls)
148 my( $to_or_from, $number );
149 if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ ) { #tollfree call
150 $to_or_from = 'from';
152 } else { #regular call
157 #remove non-phone# stuff and whitespace
160 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
162 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
164 my $intl = $self->option('international_prefix') || '011';
166 #determine the country code
168 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
169 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
173 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
174 #first look for 1 digit country code
175 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
177 $number = $u1.$u2.$rest;
178 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
181 } else { #3 digit country code
182 $countrycode = $three;
187 $countrycode = $self->option('domestic_prefix') || '1';
188 $number =~ s/^$countrycode//;# if length($number) > 10;
191 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
192 $pretty_destnum = "+$countrycode $number";
194 #find a rate prefix, first look at most specific (4 digits) then 3, etc.,
195 # finally trying the country code only
196 my $rate_prefix = '';
197 for my $len ( reverse(1..6) ) {
198 $rate_prefix = qsearchs('rate_prefix', {
199 'countrycode' => $countrycode,
200 #'npa' => { op=> 'LIKE', value=> substr($number, 0, $len) }
201 'npa' => substr($number, 0, $len),
204 $rate_prefix ||= qsearchs('rate_prefix', {
205 'countrycode' => $countrycode,
210 die "Can't find rate for call $to_or_from +$countrycode $\numbern"
213 $regionnum = $rate_prefix->regionnum;
214 $rate_detail = qsearchs('rate_detail', {
215 'ratenum' => $ratenum,
216 'dest_regionnum' => $regionnum,
219 $rate_region = $rate_prefix->rate_region;
221 warn " found rate for regionnum $regionnum ".
222 "and rate detail $rate_detail\n"
225 } elsif ( $self->option('rating_method') eq 'upstream' ) {
227 if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
229 $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
231 $regionnum = $rate_detail->dest_regionnum;
232 $rate_region = $rate_detail->dest_region;
234 $pretty_destnum = $cdr->dst;
236 warn " found rate for regionnum $regionnum and ".
237 "rate detail $rate_detail\n"
240 } else { #pass upstream price through
242 $charge = sprintf('%.2f', $cdr->upstream_price);
245 #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
246 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
250 $cdr->description, #$rate_region->regionname,
256 die "don't know how to rate CDRs using method: ".
257 $self->option('rating_method'). "\n";
261 # find the price and add detail to the invoice
264 # if $rate_detail is not found, skip this CDR... i.e.
265 # don't add it to invoice, don't set its status to NULL,
266 # don't call downstream_csv or something on it...
267 # but DO emit a warning...
268 if ( ! $rate_detail && ! scalar(@call_details) ) {
270 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
273 } else { # there *is* a rate_detail (or call_details), proceed...
275 unless ( @call_details ) {
277 $included_min{$regionnum} = $rate_detail->min_included
278 unless exists $included_min{$regionnum};
280 my $granularity = $rate_detail->sec_granularity;
281 my $seconds = $cdr->billsec; # |ength($cdr->billsec) ? $cdr->billsec : $cdr->duration;
282 $seconds += $granularity - ( $seconds % $granularity )
283 if $granularity; # 0 is per call
284 my $minutes = sprintf("%.1f", $seconds / 60);
285 $minutes =~ s/\.0$// if $granularity == 60;
287 # per call rather than per minute
288 $minutes = 1 unless $granularity;
290 $included_min{$regionnum} -= $minutes;
292 if ( $included_min{$regionnum} < 0 ) {
293 my $charge_min = 0 - $included_min{$regionnum};
294 $included_min{$regionnum} = 0;
295 $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
299 # this is why we need regionnum/rate_region....
300 warn " (rate region $rate_region)\n" if $DEBUG;
303 #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
304 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
305 $granularity ? $minutes.'m' : $minutes.' call',
308 $rate_region->regionname,
313 warn " adding details on charge to invoice: ".
314 join(' - ', @call_details )
317 push @$details, join(' - ', @call_details); #\@call_details,
319 # if the customer flag is on, call "downstream_csv" or something
320 # like it to export the call downstream!
321 # XXX price plan option to pick format, or something...
322 $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
325 my $error = $cdr->set_status_and_rated_price('done', $charge);
326 die $error if $error;
334 if ( $spool_cdr && length($downstream_cdr) ) {
336 use FS::UID qw(datasrc);
337 my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
338 mkdir $dir, 0700 unless -d $dir;
339 $dir .= '/'. $cust_pkg->custnum.
340 mkdir $dir, 0700 unless -d $dir;
341 my $filename = time2str("$dir/CDR%Y%m%d-spool.CSV", time); #XXX invoice date instead? would require changing the order things are generated in cust_main::bill insert cust_bill first - with transactions it could be done though
343 push @{ $param->{'precommit_hooks'} },
345 #lock the downstream spool file and append the records
346 use Fcntl qw(:flock);
348 my $spool = new IO::File ">>$filename"
349 or die "can't open $filename: $!\n";
350 flock( $spool, LOCK_EX)
351 or die "can't lock $filename: $!\n";
353 or die "can't seek to end of $filename: $!\n";
354 print $spool $downstream_cdr;
355 flock( $spool, LOCK_UN );
359 } #if ( $spool_cdr && length($downstream_cdr) )
361 $self->option('recur_flat') + $charges;
370 my($self, $cust_pkg) = @_;
371 $self->option('recur_flat');