package FS::cust_pkg_reason;
use strict;
-use vars qw( @ISA );
+use vars qw( $ignore_empty_action );
+use base qw( FS::otaker_Mixin FS::Record );
use FS::Record qw( qsearch qsearchs );
+use FS::upgrade_journal;
-@ISA = qw(FS::Record);
+$ignore_empty_action = 0;
=head1 NAME
=over 4
-=item num - primary key
+=item num
-=item pkgnum -
+primary key
-=item reasonnum -
+=item pkgnum
-=item otaker -
+=item reasonnum
-=item date -
+=item usernum
+=item date
=back
sub check {
my $self = shift;
+ my @actions = ( 'A', 'C', 'E', 'S' );
+ push @actions, '' if $ignore_empty_action;
+
my $error =
$self->ut_numbern('num')
|| $self->ut_number('pkgnum')
|| $self->ut_number('reasonnum')
- || $self->ut_enum('action', [ 'A', 'C', 'E', 'S' ])
- || $self->ut_text('otaker')
+ || $self->ut_enum('action', \@actions)
+ || $self->ut_alphan('otaker')
|| $self->ut_numbern('date')
;
return $error if $error;
$reason ? $reason->reason : '';
}
+# _upgrade_data
+#
+# Used by FS::Upgrade to migrate to a new database.
+
+use FS::h_cust_pkg;
+use FS::h_cust_pkg_reason;
+
+sub _upgrade_data { # class method
+ my ($class, %opts) = @_;
+
+ my $action_replace =
+ " AND ( history_action = 'replace_old' OR history_action = 'replace_new' )";
+
+ my $count = 0;
+ my @unmigrated = qsearch('cust_pkg_reason', { 'action' => '' } );
+ foreach ( @unmigrated ) {
+
+ my @history_cust_pkg_reason = qsearch( 'h_cust_pkg_reason', { $_->hash } );
+
+ next unless scalar(@history_cust_pkg_reason) == 1;
+
+ my $hashref = { pkgnum => $_->pkgnum,
+ history_date => $history_cust_pkg_reason[0]->history_date,
+ };
+
+ my @history = qsearch({ table => 'h_cust_pkg',
+ hashref => $hashref,
+ extra_sql => $action_replace,
+ order_by => 'ORDER BY history_action',
+ });
+
+ my $fuzz = 0;
+ while (scalar(@history) < 2 && $fuzz < 3) {
+ $hashref->{history_date}++;
+ $fuzz++;
+ push @history, qsearch({ table => 'h_cust_pkg',
+ hashref => $hashref,
+ extra_sql => $action_replace,
+ order_by => 'ORDER BY history_action',
+ });
+ }
+
+ next unless scalar(@history) == 2;
+
+ my @new = grep { $_->history_action eq 'replace_new' } @history;
+ my @old = grep { $_->history_action eq 'replace_old' } @history;
+
+ next if (scalar(@new) == 2 || scalar(@old) == 2);
+
+ if ( !$old[0]->get('cancel') && $new[0]->get('cancel') ) {
+ $_->action('C');
+ }elsif( !$old[0]->susp && $new[0]->susp ){
+ $_->action('S');
+ }elsif( $new[0]->expire &&
+ (!$old[0]->expire || !$old[0]->expire != $new[0]->expire )
+ ){
+ $_->action('E');
+ $_->date($new[0]->expire);
+ }elsif( $new[0]->adjourn &&
+ (!$old[0]->adjourn || $old[0]->adjourn != $new[0]->adjourn )
+ ){
+ $_->action('A');
+ $_->date($new[0]->adjourn);
+ }
+
+ my $error = $_->replace
+ if $_->modified;
+
+ die $error if $error;
+
+ $count++;
+ }
+
+ #remove nullability if scalar(@migrated) - $count == 0 && ->column('action');
+
+ unless ( FS::upgrade_journal->is_done('cust_pkg_reason__missing_reason') ) {
+ $class->_upgrade_missing_reason(%opts);
+ FS::upgrade_journal->set_done('cust_pkg_reason__missing_reason');
+ }
+
+ # Fix misplaced expire/suspend reasons due to package change (RT#71623).
+ # These will look like:
+ # - there is an expire reason linked to pkg1
+ # - pkg1 has been canceled before the reason's date
+ # - pkg2 was changed from pkg1, has an expire date equal to the reason's
+ # date, and has no expire reason (check this later)
+
+ my $error;
+ foreach my $action ('expire', 'adjourn') {
+ # Iterate this, because a package could be scheduled to expire, then
+ # changed several times, and we need to walk the reason forward to the
+ # last one.
+ while(1) {
+ my @reasons = qsearch(
+ {
+ select => 'cust_pkg_reason.*',
+ table => 'cust_pkg_reason',
+ addl_from => ' JOIN cust_pkg pkg1 USING (pkgnum)
+ JOIN cust_pkg pkg2 ON (pkg1.pkgnum = pkg2.change_pkgnum)',
+ hashref => { 'action' => uc(substr($action, 0, 1)) },
+ extra_sql => " AND pkg1.cancel IS NOT NULL
+ AND cust_pkg_reason.date > pkg1.cancel
+ AND pkg2.$action = cust_pkg_reason.date"
+ });
+ last if !@reasons;
+ warn "Checking ".scalar(@reasons)." possible misplaced $action reasons.\n";
+ foreach my $cust_pkg_reason (@reasons) {
+ my $new_pkg = qsearchs('cust_pkg', { change_pkgnum => $cust_pkg_reason->pkgnum });
+ my $new_reason = $new_pkg->last_cust_pkg_reason($action);
+ if ($new_reason and $new_reason->_date == $new_pkg->get($action)) {
+ # the expiration reason has been recreated on the new package, so
+ # just delete the old one
+ warn "Cleaning $action reason from canceled pkg#" .
+ $cust_pkg_reason->pkgnum . "\n";
+ $error = $cust_pkg_reason->delete;
+ } else {
+ # then the old reason needs to be transferred
+ warn "Moving $action reason from canceled pkg#" .
+ $cust_pkg_reason->pkgnum .
+ " to new pkg#" . $new_pkg->pkgnum ."\n";
+ $cust_pkg_reason->set('pkgnum' => $new_pkg->pkgnum);
+ $error = $cust_pkg_reason->replace;
+ }
+ die $error if $error;
+ }
+ }
+ }
+
+ #still can't fill in an action? don't abort the upgrade
+ local($ignore_empty_action) = 1;
+
+ $class->_upgrade_otaker(%opts);
+
+}
+
+sub _upgrade_missing_reason {
+ my ($class, %opts) = @_;
+
+ #false laziness w/above
+ my $action_replace =
+ " AND ( history_action = 'replace_old' OR history_action = 'replace_new' )";
+
+ #seek expirations/adjourns without reason
+ foreach my $field (qw( expire adjourn cancel susp )) {
+ my $addl_from =
+ "LEFT JOIN h_cust_pkg ON ".
+ "(cust_pkg_reason.pkgnum = h_cust_pkg.pkgnum AND".
+ " cust_pkg_reason.date = h_cust_pkg.$field AND".
+ " history_action = 'replace_new')";
+
+ my $extra_sql = 'AND h_cust_pkg.pkgnum IS NULL';
+
+ my @unmigrated = qsearch({ table => 'cust_pkg_reason',
+ hashref => { action => uc(substr($field,0,1)) },
+ addl_from => $addl_from,
+ select => 'cust_pkg_reason.*',
+ extra_sql => $extra_sql,
+ });
+ foreach ( @unmigrated ) {
+
+ my $hashref = { pkgnum => $_->pkgnum,
+ history_date => $_->date,
+ };
+
+ my @history = qsearch({ table => 'h_cust_pkg',
+ hashref => $hashref,
+ extra_sql => $action_replace,
+ order_by => 'ORDER BY history_action',
+ });
+
+ my $fuzz = 0;
+ while (scalar(@history) < 2 && $fuzz < 3) {
+ $hashref->{history_date}++;
+ $fuzz++;
+ push @history, qsearch({ table => 'h_cust_pkg',
+ hashref => $hashref,
+ extra_sql => $action_replace,
+ order_by => 'ORDER BY history_action',
+ });
+ }
+
+ next unless scalar(@history) == 2;
+
+ my @new = grep { $_->history_action eq 'replace_new' } @history;
+ my @old = grep { $_->history_action eq 'replace_old' } @history;
+
+ next if (scalar(@new) == 2 || scalar(@old) == 2);
+
+ $_->date($new[0]->get($field))
+ if ( $new[0]->get($field) &&
+ ( !$old[0]->get($field) ||
+ $old[0]->get($field) != $new[0]->get($field)
+ )
+ );
+
+ my $error = $_->replace
+ if $_->modified;
+
+ die $error if $error;
+ }
+ }
+
+ #seek cancels/suspends without reason, but with expire/adjourn reason
+ foreach my $field (qw( cancel susp )) {
+
+ my %precursor_map = ( 'cancel' => 'expire', 'susp' => 'adjourn' );
+ my $precursor = $precursor_map{$field};
+ my $preaction = uc(substr($precursor,0,1));
+ my $action = uc(substr($field,0,1));
+ my $addl_from =
+ "LEFT JOIN cust_pkg_reason ON ".
+ "(cust_pkg.pkgnum = cust_pkg_reason.pkgnum AND".
+ " cust_pkg.$precursor = cust_pkg_reason.date AND".
+ " cust_pkg_reason.action = '$preaction') ".
+ "LEFT JOIN cust_pkg_reason AS target ON ".
+ "(cust_pkg.pkgnum = target.pkgnum AND".
+ " cust_pkg.$field = target.date AND".
+ " target.action = '$action')"
+ ;
+
+ my $extra_sql = "WHERE target.pkgnum IS NULL AND ".
+ "cust_pkg.$field IS NOT NULL AND ".
+ "cust_pkg.$field < cust_pkg.$precursor + 86400 AND ".
+ "cust_pkg_reason.action = '$preaction'";
+
+ my @unmigrated = qsearch({ table => 'cust_pkg',
+ hashref => { },
+ select => 'cust_pkg.*',
+ addl_from => $addl_from,
+ extra_sql => $extra_sql,
+ });
+ foreach ( @unmigrated ) {
+ my $cpr = new FS::cust_pkg_reason { $_->last_cust_pkg_reason($precursor)->hash, 'num' => '' };
+ $cpr->date($_->get($field));
+ $cpr->action($action);
+
+ my $error = $cpr->insert;
+ die $error if $error;
+ }
+ }
+
+}
+
=back
=head1 BUGS
-Here be termites. Don't use on wooden computers.
-
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.