discounts, RT#6679

7 files changed, 343 insertions, 3 deletions

diff --git a/FS/FS/AccessRight.pm b/FS/FS/AccessRight.pm
index ec0cce5..ab263a3 100644
--- a/FS/FS/AccessRight.pm
+++ b/FS/FS/AccessRight.pm
@@ -126,6 +126,8 @@ tie my %rights, 'Tie::IxHash',
     'Change customer package',
     'Bulk change customer packages',
     'Edit customer package dates',
+    'Discount customer package', #NEW
+    'Custom discount customer package', #NEW
     'Customize customer package',
     'Suspend customer package',
     'Suspend customer package later',
diff --git a/FS/FS/Mason.pm b/FS/FS/Mason.pm
index 09f857a..d812e81 100644
--- a/FS/FS/Mason.pm
+++ b/FS/FS/Mason.pm
@@ -227,6 +227,7 @@ if ( -e $addl_handler_use_file ) {
   use FS::prospect_main;
   use FS::contact;
   use FS::svc_pbx;
+  use FS::discount;
   # Sammath Naur
 
   if ( $FS::Mason::addl_handler_use ) {
diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm
index 8d35c68..ad094d7 100644
--- a/FS/FS/Schema.pm
+++ b/FS/FS/Schema.pm
@@ -1309,6 +1309,35 @@ sub tables_hashref {
       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
     },
 
+    'cust_pkg_discount' => {
+      'columns' => [
+        'pkgdiscountnum', 'serial', '',     '', '', '',
+        'pkgnum',            'int', '',     '', '', '', 
+        'discountnum',       'int', '',     '', '', '',
+        'months_used',   'decimal', 'NULL', '', '', '',
+        'end_date',     @date_type,             '', '',
+        'otaker',        'varchar', '',     32, '', '', 
+      ],
+      'primary_key' => 'pkgdiscountnum',
+      'unique' => [],
+      'index'  => [ [ 'pkgnum' ], [ 'discountnum' ] ],
+    },
+
+    'discount' => {
+      'columns' => [
+        'discountnum', 'serial',     '',      '', '', '',
+        #'agentnum',       'int', 'NULL',      '', '', '', 
+        'name',       'varchar', 'NULL', $char_d, '', '',
+        'amount',   @money_type,                  '', '', 
+        'percent',    'decimal',     '',      '', '', '',
+        'months',     'decimal', 'NULL',      '', '', '',
+        'disabled',      'char', 'NULL',       1, '', '', 
+      ],
+      'primary_key' => 'discountnum',
+      'unique' => [],
+      'index'  => [], # [ 'agentnum' ], ],
+    },
+
     'cust_refund' => {
       'columns' => [
         'refundnum',    'serial',    '',   '', '', '', 
diff --git a/FS/FS/cust_pkg_discount.pm b/FS/FS/cust_pkg_discount.pm
new file mode 100644
index 0000000..76118ad
--- /dev/null
+++ b/FS/FS/cust_pkg_discount.pm
@@ -0,0 +1,145 @@
+package FS::cust_pkg_discount;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record; # qw( qsearch qsearchs );
+use FS::cust_pkg;
+use FS::discount;
+
+=head1 NAME
+
+FS::cust_pkg_discount - Object methods for cust_pkg_discount records
+
+=head1 SYNOPSIS
+
+  use FS::cust_pkg_discount;
+
+  $record = new FS::cust_pkg_discount \%hash;
+  $record = new FS::cust_pkg_discount { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::cust_pkg_discount object represents the application of a discount to a
+customer package.  FS::cust_pkg_discount inherits from FS::Record.  The
+following fields are currently supported:
+
+=over 4
+
+=item pkgdiscountnum
+
+primary key
+
+=item pkgnum
+
+Customer package (see L<FS::cust_pkg>)
+
+=item discountnum
+
+Discount (see L<FS::discount>)
+
+=item months_used
+
+months_used
+
+=item end_date
+
+end_date
+
+=item otaker
+
+otaker
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new discount application.  To add the record to the database, see
+ L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'cust_pkg_discount'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid discount applciation.  If there
+is an error, returns the error, otherwise returns false.  Called by the insert
+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('pkgdiscountnum')
+    || $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum')
+    || $self->ut_foreign_key('discountnum', 'discount', 'discountnum' )
+    || $self->ut_float('months_used') #actually decimal, but this will do
+    || $self->ut_numbern('end_date')
+    || $self->ut_text('otaker')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::discount>, L<FS::cust_pkg>, L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/FS/discount.pm b/FS/FS/discount.pm
new file mode 100644
index 0000000..558d0f8
--- /dev/null
+++ b/FS/FS/discount.pm
@@ -0,0 +1,162 @@
+package FS::discount;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::discount - Object methods for discount records
+
+=head1 SYNOPSIS
+
+  use FS::discount;
+
+  $record = new FS::discount \%hash;
+  $record = new FS::discount { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::discount object represents a discount definition.  FS::discount inherits
+from FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item discountnum
+
+primary key
+
+=item name
+
+name
+
+=item amount
+
+amount
+
+=item percent
+
+percent
+
+=item months
+
+months
+
+=item disabled
+
+disabled
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new discount.  To add the discount to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'discount'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid discount.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+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('discountnum')
+    || $self->ut_textn('name')
+    || $self->ut_money('amount')
+    || $self->ut_float('percent') #actually decimal, but this will do
+    || $self->ut_floatn('months') #actually decimal, but this will do
+    || $self->ut_enum('disabled', [ '', 'Y' ])
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=item description
+
+Returns a text description incorporating the amount, percent and months fields.
+
+=cut
+
+sub description {
+  my $self = shift;
+
+  my $conf = new FS::Conf;
+  my $money_char = $conf->config('money_char') || '$';  
+
+  my $desc = '';
+  $desc .= $money_char. sprintf('%.2f/month ', $self->amount)
+    if $self->amount > 0;
+  $desc .= $self->percent. '% '
+    if $self->percent > 0;
+  $desc .= 'for '. $self->months. ' months' if $self->months;
+
+  $desc;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::cust_pkg_discount>, L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/FS/part_pkg.pm b/FS/FS/part_pkg.pm
index 0aadd5a..61bfc4d 100644
--- a/FS/FS/part_pkg.pm
+++ b/FS/FS/part_pkg.pm
@@ -767,6 +767,7 @@ sub is_free {
   }
 }
 
+sub can_discount { 0; }
 
 sub freqs_href {
   #method, class method or sub? #my $self = shift;
diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm
index f9aaebe..9bb45e6 100644
--- a/FS/FS/part_pkg/flat.pm
+++ b/FS/FS/part_pkg/flat.pm
@@ -210,9 +210,9 @@ sub is_free_options {
   qw( setup_fee recur_fee );
 }
 
-sub is_prepaid {
-  0; #no, we're postpaid
-}
+sub is_prepaid { 0; } #no, we're postpaid
+
+sub can_discount { 1; } #and anything that inherits from us
 
 sub usage_valuehash {
   my $self = shift;