FS/FS/part_pkg/voip_inbound.pm

   1 package FS::part_pkg::voip_inbound;
   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::recur_Common;
  10 use FS::cdr;
  11 use FS::part_pkg::recur_Common;
  12
  13 @ISA = qw(FS::part_pkg::recur_Common);
  14
  15 $DEBUG = 0;
  16
  17 tie my %temporalities, 'Tie::IxHash',
  18   'upcoming'  => "Upcoming (future)",
  19   'preceding' => "Preceding (past)",
  20 ;
  21
  22 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
  23
  24 %info = (
  25   'name' => 'VoIP flat rate pricing of CDRs for inbound calls',
  26   'shortname' => 'VoIP/telco CDR rating (inbound)',
  27   'inherit_fields' => [ 'global_Mixin' ],
  28   'fields' => {
  29     #false laziness w/flat.pm
  30     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
  31                              'type' => 'select',
  32                              'select_options' => \%temporalities,
  33                            },
  34     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
  35                                    'subscription',
  36                          'default' => '1',
  37                        },
  38     'add_full_period'=> { 'name' => 'When prorating first month, also bill '.
  39                                     'for one full period after that',
  40                           'type' => 'checkbox',
  41                         },
  42
  43     'recur_method'  => { 'name' => 'Recurring fee method',
  44                          'type' => 'select',
  45                          'select_options' => \%FS::part_pkg::recur_Common::recur_method,
  46                        },
  47
  48     'min_charge' => { 'name' => 'Charge per minute',
  49                     },
  50
  51     'min_included' => { 'name' => 'Minutes included',
  52                     },
  53
  54     'sec_granularity' => { 'name' => 'Granularity',
  55                            'type' => 'select',
  56                            'select_options' => \%granularity,
  57                          },
  58
  59     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
  60                           'default' => '+1',
  61                         },
  62
  63     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
  64                             'type' => 'checkbox',
  65                           },
  66
  67     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
  68                         'type' => 'checkbox',
  69                       },
  70
  71     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
  72                            'type' => 'checkbox',
  73                          },
  74
  75     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
  76                                  'type' => 'checkbox',
  77                                },
  78
  79     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
  80                          },
  81
  82     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
  83                          },
  84
  85     'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
  86                          },
  87
  88     'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
  89                          },
  90
  91     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
  92                        },
  93
  94     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
  95                                 },
  96
  97     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
  98                               },
  99
 100     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
 101                       },
 102
 103     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 104                           'type' => 'checkbox',
 105                         },
 106
 107     #false laziness w/cdr_termination.pm
 108     'output_format' => { 'name' => 'CDR invoice display format',
 109                          'type' => 'select',
 110                          'select_options' => { FS::cdr::invoice_formats() },
 111                          'default'        => 'default', #XXX test
 112                        },
 113
 114     'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not)',
 115                        },
 116
 117     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 118                           'type' => 'checkbox',
 119                         },
 120
 121     'usage_mandate' => { 'name' => 'Always put usage details in separate section',
 122                           'type' => 'checkbox',
 123                        },
 124     #eofalse
 125
 126     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
 127                            'type' => 'checkbox',
 128                          },
 129
 130     #XXX also have option for an external db
 131 #    'cdr_location' => { 'name' => 'CDR database location'
 132 #                        'type' => 'select',
 133 #                        'select_options' => \%cdr_location,
 134 #                        'select_callback' => {
 135 #                          'external' => {
 136 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 137 #                          },
 138 #                          'internal' => {
 139 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 140 #                          }
 141 #                        },
 142 #                      },
 143 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 144 #                   'disabled' => 'Y',
 145 #                 },
 146 #    'username' => { 'name' => 'External database username',
 147 #                    'disabled' => 'Y',
 148 #                  },
 149 #    'password' => { 'name' => 'External database password',
 150 #                    'disabled' => 'Y',
 151 #                  },
 152
 153   },
 154   'fieldorder' => [qw(
 155                        recur_temporality
 156                        recur_method cutoff_day add_full_period
 157                        min_charge min_included sec_granularity
 158                        default_prefix
 159                        disable_tollfree
 160                        use_amaflags use_disposition
 161                        use_disposition_taqua use_carrierid
 162                        use_cdrtypenum ignore_cdrtypenum
 163                        ignore_disposition
 164                        skip_dcontext skip_dstchannel_prefix
 165                        skip_dst_length_less skip_lastapp
 166                        use_duration
 167                        output_format usage_mandate summarize_usage usage_section
 168                        bill_every_call
 169                      )
 170                   ],
 171   'weight' => 40,
 172 );
 173
 174 sub price_info {
 175     my $self = shift;
 176     my $str = $self->SUPER::price_info;
 177     $str .= " plus usage" if $str;
 178     $str;
 179 }
 180
 181 sub calc_setup {
 182   my($self, $cust_pkg ) = @_;
 183   $self->option('setup_fee');
 184 }
 185
 186 sub calc_recur {
 187   my $self = shift;
 188   my($cust_pkg, $sdate, $details, $param ) = @_;
 189
 190   my $charges = 0;
 191
 192   $charges += $self->calc_usage(@_);
 193   $charges += $self->calc_recur_Common(@_);
 194
 195   $charges;
 196
 197 }
 198
 199 sub calc_cancel {
 200   my $self = shift;
 201   my($cust_pkg, $sdate, $details, $param ) = @_;
 202
 203   $self->calc_usage(@_);
 204 }
 205
 206 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 207
 208 sub calc_usage {
 209   my $self = shift;
 210   my($cust_pkg, $sdate, $details, $param ) = @_;
 211
 212   #my $last_bill = $cust_pkg->last_bill;
 213   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 214
 215   return 0
 216     if $self->recur_temporality eq 'preceding'
 217     && ( $last_bill eq '' || $last_bill == 0 );
 218
 219   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 220
 221   my $included_min = ($self->option('min_included')
 222                         && $self->option('min_included') > 0)
 223                                         ? $self->option('min_included') : 0;
 224
 225   my $charges = 0;
 226
 227 #  my $downstream_cdr = '';
 228
 229   my $disable_tollfree  = $self->option('disable_tollfree');
 230   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
 231   my $use_duration      = $self->option('use_duration');
 232
 233   my $output_format     = $self->option('output_format', 'Hush!') || 'default';
 234
 235   #for check_chargable, so we don't keep looking up options inside the loop
 236   my %opt_cache = ();
 237
 238   eval "use Text::CSV_XS;";
 239   die $@ if $@;
 240   my $csv = new Text::CSV_XS;
 241
 242   foreach my $cust_svc (
 243     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
 244   ) {
 245     my $svc_phone = $cust_svc->svc_x;
 246
 247     foreach my $cdr ( $svc_phone->get_cdrs(
 248       'for_update'     => 1,
 249       'status'         => '', # unprocessed only
 250       'default_prefix' => $self->option('default_prefix'),
 251       'inbound'        => 1,
 252       )
 253     ) {
 254       if ( $DEBUG > 1 ) {
 255         warn "rating inbound CDR $cdr\n".
 256              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 257       }
 258       my $granularity = length($self->option('sec_granularity'))
 259                           ? $self->option('sec_granularity')
 260                           : 60;
 261
 262       my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
 263
 264       $seconds += $granularity - ( $seconds % $granularity )
 265         if $seconds      # don't granular-ize 0 billsec calls (bills them)
 266         && $granularity; # 0 is per call
 267       my $minutes = sprintf("%.1f",$seconds / 60);
 268       $minutes =~ s/\.0$// if $granularity == 60; # count whole minutes, convert to integer
 269       $minutes = 1 unless $granularity; # per call
 270
 271       my $charge_min = $minutes;
 272       my $charge = 0;
 273
 274       $included_min -= $minutes;
 275       if ( $included_min > 0 ) {
 276         $charge_min = 0;
 277       }
 278       else {
 279          $charge_min = 0 - $included_min;
 280          $included_min = 0;
 281       }
 282
 283       $charge = sprintf('%.2f', ( $self->option('min_charge') * $charge_min )
 284                                 + 0.00000001 ); #so 1.00005 rounds to 1.0001
 285
 286       if ( $charge > 0 ) {
 287         $charges += $charge;
 288         my @call_details = ($cdr->downstream_csv( 'format' => $output_format,
 289                                             'charge'  => $charge,
 290                                             'minutes' => $minutes,
 291                                             'granularity' => $granularity,
 292                                           )
 293                                 );
 294         push @$details,
 295             [ 'C',
 296               $call_details[0],
 297               $charge,
 298               $cdr->calltypenum, #classnum
 299               $self->phonenum,
 300               $cdr->accountcode,
 301               $seconds,
 302               '', #regionname, not set for inbound calls
 303             ];
 304      }
 305
 306      my $error = $cdr->set_status_and_rated_price( 'done',
 307                                                   $charge,
 308                                                   $cust_svc->svcnum,
 309                                                   'inbound' => 1 );
 310      die $error if $error;
 311
 312     } #$cdr
 313   } # $cust_svc
 314   unshift @$details, [ 'C',
 315                        FS::cdr::invoice_header($output_format),
 316                        '',
 317                        '',
 318                        '',
 319                        '',
 320                        '',
 321                      ]
 322     if @$details;
 323
 324   $charges;
 325 }
 326
 327 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 328 sub check_chargable {
 329   my( $self, $cdr, %flags ) = @_;
 330
 331   #should have some better way of checking these options from a hash
 332   #or something
 333
 334   my @opt = qw(
 335     use_amaflags
 336     use_disposition
 337     use_disposition_taqua
 338     use_carrierid
 339     use_cdrtypenum
 340     ignore_cdrtypenum
 341     ignore_disposition
 342     skip_dcontext
 343     skip_dstchannel_prefix
 344     skip_dst_length_less
 345     skip_lastapp
 346   );
 347   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
 348     $flags{option_cache}->{$opt} = $self->option($opt, 1);
 349   }
 350   my %opt = %{ $flags{option_cache} };
 351
 352   return 'amaflags != 2'
 353     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
 354
 355   return 'disposition != ANSWERED'
 356     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
 357
 358   return "disposition != 100"
 359     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
 360
 361   return "disposition IN ( $opt{'ignore_disposition'} )"
 362     if $opt{'ignore_disposition'} =~ /\S/
 363     && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'ignore_disposition'});
 364
 365   return "carrierid != $opt{'use_carrierid'}"
 366     if length($opt{'use_carrierid'})
 367     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
 368     && ! $flags{'da_rewrote'};
 369
 370   return "cdrtypenum != $opt{'use_cdrtypenum'}"
 371     if length($opt{'use_cdrtypenum'})
 372     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
 373
 374   return "cdrtypenum == $opt{'ignore_cdrtypenum'}"
 375     if length($opt{'ignore_cdrtypenum'})
 376     && $cdr->cdrtypenum eq $opt{'ignore_cdrtypenum'}; #eq otherwise 0 matches ''
 377
 378   return "dcontext IN ( $opt{'skip_dcontext'} )"
 379     if $opt{'skip_dcontext'} =~ /\S/
 380     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
 381
 382   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
 383   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
 384     if $len_prefix
 385     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
 386
 387   my $dst_length = $opt{'skip_dst_length_less'};
 388   return "destination less than $dst_length digits"
 389     if $dst_length && length($cdr->dst) < $dst_length;
 390
 391   return "lastapp is $opt{'skip_lastapp'}"
 392     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
 393
 394   #all right then, rate it
 395   '';
 396 }
 397
 398 sub is_free {
 399   0;
 400 }
 401
 402 #  This equates svc_phone records; perhaps svc_phone should have a field
 403 #  to indicate it represents a line
 404 sub calc_units {
 405   my($self, $cust_pkg ) = @_;
 406   my $count =
 407       scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 408   $count;
 409 }
 410
 411 1;
 412