FS/FS/cust_pkg_discount.pm

   1 package FS::cust_pkg_discount;
   2
   3 use strict;
   4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::Record );
   5 use FS::Record qw( dbh qsearchs ); # qsearch );
   6 use FS::cust_pkg;
   7 use FS::discount;
   8
   9 =head1 NAME
  10
  11 FS::cust_pkg_discount - Object methods for cust_pkg_discount records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::cust_pkg_discount;
  16
  17   $record = new FS::cust_pkg_discount \%hash;
  18   $record = new FS::cust_pkg_discount { 'column' => 'value' };
  19
  20   $error = $record->insert;
  21
  22   $error = $new_record->replace($old_record);
  23
  24   $error = $record->delete;
  25
  26   $error = $record->check;
  27
  28 =head1 DESCRIPTION
  29
  30 An FS::cust_pkg_discount object represents the application of a discount to a
  31 customer package.  FS::cust_pkg_discount inherits from FS::Record.  The
  32 following fields are currently supported:
  33
  34 =over 4
  35
  36 =item pkgdiscountnum
  37
  38 primary key
  39
  40 =item pkgnum
  41
  42 Customer package (see L<FS::cust_pkg>)
  43
  44 =item discountnum
  45
  46 Discount (see L<FS::discount>)
  47
  48 =item months_used
  49
  50 months_used
  51
  52 =item end_date
  53
  54 end_date
  55
  56 =item usernum
  57
  58 order taker, see L<FS::access_user>
  59
  60
  61 =back
  62
  63 =head1 METHODS
  64
  65 =over 4
  66
  67 =item new HASHREF
  68
  69 Creates a new discount application.  To add the record to the database, see
  70  L<"insert">.
  71
  72 Note that this stores the hash reference, not a distinct copy of the hash it
  73 points to.  You can ask the object for a copy with the I<hash> method.
  74
  75 =cut
  76
  77 # the new method can be inherited from FS::Record, if a table method is defined
  78
  79 sub table { 'cust_pkg_discount'; }
  80
  81 =item insert
  82
  83 Adds this record to the database.  If there is an error, returns the error,
  84 otherwise returns false.
  85
  86 =cut
  87
  88 sub insert {
  89   #my( $self, %options ) = @_;
  90   my $self = shift;
  91
  92   local $SIG{HUP} = 'IGNORE';
  93   local $SIG{INT} = 'IGNORE';
  94   local $SIG{QUIT} = 'IGNORE';
  95   local $SIG{TERM} = 'IGNORE';
  96   local $SIG{TSTP} = 'IGNORE';
  97   local $SIG{PIPE} = 'IGNORE';
  98
  99   my $oldAutoCommit = $FS::UID::AutoCommit;
 100   local $FS::UID::AutoCommit = 0;
 101   my $dbh = dbh;
 102
 103   if ( $self->discountnum == -1 ) {
 104     my $discount = new FS::discount {
 105       '_type'    => $self->_type,
 106       'amount'   => $self->amount,
 107       'percent'  => $self->percent,
 108       'months'   => $self->months,
 109       'setup'    => $self->setup,
 110       #'linked'   => $self->linked,
 111       'disabled' => 'Y',
 112     };
 113     my $error = $discount->insert;
 114     if ( $error ) {
 115       $dbh->rollback if $oldAutoCommit;
 116       return $error;
 117     }
 118     $self->discountnum($discount->discountnum);
 119   }
 120
 121   my $error = $self->SUPER::insert; #(@_); #(%options);
 122   if ( $error ) {
 123     $dbh->rollback if $oldAutoCommit;
 124     return $error;
 125   }
 126
 127   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 128   '';
 129
 130 }
 131
 132 =item delete
 133
 134 Delete this record from the database.
 135
 136 =cut
 137
 138 # the delete method can be inherited from FS::Record
 139
 140 =item replace OLD_RECORD
 141
 142 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 143 returns the error, otherwise returns false.
 144
 145 =cut
 146
 147 # the replace method can be inherited from FS::Record
 148
 149 =item check
 150
 151 Checks all fields to make sure this is a valid discount applciation.  If there
 152 is an error, returns the error, otherwise returns false.  Called by the insert
 153 and replace methods.
 154
 155 =cut
 156
 157 # the check method should currently be supplied - FS::Record contains some
 158 # data checking routines
 159
 160 sub check {
 161   my $self = shift;
 162
 163   my $error =
 164     $self->ut_numbern('pkgdiscountnum')
 165     || $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum')
 166     || $self->ut_foreign_key('discountnum', 'discount', 'discountnum' )
 167     || $self->ut_sfloat('months_used') #actually decimal, but this will do
 168     || $self->ut_numbern('end_date')
 169     || $self->ut_alphan('otaker')
 170     || $self->ut_numbern('usernum')
 171     || $self->ut_enum('disabled', [ '', 'Y' ] )
 172   ;
 173   return $error if $error;
 174
 175   return "Discount does not apply to setup fees, and package has no recurring"
 176     if ! $self->discount->setup && $self->cust_pkg->part_pkg->freq =~ /^0/;
 177
 178   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
 179
 180   $self->SUPER::check;
 181 }
 182
 183 =item cust_pkg
 184
 185 Returns the customer package (see L<FS::cust_pkg>).
 186
 187 =cut
 188
 189 sub cust_pkg {
 190   my $self = shift;
 191   qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );
 192 }
 193
 194 =item discount
 195
 196 Returns the discount (see L<FS::discount>).
 197
 198 =cut
 199
 200 sub discount {
 201   my $self = shift;
 202   qsearchs('discount', { 'discountnum' => $self->discountnum } );
 203 }
 204
 205 =item increment_months_used MONTHS
 206
 207 Increments months_used by the given parameter
 208
 209 =cut
 210
 211 sub increment_months_used {
 212   my( $self, $used ) = @_;
 213   #UPDATE cust_pkg_discount SET months_used = months_used + ?
 214   #leaves no history, and billing is mutexed per-customer, so the dum way is ok
 215   $self->months_used( $self->months_used + $used );
 216   $self->replace();
 217 }
 218
 219 =item decrement_months_used MONTHS
 220
 221 Decrement months_used by the given parameter
 222
 223 (Note: as in, extending the length of the discount.  Typically only used to
 224 stack/extend a discount when the customer package has one active already.)
 225
 226 =cut
 227
 228 sub decrement_months_used {
 229   my( $self, $recharged ) = @_;
 230   #UPDATE cust_pkg_discount SET months_used = months_used - ?
 231   #leaves no history, and billing is mutexed per-customer
 232
 233   #we're run from part_event/Action/referral_pkg_discount on behalf of a
 234   # different customer, so we need to grab this customer's mutex.
 235   #   incidentally, that's some inelegant encapsulation breaking shit, and a
 236   #   great argument in favor of native-DB trigger history so we can trust
 237   #   in normal ACID like the SQL above instead of this
 238   $self->cust_pkg->cust_main->select_for_update;
 239
 240   $self->months_used( $self->months_used - $recharged );
 241   $self->replace();
 242 }
 243
 244 =item status
 245
 246 =cut
 247
 248 sub status {
 249   my $self = shift;
 250   my $discount = $self->discount;
 251
 252   if ( $self->disabled ne 'Y'
 253        and ( ! $discount->months || $self->months_used < $discount->months )
 254              #XXX also end date
 255      ) {
 256     'active';
 257   } else {
 258     'expired';
 259   }
 260 }
 261
 262 # Used by FS::Upgrade to migrate to a new database.
 263 sub _upgrade_data {  # class method
 264   my ($class, %opts) = @_;
 265   $class->_upgrade_otaker(%opts);
 266 }
 267
 268 =back
 269
 270 =head1 BUGS
 271
 272 =head1 SEE ALSO
 273
 274 L<FS::discount>, L<FS::cust_pkg>, L<FS::Record>, schema.html from the base documentation.
 275
 276 =cut
 277
 278 1;
 279