FS/FS/cust_pkg_reason.pm

   1 package FS::cust_pkg_reason;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs );
   6
   7 @ISA = qw(FS::Record);
   8
   9 =head1 NAME
  10
  11 FS::cust_pkg_reason - Object methods for cust_pkg_reason records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::cust_pkg_reason;
  16
  17   $record = new FS::cust_pkg_reason \%hash;
  18   $record = new FS::cust_pkg_reason { '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_reason object represents a relationship between a cust_pkg
  31 and a reason, for example cancellation or suspension reasons.
  32 FS::cust_pkg_reason inherits from FS::Record.  The following fields are
  33 currently supported:
  34
  35 =over 4
  36
  37 =item num - primary key
  38
  39 =item pkgnum -
  40
  41 =item reasonnum -
  42
  43 =item otaker -
  44
  45 =item date -
  46
  47
  48 =back
  49
  50 =head1 METHODS
  51
  52 =over 4
  53
  54 =item new HASHREF
  55
  56 Creates a new cust_pkg_reason.  To add the example to the database, see
  57 L<"insert">.
  58
  59 Note that this stores the hash reference, not a distinct copy of the hash it
  60 points to.  You can ask the object for a copy with the I<hash> method.
  61
  62 =cut
  63
  64 sub table { 'cust_pkg_reason'; }
  65
  66 =item insert
  67
  68 Adds this record to the database.  If there is an error, returns the error,
  69 otherwise returns false.
  70
  71 =cut
  72
  73 =item delete
  74
  75 Delete this record from the database.
  76
  77 =cut
  78
  79 =item replace OLD_RECORD
  80
  81 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  82 returns the error, otherwise returns false.
  83
  84 =cut
  85
  86 =item check
  87
  88 Checks all fields to make sure this is a valid cust_pkg_reason.  If there is
  89 an error, returns the error, otherwise returns false.  Called by the insert
  90 and replace methods.
  91
  92 =cut
  93
  94 sub check {
  95   my $self = shift;
  96
  97   my $error =
  98     $self->ut_numbern('num')
  99     || $self->ut_number('pkgnum')
 100     || $self->ut_number('reasonnum')
 101     || $self->ut_enum('action', [ 'A', 'C', 'E', 'S' ])
 102     || $self->ut_text('otaker')
 103     || $self->ut_numbern('date')
 104   ;
 105   return $error if $error;
 106
 107   $self->SUPER::check;
 108 }
 109
 110 =item reason
 111
 112 Returns the reason (see L<FS::reason>) associated with this cust_pkg_reason.
 113
 114 =cut
 115
 116 sub reason {
 117   my $self = shift;
 118   qsearchs( 'reason', { 'reasonnum' => $self->reasonnum } );
 119 }
 120
 121 =item reasontext
 122
 123 Returns the text of the reason (see L<FS::reason>) associated with this
 124 cust_pkg_reason.
 125
 126 =cut
 127
 128 sub reasontext {
 129   my $reason = shift->reason;
 130   $reason ? $reason->reason : '';
 131 }
 132
 133 # _upgrade_data
 134 #
 135 # Used by FS::Upgrade to migrate to a new database.
 136
 137 use FS::h_cust_pkg;
 138 use FS::h_cust_pkg_reason;
 139
 140 sub _upgrade_data { # class method
 141   my ($class, %opts) = @_;
 142
 143   my $test_cust_pkg_reason = new FS::cust_pkg_reason;
 144   return '' unless $test_cust_pkg_reason->dbdef_table->column('action');
 145
 146   my $count = 0;
 147   my @unmigrated = qsearch('cust_pkg_reason', { 'action' => '' } );
 148   foreach ( @unmigrated ) {
 149
 150     my @history_cust_pkg_reason = qsearch( 'h_cust_pkg_reason', { $_->hash } );
 151
 152     next unless scalar(@history_cust_pkg_reason) == 1;
 153
 154     my %action_value = ( op    => 'LIKE',
 155                          value => 'replace_%',
 156                        );
 157     my $hashref = { pkgnum => $_->pkgnum,
 158                     history_date   => $history_cust_pkg_reason[0]->history_date,
 159                     history_action => { %action_value },
 160                   };
 161
 162     my @history = qsearch({ table    => 'h_cust_pkg',
 163                             hashref  => $hashref,
 164                             order_by => 'ORDER BY history_action',
 165                          });
 166
 167     my $fuzz = 0;
 168     while (scalar(@history) < 2 && $fuzz < 3) {
 169       $hashref->{history_date}++;
 170       $hashref->{history_action} = { %action_value }; # qsearch distorts this!
 171       $fuzz++;
 172       push @history, qsearch({ table    => 'h_cust_pkg',
 173                                hashref  => $hashref,
 174                                order_by => 'ORDER BY history_action',
 175                             });
 176     }
 177
 178     next unless scalar(@history) == 2;
 179
 180     my @new = grep { $_->history_action eq 'replace_new' } @history;
 181     my @old = grep { $_->history_action eq 'replace_old' } @history;
 182
 183     next if (scalar(@new) == 2 || scalar(@old) == 2);
 184
 185     if ( !$old[0]->get('cancel') && $new[0]->get('cancel') ) {
 186       $_->action('C');
 187     }elsif( !$old[0]->susp && $new[0]->susp ){
 188       $_->action('S');
 189     }elsif( $new[0]->expire &&
 190             (!$old[0]->expire || !$old[0]->expire != $new[0]->expire )
 191           ){
 192       $_->action('E');
 193       $_->date($new[0]->expire);
 194     }elsif( $new[0]->adjourn &&
 195             (!$old[0]->adjourn || $old[0]->adjourn != $new[0]->adjourn )
 196           ){
 197       $_->action('A');
 198       $_->date($new[0]->adjourn);
 199     }
 200
 201     my $error = $_->replace
 202       if $_->modified;
 203
 204     die $error if $error;
 205
 206     $count++;
 207   }
 208
 209   #remove nullability if scalar(@migrated) - $count == 0 && ->column('action');
 210
 211   #seek expirations/adjourns without reason
 212   foreach my $field qw( expire adjourn cancel susp ) {
 213     my $addl_from =
 214       "LEFT JOIN h_cust_pkg ON ".
 215       "(cust_pkg_reason.pkgnum = h_cust_pkg.pkgnum AND".
 216       " cust_pkg_reason.date = h_cust_pkg.$field AND".
 217       " history_action = 'replace_new')";
 218
 219     my $extra_sql = 'AND h_cust_pkg.pkgnum IS NULL';
 220
 221     my @unmigrated = qsearch({ table   => 'cust_pkg_reason',
 222                                hashref => { action => uc(substr($field,0,1)) },
 223                                addl_from => $addl_from,
 224                                select    => 'cust_pkg_reason.*',
 225                                extra_sql => $extra_sql,
 226                             });
 227     foreach ( @unmigrated ) {
 228
 229       my %action_value = ( op    => 'LIKE',
 230                            value => 'replace_%',
 231                          );
 232       my $hashref = { pkgnum => $_->pkgnum,
 233                       history_date   => $_->date,
 234                       history_action => { %action_value },
 235                     };
 236
 237       my @history = qsearch({ table    => 'h_cust_pkg',
 238                               hashref  => $hashref,
 239                               order_by => 'ORDER BY history_action',
 240                            });
 241
 242       my $fuzz = 0;
 243       while (scalar(@history) < 2 && $fuzz < 3) {
 244         $hashref->{history_date}++;
 245         $hashref->{history_action} = { %action_value }; # qsearch distorts this!
 246         $fuzz++;
 247         push @history, qsearch({ table    => 'h_cust_pkg',
 248                                  hashref  => $hashref,
 249                                  order_by => 'ORDER BY history_action',
 250                               });
 251       }
 252
 253       next unless scalar(@history) == 2;
 254
 255       my @new = grep { $_->history_action eq 'replace_new' } @history;
 256       my @old = grep { $_->history_action eq 'replace_old' } @history;
 257
 258       next if (scalar(@new) == 2 || scalar(@old) == 2);
 259
 260       $_->date($new[0]->get($field))
 261         if ( $new[0]->get($field) &&
 262              ( !$old[0]->get($field) ||
 263                 $old[0]->get($field) != $new[0]->get($field)
 264              )
 265            );
 266
 267       my $error = $_->replace
 268         if $_->modified;
 269
 270       die $error if $error;
 271     }
 272   }
 273
 274   #seek cancels/suspends without reason, but with expire/adjourn reason
 275   foreach my $field qw( cancel susp ) {
 276
 277     my %precursor_map = ( 'cancel' => 'expire', 'susp' => 'adjourn' );
 278     my $precursor = $precursor_map{$field};
 279     my $preaction = uc(substr($precursor,0,1));
 280     my $action    = uc(substr($field,0,1));
 281     my $addl_from =
 282       "LEFT JOIN cust_pkg_reason ON ".
 283       "(cust_pkg.pkgnum = cust_pkg_reason.pkgnum AND".
 284       " cust_pkg.$precursor = cust_pkg_reason.date AND".
 285       " cust_pkg_reason.action = '$preaction') ".
 286       "LEFT JOIN cust_pkg_reason AS target ON ".
 287       "(cust_pkg.pkgnum = target.pkgnum AND".
 288       " cust_pkg.$field = target.date AND".
 289       " target.action = '$action')"
 290     ;
 291
 292     my $extra_sql = "WHERE target.pkgnum IS NULL AND ".
 293                     "cust_pkg.$field IS NOT NULL AND ".
 294                     "cust_pkg.$field < cust_pkg.$precursor + 86400 AND ".
 295                     "cust_pkg_reason.action = '$preaction'";
 296
 297     my @unmigrated = qsearch({ table     => 'cust_pkg',
 298                                hashref   => { },
 299                                select    => 'cust_pkg.*',
 300                                addl_from => $addl_from,
 301                                extra_sql => $extra_sql,
 302                             });
 303     foreach ( @unmigrated ) {
 304       my $cpr = new FS::cust_pkg_reason { $_->last_cust_pkg_reason($precursor)->hash, 'num' => '' };
 305       $cpr->date($_->get($field));
 306       $cpr->action($action);
 307
 308       my $error = $cpr->insert;
 309       die $error if $error;
 310     }
 311   }
 312
 313   '';
 314
 315 }
 316
 317 =back
 318
 319 =head1 BUGS
 320
 321 Here be termites.  Don't use on wooden computers.
 322
 323 =head1 SEE ALSO
 324
 325 L<FS::Record>, schema.html from the base documentation.
 326
 327 =cut
 328
 329 1;
 330