1 package FS::rate_detail;
2 use base qw(FS::Record);
5 use vars qw( $DEBUG $me );
7 use FS::Record qw( qsearch qsearchs dbh );
13 $me = '[FS::rate_detail]';
17 FS::rate_detail - Object methods for rate_detail records
23 $record = new FS::rate_detail \%hash;
24 $record = new FS::rate_detail { 'column' => 'value' };
26 $error = $record->insert;
28 $error = $new_record->replace($old_record);
30 $error = $record->delete;
32 $error = $record->check;
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:
41 =item ratedetailnum - primary key
43 =item ratenum - rate plan (see L<FS::rate>)
45 =item orig_regionnum - call origination region
47 =item dest_regionnum - call destination region
49 =item min_included - included minutes
51 =item min_charge - charge per minute
53 =item sec_granularity - granularity in seconds, i.e. 6 or 60; 0 for per-call
55 =item classnum - usage class (see L<FS::usage_class>) if any for this rate
57 =item ratetimenum - rating time period (see L<FS::rate_time) if any
59 =item cdrtypenum - CDR type (see L<FS::cdr_type>) if any for this rate
61 =item region_group - Group in region group for rate plan
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.
67 =item upstream_mult_cost - the multiplier to apply to the upstream price to
68 calculate the wholesale cost.
78 Creates a new call plan rate. To add the call plan rate to the database, see
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.
86 # the new method can be inherited from FS::Record, if a table method is defined
88 sub table { 'rate_detail'; }
92 Adds this record to the database. If there is an error, returns the error,
93 otherwise returns false.
97 # the insert method can be inherited from FS::Record
101 Delete this record from the database.
105 # the delete method can be inherited from FS::Record
107 =item replace OLD_RECORD
109 Replaces the OLD_RECORD with this one in the database. If there is an error,
110 returns the error, otherwise returns false.
114 # the replace method can be inherited from FS::Record
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
124 # the check method should currently be supplied - FS::Record contains some
125 # data checking routines
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_foreign_keyn('cdrtypenum', 'cdr_type', 'cdrtypenum' )
136 || $self->ut_number('min_included')
138 #|| $self->ut_money('min_charge')
139 #good enough for now...
140 || $self->ut_floatn('conn_charge')
141 || $self->ut_floatn('conn_cost')
142 || $self->ut_float('min_charge')
143 || $self->ut_floatn('min_cost')
145 || $self->ut_number('sec_granularity')
147 || $self->ut_foreign_keyn('classnum', 'usage_class', 'classnum' )
148 || $self->ut_enum('region_group', [ '', 'Y' ])
150 || $self->ut_floatn('upstream_mult_charge')
151 || $self->ut_floatn('upstream_mult_cost')
153 return $error if $error;
160 Returns the parent call plan (see L<FS::rate>) associated with this call plan
165 Returns the origination region (see L<FS::rate_region>) associated with this
172 qsearchs('rate_region', { 'regionnum' => $self->orig_regionnum } );
177 Returns the destination region (see L<FS::rate_region>) associated with this
184 qsearchs('rate_region', { 'regionnum' => $self->dest_regionnum } );
187 =item dest_regionname
189 Returns the name of the destination region (see L<FS::rate_region>) associated
190 with this call plan rate.
194 sub dest_regionname {
196 my $dest_region = $self->dest_region;
197 $dest_region ? $dest_region->regionname : 'Global default';
198 # should be 'Anywhere' or something, to indicate that it's the
199 # cross-region default
202 =item dest_prefixes_short
204 Returns a short list of the prefixes for the destination region
205 (see L<FS::rate_region>) associated with this call plan rate.
209 sub dest_prefixes_short {
211 my $dest_region = $self->dest_region;
212 $dest_region ? $dest_region->prefixes_short : '';
217 Returns the L<FS::rate_time> object associated with this call
218 plan rate, if there is one.
224 $self->ratetimenum ? FS::rate_time->by_key($self->ratetimenum) : ();
229 Returns the I<ratetimename> field of the L<FS::rate_time> object
230 associated with this rate plan.
236 $self->ratetimenum ? $self->rate_time->ratetimename : '(any time)';
241 Returns the name of the usage class (see L<FS::usage_class>) associated with
248 my $usage_class = qsearchs('usage_class', { classnum => $self->classnum });
249 $usage_class ? $usage_class->classname : '';
254 Returns the name of the CDR type (see L<FS::cdr_type) associated with this
255 rate, if there is one. If not, returns the cdrtypenum itself. This will
256 only return an empty string if cdrtypenum is NULL.
262 my $cdrtypenum = $self->cdrtypenum or return '';
263 my $cdr_type = qsearchs('cdr_type', { cdrtypenum => $cdrtypenum });
264 return $cdr_type ? $cdr_type->cdrtypename : $cdrtypenum;
275 Returns an (ordered) hash of granularity => name pairs
279 tie my %granularities, 'Tie::IxHash',
282 '30' => '30 second', # '1/2 minute',
293 Returns an (ordered) hash of conn_sec => name pairs
297 tie my %conn_secs, 'Tie::IxHash',
299 '1' => 'first second',
300 '6' => 'first 6 seconds',
301 '30' => 'first 30 seconds', # '1/2 minute',
302 '60' => 'first minute',
303 '120' => 'first 2 minutes',
304 '180' => 'first 3 minutes',
305 '300' => 'first 5 minutes',
312 =item process_edit_import
317 sub process_edit_import {
320 #do we actually belong in rate_detail, like 'table' says? even though we
321 # can possible create new rate records, that's a side effect, mostly we
322 # do edit rate_detail records in batch...
324 my $opt = { 'table' => 'rate_detail',
325 'params' => [], #required, apparantly
326 'formats' => { 'default' => [
335 my( $rate_detail, $g ) = @_;
336 $g = 0 if $g =~ /^\s*(per-)?call\s*$/i;
337 $g = 60 if $g =~ /^\s*minute\s*$/i;
338 $g =~ /^(\d+)/ or die "can't parse granularity: $g".
339 " for record ". Dumper($rate_detail);
340 $rate_detail->sec_granularity($1);
344 'format_headers' => { 'default' => 1, },
345 'format_types' => { 'default' => 'xls' },
349 #FS::Record::process_batch_import( $job, $opt, @_ );
351 my $table = $opt->{table};
352 my @pass_params = @{ $opt->{params} };
353 my %formats = %{ $opt->{formats} };
356 warn Dumper($param) if $DEBUG;
358 my $files = $param->{'uploaded_files'}
359 or die "No files provided.\n";
361 my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
363 my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
364 my $file = $dir. $files{'file'};
368 #FS::Record::batch_import( {
369 FS::rate_detail::edit_import( {
372 formats => \%formats,
373 format_types => $opt->{format_types},
374 format_headers => $opt->{format_headers},
375 format_sep_chars => $opt->{format_sep_chars},
376 format_fixedlength_formats => $opt->{format_fixedlength_formats},
381 format => $param->{format},
382 params => { map { $_ => $param->{$_} } @pass_params },
384 default_csv => $opt->{default_csv},
389 die "$error\n" if $error;
397 #false laziness w/ #FS::Record::batch_import, grep "edit_import" for differences
398 #could be turned into callbacks or something
403 warn "$me edit_import call with params: \n". Dumper($param)
406 my $table = $param->{table};
407 my $formats = $param->{formats};
409 my $job = $param->{job};
410 my $file = $param->{file};
411 my $format = $param->{'format'};
412 my $params = $param->{params} || {};
414 die "unknown format $format" unless exists $formats->{ $format };
416 my $type = $param->{'format_types'}
417 ? $param->{'format_types'}{ $format }
418 : $param->{type} || 'csv';
421 if ( $file =~ /\.(\w+)$/i ) {
425 warn "can't parse file type from filename $file; defaulting to CSV";
429 if $param->{'default_csv'} && $type ne 'xls';
432 my $header = $param->{'format_headers'}
433 ? $param->{'format_headers'}{ $param->{'format'} }
436 my $sep_char = $param->{'format_sep_chars'}
437 ? $param->{'format_sep_chars'}{ $param->{'format'} }
440 my $fixedlength_format =
441 $param->{'format_fixedlength_formats'}
442 ? $param->{'format_fixedlength_formats'}{ $param->{'format'} }
445 my @fields = @{ $formats->{ $format } };
451 my @header = (); #edit_import
452 if ( $type eq 'csv' || $type eq 'fixedlength' ) {
454 if ( $type eq 'csv' ) {
457 $attr{sep_char} = $sep_char if $sep_char;
458 $parser = new Text::CSV_XS \%attr;
460 } elsif ( $type eq 'fixedlength' ) {
462 eval "use Parse::FixedLength;";
464 $parser = new Parse::FixedLength $fixedlength_format;
467 die "Unknown file type $type\n";
470 @buffer = split(/\r?\n/, slurp($file) );
471 splice(@buffer, 0, ($header || 0) );
472 $count = scalar(@buffer);
474 } elsif ( $type eq 'xls' ) {
476 eval "use Spreadsheet::ParseExcel;";
479 eval "use DateTime::Format::Excel;";
480 #for now, just let the error be thrown if it is used, since only CDR
481 # formats bill_west and troop use it, not other excel-parsing things
484 my $excel = Spreadsheet::ParseExcel::Workbook->new->Parse($file);
486 $parser = $excel->{Worksheet}[0]; #first sheet
488 $count = $parser->{MaxRow} || $parser->{MinRow};
493 #edit_import - need some magic to parse the header
495 my @header_row = @{ $parser->{Cells}[$0] };
496 @header = map $_->{Val}, @header_row;
500 die "Unknown file type $type\n";
505 local $SIG{HUP} = 'IGNORE';
506 local $SIG{INT} = 'IGNORE';
507 local $SIG{QUIT} = 'IGNORE';
508 local $SIG{TERM} = 'IGNORE';
509 local $SIG{TSTP} = 'IGNORE';
510 local $SIG{PIPE} = 'IGNORE';
512 my $oldAutoCommit = $FS::UID::AutoCommit;
513 local $FS::UID::AutoCommit = 0;
516 #edit_import - use the header to setup looping over different rates
519 splice(@header,0,4); # # Region Country Prefixes
520 while ( my @next = splice(@header,0,4) ) {
522 if ( $next[0] =~ /^(\d+):\s*([^:]+):/ ) {
523 $rate = qsearchs('rate', { 'ratenum' => $1 } )
524 or die "unknown ratenum $1";
525 } elsif ( $next[0] =~ /^(NEW:)?\s*([^:]+)/i ) {
526 $rate = new FS::rate { 'ratename' => $2 };
527 my $error = $rate->insert;
529 $dbh->rollback if $oldAutoCommit;
530 return "error inserting new rate: $error\n";
540 my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
544 if ( $type eq 'csv' ) {
546 last unless scalar(@buffer);
547 $line = shift(@buffer);
549 $parser->parse($line) or do {
550 $dbh->rollback if $oldAutoCommit;
551 return "can't parse: ". $parser->error_input();
553 @columns = $parser->fields();
555 } elsif ( $type eq 'fixedlength' ) {
557 @columns = $parser->parse($line);
559 } elsif ( $type eq 'xls' ) {
561 last if $row > ($parser->{MaxRow} || $parser->{MinRow})
562 || ! $parser->{Cells}[$row];
564 my @row = @{ $parser->{Cells}[$row] };
565 @columns = map $_->{Val}, @row;
568 #warn $z++. ": $_\n" for @columns;
571 die "Unknown file type $type\n";
576 my @repeat = @columns[0..3];
578 foreach my $rate ( @rate ) {
583 foreach my $field ( @fields ) {
585 my $value = shift @columns;
587 if ( ref($field) eq 'CODE' ) {
588 #&{$field}(\%hash, $value);
589 push @later, $field, $value;
591 } elsif ($field) { #edit_import
592 #??? $hash{$field} = $value if length($value);
593 $hash{$field} = $value if defined($value) && length($value);
598 unshift @columns, @repeat; #edit_import put these back on for next time
600 my $class = "FS::$table";
602 my $record = $class->new( \%hash );
604 $record->ratenum($rate->ratenum); #edit_import
606 #edit_improt n/a my $param = {};
607 while ( scalar(@later) ) {
608 my $sub = shift @later;
609 my $data = shift @later;
610 #&{$sub}($record, $data, $conf, $param);# $record->&{$sub}($data, $conf);
611 &{$sub}($record, $data); #edit_import - don't have $conf
612 #edit_import wrong loop last if exists( $param->{skiprow} );
614 #edit_import wrong loop next if exists( $param->{skiprow} );
616 #edit_import update or insert, not just insert
619 'hashref' => { map { $_ => $record->$_() } qw(ratenum dest_regionnum) },
624 $record->ratedetailnum($old->ratedetailnum);
625 $error = $record->replace($old)
631 $dbh->rollback if $oldAutoCommit;
632 return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
640 if ( $job && time - $min_sec > $last ) { #progress bar
641 $job->update_statustext( int(100 * $imported / $count) );
647 $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
649 return "Empty file!" unless $imported || $param->{empty_ok};
661 L<FS::rate>, L<FS::rate_region>, L<FS::Record>,
662 schema.html from the base documentation.