ACL for hardware class config, RT#85057

[freeside.git] / FS / FS / sales.pm

diff --git a/FS/FS/sales.pm b/FS/FS/sales.pm
index 82c875a..c1e075e 100644 (file)
--- a/FS/FS/sales.pm
+++ b/FS/FS/sales.pm
@@ -1,5 +1,5 @@
 package FS::sales;
-use base qw( FS::Agent_Mixin FS::Record );
+use base qw( FS::Commission_Mixin FS::Agent_Mixin FS::Record );
 
 use strict;
 use FS::Record qw( qsearch qsearchs );
@@ -38,14 +38,21 @@ FS::Record.  The following fields are currently supported:
 
 primary key
 
+=item salesperson
+
+Name
+
 =item agentnum
 
-agentnum
+Agent (see L<FS::agent>)
 
 =item disabled
 
-disabled
+Disabled flag, empty or `Y'
 
+=item sales_custnum
+
+Sales person master customer (see L<FS::cust_main>)
 
 =back
 
@@ -131,59 +138,64 @@ sub sales_cust_main {
   qsearchs( 'cust_main', { 'custnum' => $self->sales_custnum } );
 }
 
-sub cust_bill_pkg {
-  my( $self, $sdate, $edate, %search ) = @_;
-
-  my $cmp_salesnum = delete $search{'cust_main_sales'}
-                       ? ' COALESCE( cust_pkg.salesnum, cust_main.salesnum )'
-                       : ' cust_pkg.salesnum ';
+=item cust_bill_pkg START END OPTIONS
 
-  my $classnum_sql = '';
-  if ( exists( $search{'classnum'}  ) ) {
-    my $classnum = $search{'classnum'};
-    $classnum_sql = " AND part_pkg.classnum ". ( $classnum ? " = $classnum "
-                                                           : ' IS NULL '     );
-  }
+Returns the package line items (see L<FS::cust_bill_pkg>) for which this 
+sales person could receive commission.
 
-  qsearch({ 'table'     => 'cust_bill_pkg',
-            'select'    => 'cust_bill_pkg.*',
-            'addl_from' => ' LEFT JOIN cust_bill USING ( invnum ) '.
-                           ' LEFT JOIN cust_pkg  USING ( pkgnum ) '.
-                           ' LEFT JOIN part_pkg  USING ( pkgpart ) '.
-                           ' LEFT JOIN cust_main ON ( cust_pkg.custnum = cust_main.custnum )',
-            'extra_sql' => ( keys %{ $search{'hashref'} }
-                               ? ' AND ' : 'WHERE '
-                           ).
-                           "     cust_bill._date >= $sdate ".
-                           " AND cust_bill._date  < $edate ".
-                           " AND $cmp_salesnum = ". $self->salesnum.
-                           $classnum_sql,
-            #%search,
-         });
-}
+START and END are an optional date range to limit the results.
 
-sub cust_credit {
-  my( $self, $sdate, $edate, %search ) = @_;
+OPTIONS may contain:
+- I<cust_main_sales>: if this is a true value, sales of packages that have no
+package sales person will be included if this is their customer sales person.
+- I<classnum>: limit to this package classnum.
+- I<paid>: limit to sales that have no unpaid balance.
 
-  $search{'hashref'}->{'commission_salesnum'} = $self->salesnum;
+=cut
 
-  my $classnum_sql = '';
-  if ( exists($search{'commission_classnum'}) ) {
-    my $classnum = delete($search{'commission_classnum'});
-    $classnum_sql = " AND part_pkg.classnum ". ( $classnum ? " = $classnum"
-                                                           : " IS NULL "    );
+sub sales_where {
+  my $self = shift;
+  my $salesnum = $self->salesnum;
+  die "bad salesnum" unless $salesnum =~ /^(\d+)$/;
+  my %opt = @_;
 
-    $search{'addl_from'} .=
-      ' LEFT JOIN cust_pkg ON ( commission_pkgnum = cust_pkg.pkgnum ) '.
-      ' LEFT JOIN part_pkg USING ( pkgpart ) ';
+  my $cmp_salesnum = 'cust_pkg.salesnum';
+  if ($opt{cust_main_sales}) {
+    $cmp_salesnum = 'COALESCE(cust_pkg.salesnum, cust_main.salesnum)';
   }
 
-  qsearch({ 'table'     => 'cust_credit',
-            'extra_sql' => " AND cust_credit._date >= $sdate ".
-                           " AND cust_credit._date  < $edate ".
-                           $classnum_sql,
-            %search,
-         });
+  my @where = ( "$cmp_salesnum    = $salesnum",
+                "sales_pkg_class.salesnum = $salesnum"
+              );
+
+  # sales_pkg_class number-of-months limit, grr
+  # (we should be able to just check for the cust_event record from the 
+  # commission credit, but the report is supposed to act as a check on that)
+  #
+  # Pg-specific, of course
+  my $setup_date = 'TO_TIMESTAMP( cust_pkg.setup )';
+  my $interval = "(sales_pkg_class.commission_duration || ' months')::interval";
+  my $charge_date = 'TO_TIMESTAMP( cust_bill._date )';
+  push @where, "CASE WHEN sales_pkg_class.commission_duration IS NOT NULL ".
+               "THEN $charge_date < $setup_date + $interval ".
+               "ELSE TRUE END";
+
+  @where;
+}
+
+sub commission_where {
+  my $self = shift;
+  'cust_credit.commission_salesnum = ' . $self->salesnum;
+}
+
+# slightly modify it
+sub cust_bill_pkg_search {
+  my $self = shift;
+  my $search = $self->SUPER::cust_bill_pkg_search(@_);
+  $search->{addl_from} .= '
+    JOIN sales_pkg_class ON( COALESCE(sales_pkg_class.classnum, 0) = COALESCE(part_pkg.classnum, 0) )';
+
+  return $search;
 }
 
 =back