X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fsql_external.pm;h=1aa3cda5f1f78fd4a467a5fde1afd5b35577e191;hb=fcce61390d750f98bd82e84d4664ae9c03202be2;hp=3cf2064527c66db8ab08ac08dd21ed6300862168;hpb=624b2d44625f69d71175c3348cae635d580c890b;p=freeside.git

diff --git a/FS/FS/part_pkg/sql_external.pm b/FS/FS/part_pkg/sql_external.pm
index 3cf206452..1aa3cda5f 100644
--- a/FS/FS/part_pkg/sql_external.pm
+++ b/FS/FS/part_pkg/sql_external.pm
@@ -1,25 +1,28 @@
 package FS::part_pkg::sql_external;
+use base qw( FS::part_pkg::discount_Mixin FS::part_pkg::recur_Common );
 
 use strict;
-use base qw( FS::part_pkg::recur_Common );
 use vars qw( %info );
-use DBI;
+use FS::DBI;
 #use FS::Record qw(qsearch qsearchs);
 
+tie our %query_style, 'Tie::IxHash', (
+  'simple'    => 'Simple (a single value for the recurring charge)',
+  'detailed'  => 'Detailed (multiple rows for invoice details)',
+);
+
+our @detail_cols = ( qw(amount format duration phonenum accountcode
+                        startdate regionname detail)
+                   );
 %info = (
   'name' => 'Base charge plus additional fees for external services from a configurable SQL query',
   'shortname' => 'External SQL query',
+  'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
   'fields' => {
-    'setup_fee' => { 'name' => 'Setup fee for this package',
-                     'default' => 0,
-                   },
-    'recur_fee' => { 'name' => 'Base recurring fee for this package',
-                     'default' => 0,
-                   },
-    'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
-                                   ' of service at cancellation',
-                         'type' => 'checkbox',
-                       },
+    'sync_bill_date' => { 'name' => 'Prorate first month to synchronize '.
+                                    'with the customer\'s other packages',
+                          'type' => 'checkbox',
+                        },
     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
                                    'subscription',
                          'default' => '1',
@@ -41,25 +44,41 @@ use DBI;
                        'default' => '',
                      },
     'query' => { 'name' => 'SQL query',
+	         'type' => 'textarea',
                  'default' => '',
                },
+
+    'query_style' => {
+      'name' => 'Query output style',
+      'type' => 'select',
+      'select_options' => \%query_style,
+    },
+
   },
-  'fieldorder' => [qw( setup_fee recur_fee unused_credit recur_method cutoff_day
-                       datasrc db_username db_password query 
+  'fieldorder' => [qw( recur_method cutoff_day sync_bill_date),
+                   FS::part_pkg::prorate_Mixin::fieldorder,
+                   qw( datasrc db_username db_password query query_style
                   )],
   'weight' => '58',
 );
 
+sub price_info {
+    my $self = shift;
+    my $str = $self->SUPER::price_info;
+    $str .= " plus per-service charges" if $str;
+    $str;
+}
+
 sub calc_recur {
   my $self = shift;
-  my($cust_pkg) = @_; #, $sdate, $details, $param ) = @_;
-
-  my $price = $self->calc_recur_Common(@_);
+  my($cust_pkg, $sdate, $details, $param ) = @_;
+  my $price = 0;
+  my $quantity; # can be overridden; if not we use the default
 
-  my $dbh = DBI->connect( map { $self->option($_) }
+  my $dbh = FS::DBI->connect( map { $self->option($_) }
                               qw( datasrc db_username db_password )
                         )
-    or die $DBI::errstr;
+    or die $FS::DBI::errstr;
 
   my $sth = $dbh->prepare( $self->option('query') )
     or die $dbh->errstr;
@@ -69,13 +88,102 @@ sub calc_recur {
   ) {
     my $id = $cust_svc->svc_x->id;
     $sth->execute($id) or die $sth->errstr;
-    $price += $sth->fetchrow_arrayref->[0];
+
+    if ( $self->option('query_style') eq 'detailed' ) {
+
+      while (my $row = $sth->fetchrow_hashref) {
+        if (exists $row->{amount}) {
+          if ( $row->{amount} eq '' ) {
+            # treat as zero
+          } elsif ( $row->{amount} =~ /^\d+(?:\.\d+)?$/ ) {
+            $price += $row->{amount};
+          } else {
+            die "sql_external query returned non-numeric amount: $row->{amount}";
+          }
+        }
+        if (defined $row->{quantity}) {
+          if ( $row->{quantity} eq '' ) {
+            # treat as zero
+          } elsif ( $row->{quantity} =~ /^\d+$/ ) {
+            $quantity += $row->{quantity};
+          } else {
+            die "sql_external query returned non-integer quantity: $row->{quantity}";
+          }
+        }
+
+        my $detail = FS::cust_bill_pkg_detail->new;
+        foreach my $field (@detail_cols) {
+          if (exists $row->{$field}) {
+            $detail->set($field, $row->{$field});
+          }
+        }
+        if (!$detail->get('detail')) {
+          die "sql_external query did not return detail description";
+          # or make something up?
+          # or just don't insert the detail?
+        }
+
+        push @$details, $detail;
+      } # while $row
+
+    } else {
+
+      # simple style: returns only a single value, which is the price
+      $price += $sth->fetchrow_arrayref->[0];
+
+    }
   }
+  $price = sprintf('%.2f', $price);
 
-  $price;
+  # XXX probably shouldn't allow package quantity > 1 on these packages.
+  if ($cust_pkg->quantity > 1) {
+    warn "sql_external package #".$cust_pkg->pkgnum." has quantity > 1\n";
+  }
+
+  $param->{'override_quantity'} = $quantity;
+  $param->{'override_charges'} = $price;
+  ($cust_pkg->quantity || 1) * $self->calc_recur_Common($cust_pkg,$sdate,$details,$param);
+}
+
+sub cutoff_day {
+  my $self = shift;
+  my $cust_pkg = shift;
+  my $cust_main = $cust_pkg->cust_main;
+  # force it to act like a prorate package, is what this means
+  # because we made a distinction once between prorate and flat packages
+  if ( $cust_main->force_prorate_day  and $cust_main->prorate_day ) {
+     return ( $cust_main->prorate_day );
+  }
+  if ( $self->option('sync_bill_date',1) ) {
+    my $next_bill = $cust_pkg->cust_main->next_bill_date;
+    if ( $next_bill ) {
+      return (localtime($next_bill))[3];
+    } else {
+      # This is the customer's only active package and hasn't been billed
+      # yet, so set the cutoff day to either today or tomorrow, whichever
+      # would result in a full period after rounding.
+      my $setup = $cust_pkg->setup; # because it's "now"
+      my $rounding_mode = $self->option('prorate_round_day',1);
+      return () if !$setup or !$rounding_mode;
+      my ($sec, $min, $hour, $mday, $mon, $year) = localtime($setup);
+
+      if (   ( $rounding_mode == 1 and $hour >= 12 )
+          or ( $rounding_mode == 3 and ( $sec > 0 or $min > 0 or $hour > 0 ))
+      ) {
+        # then the prorate period will be rounded down to start from
+        # midnight tomorrow, so the cutoff day should be the current day +
+        # 1.
+        $setup = timelocal(59,59,23,$mday,$mon,$year) + 1;
+        $mday = (localtime($setup))[3];
+      }
+      # otherwise, it will be rounded up, so leave the cutoff day at today.
+      return $mday;
+    }
+  }
+  return ();
 }
 
-sub can_discount { 0; }
+sub can_discount { 1; }
 
 sub is_free { 0; }