discounts, RT#6679
authorivan <ivan>
Sat, 30 Jan 2010 07:38:32 +0000 (07:38 +0000)
committerivan <ivan>
Sat, 30 Jan 2010 07:38:32 +0000 (07:38 +0000)
17 files changed:
FS/FS.pm
FS/FS/AccessRight.pm
FS/FS/Mason.pm
FS/FS/Schema.pm
FS/FS/cust_pkg_discount.pm [new file with mode: 0644]
FS/FS/discount.pm [new file with mode: 0644]
FS/FS/part_pkg.pm
FS/FS/part_pkg/flat.pm
FS/MANIFEST
FS/t/cust_pkg_discount.t [new file with mode: 0644]
FS/t/discount.t [new file with mode: 0644]
httemplate/browse/discount.html [new file with mode: 0644]
httemplate/edit/discount.html [new file with mode: 0644]
httemplate/edit/elements/edit.html
httemplate/edit/process/discount.html [new file with mode: 0644]
httemplate/elements/menu.html
httemplate/elements/tr-input-text.html

index 13dc04f..bfa23af 100644 (file)
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -226,6 +226,10 @@ L<FS::cust_pkg_option> - Customer package option class
 
 L<FS::cust_pkg_detail> - Customer package details class
 
+L<FS:;cust_pkg_discount> - Customer package discount class
+
+L<FS:;discount> - Discount class
+
 L<FS::reason_type> - Reason type class
 
 L<FS::reason> - Reason class
index ec0cce5..ab263a3 100644 (file)
@@ -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',
index 09f857a..d812e81 100644 (file)
@@ -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 ) {
index 8d35c68..ad094d7 100644 (file)
@@ -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 (file)
index 0000000..76118ad
--- /dev/null
@@ -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 (file)
index 0000000..558d0f8
--- /dev/null
@@ -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;
+
index 0aadd5a..61bfc4d 100644 (file)
@@ -767,6 +767,7 @@ sub is_free {
   }
 }
 
