X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_pkg_discount.pm;h=aa8981621295f9d60e974f8dbbbcf42f2727eff6;hp=76118ad9211e5fc5e09ae171cffa4a9d9935c096;hb=a36e0f8a0f69349dafaa16d1d2d57dfb6e5dbc85;hpb=0fcdc36642e1430f02ebf5326740e231883bd41f diff --git a/FS/FS/cust_pkg_discount.pm b/FS/FS/cust_pkg_discount.pm index 76118ad92..aa8981621 100644 --- a/FS/FS/cust_pkg_discount.pm +++ b/FS/FS/cust_pkg_discount.pm @@ -1,9 +1,11 @@ package FS::cust_pkg_discount; +use base qw( FS::otaker_Mixin + FS::cust_main_Mixin + FS::pkg_discount_Mixin + FS::Record ); use strict; -use base qw( FS::Record ); -use FS::Record; # qw( qsearch qsearchs ); -use FS::cust_pkg; +use FS::Record qw( dbh ); # qsearch qsearchs dbh ); use FS::discount; =head1 NAME @@ -53,10 +55,13 @@ months_used end_date -=item otaker +=item usernum -otaker +order taker, see L +=item setuprecur + +whether this discount applies to setup fees or recurring fees =back @@ -83,10 +88,6 @@ sub table { 'cust_pkg_discount'; } 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. @@ -122,15 +123,150 @@ sub check { $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_sfloat('months_used') #actually decimal, but this will do || $self->ut_numbern('end_date') - || $self->ut_text('otaker') + || $self->ut_alphan('otaker') + || $self->ut_numbern('usernum') + || $self->ut_enum('disabled', [ '', 'Y' ] ) + || $self->ut_enum('setuprecur', [ 'setup', 'recur' ] ) ; return $error if $error; + my $cust_pkg = $self->cust_pkg; + my $discount = $self->discount; + if ( $self->setuprecur eq 'setup' ) { + if ( !$discount->setup ) { + # UI prevents this, and historical discounts should never have it either + return "Discount #".$self->discountnum." can't be applied to setup fees."; + } elsif ( $cust_pkg->base_setup == 0 ) { + # and this + return "Can't apply setup discount to a package with no setup fee."; + } + # else we're good. do NOT disallow applying setup discounts when the + # setup date is already set; upgrades use that. + } else { + if ( $self->cust_pkg->base_recur == 0 ) { + return "Can't apply recur discount to a package with no recurring fee."; + } elsif ( $cust_pkg->part_pkg->freq eq '0' ) { + return "Can't apply recur discount to a one-time charge."; + } + } + + $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum; + $self->SUPER::check; } +=item cust_pkg + +Returns the customer package (see L). + +=item discount + +Returns the discount (see L). + +=item increment_months_used MONTHS + +Increments months_used by the given parameter + +=cut + +sub increment_months_used { + my( $self, $used ) = @_; + #UPDATE cust_pkg_discount SET months_used = months_used + ? + #leaves no history, and billing is mutexed per-customer, so the dum way is ok + $self->months_used( $self->months_used + $used ); + $self->replace(); +} + +=item decrement_months_used MONTHS + +Decrement months_used by the given parameter + +(Note: as in, extending the length of the discount. Typically only used to +stack/extend a discount when the customer package has one active already.) + +=cut + +sub decrement_months_used { + my( $self, $recharged ) = @_; + #UPDATE cust_pkg_discount SET months_used = months_used - ? + #leaves no history, and billing is mutexed per-customer + + #we're run from part_event/Action/referral_pkg_discount on behalf of a + # different customer, so we need to grab this customer's mutex. + # incidentally, that's some inelegant encapsulation breaking shit, and a + # great argument in favor of native-DB trigger history so we can trust + # in normal ACID like the SQL above instead of this + $self->cust_pkg->cust_main->select_for_update; + + $self->months_used( $self->months_used - $recharged ); + $self->replace(); +} + +=item status + +=cut + +sub status { + my $self = shift; + my $discount = $self->discount; + + if ( $self->disabled ne 'Y' + and ( ! $discount->months || $self->months_used < $discount->months ) + #XXX also end date + ) { + 'active'; + } else { + 'expired'; + } +} + +# Used by FS::Upgrade to migrate to a new database. +sub _upgrade_data { # class method + my ($class, %opts) = @_; + $class->_upgrade_otaker(%opts); + + # #14092: set setuprecur field on discounts. if we get one that applies to + # both setup and recur, split it into two discounts. + my $search = FS::Cursor->new({ + table => 'cust_pkg_discount', + hashref => { setuprecur => '' } + }); + while ( my $cust_pkg_discount = $search->fetch ) { + my $discount = $cust_pkg_discount->discount; + my $cust_pkg = $cust_pkg_discount->cust_pkg; + # 1. Does it apply to the setup fee? + # Yes, if: the discount applies to setup fees generally, and the package + # has a setup fee. + # No, if: the discount is a flat amount, and is not first-month only. + if ( $discount->setup + and $cust_pkg->base_setup > 0 + and ($discount->amount == 0 or $discount->months == 1) + ) + { + # then clone this discount into a new one + my $setup_discount = FS::cust_pkg_discount->new({ + $cust_pkg_discount->hash, + setuprecur => 'setup', + pkgdiscountnum => '' + }); + my $error = $setup_discount->insert; + die "$error (migrating cust_pkg_discount to setup discount)" if $error; + } + # 2. Does it apply to the recur fee? + # Yes, if: the package has a recur fee. + if ( $cust_pkg->base_recur > 0 ) { + # then modify this discount in place + $cust_pkg_discount->set('setuprecur' => 'recur'); + my $error = $cust_pkg_discount->replace; + die "$error (migrating cust_pkg_discount)" if $error; + } + # not in here yet: splitting the cust_bill_pkg_discount records. + # (not really necessary) + } +} + =back =head1 BUGS