FS/FS/quotation_pkg.pm

   1 package FS::quotation_pkg;
   2 use base qw( FS::TemplateItem_Mixin FS::Record );
   3
   4 use strict;
   5 use FS::Record qw( qsearchs dbh ); #qsearch
   6 use FS::part_pkg;
   7 use FS::quotation_pkg_discount; #so its loaded when TemplateItem_Mixin needs it
   8 use List::Util qw(sum);
   9
  10 =head1 NAME
  11
  12 FS::quotation_pkg - Object methods for quotation_pkg records
  13
  14 =head1 SYNOPSIS
  15
  16   use FS::quotation_pkg;
  17
  18   $record = new FS::quotation_pkg \%hash;
  19   $record = new FS::quotation_pkg { 'column' => 'value' };
  20
  21   $error = $record->insert;
  22
  23   $error = $new_record->replace($old_record);
  24
  25   $error = $record->delete;
  26
  27   $error = $record->check;
  28
  29 =head1 DESCRIPTION
  30
  31 An FS::quotation_pkg object represents a quotation package.
  32 FS::quotation_pkg inherits from FS::Record.  The following fields are currently
  33 supported:
  34
  35 =over 4
  36
  37 =item quotationpkgnum
  38
  39 primary key
  40
  41 =item pkgpart
  42
  43 pkgpart (L<FS::part_pkg>) of the package
  44
  45 =item locationnum
  46
  47 locationnum (L<FS::cust_location>) where the package will be in service
  48
  49 =item start_date
  50
  51 expected start date for the package, as a timestamp
  52
  53 =item contract_end
  54
  55 contract end date
  56
  57 =item quantity
  58
  59 quantity
  60
  61 =item waive_setup
  62
  63 'Y' to waive the setup fee
  64
  65 =item unitsetup
  66
  67 The amount per package that will be charged in setup/one-time fees.
  68
  69 =item unitrecur
  70
  71 The amount per package that will be charged per billing cycle.
  72
  73 =back
  74
  75 =head1 METHODS
  76
  77 =over 4
  78
  79 =item new HASHREF
  80
  81 Creates a new quotation package.  To add the quotation package to the database,
  82 see L<"insert">.
  83
  84 Note that this stores the hash reference, not a distinct copy of the hash it
  85 points to.  You can ask the object for a copy with the I<hash> method.
  86
  87 =cut
  88
  89 sub table { 'quotation_pkg'; }
  90
  91 sub display_table         { 'quotation_pkg'; }
  92
  93 #forget it, just overriding cust_bill_pkg_display entirely
  94 #sub display_table_orderby { 'quotationpkgnum'; } # something else?
  95 #                                                 #  (for invoice display order)
  96
  97 sub discount_table        { 'quotation_pkg_discount'; }
  98
  99 =item insert
 100
 101 Adds this record to the database.  If there is an error, returns the error,
 102 otherwise returns false.
 103
 104 =cut
 105
 106 sub insert {
 107   my ($self, %options) = @_;
 108
 109   my $dbh = dbh;
 110   my $oldAutoCommit = $FS::UID::AutoCommit;
 111   local $FS::UID::AutoCommit = 0;
 112
 113   my $error = $self->SUPER::insert;
 114
 115   if ( !$error and $self->discountnum ) {
 116     $error = $self->insert_discount;
 117     $error .= ' (setting discount)' if $error;
 118   }
 119
 120   # update $self and any discounts with their amounts
 121   if ( !$error ) {
 122     $error = $self->estimate;
 123     $error .= ' (calculating charges)' if $error;
 124   }
 125
 126   if ( $error ) {
 127     $dbh->rollback if $oldAutoCommit;
 128     return $error;
 129   } else {
 130     $dbh->commit if $oldAutoCommit;
 131     return '';
 132   }
 133 }
 134
 135 =item delete
 136
 137 Delete this record from the database.
 138
 139 =cut
 140
 141 sub delete {
 142   my $self = shift;
 143
 144   my $dbh = dbh;
 145   my $oldAutoCommit = $FS::UID::AutoCommit;
 146   local $FS::UID::AutoCommit = 0;
 147
 148   foreach ($self->quotation_pkg_discount, $self->quotation_pkg_tax) {
 149     my $error = $_->delete;
 150     if ( $error ) {
 151       $dbh->rollback if $oldAutoCommit;
 152       return $error . ' (deleting discount)';
 153     }
 154   }
 155
 156   my $error = $self->SUPER::delete;
 157   if ( $error ) {
 158     $dbh->rollback if $oldAutoCommit;
 159     return $error;
 160   } else {
 161     $dbh->commit if $oldAutoCommit;
 162     return '';
 163   }
 164
 165 }
 166
 167 =item replace OLD_RECORD
 168
 169 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 170 returns the error, otherwise returns false.
 171
 172 =item check
 173
 174 Checks all fields to make sure this is a valid quotation package.  If there is
 175 an error, returns the error, otherwise returns false.  Called by the insert
 176 and replace methods.
 177
 178 =cut
 179
 180 sub check {
 181   my $self = shift;
 182
 183   my $error =
 184     $self->ut_numbern('quotationpkgnum')
 185     || $self->ut_foreign_key(  'quotationnum', 'quotation',    'quotationnum' )
 186     || $self->ut_foreign_key(  'pkgpart',      'part_pkg',     'pkgpart'      )
 187     || $self->ut_foreign_keyn( 'locationnum', 'cust_location', 'locationnum'  )
 188     || $self->ut_numbern('start_date')
 189     || $self->ut_numbern('contract_end')
 190     || $self->ut_numbern('quantity')
 191     || $self->ut_moneyn('unitsetup')
 192     || $self->ut_moneyn('unitrecur')
 193     || $self->ut_enum('waive_setup', [ '', 'Y'] )
 194   ;
 195
 196   if ($self->locationnum eq '') {
 197     # use the customer default
 198     my $quotation = $self->quotation;
 199     if ($quotation->custnum) {
 200       $self->set('locationnum', $quotation->cust_main->ship_locationnum);
 201     } elsif ($quotation->prospectnum) {
 202       $self->set('locationnum', $quotation->prospect_main->locationnum);
 203     } # else the quotation is invalid
 204   }
 205
 206   return $error if $error;
 207
 208   $self->SUPER::check;
 209 }
 210
 211 #it looks redundant with a v4.x+ auto-generated method, but need to override
 212 # FS::TemplateItem_Mixin's version
 213 sub part_pkg {
 214   my $self = shift;
 215   qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart } );
 216 }
 217
 218 sub desc {
 219   my $self = shift;
 220   $self->part_pkg->pkg;
 221 }
 222
 223 =item estimate
 224
 225 Update the quotation_pkg record with the estimated setup and recurring
 226 charges for the package. Returns nothing on success, or an error message
 227 on failure.
 228
 229 =cut
 230
 231 sub estimate {
 232   my $self = shift;
 233   my $part_pkg = $self->part_pkg;
 234   my $quantity = $self->quantity || 1;
 235   my ($unitsetup, $unitrecur);
 236   # calculate base fees
 237   if ( $self->waive_setup eq 'Y' || $self->{'_NO_SETUP_KLUDGE'} ) {
 238     $unitsetup = '0.00';
 239   } else {
 240     $unitsetup = $part_pkg->base_setup;
 241   }
 242   if ( $self->{'_NO_RECUR_KLUDGE'} ) {
 243     $unitrecur = '0.00';
 244   } else {
 245     $unitrecur = $part_pkg->base_recur;
 246   }
 247
 248   #XXX add-on packages
 249
 250   $self->set('unitsetup', $unitsetup);
 251   $self->set('unitrecur', $unitrecur);
 252   my $error = $self->replace;
 253   return $error if $error;
 254
 255   # semi-duplicates calc_discount
 256   my $setup_discount = 0;
 257   my $recur_discount = 0;
 258
 259   my %setup_discounts; # quotationpkgdiscountnum => amount
 260   my %recur_discounts; # quotationpkgdiscountnum => amount
 261
 262   # XXX the order of applying discounts is ill-defined, which matters
 263   # if there are percentage and amount discounts on the same package.
 264   #
 265   # but right now there can only be one discount on any package, so
 266   # it doesn't matter
 267   foreach my $pkg_discount ($self->quotation_pkg_discount) {
 268
 269     my $discount = $pkg_discount->discount;
 270     my $this_setup_discount = 0;
 271     my $this_recur_discount = 0;
 272
 273     if ( $discount->percent > 0 ) {
 274
 275       if ( $discount->setup ) {
 276         $this_setup_discount = ($discount->percent * $unitsetup / 100);
 277       }
 278       $this_recur_discount = ($discount->percent * $unitrecur / 100);
 279
 280     } elsif ( $discount->amount > 0 ) {
 281
 282       my $discount_left = $discount->amount;
 283       if ( $discount->setup ) {
 284         if ( $discount_left > $unitsetup - $setup_discount ) {
 285           # then discount the setup to zero
 286           $discount_left -= $unitsetup - $setup_discount;
 287           $this_setup_discount = $unitsetup - $setup_discount;
 288         } else {
 289           # not enough discount to fully cover the setup
 290           $this_setup_discount = $discount_left;
 291           $discount_left = 0;
 292         }
 293       }
 294       # same logic for recur
 295       if ( $discount_left > $unitrecur - $recur_discount ) {
 296         $this_recur_discount = $unitrecur - $recur_discount;
 297       } else {
 298         $this_recur_discount = $discount_left;
 299       }
 300
 301     }
 302
 303     # increment the total discountage
 304     $setup_discount += $this_setup_discount;
 305     $recur_discount += $this_recur_discount;
 306     # and update the pkg_discount object
 307     $pkg_discount->set('setup_amount', sprintf('%.2f', $setup_discount));
 308     $pkg_discount->set('recur_amount', sprintf('%.2f', $recur_discount));
 309     my $error = $pkg_discount->replace;
 310     return $error if $error;
 311   }
 312
 313   '';
 314 }
 315
 316 =item insert_discount
 317
 318 Associates this package with a discount (see L<FS::cust_pkg_discount>,
 319 possibly inserting a new discount on the fly (see L<FS::discount>). Properties
 320 of the discount will be taken from this object.
 321
 322 =cut
 323
 324 sub insert_discount {
 325   #my ($self, %options) = @_;
 326   my $self = shift;
 327
 328   my $quotation_pkg_discount = FS::quotation_pkg_discount->new( {
 329     'quotationpkgnum' => $self->quotationpkgnum,
 330     'discountnum'     => $self->discountnum,
 331     #for the create a new discount case
 332     '_type'           => $self->discountnum__type,
 333     'amount'      => $self->discountnum_amount,
 334     'percent'     => $self->discountnum_percent,
 335     'months'      => $self->discountnum_months,
 336     'setup'       => $self->discountnum_setup,
 337   } );
 338
 339   $quotation_pkg_discount->insert;
 340 }
 341
 342 sub _item_discount {
 343   my $self = shift;
 344   my @pkg_discounts = $self->pkg_discount;
 345   return if @pkg_discounts == 0;
 346
 347   my @ext;
 348   my $d = {
 349     _is_discount    => 1,
 350     description     => $self->mt('Discount'),
 351     setup_amount    => 0,
 352     recur_amount    => 0,
 353     amount          => 0,
 354     ext_description => \@ext,
 355     # maybe should show quantity/unit discount?
 356   };
 357   foreach my $pkg_discount (@pkg_discounts) {
 358     push @ext, $pkg_discount->description;
 359     $d->{setup_amount} -= $pkg_discount->setup_amount;
 360     $d->{recur_amount} -= $pkg_discount->recur_amount;
 361   }
 362   $d->{setup_amount} *= $self->quantity || 1;
 363   $d->{recur_amount} *= $self->quantity || 1;
 364   $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
 365
 366   return $d;
 367 }
 368
 369 sub setup {
 370   my $self = shift;
 371   ($self->unitsetup - sum(0, map { $_->setup_amount } $self->pkg_discount))
 372     * ($self->quantity || 1);
 373 }
 374
 375 sub recur {
 376   my $self = shift;
 377   ($self->unitrecur - sum(0, map { $_->recur_amount } $self->pkg_discount))
 378     * ($self->quantity || 1);
 379 }
 380
 381 =item part_pkg_currency_option OPTIONNAME
 382
 383 Returns a two item list consisting of the currency of this quotation's customer
 384 or prospect, if any, and a value for the provided option.  If the customer or
 385 prospect has a currency, the value is the option value the given name and the
 386 currency (see L<FS::part_pkg_currency>).  Otherwise, if the customer or
 387 prospect has no currency, is the regular option value for the given name (see
 388 L<FS::part_pkg_option>).
 389
 390 =cut
 391
 392 #false laziness w/cust_pkg->part_pkg_currency_option
 393 sub part_pkg_currency_option {
 394   my( $self, $optionname ) = @_;
 395   my $part_pkg = $self->part_pkg;
 396   my $prospect_or_customer = $self->cust_main || $self->prospect_main;
 397   if ( my $currency = $prospect_or_customer->currency ) {
 398     ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
 399   } else {
 400     ('', $part_pkg->option($optionname) );
 401   }
 402 }
 403
 404
 405 =item cust_bill_pkg_display [ type => TYPE ]
 406
 407 =cut
 408
 409 sub cust_bill_pkg_display {
 410   my ( $self, %opt ) = @_;
 411
 412   my $type = $opt{type} if exists $opt{type};
 413   return () if $type eq 'U'; #quotations don't have usage
 414
 415   if ( $self->get('display') ) {
 416     return ( grep { defined($type) ? ($type eq $_->type) : 1 }
 417                @{ $self->get('display') }
 418            );
 419   } else {
 420
 421     #??
 422     my $setup = $self->new($self->hashref);
 423     $setup->{'_NO_RECUR_KLUDGE'} = 1;
 424     $setup->{'type'} = 'S';
 425     my $recur = $self->new($self->hashref);
 426     $recur->{'_NO_SETUP_KLUDGE'} = 1;
 427     $recur->{'type'} = 'R';
 428
 429     if ( $type eq 'S' ) {
 430 sub tax_locationnum {
 431   my $self = shift;
 432   $self->locationnum;
 433 }
 434
 435       return ($setup);
 436     } elsif ( $type eq 'R' ) {
 437       return ($recur);
 438     } else {
 439       #return ($setup, $recur);
 440       return ($self);
 441     }
 442
 443   }
 444
 445 }
 446
 447 =item cust_main
 448
 449 Returns the customer (L<FS::cust_main> object).
 450
 451 =cut
 452
 453 sub cust_main {
 454   my $self = shift;
 455   my $quotation = $self->quotation or return '';
 456   $quotation->cust_main;
 457 }
 458
 459 =item prospect_main
 460
 461 Returns the prospect (L<FS::prospect_main> object).
 462
 463 =cut
 464
 465 sub prospect_main {
 466   my $self = shift;
 467   my $quotation = $self->quotation or return '';
 468   $quotation->prospect_main;
 469 }
 470
 471
 472 sub _upgrade_data {
 473   my $class = shift;
 474   my @quotation_pkg_without_location =
 475     qsearch( 'quotation_pkg', { locationnum => '' } );
 476   if (@quotation_pkg_without_location) {
 477     warn "setting default location on quotation_pkg records\n";
 478     foreach my $quotation_pkg (@quotation_pkg_without_location) {
 479       # check() will fix this
 480       my $error = $quotation_pkg->replace;
 481       if ($error) {
 482         die "quotation #".$quotation_pkg->quotationnum.": $error\n";
 483       }
 484     }
 485   }
 486   '';
 487 }
 488
 489 =back
 490
 491 =head1 BUGS
 492
 493 Doesn't support fees, or add-on packages.
 494
 495 =head1 SEE ALSO
 496
 497 L<FS::Record>, schema.html from the base documentation.
 498
 499 =cut
 500
 501 1;
 502