X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Frate.pm;h=9b90dd28b4298301836174687e206acf9c40637e;hp=f30e4c772c5b2d5d1f69954686a0932d2cc177c5;hb=20f03d52cc6c930f610c0b4466eeeeda54fdbb40;hpb=de3bf373e97f6875e09fc17d99068a2716bf3b2d diff --git a/FS/FS/rate.pm b/FS/FS/rate.pm index f30e4c772..9b90dd28b 100644 --- a/FS/FS/rate.pm +++ b/FS/FS/rate.pm @@ -1,12 +1,11 @@ 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 @@ -35,10 +34,30 @@ FS::Record. The following fields are currently supported: =over 4 -=item ratenum - primary key +=item ratenum + +primary key =item ratename +Rate name + +=item agentnum + +Optional agent (see L) 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. + +Deprecated; we now find the default detail by its lack of regionnum. + +=item + =back =head1 METHODS @@ -254,15 +273,14 @@ and replace 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; @@ -272,112 +290,163 @@ sub check { =item dest_detail REGIONNUM | RATE_REGION_OBJECTD | HASHREF Returns the rate detail (see L) for this rate to the -specificed destination, or the empty string if no rate can be found for -the given 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), or as a hashref with two keys: I -and I. +(see L), or as a hashref containing the following keys: + +=over 2 + +=item I - required. + +=item I - required. + +=item I - optional. Specifies a time in seconds from the start +of the week, and will return a timed rate (one with a non-null I) +if one exists at that time. If not, returns a non-timed rate. -An optional third key, I, will return a timed rate (one with -a non-null I) if one exists for a call at that time. If -no matching timed rate exists, the non-timed rate will be returned. +=item I - 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; - my $weektime; + 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 = ''; - for my $len ( reverse(1..10) ) { - $rate_prefix = qsearchs('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' => { op=> 'LIKE', value=> substr($number, 0, $len) } - 'npa' => substr($phonenum, 0, $len), - } ) and last; + 'npa' => '', + }); } - $rate_prefix ||= qsearchs('rate_prefix', { - 'countrycode' => $countrycode, - 'npa' => '', - }); - return '' unless $rate_prefix; + if ( !$rate_prefix ) { + # then this call doesn't match any known region; just return the + # appropriate anywhere rate + return $self->default_detail($cdrtypenum) || $self->default_detail(''); + } $regionnum = $rate_prefix->regionnum; - #$rate_region = $rate_prefix->rate_region; - } else { $regionnum = ref($_[0]) ? shift->regionnum : shift; } - - if(!defined($weektime)) { - return qsearchs( 'rate_detail', - { 'ratenum' => $self->ratenum, - 'dest_regionnum' => $regionnum, - 'ratetimenum' => '', - } ); + + my %hash = ( + 'ratenum' => $self->ratenum, + 'dest_regionnum' => $regionnum, + ); + + # find all rates matching ratenum, regionnum, cdrtypenum + my @details = qsearch( 'rate_detail', { + %hash, + 'cdrtypenum' => $cdrtypenum + }); + # failing that, return the global default for this plan with the correct + # cdrtypenum (skips weektime processing) + if ( !@details and $cdrtypenum ) { + my $detail = $self->default_detail($cdrtypenum); + return $detail if $detail; } - else { - my @details = grep { my $rate_time = $_->rate_time; - $rate_time && $rate_time->contains($weektime) } - qsearch( 'rate_detail', - { 'ratenum' => $self->ratenum, - 'dest_regionnum' => $regionnum, } ); - if(!@details) { - # this may change at some point - return $self->dest_detail($regionnum); - } - elsif(@details == 1) { - return $details[0]; + # failing that, find all rates maching ratenum, regionnum and null cdrtypenum + # (these can have weektime stuff) + 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]; } - else { - die "overlapping rate_detail times (region $regionnum, time $weektime)\n"; + 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) for this rate. +=back + +=item default_detail [ CDRTYPENUM ] + +Returns the default rate detail for CDRTYPENUM (or for null CDR type, if not +specified). + =cut -sub rate_detail { +sub default_detail { my $self = shift; - qsearch( 'rate_detail', { 'ratenum' => $self->ratenum } ); + my $cdrtypenum = shift || ''; +# $self->default_detailnum ? +# FS::rate_detail->by_key($self->default_detailnum) : '' + qsearchs( 'rate_detail', { + ratenum => $self->ratenum, + cdrtypenum => $cdrtypenum, + dest_regionnum => '', + orig_regionnum => '', + }) || ''; } - -=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'} } ) @@ -421,8 +490,8 @@ sub process { warn "$rate replacing $old (". $param->{'ratenum'}. ")\n" if $DEBUG; my @param = ( 'job'=>$job ); - push @param, 'rate_detail'=>\@rate_detail - unless $param->{'preserve_rate_detail'}; + + $rate->default_detailnum($old->default_detailnum); $error = $rate->replace( $old, @param );