show credit balance on invoices, #11564
[freeside.git] / FS / FS / rate.pm
index 1285812..02d8250 100644 (file)
@@ -272,25 +272,43 @@ sub check {
 =item dest_detail REGIONNUM | RATE_REGION_OBJECTD | HASHREF
 
 Returns the rate detail (see L<FS::rate_detail>) for this rate to the
-specificed destination.  Destination can be specified as an FS::rate_detail
-object or regionnum (see L<FS::rate_detail>), or as a hashref with two keys:
-I<countrycode> and I<phonenum>.
+specificed destination, or the empty string if no rate can be found for
+the given destination.
+
+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;
+  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 (4 digits) then 3, etc.,
+    #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..6) ) {
+    for my $len ( reverse(1..10) ) {
       $rate_prefix = qsearchs('rate_prefix', {
         'countrycode' => $countrycode,
         #'npa'         => { op=> 'LIKE', value=> substr($number, 0, $len) }
@@ -302,21 +320,51 @@ sub dest_detail {
       'npa'         => '',
     });
 
-    #
-    #die "Can't find rate for call $to_or_from +$countrycode $number\n"
-    die "Can't find rate for +$countrycode $phonenum\n"
-      unless $rate_prefix;
+    return '' unless $rate_prefix;
 
     $regionnum = $rate_prefix->regionnum;
 
-    #$rate_region = $rate_prefix->rate_region;
-
   } else {
     $regionnum = ref($_[0]) ? shift->regionnum : shift;
   }
 
-  qsearchs( 'rate_detail', { 'ratenum'        => $self->ratenum,
-                             'dest_regionnum' => $regionnum,     } );
+  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 '';
+  }
+  # found nothing
+  return;
 }
 
 =item rate_detail
@@ -364,6 +412,7 @@ sub process {
         '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 {
@@ -371,6 +420,9 @@ sub process {
       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'
       };
@@ -387,10 +439,13 @@ sub process {
   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,