RT# 81961 Repair broken links in POD documentation
[freeside.git] / FS / FS / cust_pkg.pm
index 91c5bd3..5dc3f4e 100644 (file)
@@ -143,7 +143,7 @@ Billing item definition (see L<FS::part_pkg>)
 
 =item locationnum
 
-Optional link to package location (see L<FS::location>)
+Optional link to package location (see L<FS::cust_location>)
 
 =item order_date
 
@@ -554,7 +554,7 @@ Available options are:
 
 =item reason
 
-can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason.  The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
+can be set to a cancellation reason (see L<FS::reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason.  The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
 
 =item reason_otaker
 
@@ -1497,7 +1497,7 @@ Available options are:
 
 =over 4
 
-=item reason - can be set to a cancellation reason (see L<FS:reason>),
+=item reason - can be set to a cancellation reason (see L<FS::reason>),
 either a reasonnum of an existing reason, or passing a hashref will create 
 a new reason.  The hashref should have the following keys: 
 - typenum - Reason type (see L<FS::reason_type>
@@ -2363,13 +2363,16 @@ sub change {
     $same_pkgpart = 0;
   }
 
+  if ($opt->{'waive_setup'}) { $self->set('waive_setup', $opt->{'waive_setup'}) }
+  else { $self->set('waive_setup', ''); }
+
   # Before going any further here: if the package is still in the pre-setup
   # state, it's safe to modify it in place. No need to charge/credit for 
   # partial period, transfer usage pools, copy invoice details, or change any
   # dates. We DO need to "transfer" services (from the package to itself) to
   # check their validity on the new pkgpart.
   if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
-    foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
+    foreach ( qw( locationnum pkgpart quantity refnum salesnum waive_setup ) ) {
       if ( length($opt->{$_}) ) {
         $self->set($_, $opt->{$_});
       }
@@ -2762,6 +2765,10 @@ The date for the package change.  Required, and must be in the future.
 
 =item quantity
 
+=item discount
+
+Optional hashref that will be passed to $new_pkg->change_discount()
+
 =item contract_end
 
 The pkgpart, locationnum, quantity and optional contract_end of the new 
@@ -2779,6 +2786,9 @@ sub change_later {
   my $error = $self->_check_change($opt);
   return $error if $error;
 
+  my %discount;
+  %discount = %{$opt->{discount}} if ref $opt->{discount};
+
   my $oldAutoCommit = $FS::UID::AutoCommit;
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
@@ -2831,6 +2841,10 @@ sub change_later {
                  (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
                   $change_to->cancel('no_delay_cancel' => 1) ||
                   $change_to->delete);
+
+        # Apply user-specified discount to new cust_pkg
+        $error = $err_or_pkg->change_discount(\%discount)
+          if !$error && %discount && $discount{discountnum} =~ /^-?\d+$/;
       } else {
         $error = $err_or_pkg;
       }
@@ -2838,6 +2852,10 @@ sub change_later {
       $self->set('expire', $date);
       $change_to->set('start_date', $date);
       $error = $self->replace || $change_to->replace;
+
+      # Apply user-specified discount to new cust_pkg
+      $error = $change_to->change_discount(\%discount)
+        if !$error && %discount && $discount{discountnum} =~ /^-?\d+$/;
     }
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
@@ -2877,6 +2895,11 @@ sub change_later {
     $self->set('expire', $date);
     $error = $self->replace;
   }
+
+  # Apply user-specified discount to new cust_pkg
+  $new->change_discount(\%discount)
+    if !$error && %discount && $discount{discountnum} =~ /^-?\d+$/;
+
   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
   } else {
@@ -3156,11 +3179,10 @@ sub process_bulk_cust_pkg {
   my $param = thaw(decode_base64(shift));
   warn Dumper($param) if $DEBUG;
 
-  my $old_part_pkg = qsearchs('part_pkg', 
-                              { pkgpart => $param->{'old_pkgpart'} });
   my $new_part_pkg = qsearchs('part_pkg',
                               { pkgpart => $param->{'new_pkgpart'} });
-  die "Must select a new package type\n" unless $new_part_pkg;
+  die "Must select a new package definition\n" unless $new_part_pkg;
+
   #my $keep_dates = $param->{'keep_dates'} || 0;
   my $keep_dates = 1; # there is no good reason to turn this off
 
@@ -3175,7 +3197,14 @@ sub process_bulk_cust_pkg {
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
 
-  my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
+  my @old_pkgpart = ref($param->{'old_pkgpart'}) ? @{ $param->{'old_pkgpart'} }
+                                                 : $param->{'old_pkgpart'};
+
+  my @cust_pkgs = qsearch({
+                    'table' => 'cust_pkg',
+                    'extra_sql' => ' WHERE pkgpart IN ('.
+                                       join(',', @old_pkgpart). ')',
+                  });
 
   my $i = 0;
   foreach my $old_cust_pkg ( @cust_pkgs ) {
@@ -4601,7 +4630,7 @@ Available options are:
 
 =item reason
 
-can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason.  The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
+can be set to a cancellation reason (see L<FS::reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason.  The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
 
 =item reason_otaker
 
@@ -4701,6 +4730,139 @@ sub insert_discount {
   $cust_pkg_discount->insert;
 }
 
+
+=item change_discount %opt
+
+Method checks if the given values represent a change in either setup or
+discount level.  If so, the existing discounts are revoked, the new
+discounts are recorded.
+
+Usage:
+
+$error = change_discount(
+  {
+    # -1: Indicates a "custom discount"
+    #  0: Indicates to remove any discount
+    # >0: discountnum to apply
+    discountnum => [-1, 0, discountnum],
+
+    # When discountnum is "-1" to indicate custom discount, include
+    # the additional fields:
+    amount      => AMOUNT_DISCOUNT
+    percent     => PERCENTAGE_DISCOUNT
+    months      => 12,
+    setup       => 1, # APPLY TO SETUP
+    _type       => amount/percentage
+  },
+);
+
+
+=cut
+
+sub change_discount {
+  my ($self, $opt) = @_;
+  return "change_discount() called with bad \%opt hashref"
+    unless ref $opt;
+
+  my %opt = %{$opt};
+
+  my @old_discount =
+    qsearch('cust_pkg_discount',{
+      pkgnum   => $self->pkgnum,
+      disabled => '',
+    });
+
+  if ($DEBUG) {
+    warn "change_discount() pkgnum: ".$self->pkgnum." \n";
+    warn "change_discount() \%opt: \n";
+    warn Dumper(\%opt);
+  }
+
+  my @to_be_disabled;
+  my %change = %opt;
+
+  return "change_discount() called with bad discountnum"
+    unless $change{discountnum} =~ /^-?\d+$/;
+
+  if ($change{discountnum} eq 0) {
+    # Removing old discount
+
+    %change = ();
+
+    push @to_be_disabled, @old_discount;
+
+  } else {
+
+    if ( grep { $_->discountnum eq $change{discountnum} } @old_discount ){
+      # Duplicate, disregard this entry
+      %change = ();
+    } else {
+      # Mark any discounts we're replacing
+      push @to_be_disabled, @old_discount;
+    }
+  }
+
+  # If we still have changes queued, create data structures for
+  # insert_discount().
+  my @discount_insert;
+  if (%change) {
+    push @discount_insert, {
+      discountnum         => $change{discountnum},
+      discountnum__type   => $change{_type},
+      discountnum_amount  => $change{amount},
+      discountnum_percent => $change{percent} ? $change{percent} : '0',
+      discountnum_months  => $change{months},
+      discountnum_setup   => $change{setup} ? 'Y' : '',
+    }
+  }
+
+  if ($DEBUG) {
+    warn "change_discount() \% opt before insert \n";
+    warn Dumper \%opt;
+    warn "\@to_be_disabled \n";
+    warn Dumper \@to_be_disabled;
+  }
+
+  # Roll these updates into a transaction
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $error;
+
+  # The "waive setup fee" flag has traditionally been handled by setting
+  # $cust_pkg->waive_setup = Y.  This has been appropriately, and separately
+  # handled, and it operates on a different table than cust_pkg_discount,
+  # so the "-2 for waive setup fee" option is not being reimplemented
+  # here.  Perhaps this may change later.
+
+  # Create new discounts
+  for my $insert_discount (@discount_insert) {
+
+    # Set parameters for insert_discount into object, and insert
+    for my $k (keys %{$insert_discount}) {
+      $self->set($k, $insert_discount->{$k});
+    }
+    $error ||= $self->insert_discount();
+  }
+
+  # Disabling old discounts
+  for my $tbd (@to_be_disabled) {
+    unless ($error) {
+      $tbd->set(disabled => 'Y');
+      $error = $tbd->replace();
+    }
+  }
+
+  if ($error) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $dbh->commit if $oldAutoCommit;
+  return undef;
+}
+
 =item set_usage USAGE_VALUE_HASHREF 
 
 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
@@ -5731,6 +5893,8 @@ sub search {
     push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
   }
 
+  push @where, "cust_pkg_reason.reasonnum = '".$params->{reasonnum}."'" if $params->{reasonnum};
+
   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
 
   my $addl_from = 'LEFT JOIN part_pkg  USING ( pkgpart  ) '.
@@ -5738,6 +5902,10 @@ sub search {
                   'LEFT JOIN cust_location USING ( locationnum ) '.
                   FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
 
+  if ($params->{reasonnum}) {
+    $addl_from .= 'LEFT JOIN cust_pkg_reason ON (cust_pkg_reason.pkgnum = cust_pkg.pkgnum) ';
+  }
+
   my $select;
   my $count_query;
   if ( $params->{'select_zip5'} ) {
@@ -5801,6 +5969,24 @@ sub fcc_477_count {
 
 }
 
+=item fcc_477_record
+
+Returns a fcc_477 record based on option name.
+
+=cut
+
+sub fcc_477_record {
+  my ($self, $option_name) = @_;
+
+  my $fcc_record = qsearchs({
+    'table'     => 'part_pkg_fcc_option',
+    'hashref'   => { 'pkgpart' => $self->{Hash}->{pkgpart}, 'fccoptionname' => $option_name, },
+  });
+
+  return ( $fcc_record );
+
+}
+
 =item tax_locationnum_sql
 
 Returns an SQL expression for the tax location for a package, based
@@ -6325,4 +6511,3 @@ L<FS::pkg_svc>, schema.html from the base documentation
 =cut
 
 1;
-