add options to skip CDRs under a defined length and with specific lastapp
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
1 package FS::part_pkg::voip_cdr;
2
3 use strict;
4 use vars qw(@ISA $DEBUG %info);
5 use Date::Format;
6 use Tie::IxHash;
7 use FS::Conf;
8 use FS::Record qw(qsearchs qsearch);
9 use FS::part_pkg::flat;
10 use FS::cdr;
11 use FS::rate;
12 use FS::rate_prefix;
13 use FS::rate_detail;
14
15 @ISA = qw(FS::part_pkg::flat);
16
17 $DEBUG = 0;
18
19 tie my %rating_method, 'Tie::IxHash',
20   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
21   '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   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
23 ;
24
25 #tie my %cdr_location, 'Tie::IxHash',
26 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
27 #  'external' => 'External: CDR records queried directly from an external '.
28 #                'Asterisk (or other?) CDR table',
29 #;
30
31 tie my %temporalities, 'Tie::IxHash',
32   'upcoming'  => "Upcoming (future)",
33   'preceding' => "Preceding (past)",
34 ;
35
36 %info = (
37   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
38   'shortname' => 'VoIP/telco CDR rating (standard)',
39   'fields' => {
40     'setup_fee'     => { 'name' => 'Setup fee for this package',
41                          'default' => 0,
42                        },
43     'recur_fee'     => { 'name' => 'Base recurring fee for this package',
44                          'default' => 0,
45                        },
46
47     #false laziness w/flat.pm
48     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
49                              'type' => 'select',
50                              'select_options' => \%temporalities,
51                            },
52
53     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
54                                    ' of service at cancellation',
55                          'type' => 'checkbox',
56                        },
57
58     'rating_method' => { 'name' => 'Region rating method',
59                          'type' => 'radio',
60                          'options' => \%rating_method,
61                        },
62
63     'ratenum'   => { 'name' => 'Rate plan',
64                      'type' => 'select',
65                      'select_table' => 'rate',
66                      'select_key'   => 'ratenum',
67                      'select_label' => 'ratename',
68                    },
69
70     'ignore_unrateable' => { 'name' => 'Ignore calls without a rate in the rate tables.  By default, the system will throw a fatal error upon encountering unrateable calls.',
71                              'type' => 'checkbox',
72                            },
73
74     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
75                           'default' => '+1',
76                         },
77
78     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
79                        'type' => 'checkbox'
80                      },
81
82     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
83                            'default' => '1',
84                          },
85
86 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
87 #                                    'type' => 'checkbox',
88 #                                  },
89
90     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
91                                 'default' => '011',
92                               },
93
94     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
95                             'type' => 'checkbox',
96                           },
97
98     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
99                         'type' => 'checkbox',
100                       },
101
102     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
103                            'type' => 'checkbox',
104                          },
105
106     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
107                                  'type' => 'checkbox',
108                                },
109
110     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
111                          },
112
113     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
114                          },
115
116     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
117                        },
118
119     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
120                                 },
121
122     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
123                               },
124
125     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
126                       },
127
128     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
129                           'type' => 'checkbox',
130                         },
131
132     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
133                       },
134
135     'output_format' => { 'name' => 'CDR invoice display format',
136                          'type' => 'select',
137                          'select_options' => { FS::cdr::invoice_formats() },
138                          'default'        => 'default', #XXX test
139                        },
140
141     'usage_section' => { 'name' => 'Section in which to place separate usage charges',
142                        },
143
144     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
145                           'type' => 'checkbox',
146                         },
147
148     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
149                            'type' => 'checkbox',
150                          },
151
152     #XXX also have option for an external db
153 #    'cdr_location' => { 'name' => 'CDR database location'
154 #                        'type' => 'select',
155 #                        'select_options' => \%cdr_location,
156 #                        'select_callback' => {
157 #                          'external' => {
158 #                            'enable' => [ 'datasrc', 'username', 'password' ],
159 #                          },
160 #                          'internal' => {
161 #                            'disable' => [ 'datasrc', 'username', 'password' ],
162 #                          }
163 #                        },
164 #                      },
165 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
166 #                   'disabled' => 'Y',
167 #                 },
168 #    'username' => { 'name' => 'External database username',
169 #                    'disabled' => 'Y',
170 #                  },
171 #    'password' => { 'name' => 'External database password',
172 #                    'disabled' => 'Y',
173 #                  },
174
175   },
176   'fieldorder' => [qw(
177                        setup_fee recur_fee recur_temporality unused_credit
178                        rating_method ratenum ignore_unrateable
179                        default_prefix
180                        disable_src
181                        domestic_prefix international_prefix
182                        disable_tollfree
183                        use_amaflags use_disposition
184                        use_disposition_taqua use_carrierid use_cdrtypenum
185                        skip_dcontext skip_dstchannel_prefix
186                        skip_dst_length_less skip_lastapp
187                        use_duration
188                        411_rewrite
189                        output_format summarize_usage usage_section
190                        bill_every_call
191                      )
192                   ],
193   'weight' => 40,
194 );
195
196 sub calc_setup {
197   my($self, $cust_pkg ) = @_;
198   $self->option('setup_fee');
199 }
200
201 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
202 sub calc_recur {
203   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
204
205   #my $last_bill = $cust_pkg->last_bill;
206   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
207
208   return 0
209     if $self->option('recur_temporality', 1) eq 'preceding'
210     && ( $last_bill eq '' || $last_bill == 0 );
211
212   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
213
214   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
215
216   my %included_min = ();
217
218   my $charges = 0;
219
220   my $downstream_cdr = '';
221
222   my $rating_method     = $self->option('rating_method') || 'prefix';
223   my $intl              = $self->option('international_prefix') || '011';
224   my $domestic_prefix   = $self->option('domestic_prefix');
225   my $disable_tollfree  = $self->option('disable_tollfree');
226   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
227   my $use_duration      = $self->option('use_duration');
228
229   my $output_format     = $self->option('output_format', 'Hush!')
230                           || ( $rating_method eq 'upstream_simple'
231                                  ? 'simple'
232                                  : 'default'
233                              );
234
235   my @dirass = ();
236   if ( $self->option('411_rewrite') ) {
237     my $dirass = $self->option('411_rewrite');
238     $dirass =~ s/\s//g;
239     @dirass = split(',', $dirass);
240   }
241
242   #for check_chargable, so we don't keep looking up options inside the loop
243   my %opt_cache = ();
244
245   eval "use Text::CSV_XS;";
246   die $@ if $@;
247   my $csv = new Text::CSV_XS;
248
249   foreach my $cust_svc (
250     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
251   ) {
252
253     foreach my $cdr (
254       $cust_svc->get_cdrs_for_update(
255         'disable_src'    => $self->option('disable_src'),
256         'default_prefix' => $self->option('default_prefix'),
257       )  # $last_bill, $$sdate )
258     ) {
259       if ( $DEBUG > 1 ) {
260         warn "rating CDR $cdr\n".
261              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
262       }
263
264       my $rate_detail;
265       my( $rate_region, $regionnum );
266       my $pretty_destnum;
267       my $charge = '';
268       my $classnum = '';
269       my @call_details = ();
270       if ( $rating_method eq 'prefix' ) {
271
272         my $da_rewrote = 0;
273         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
274           $cdr->dst('411');
275           $da_rewrote = 1;
276         }
277
278         my $reason = $self->check_chargable( $cdr,
279                                              'da_rewrote'   => $da_rewrote,
280                                              'option_cache' => \%opt_cache,
281                                            );
282
283         if ( $reason ) {
284
285           warn "not charging for CDR ($reason)\n" if $DEBUG;
286           $charge = 0;
287
288         } else {
289           
290           ###
291           # look up rate details based on called station id
292           # (or calling station id for toll free calls)
293           ###
294
295           my( $to_or_from, $number );
296           if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
297                && ! $disable_tollfree
298               )
299           { #tollfree call
300             $to_or_from = 'from';
301             $number = $cdr->src;
302           } else { #regular call
303             $to_or_from = 'to';
304             $number = $cdr->dst;
305           }
306
307           warn "parsing call $to_or_from $number\n" if $DEBUG;
308
309           #remove non-phone# stuff and whitespace
310           $number =~ s/\s//g;
311 #          my $proto = '';
312 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
313 #          my $siphost = '';
314 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
315
316           #determine the country code
317           my $countrycode;
318           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
319                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
320              )
321           {
322
323             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
324             #first look for 1 digit country code
325             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
326               $countrycode = $one;
327               $number = $u1.$u2.$rest;
328             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
329               $countrycode = $two;
330               $number = $u2.$rest;
331             } else { #3 digit country code
332               $countrycode = $three;
333               $number = $rest;
334             }
335
336           } else {
337             $countrycode = $domestic_prefix || '1';
338             $number =~ s/^$countrycode//;# if length($number) > 10;
339           }
340
341           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
342           $pretty_destnum = "+$countrycode $number";
343
344           my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
345             or die "ratenum $ratenum not found!";
346
347           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
348                                               'phonenum'    => $number,
349                                             });
350
351           if ( $rate_detail ) {
352
353             $rate_region = $rate_detail->dest_region;
354             $regionnum = $rate_region->regionnum;
355             warn "  found rate for regionnum $regionnum ".
356                  "and rate detail $rate_detail\n"
357               if $DEBUG;
358
359           } elsif ( $ignore_unrateable ) {
360
361             $rate_region = '';
362             $regionnum = '';
363             #code below will throw a warning & skip
364
365           } else {
366
367             die "FATAL: no rate_detail found in ".
368                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
369                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
370                 "add a rate or set ignore_unrateable flag on the package def\n";
371           }
372
373         }
374
375       } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used.  very much becoming the odd one out. remove?
376
377         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
378
379           $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
380
381           $regionnum = $rate_detail->dest_regionnum;
382           $rate_region = $rate_detail->dest_region;
383
384           $pretty_destnum = $cdr->dst;
385
386           warn "  found rate for regionnum $regionnum and ".
387                "rate detail $rate_detail\n"
388             if $DEBUG;
389
390         } else { #pass upstream price through
391
392           $charge = sprintf('%.2f', $cdr->upstream_price);
393           $charges += $charge;
394  
395           @call_details = (
396             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
397             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
398             'N/A', #minutes...
399             '$'.$charge,
400             #$pretty_destnum,
401             $cdr->description, #$rate_region->regionname,
402           );
403
404         }
405
406       } elsif ( $rating_method eq 'upstream_simple' ) {
407
408         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
409         $charge = sprintf('%.3f', $cdr->upstream_price);
410         $charges += $charge;
411
412         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
413                                                'charge' => $charge,
414                                              )
415                         );
416         $classnum = $cdr->calltypenum;
417
418       } else {
419         die "don't know how to rate CDRs using method: $rating_method\n";
420       }
421
422       ###
423       # find the price and add detail to the invoice
424       ###
425
426       # if $rate_detail is not found, skip this CDR... i.e. 
427       # don't add it to invoice, don't set its status to done,
428       # don't call downstream_csv or something on it...
429       # but DO emit a warning...
430       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
431       if ( ! $rate_detail && $charge eq '' ) {
432
433         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
434              "; skipping\n"
435
436       } else { # there *is* a rate_detail (or call_details), proceed...
437
438         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
439
440           $included_min{$regionnum} = $rate_detail->min_included
441             unless exists $included_min{$regionnum};
442
443           my $granularity = $rate_detail->sec_granularity;
444
445                       # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
446           my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
447
448           $seconds += $granularity - ( $seconds % $granularity )
449             if $seconds      # don't granular-ize 0 billsec calls (bills them)
450             && $granularity; # 0 is per call
451           my $minutes = sprintf("%.1f", $seconds / 60);
452           $minutes =~ s/\.0$// if $granularity == 60;
453
454           # per call rather than per minute
455           $minutes = 1 unless $granularity;
456
457           $included_min{$regionnum} -= $minutes;
458
459           if ( $included_min{$regionnum} < 0 ) {
460             my $charge_min = 0 - $included_min{$regionnum};
461             $included_min{$regionnum} = 0;
462             $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
463             $charges += $charge;
464           }
465
466           # this is why we need regionnum/rate_region....
467           warn "  (rate region $rate_region)\n" if $DEBUG;
468
469           @call_details = (
470            $cdr->downstream_csv( 'format'         => $output_format,
471                                  'granularity'    => $granularity,
472                                  'minutes'        => $minutes,
473                                  'charge'         => $charge,
474                                  'pretty_dst'     => $pretty_destnum,
475                                  'dst_regionname' => $rate_region->regionname,
476                                )
477           );
478
479           $classnum = $rate_detail->classnum;
480
481         }
482
483         if ( $charge > 0 ) {
484           #just use FS::cust_bill_pkg_detail objects?
485           my $call_details;
486
487           #if ( $self->option('rating_method') eq 'upstream_simple' ) {
488           if ( scalar(@call_details) == 1 ) {
489             $call_details = [ 'C', $call_details[0], $charge, $classnum ];
490           } else { #only used for $rating_method eq 'upstream' now
491             $csv->combine(@call_details);
492             $call_details = [ 'C', $csv->string, $charge, $classnum ];
493           }
494           warn "  adding details on charge to invoice: [ ".
495               join(', ', @{$call_details} ). " ]"
496             if ( $DEBUG && ref($call_details) );
497           push @$details, $call_details; #\@call_details,
498         }
499
500         # if the customer flag is on, call "downstream_csv" or something
501         # like it to export the call downstream!
502         # XXX price plan option to pick format, or something...
503         $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
504           if $spool_cdr;
505
506         my $error = $cdr->set_status_and_rated_price('done', $charge);
507         die $error if $error;
508
509       }
510
511     } # $cdr
512
513   } # $cust_svc
514
515   unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
516     if @$details && $rating_method ne 'upstream';
517
518   if ( $spool_cdr && length($downstream_cdr) ) {
519
520     use FS::UID qw(datasrc);
521     my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
522     mkdir $dir, 0700 unless -d $dir;
523     $dir .= '/'. $cust_pkg->custnum.
524     mkdir $dir, 0700 unless -d $dir;
525     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
526
527     push @{ $param->{'precommit_hooks'} },
528          sub {
529                #lock the downstream spool file and append the records 
530                use Fcntl qw(:flock);
531                use IO::File;
532                my $spool = new IO::File ">>$filename"
533                  or die "can't open $filename: $!\n";
534                flock( $spool, LOCK_EX)
535                  or die "can't lock $filename: $!\n";
536                seek($spool, 0, 2)
537                  or die "can't seek to end of $filename: $!\n";
538                print $spool $downstream_cdr;
539                flock( $spool, LOCK_UN );
540                close $spool;
541              };
542
543   } #if ( $spool_cdr && length($downstream_cdr) )
544
545   $charges += $self->option('recur_fee')
546     if $param->{'increment_next_bill'};
547
548   $charges;
549 }
550
551 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
552 sub check_chargable {
553   my( $self, $cdr, %flags ) = @_;
554
555   #should have some better way of checking these options from a hash
556   #or something
557
558   my @opt = qw(
559     use_amaflags
560     use_disposition
561     use_disposition_taqua
562     use_carrierid
563     use_cdrtypenum
564     skip_dcontext
565     skip_dstchannel_prefix
566     skip_dst_length_less
567     skip_lastapp
568   );
569   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
570     $flags{option_cache}->{$opt} = $self->option($opt);
571   }
572   my %opt = %{ $flags{option_cache} };
573
574   return 'amaflags != 2'
575     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
576
577   return 'disposition != ANSWERED'
578     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
579
580   return "disposition != 100"
581     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
582
583   return "carrierid != $opt{'use_carrierid'}"
584     if length($opt{'use_carrierid'})
585     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
586     && ! $flags{'da_rewrote'};
587
588   return "cdrtypenum != $opt{'use_cdrtypenum'}"
589     if length($opt{'use_cdrtypenum'})
590     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
591
592   return "dcontext IN ( $opt{'skip_dcontext'} )"
593     if $opt{'skip_dcontext'} =~ /\S/
594     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
595
596   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
597   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
598     if $len_prefix
599     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
600
601   my $dst_length = $opt{'skip_dst_length_less'};
602   return "destination less than $dst_length digits"
603     if $dst_length && length($cdr->dst) < $dst_length;
604
605   return "lastapp is $opt{'skip_lastapp'}"
606     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
607
608   #all right then, rate it
609   '';
610 }
611
612 sub is_free {
613   0;
614 }
615
616 sub base_recur {
617   my($self, $cust_pkg) = @_;
618   $self->option('recur_fee');
619 }
620
621 #  This equates svc_phone records; perhaps svc_phone should have a field
622 #  to indicate it represents a line
623 sub calc_units {    
624   my($self, $cust_pkg ) = @_;
625   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
626 }
627
628 1;
629