package FS::rate;
+use base qw(FS::Record);
use strict;
-use vars qw( @ISA $DEBUG );
+use vars qw( $DEBUG );
use FS::Record qw( qsearch qsearchs dbh fields );
use FS::rate_detail;
-@ISA = qw(FS::Record);
-
$DEBUG = 0;
=head1 NAME
=over 4
-=item ratenum - primary key
+=item ratenum
+
+primary key
=item ratename
+Rate name
+
+=item agentnum
+
+Optional agent (see L<FS::agent>) for agent-virtualized rates.
+
+=item default_detailnum
+
+Optional rate detail to apply when a call doesn't match any region in the
+rate plan. If this is not set, the call will either be left unrated (though
+it may still be processed under a different pricing addon package), or be
+marked as 'skipped', or throw a fatal error, depending on the setting of
+the 'ignore_unrateable' package option.
+
+=item
+
=back
=head1 METHODS
=cut
-# the check method should currently be supplied - FS::Record contains some
-# data checking routines
-
sub check {
my $self = shift;
my $error =
$self->ut_numbern('ratenum')
|| $self->ut_text('ratename')
+ #|| $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
+ || $self->ut_numbern('default_detailnum')
;
return $error if $error;
$self->SUPER::check;
}
-=item dest_detail REGIONNUM | RATE_REGION_OBJECTD
+=item dest_detail REGIONNUM | RATE_REGION_OBJECTD | HASHREF
Returns the rate detail (see L<FS::rate_detail>) for this rate to the
-specificed destination.
+specificed destination. If no rate can be found, returns the default
+rate if there is one, and an empty string otherwise.
+
+Destination can be specified as an FS::rate_detail object or regionnum
+(see L<FS::rate_detail>), or as a hashref containing the following keys:
+
+=over 2
+
+=item I<countrycode> - required.
+
+=item I<phonenum> - required.
+
+=item I<weektime> - optional. Specifies a time in seconds from the start
+of the week, and will return a timed rate (one with a non-null I<ratetimenum>)
+if one exists at that time. If not, returns a non-timed rate.
+
+=item I<cdrtypenum> - optional. Specifies a value for the cdrtypenum
+field, and will return a rate matching that, if one exists. If not, returns
+a rate with null cdrtypenum.
=cut
sub dest_detail {
my $self = shift;
- my $regionnum = ref($_[0]) ? shift->regionnum : shift;
- qsearchs( 'rate_detail', { 'ratenum' => $self->ratenum,
- 'dest_regionnum' => $regionnum, } );
+
+ my( $regionnum, $weektime, $cdrtypenum );
+ if ( ref($_[0]) eq 'HASH' ) {
+
+ my $countrycode = $_[0]->{'countrycode'};
+ my $phonenum = $_[0]->{'phonenum'};
+ $weektime = $_[0]->{'weektime'};
+ $cdrtypenum = $_[0]->{'cdrtypenum'} || '';
+
+ #find a rate prefix, first look at most specific, then fewer digits,
+ # finally trying the country code only
+ my $rate_prefix = '';
+ $rate_prefix = qsearchs({
+ 'table' => 'rate_prefix',
+ 'addl_from' => ' JOIN rate_region USING (regionnum)',
+ 'hashref' => {
+ 'countrycode' => $countrycode,
+ 'npa' => $phonenum,
+ },
+ 'extra_sql' => ' AND exact_match = \'Y\''
+ });
+ if (!$rate_prefix) {
+ for my $len ( reverse(1..10) ) {
+ $rate_prefix = qsearchs('rate_prefix', {
+ 'countrycode' => $countrycode,
+ #'npa' => { op=> 'LIKE', value=> substr($number, 0, $len) }
+ 'npa' => substr($phonenum, 0, $len),
+ } ) and last;
+ }
+ $rate_prefix ||= qsearchs('rate_prefix', {
+ 'countrycode' => $countrycode,
+ 'npa' => '',
+ });
+ }
+
+ return '' unless $rate_prefix;
+
+ $regionnum = $rate_prefix->regionnum;
+
+ } else {
+ $regionnum = ref($_[0]) ? shift->regionnum : shift;
+ }
+
+ my %hash = (
+ 'ratenum' => $self->ratenum,
+ 'dest_regionnum' => $regionnum,
+ );
+
+ # find all rates matching ratenum, regionnum, cdrtypenum
+ my @details = qsearch( 'rate_detail', {
+ %hash,
+ 'cdrtypenum' => $cdrtypenum
+ });
+ # find all rates maching ratenum, regionnum and null cdrtypenum
+ if ( !@details and $cdrtypenum ) {
+ @details = qsearch( 'rate_detail', {
+ %hash,
+ 'cdrtypenum' => ''
+ });
+ }
+ # find one of those matching weektime
+ if ( defined($weektime) ) {
+ my @exact = grep {
+ my $rate_time = $_->rate_time;
+ $rate_time && $rate_time->contains($weektime)
+ } @details;
+ if ( @exact == 1 ) {
+ return $exact[0];
+ }
+ elsif ( @exact > 1 ) {
+ die "overlapping rate_detail times (region $regionnum, time $weektime)\n"
+ }
+ # else @exact == 0
+ }
+ # if not found or there is no weektime, find one matching null weektime
+ foreach (@details) {
+ return $_ if $_->ratetimenum eq '';
+ }
+ # if still nothing, return the global default rate for this plan
+ return $self->default_detail;
}
=item rate_detail
Returns all region-specific details (see L<FS::rate_detail>) for this rate.
+=back
+
+=item default_detail
+
+Returns the default rate detail, if there is one.
+
=cut
-sub rate_detail {
+sub default_detail {
my $self = shift;
- qsearch( 'rate_detail', { 'ratenum' => $self->ratenum } );
+ $self->default_detailnum ?
+ FS::rate_detail->by_key($self->default_detailnum) : ''
}
-
-=back
-
=head1 SUBROUTINES
=over 4
=item process
-Experimental job-queue processor for web interface adds/edits
+Job-queue processor for web interface adds/edits
=cut
-use Storable qw(thaw);
use Data::Dumper;
-use MIME::Base64;
sub process {
my $job = shift;
-
- my $param = thaw(decode_base64(shift));
+ my $param = shift;
warn Dumper($param) if $DEBUG;
my $old = qsearchs('rate', { 'ratenum' => $param->{'ratenum'} } )
'dest_regionnum' => $regionnum,
map { $_ => $param->{"$_$regionnum"} }
qw( min_included min_charge sec_granularity )
+ #qw( min_included conn_charge conn_sec min_charge sec_granularity )
};
} else {
new FS::rate_detail {
'dest_regionnum' => $regionnum,
'min_included' => 0,
+ 'conn_charge' => 0,
+ 'conn_sec' => 0,
+ 'conn_charge' => 0,
'min_charge' => 0,
'sec_granularity' => '60'
};
my $error = '';
if ( $param->{'ratenum'} ) {
warn "$rate replacing $old (". $param->{'ratenum'}. ")\n" if $DEBUG;
- $error = $rate->replace( $old,
- 'rate_detail' => \@rate_detail,
- 'job' => $job,
- );
+
+ my @param = ( 'job'=>$job );
+ push @param, 'rate_detail'=>\@rate_detail
+ unless $param->{'preserve_rate_detail'};
+
+ $error = $rate->replace( $old, @param );
+
} else {
warn "inserting $rate\n" if $DEBUG;
$error = $rate->insert( 'rate_detail' => \@rate_detail,
projects / freeside.git / blobdiff