+sub can_discount { 0; }
 
 sub freqs_href {
   #method, class method or sub? #my $self = shift;
index f9aaebe..9bb45e6 100644 (file)
@@ -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;
index 0063e00..a92b9dd 100644 (file)
@@ -476,3 +476,7 @@ t/prospect_main.t
 FS/o2m_Common.pm
 FS/svc_pbx.pm
 t/svc_pbx.t
+FS/discount.pm
+t/discount.t
+FS/cust_pkg_discount.pm
+t/cust_pkg_discount.t
diff --git a/FS/t/cust_pkg_discount.t b/FS/t/cust_pkg_discount.t
new file mode 100644 (file)
index 0000000..51108a7
--- /dev/null
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::cust_pkg_discount;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/discount.t b/FS/t/discount.t
new file mode 100644 (file)
index 0000000..d221e8e
--- /dev/null
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::discount;
+$loaded=1;
+print "ok 1\n";
diff --git a/httemplate/browse/discount.html b/httemplate/browse/discount.html
new file mode 100644 (file)
index 0000000..f7ef0b3
--- /dev/null
@@ -0,0 +1,28 @@
+<% include( 'elements/browse.html',
+                 'title'       => 'Discounts',
+                 'name'        => 'discounts',
+                 'menubar'     => [ 'Add a new discount' =>
+                                      $p.'edit/discount.html',
+                                  ],
+                 'query'       => { 'table' => 'discount', },
+                 'count_query' => 'SELECT COUNT(*) FROM discount',
+                 'disableable' => 1,
+                 'disabled_statuspos' => 2,
+                 'header'      => [ '#', 'Name', 'Discount', ],
+                 'fields'      => [ 'discountnum',
+                                    'name',
+                                    'description',
+                                  ],
+                 'links'       => [ $link,
+                                    $link,
+                                  ],
+             )
+%>
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Configuration');
+
+my $link = [ "${p}edit/discount.html?", 'discountnum' ];
+
+</%init>
diff --git a/httemplate/edit/discount.html b/httemplate/edit/discount.html
new file mode 100644 (file)
index 0000000..24d8fa5
--- /dev/null
@@ -0,0 +1,137 @@
+<% include( 'elements/edit.html',
+                 'name'   => 'Discount',
+                 'table'  => 'discount',
+                 'fields' => [
+                               'name',
+                               { field => 'disabled', type => 'checkbox', value=>'Y', },
+                               { field => '_type',    type => 'select',
+                                 options => \@_type_options,
+                                 onchange => '_type_changed',
+                               },
+                               { field => 'amount',   type => 'money',
+                                 default => '0.00',
+                                 #cell_style => $amount_style,
+                               },
+                               { field => 'percent',  type => 'percentage',
+                                 default => 0,
+                                 #cell_style => $percent_style,
+                               },
+                               { field => 'months', type => 'text', size => 2,
+                                 postfix => '<BR><FONT SIZE="-1"><I>(blank for non-expiring discount)</I></FONT>',
+                               },
+                             ],
+                 'labels' => { 
+                               'discountnum' => 'Discount #',
+                               'name'        => 'Name&nbsp;',
+                               'disabled'    => 'Disabled&nbsp;',
+                               '_type'       => 'Type&nbsp;',
+                               'amount'      => 'Amount&nbsp;',
+                               'percent'     => 'Percentage&nbsp;',
+                               'months'      => '# of Months',
+                             },
+                 'viewall_dir' => 'browse',
+                 'new_callback' => $new_callback,
+                 'edit_callback' => $edit_callback,
+                 'error_callback' => $error_callback,
+                 'html_init' => $javascript,
+                 'body_etc' => 'onLoad="_type_changed(document.edit_topform._type)"',
+           )
+%>
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Configuration');
+
+my @_type_options = ( 'Amount', 'Percentage' );
+
+#my $amount_style = '';
+#my $percent_style = '';
+
+#my $hide = 'display:none;visibility:hidden';
+my $select = 'Select discount type';
+
+my $new_callback = sub {
+  #my( $cgi, $object, $fields_listref, $opt_hashref ) = @_;
+
+  #$amount_style  = $hide;
+  #$percent_style = $hide;
+  unshift @_type_options, $select;
+};
+
+my $edit_callback = sub {
+  #my( $cgi, $object, $fields_listref, $opt_hashref ) = @_;
+  my( $cgi, $object ) = @_;
+
+  if ( $object->amount > 0 && $object->percent == 0 ) {
+    $object->set('_type', 'Amount');
+    #$percent_style = $hide;
+  } elsif ( $object->amount == 0 && $object->percent > 0 ) {
+    $object->set('_type', 'Percentage');
+    #$amount_style = $hide;
+  } elsif ( $object->amount == 0 && $object->percent == 0 ) {
+    #$amount_style  = $hide;
+    #$percent_style = $hide;
+    unshift @_type_options, $select;
+  } else {
+    die "discount.amount and discount.percent not yet handled by web UI";
+  }
+
+};
+
+my $error_callback = sub {
+  #my( $cgi, $object, $fields_listref, $opt_hashref ) = @_;
+  my( $cgi, $object ) = @_;
+
+  if ( $cgi->param('_type') eq 'Amount' ) {
+    $object->set('_type', 'Amount');
+    #A$percent_style = $hide;
+  } elsif ( $cgi->param('_type') eq 'Percentage' ) {
+    $object->set('_type', 'Percentage');
+    #$amount_style = $hide;
+  } else {
+    #$amount_style  = $hide;
+    #$percent_style = $hide;
+    unshift @_type_options, $select;
+  }
+
+};
+
+my $javascript = <<END;
+  <SCRIPT TYPE="text/javascript">
+    function _type_changed(what) {
+      var _type = what.options[what.selectedIndex].value;
+
+      if ( _type == '$select' ) {
+        document.getElementById('amount_label').style.display = 'none';
+        document.getElementById('amount_label').style.visibility = 'hidden';
+        document.getElementById('amount_input0').style.display = 'none';
+        document.getElementById('amount_input0').style.visibility = 'hidden';
+        document.getElementById('percent_label').style.display = 'none';
+        document.getElementById('percent_label').style.visibility = 'hidden';
+        document.getElementById('percent_input0').style.display = 'none';
+        document.getElementById('percent_input0').style.visibility = 'hidden';
+      } else if ( _type == 'Amount' ) {
+        document.getElementById('amount_label').style.display = '';
+        document.getElementById('amount_label').style.visibility = '';
+        document.getElementById('amount_input0').style.display = '';
+        document.getElementById('amount_input0').style.visibility = '';
+        document.getElementById('percent_label').style.display = 'none';
+        document.getElementById('percent_label').style.visibility = 'hidden';
+        document.getElementById('percent_input0').style.display = 'none';
+        document.getElementById('percent_input0').style.visibility = 'hidden';
+      } else if ( _type == 'Percentage' ) {
+        document.getElementById('amount_label').style.display = 'none';
+        document.getElementById('amount_label').style.visibility = 'hidden';
+        document.getElementById('amount_input0').style.display = 'none';
+        document.getElementById('amount_input0').style.visibility = 'hidden';
+        document.getElementById('percent_label').style.display = '';
+        document.getElementById('percent_label').style.visibility = '';
+        document.getElementById('percent_input0').style.display = '';
+        document.getElementById('percent_input0').style.visibility = '';
+     }
+
+    }
+  </SCRIPT>
+END
+
+</%init>
index 4fe32c1..3e8b6b8 100644 (file)
@@ -250,6 +250,7 @@ Example:
 %     #text and derivitives
 %     'size'          => $f->{'size'},
 %     'maxlength'     => $f->{'maxlength'},
+%     'postfix'       => $f->{'postfix'},
 %
 %     #checkbox, title, fixed, hidden
 %     #& deprecated weird value hashref used only by reason.html
@@ -372,7 +373,7 @@ Example:
 %       $table = $f->{'m2name_table'};
 %       $col   = $f->{'m2name_namecol'};
 %     } elsif ( $f->{'o2m_table'} ) {
-%       $table = $f->{'o2m_table'};
+%       $table = $f->{'o2m_tbekable'};
 %       $col   = dbdef->table($f->{'o2m_table'})->primary_key;
 %     } elsif ( $f->{'m2m_method'} ) {
 %       $table = $f->{'m2m_method'};
diff --git a/httemplate/edit/process/discount.html b/httemplate/edit/process/discount.html
new file mode 100644 (file)
index 0000000..54307b7
--- /dev/null
@@ -0,0 +1,28 @@
+<% include( 'elements/process.html',
+               'table'       => 'discount',
+               'viewall_dir' => 'browse',
+               'precheck_callback' => $precheck_callback,
+           )
+%>
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Configuration');
+
+my $precheck_callback = sub {
+  my( $cgi ) = @_;
+
+  if ( $cgi->param('_type') eq 'Select discount type' ) {
+    return 'Please select a discount type';
+  } elsif ( $cgi->param('_type') eq 'Amount' ) {
+    $cgi->param('percent', '0');
+    return 'Amount must be greater than 0' unless $cgi->param('amount') > 0;
+  } elsif ( $cgi->param('_type') eq 'Percentage' ) {
+    $cgi->param('amount', '0.00');
+    return 'Percentage must be greater than 0' unless $cgi->param('percent') > 0;
+  }
+
+  '';
+};
+
+</%init>
index 573741e..5090abc 100644 (file)
@@ -347,18 +347,27 @@ if ( $curuser->access_right('Configuration') ) {
   $config_export_svc{'Service definitions'} = [ $fsurl.'browse/part_svc.cgi', 'Services are items you offer to your customers' ];
 }
 
+tie my %config_pkg_reason, 'Tie::IxHash',
+  'Cancel reasons' => [ $fsurl.'browse/reason.html?class=C', 'Cancel reasons explain why a service was cancelled.' ],
+  'Cancel reason types' => [ $fsurl.'browse/reason_type.html?class=C', 'Cancel reason types define groups of reasons.' ],
+  'Suspend reasons' => [ $fsurl.'browse/reason.html?class=S', 'Suspend reasons explain why a service was suspended.' ],
+  'Suspend reason types' => [ $fsurl.'browse/reason_type.html?class=S', 'Suspend reason types define groups of reasons.' ],
+;
+
 tie my %config_pkg, 'Tie::IxHash', ();
 $config_pkg{'Package definitions'} = [ $fsurl.'browse/part_pkg.cgi', 'One or more services are grouped together into a package and given pricing information. Customers purchase packages, not services' ]
   if    $curuser->access_right('Edit package definitions')
      || $curuser->access_right('Edit global package definitions');
 if ( $curuser->access_right('Configuration') ) {
+
+  #package grouping sub-menu?
   $config_pkg{'Package classes'} =  [ $fsurl.'browse/pkg_class.html', 'Package classes define groups of packages, for taxation, ordering convenience and reporting.' ];
   $config_pkg{'Package categories'} =  [ $fsurl.'browse/pkg_category.html', 'Package categories define groups of package classes.' ];
   $config_pkg{'Package report classes'} =  [ $fsurl.'browse/part_pkg_report_option.html', 'Package classes define optional groups of packages for reporting only.' ];
-  $config_pkg{'Cancel reasons'} = [ $fsurl.'browse/reason.html?class=C', 'Cancel reasons explain why a service was cancelled.' ];
-  $config_pkg{'Cancel reason types'} = [ $fsurl.'browse/reason_type.html?class=C', 'Cancel reason types define groups of reasons.' ];
-  $config_pkg{'Suspend reasons'} = [ $fsurl.'browse/reason.html?class=S', 'Suspend reasons explain why a service was suspended.' ];
-  $config_pkg{'Suspend reason types'} = [ $fsurl.'browse/reason_type.html?class=S', 'Suspend reason types define groups of reasons.' ];
+  #eo package grouping sub-menu
+
+  $config_pkg{'Discounts'} = [ $fsurl.'browse/discount.html', '' ];
+  $config_pkg{'Cancel/Suspend Reasons'} = [ \%config_pkg_reason, '' ];
 }
 
 tie my %config_cust, 'Tie::IxHash',
index 14f1425..81efa1f 100644 (file)
@@ -1,6 +1,6 @@
 <% include('tr-td-label.html', @_ ) %>
 
-  <TD <% $cell_style %>><% include('input-text.html', @_ ) %></TD>
+  <TD <% $cell_style %> ID="<% $opt{input_id} || $opt{id}.'_input0' %>"><% include('input-text.html', @_ ) %></TD>
 
 </TR>