FS/FS/rate_detail.pm

   1 package FS::rate_detail;
   2 use base qw(FS::Record);
   3
   4 use strict;
   5 use vars qw( $DEBUG $me );
   6 use Tie::IxHash;
   7 use FS::Record qw( qsearch qsearchs dbh );
   8 use FS::rate;
   9 use FS::rate_region;
  10 use FS::rate_time;
  11
  12 $DEBUG = 0;
  13 $me = '[FS::rate_detail]';
  14
  15 =head1 NAME
  16
  17 FS::rate_detail - Object methods for rate_detail records
  18
  19 =head1 SYNOPSIS
  20
  21   use FS::rate_detail;
  22
  23   $record = new FS::rate_detail \%hash;
  24   $record = new FS::rate_detail { 'column' => 'value' };
  25
  26   $error = $record->insert;
  27
  28   $error = $new_record->replace($old_record);
  29
  30   $error = $record->delete;
  31
  32   $error = $record->check;
  33
  34 =head1 DESCRIPTION
  35
  36 An FS::rate_detail object represents an call plan rate.  FS::rate_detail
  37 inherits from FS::Record.  The following fields are currently supported:
  38
  39 =over 4
  40
  41 =item ratedetailnum - primary key
  42
  43 =item ratenum - rate plan (see L<FS::rate>)
  44
  45 =item orig_regionnum - call origination region
  46
  47 =item dest_regionnum - call destination region
  48
  49 =item min_included - included minutes
  50
  51 =item min_charge - charge per minute
  52
  53 =item sec_granularity - granularity in seconds, i.e. 6 or 60; 0 for per-call
  54
  55 =item classnum - usage class (see L<FS::usage_class>) if any for this rate
  56
  57 =item ratetimenum - rating time period (see L<FS::rate_time) if any
  58
  59 =item cdrtypenum - CDR type (see L<FS::cdr_type>) if any for this rate
  60
  61 =item region_group - Group in region group for rate plan
  62
  63 =item upstream_mult_charge - the multiplier to apply to the upstream price.
  64 Defaults to zero, and should stay zero unless this rate is intended to include
  65 a markup on pre-rated CDRs.
  66
  67 =item upstream_mult_cost - the multiplier to apply to the upstream price to
  68 calculate the wholesale cost.
  69
  70 =back
  71
  72 =head1 METHODS
  73
  74 =over 4
  75
  76 =item new HASHREF
  77
  78 Creates a new call plan rate.  To add the call plan rate to the database, see
  79 L<"insert">.
  80
  81 Note that this stores the hash reference, not a distinct copy of the hash it
  82 points to.  You can ask the object for a copy with the I<hash> method.
  83
  84 =cut
  85
  86 # the new method can be inherited from FS::Record, if a table method is defined
  87
  88 sub table { 'rate_detail'; }
  89
  90 =item insert
  91
  92 Adds this record to the database.  If there is an error, returns the error,
  93 otherwise returns false.
  94
  95 =cut
  96
  97 # the insert method can be inherited from FS::Record
  98
  99 =item delete
 100
 101 Delete this record from the database.
 102
 103 =cut
 104
 105 # the delete method can be inherited from FS::Record
 106
 107 =item replace OLD_RECORD
 108
 109 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 110 returns the error, otherwise returns false.
 111
 112 =cut
 113
 114 # the replace method can be inherited from FS::Record
 115
 116 =item check
 117
 118 Checks all fields to make sure this is a valid call plan rate.  If there is
 119 an error, returns the error, otherwise returns false.  Called by the insert
 120 and replace methods.
 121
 122 =cut
 123
 124 # the check method should currently be supplied - FS::Record contains some
 125 # data checking routines
 126
 127 sub check {
 128   my $self = shift;
 129
 130   my $error =
 131        $self->ut_numbern('ratedetailnum')
 132     || $self->ut_foreign_key('ratenum', 'rate', 'ratenum')
 133     || $self->ut_foreign_keyn('orig_regionnum', 'rate_region', 'regionnum' )
 134     || $self->ut_foreign_keyn('dest_regionnum', 'rate_region', 'regionnum' )
 135     || $self->ut_number('min_included')
 136
 137     #|| $self->ut_money('min_charge')
 138     #good enough for now...
 139     || $self->ut_floatn('conn_charge')
 140     || $self->ut_floatn('conn_cost')
 141     || $self->ut_float('min_charge')
 142     || $self->ut_floatn('min_cost')
 143
 144     || $self->ut_number('sec_granularity')
 145
 146     || $self->ut_foreign_keyn('classnum', 'usage_class', 'classnum' )
 147     || $self->ut_enum('region_group',    [ '', 'Y' ])
 148
 149     || $self->ut_floatn('upstream_mult_charge')
 150     || $self->ut_floatn('upstream_mult_cost')
 151   ;
 152   return $error if $error;
 153
 154   $self->SUPER::check;
 155 }
 156
 157 =item rate
 158
 159 Returns the parent call plan (see L<FS::rate>) associated with this call plan
 160 rate.
 161
 162 =item orig_region
 163
 164 Returns the origination region (see L<FS::rate_region>) associated with this
 165 call plan rate.
 166
 167 =cut
 168
 169 sub orig_region {
 170   my $self = shift;
 171   qsearchs('rate_region', { 'regionnum' => $self->orig_regionnum } );
 172 }
 173
 174 =item dest_region
 175
 176 Returns the destination region (see L<FS::rate_region>) associated with this
 177 call plan rate.
 178
 179 =cut
 180
 181 sub dest_region {
 182   my $self = shift;
 183   qsearchs('rate_region', { 'regionnum' => $self->dest_regionnum } );
 184 }
 185
 186 =item dest_regionname
 187
 188 Returns the name of the destination region (see L<FS::rate_region>) associated
 189 with this call plan rate.
 190
 191 =cut
 192
 193 sub dest_regionname {
 194   my $self = shift;
 195   my $dest_region = $self->dest_region;
 196   $dest_region ? $dest_region->regionname : 'Global default';
 197 }
 198
 199 =item dest_prefixes_short
 200
 201 Returns a short list of the prefixes for the destination region
 202 (see L<FS::rate_region>) associated with this call plan rate.
 203
 204 =cut
 205
 206 sub dest_prefixes_short {
 207   my $self = shift;
 208   my $dest_region = $self->dest_region;
 209   $dest_region ? $dest_region->prefixes_short : '';
 210 }
 211
 212 =item rate_time
 213
 214 Returns the L<FS::rate_time> object associated with this call
 215 plan rate, if there is one.
 216
 217 =cut
 218
 219 sub rate_time {
 220   my $self = shift;
 221   $self->ratetimenum ? FS::rate_time->by_key($self->ratetimenum) : ();
 222 }
 223
 224 =item rate_time_name
 225
 226 Returns the I<ratetimename> field of the L<FS::rate_time> object
 227 associated with this rate plan.
 228
 229 =cut
 230
 231 sub rate_time_name {
 232   my $self = shift;
 233   $self->ratetimenum ? $self->rate_time->ratetimename : '(default)';
 234 }
 235
 236 =item classname
 237
 238 Returns the name of the usage class (see L<FS::usage_class>) associated with
 239 this call plan rate.
 240
 241 =cut
 242
 243 sub classname {
 244   my $self = shift;
 245   my $usage_class = qsearchs('usage_class', { classnum => $self->classnum });
 246   $usage_class ? $usage_class->classname : '';
 247 }
 248
 249 =item cdrtypename
 250
 251 Returns the name of the CDR type (see L<FS::cdr_type) associated with this
 252 rate, if there is one.  If not, returns the cdrtypenum itself.  This will
 253 only return an empty string if cdrtypenum is NULL.
 254
 255 =cut
 256
 257 sub cdrtypename {
 258   my $self = shift;
 259   my $cdrtypenum = $self->cdrtypenum or return '';
 260   my $cdr_type = qsearchs('cdr_type', { cdrtypenum => $cdrtypenum });
 261   return $cdr_type ? $cdr_type->cdrtypename : $cdrtypenum;
 262 }
 263
 264 =back
 265
 266 =head1 SUBROUTINES
 267
 268 =over 4
 269
 270 =item granularities
 271
 272   Returns an (ordered) hash of granularity => name pairs
 273
 274 =cut
 275
 276 tie my %granularities, 'Tie::IxHash',
 277   '1', => '1 second',
 278   '6'  => '6 second',
 279   '30' => '30 second', # '1/2 minute',
 280   '60' => 'minute',
 281   '0'  => 'call',
 282 ;
 283
 284 sub granularities {
 285   %granularities;
 286 }
 287
 288 =item conn_secs
 289
 290   Returns an (ordered) hash of conn_sec => name pairs
 291
 292 =cut
 293
 294 tie my %conn_secs, 'Tie::IxHash',
 295     '0' => 'connection',
 296     '1' => 'first second',
 297     '6' => 'first 6 seconds',
 298    '30' => 'first 30 seconds', # '1/2 minute',
 299    '60' => 'first minute',
 300   '120' => 'first 2 minutes',
 301   '180' => 'first 3 minutes',
 302   '300' => 'first 5 minutes',
 303 ;
 304
 305 sub conn_secs {
 306   %conn_secs;
 307 }
 308
 309 =item process_edit_import
 310
 311 =cut
 312
 313 use Data::Dumper;
 314 sub process_edit_import {
 315   my $job = shift;
 316
 317   #do we actually belong in rate_detail, like 'table' says?  even though we
 318   # can possible create new rate records, that's a side effect, mostly we
 319   # do edit rate_detail records in batch...
 320
 321   my $opt = { 'table'          => 'rate_detail',
 322               'params'         => [], #required, apparantly
 323               'formats'        => { 'default' => [
 324                 'dest_regionnum',
 325                 '', #regionname
 326                 '', #country
 327                 '', #prefixes
 328                 #loop these
 329                 'min_included',
 330                 'min_charge',
 331                 sub {
 332                   my( $rate_detail, $g ) = @_;
 333                   $g  = 0  if $g =~ /^\s*(per-)?call\s*$/i;
 334                   $g  = 60 if $g =~ /^\s*minute\s*$/i;
 335                   $g  =~ /^(\d+)/ or die "can't parse granularity: $g".
 336                                          " for record ". Dumper($rate_detail);
 337                   $rate_detail->sec_granularity($1);
 338                 },
 339                 'classnum',
 340               ] },
 341               'format_headers' => { 'default' => 1, },
 342               'format_types'   => { 'default' => 'xls' },
 343             };
 344
 345   #false laziness w/
 346   #FS::Record::process_batch_import( $job, $opt, @_ );
 347
 348   my $table = $opt->{table};
 349   my @pass_params = @{ $opt->{params} };
 350   my %formats = %{ $opt->{formats} };
 351
 352   my $param = shift;
 353   warn Dumper($param) if $DEBUG;
 354
 355   my $files = $param->{'uploaded_files'}
 356     or die "No files provided.\n";
 357
 358   my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
 359
 360   my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
 361   my $file = $dir. $files{'file'};
 362
 363   my $error =
 364     #false laziness w/
 365     #FS::Record::batch_import( {
 366     FS::rate_detail::edit_import( {
 367       #class-static
 368       table                      => $table,
 369       formats                    => \%formats,
 370       format_types               => $opt->{format_types},
 371       format_headers             => $opt->{format_headers},
 372       format_sep_chars           => $opt->{format_sep_chars},
 373       format_fixedlength_formats => $opt->{format_fixedlength_formats},
 374       #per-import
 375       job                        => $job,
 376       file                       => $file,
 377       #type                       => $type,
 378       format                     => $param->{format},
 379       params                     => { map { $_ => $param->{$_} } @pass_params },
 380       #?
 381       default_csv                => $opt->{default_csv},
 382     } );
 383
 384   unlink $file;
 385
 386   die "$error\n" if $error;
 387
 388 }
 389
 390 =item edit_import
 391
 392 =cut
 393
 394 #false laziness w/ #FS::Record::batch_import, grep "edit_import" for differences
 395 #could be turned into callbacks or something
 396 use Text::CSV_XS;
 397 sub edit_import {
 398   my $param = shift;
 399
 400   warn "$me edit_import call with params: \n". Dumper($param)
 401     if $DEBUG;
 402
 403   my $table   = $param->{table};
 404   my $formats = $param->{formats};
 405
 406   my $job     = $param->{job};
 407   my $file    = $param->{file};
 408   my $format  = $param->{'format'};
 409   my $params  = $param->{params} || {};
 410
 411   die "unknown format $format" unless exists $formats->{ $format };
 412
 413   my $type = $param->{'format_types'}
 414              ? $param->{'format_types'}{ $format }
 415              : $param->{type} || 'csv';
 416
 417   unless ( $type ) {
 418     if ( $file =~ /\.(\w+)$/i ) {
 419       $type = lc($1);
 420     } else {
 421       #or error out???
 422       warn "can't parse file type from filename $file; defaulting to CSV";
 423       $type = 'csv';
 424     }
 425     $type = 'csv'
 426       if $param->{'default_csv'} && $type ne 'xls';
 427   }
 428
 429   my $header = $param->{'format_headers'}
 430                  ? $param->{'format_headers'}{ $param->{'format'} }
 431                  : 0;
 432
 433   my $sep_char = $param->{'format_sep_chars'}
 434                    ? $param->{'format_sep_chars'}{ $param->{'format'} }
 435                    : ',';
 436
 437   my $fixedlength_format =
 438     $param->{'format_fixedlength_formats'}
 439       ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
 440       : '';
 441
 442   my @fields = @{ $formats->{ $format } };
 443
 444   my $row = 0;
 445   my $count;
 446   my $parser;
 447   my @buffer = ();
 448   my @header = (); #edit_import
 449   if ( $type eq 'csv' || $type eq 'fixedlength' ) {
 450
 451     if ( $type eq 'csv' ) {
 452
 453       my %attr = ();
 454       $attr{sep_char} = $sep_char if $sep_char;
 455       $parser = new Text::CSV_XS \%attr;
 456
 457     } elsif ( $type eq 'fixedlength' ) {
 458
 459       eval "use Parse::FixedLength;";
 460       die $@ if $@;
 461       $parser = new Parse::FixedLength $fixedlength_format;
 462
 463     } else {
 464       die "Unknown file type $type\n";
 465     }
 466
 467     @buffer = split(/\r?\n/, slurp($file) );
 468     splice(@buffer, 0, ($header || 0) );
 469     $count = scalar(@buffer);
 470
 471   } elsif ( $type eq 'xls' ) {
 472
 473     eval "use Spreadsheet::ParseExcel;";
 474     die $@ if $@;
 475
 476     eval "use DateTime::Format::Excel;";
 477     #for now, just let the error be thrown if it is used, since only CDR
 478     # formats bill_west and troop use it, not other excel-parsing things
 479     #die $@ if $@;
 480
 481     my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
 482
 483     $parser = $excel->{Worksheet}[0]; #first sheet
 484
 485     $count = $parser->{MaxRow} || $parser->{MinRow};
 486     $count++;
 487
 488     $row = $header || 0;
 489
 490     #edit_import - need some magic to parse the header
 491     if ( $header ) {
 492       my @header_row = @{ $parser->{Cells}[$0] };
 493       @header = map $_->{Val}, @header_row;
 494     }
 495
 496   } else {
 497     die "Unknown file type $type\n";
 498   }
 499
 500   #my $columns;
 501
 502   local $SIG{HUP} = 'IGNORE';
 503   local $SIG{INT} = 'IGNORE';
 504   local $SIG{QUIT} = 'IGNORE';
 505   local $SIG{TERM} = 'IGNORE';
 506   local $SIG{TSTP} = 'IGNORE';
 507   local $SIG{PIPE} = 'IGNORE';
 508
 509   my $oldAutoCommit = $FS::UID::AutoCommit;
 510   local $FS::UID::AutoCommit = 0;
 511   my $dbh = dbh;
 512
 513   #edit_import - use the header to setup looping over different rates
 514   my @rate = ();
 515   if ( @header ) {
 516     splice(@header,0,4); # # Region Country Prefixes
 517     while ( my @next = splice(@header,0,4) ) {
 518       my $rate;
 519       if ( $next[0] =~ /^(\d+):\s*([^:]+):/ ) {
 520         $rate = qsearchs('rate', { 'ratenum' => $1 } )
 521           or die "unknown ratenum $1";
 522       } elsif ( $next[0] =~ /^(NEW:)?\s*([^:]+)/i ) {
 523         $rate = new FS::rate { 'ratename' => $2 };
 524         my $error = $rate->insert;
 525         if ( $error ) {
 526           $dbh->rollback if $oldAutoCommit;
 527           return "error inserting new rate: $error\n";
 528         }
 529       }
 530       push @rate, $rate;
 531     }
 532   }
 533   die unless @rate;
 534
 535   my $line;
 536   my $imported = 0;
 537   my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
 538   while (1) {
 539
 540     my @columns = ();
 541     if ( $type eq 'csv' ) {
 542
 543       last unless scalar(@buffer);
 544       $line = shift(@buffer);
 545
 546       $parser->parse($line) or do {
 547         $dbh->rollback if $oldAutoCommit;
 548         return "can't parse: ". $parser->error_input();
 549       };
 550       @columns = $parser->fields();
 551
 552     } elsif ( $type eq 'fixedlength' ) {
 553
 554       @columns = $parser->parse($line);
 555
 556     } elsif ( $type eq 'xls' ) {
 557
 558       last if $row > ($parser->{MaxRow} || $parser->{MinRow})
 559            || ! $parser->{Cells}[$row];
 560
 561       my @row = @{ $parser->{Cells}[$row] };
 562       @columns = map $_->{Val}, @row;
 563
 564       #my $z = 'A';
 565       #warn $z++. ": $_\n" for @columns;
 566
 567     } else {
 568       die "Unknown file type $type\n";
 569     }
 570
 571     #edit_import loop
 572
 573     my @repeat = @columns[0..3];
 574
 575     foreach my $rate ( @rate ) {
 576
 577       my @later = ();
 578       my %hash = %$params;
 579
 580       foreach my $field ( @fields ) {
 581
 582         my $value = shift @columns;
 583
 584         if ( ref($field) eq 'CODE' ) {
 585           #&{$field}(\%hash, $value);
 586           push @later, $field, $value;
 587         #} else {
 588         } elsif ($field) { #edit_import
 589           #??? $hash{$field} = $value if length($value);
 590           $hash{$field} = $value if defined($value) && length($value);
 591         }
 592
 593       }
 594
 595       unshift @columns, @repeat; #edit_import put these back on for next time
 596
 597       my $class = "FS::$table";
 598
 599       my $record = $class->new( \%hash );
 600
 601       $record->ratenum($rate->ratenum); #edit_import
 602
 603       #edit_improt n/a my $param = {};
 604       while ( scalar(@later) ) {
 605         my $sub = shift @later;
 606         my $data = shift @later;
 607         #&{$sub}($record, $data, $conf, $param);# $record->&{$sub}($data, $conf);
 608         &{$sub}($record, $data); #edit_import - don't have $conf
 609         #edit_import wrong loop last if exists( $param->{skiprow} );
 610       }
 611       #edit_import wrong loop next if exists( $param->{skiprow} );
 612
 613       #edit_import update or insert, not just insert
 614       my $old = qsearchs({
 615         'table'   => $table,
 616         'hashref' => { map { $_ => $record->$_() } qw(ratenum dest_regionnum) },
 617       });
 618
 619       my $error;
 620       if ( $old ) {
 621         $record->ratedetailnum($old->ratedetailnum);
 622         $error = $record->replace($old)
 623       } else {
 624         $record->insert;
 625       }
 626
 627       if ( $error ) {
 628         $dbh->rollback if $oldAutoCommit;
 629         return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
 630       }
 631
 632     }
 633
 634     $row++;
 635     $imported++;
 636
 637     if ( $job && time - $min_sec > $last ) { #progress bar
 638       $job->update_statustext( int(100 * $imported / $count) );
 639       $last = time;
 640     }
 641
 642   }
 643
 644   $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
 645
 646   return "Empty file!" unless $imported || $param->{empty_ok};
 647
 648   ''; #no error
 649
 650 }
 651
 652 =back
 653
 654 =head1 BUGS
 655
 656 =head1 SEE ALSO
 657
 658 L<FS::rate>, L<FS::rate_region>, L<FS::Record>,
 659 schema.html from the base documentation.
 660
 661 =cut
 662
 663 1;
 664