RT#14671: Usage for current day when billing outstanding usage (for cancelling custom...
[freeside.git] / FS / FS / part_pkg_link.pm
index fb7a8d3..aee0131 100644 (file)
@@ -2,8 +2,11 @@ package FS::part_pkg_link;
 
 use strict;
 use vars qw( @ISA );
-use FS::Record qw( qsearchs );
+use FS::Record qw( qsearchs qsearch dbh );
 use FS::part_pkg;
+use FS::cust_pkg;
+use FS::reason;
+use FS::reason_type;
 
 @ISA = qw(FS::Record);
 
@@ -49,12 +52,13 @@ Destination package (see L<FS::part_pkg>)
 =item link_type
 
 Link type - currently, "bill" (source package bills a line item from target
-package), or "svc" (source package includes services from target package).
+package), or "svc" (source package includes services from target package), 
+or "supp" (ordering source package creates a target package).
 
 =item hidden
 
 Flag indicating that this subpackage should be felt, but not seen as an invoice
-line item when set to 'Y'
+line item when set to 'Y'.  Not allowed for "supp" links.
 
 =back
 
@@ -80,17 +84,136 @@ sub table { 'part_pkg_link'; }
 Adds this record to the database.  If there is an error, returns the error,
 otherwise returns false.
 
+If this is a supplemental package link, inserting it will order the 
+supplemental packages for any main packages that already exist.
+
 =cut
 
-# the insert method can be inherited from FS::Record
+sub insert {
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $self = shift;
+  my $error = $self->SUPER::insert(@_);
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error if $error;
+  }
+
+  if ( $self->link_type eq 'supp' ) {
+    # queue this?
+    my @main_pkgs = qsearch('cust_pkg', {
+        pkgpart => $self->src_pkgpart,
+        cancel  => '',
+    });
+    foreach my $main_pkg (@main_pkgs) {
+      # duplicates code in FS::cust_pkg::uncancel, sort of
+      my $supp_pkg = FS::cust_pkg->new({
+          'pkgpart'     => $self->dst_pkgpart,
+          'pkglinknum'  => $self->pkglinknum,
+          'main_pkgnum' => $main_pkg->pkgnum,
+          'order_date'  => time,
+          map { $_ => $main_pkg->get($_) }
+          qw( custnum locationnum pkgbatch 
+              start_date setup expire adjourn contract_end bill susp 
+              refnum discountnum waive_setup quantity 
+              recur_show_zero setup_show_zero )
+      });
+      $error = $supp_pkg->insert;
+      if ( $error ) {
+        $dbh->rollback if $oldAutoCommit;
+        return "$error (ordering new supplemental package to pkg#".$main_pkg->pkgnum.")" if $error;
+      }
+    }
+
+    return $error if $error;
+  }
+
+  return;
+}
 
 =item delete
 
 Delete this record from the database.
 
+If this is a supplemental package link, deleting it will set pkglinknum = null
+for any related packages, and set those packages to expire on their next bill
+date.
+
 =cut
 
-# the delete method can be inherited from FS::Record
+my $cancel_reason_text = 'Supplemental package removed';
+my $cancel_reason_type = 'Cancel Reason';
+
+sub delete {
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $self = shift;
+
+  if ( $self->link_type eq 'supp' ) {
+    my $error = $self->remove_linked;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return $error;
+    }
+  }
+
+  my $error = $self->SUPER::delete(@_);
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+  $dbh->commit;
+  return;
+}
+
+sub remove_linked {
+  my $self = shift;
+  my $pkglinknum = $self->pkglinknum;
+  my $error;
+
+  # find linked packages
+  my @pkgs = qsearch('cust_pkg', { pkglinknum => $pkglinknum });
+  warn "expiring ".scalar(@pkgs).
+       " linked packages from part_pkg_link #$pkglinknum\n";
+
+  my $reason = qsearchs('reason', { reason => $cancel_reason_text });
+  if (!$reason) {
+    # upgrade/FS::Setup created this one automatically
+    my $reason_type = qsearchs('reason_type',
+                               { type => $cancel_reason_type }
+      ) or die "default cancel reason type does not exist";
+
+    $reason = FS::reason->new({
+        reason_type => $reason_type->typenum,
+        reason      => $cancel_reason_text,
+        disabled    => 'Y',
+    });
+    $error = $reason->insert;
+    if ( $error ) {
+      return "$error (creating package cancel reason)";
+    }
+  }
+
+  foreach my $pkg (@pkgs) {
+    $pkg->set('pkglinknum' => '');
+    if ( $pkg->get('cancel') ) {
+      # then just replace it to unlink the package from this object
+      $error = $pkg->replace;
+    } else {
+      $error = $pkg->cancel(
+        'date'    => $pkg->get('bill'), # cancel on next bill, or else now
+        'reason'  => $reason->reasonnum,
+      );
+    }
+    if ( $error ) {
+      return "$error (scheduling package #".$pkg->pkgnum." for expiration)";
+    }
+  }
+}
 
 =item replace OLD_RECORD
 
@@ -119,11 +242,26 @@ sub check {
     $self->ut_numbern('pkglinknum')
     || $self->ut_foreign_key('src_pkgpart', 'part_pkg', 'pkgpart')
     || $self->ut_foreign_key('dst_pkgpart', 'part_pkg', 'pkgpart')
-    || $self->ut_enum('link_type', [ 'bill', 'svc' ] )
+    || $self->ut_enum('link_type', [ 'bill', 'svc', 'supp' ] )
     || $self->ut_enum('hidden', [ '', 'Y' ] )
   ;
   return $error if $error;
 
+  if ( $self->link_type eq 'supp' ) {
+    # some sanity checking
+    my $src_pkg = $self->src_pkg;
+    my $dst_pkg = $self->dst_pkg;
+    if ( $src_pkg->freq eq '0' and $dst_pkg->freq ne '0' ) {
+      return "One-time charges can't have supplemental packages."
+    } elsif ( $dst_pkg->freq ne '0' ) {
+      my $ratio = $dst_pkg->freq / $src_pkg->freq;
+      if ($ratio != int($ratio)) {
+        return "Supplemental package period (pkgpart ".$dst_pkg->pkgpart.
+               ") must be an integer multiple of main package period.";
+      }
+    }
+  }
+
   $self->SUPER::check;
 }