FS/FS/Upgrade.pm

   1 package FS::Upgrade;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK $DEBUG );
   5 use Exporter;
   6 use Tie::IxHash;
   7 use FS::UID qw( dbh driver_name );
   8 use FS::Conf;
   9 use FS::Record qw(qsearchs str2time_sql);
  10
  11 use FS::svc_domain;
  12 $FS::svc_domain::whois_hack = 1;
  13
  14 @ISA = qw( Exporter );
  15 @EXPORT_OK = qw( upgrade_schema upgrade upgrade_sqlradius );
  16
  17 $DEBUG = 1;
  18
  19 =head1 NAME
  20
  21 FS::Upgrade - Database upgrade routines
  22
  23 =head1 SYNOPSIS
  24
  25   use FS::Upgrade;
  26
  27 =head1 DESCRIPTION
  28
  29 Currently this module simply provides a place to store common subroutines for
  30 database upgrades.
  31
  32 =head1 SUBROUTINES
  33
  34 =over 4
  35
  36 =item upgrade
  37
  38 =cut
  39
  40 sub upgrade {
  41   my %opt = @_;
  42
  43   my $data = upgrade_data(%opt);
  44
  45   my $oldAutoCommit = $FS::UID::AutoCommit;
  46   local $FS::UID::AutoCommit = 0;
  47   local $FS::UID::AutoCommit = 0;
  48
  49   foreach my $table ( keys %$data ) {
  50
  51     my $class = "FS::$table";
  52     eval "use $class;";
  53     die $@ if $@;
  54
  55     if ( $class->can('_upgrade_data') ) {
  56       warn "Upgrading $table...\n";
  57
  58       my $start = time;
  59
  60       $class->_upgrade_data(%opt);
  61
  62       if ( $oldAutoCommit ) {
  63         warn "  committing\n";
  64         dbh->commit or die dbh->errstr;
  65       }
  66
  67       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
  68       warn "  done in ". (time-$start). " seconds\n";
  69
  70     } else {
  71       warn "WARNING: asked for upgrade of $table,".
  72            " but FS::$table has no _upgrade_data method\n";
  73     }
  74
  75 #    my @records = @{ $data->{$table} };
  76 #
  77 #    foreach my $record ( @records ) {
  78 #      my $args = delete($record->{'_upgrade_args'}) || [];
  79 #      my $object = $class->new( $record );
  80 #      my $error = $object->insert( @$args );
  81 #      die "error inserting record into $table: $error\n"
  82 #        if $error;
  83 #    }
  84
  85   }
  86
  87 }
  88
  89 =item upgrade_data
  90
  91 =cut
  92
  93 sub upgrade_data {
  94   my %opt = @_;
  95
  96   tie my %hash, 'Tie::IxHash',
  97
  98     #cust_main (remove paycvv from history)
  99     'cust_main' => [],
 100
 101     #msgcat
 102     'msgcat' => [],
 103
 104     #reason type and reasons
 105     'reason_type'     => [],
 106     'cust_pkg_reason' => [],
 107
 108     #need part_pkg before cust_credit...
 109     'part_pkg' => [],
 110
 111     #customer credits
 112     'cust_credit' => [],
 113
 114     #duplicate history records
 115     'h_cust_svc'  => [],
 116
 117     #populate cust_pay.otaker
 118     'cust_pay'    => [],
 119
 120     #populate part_pkg_taxclass for starters
 121     'part_pkg_taxclass' => [],
 122
 123     #remove bad pending records
 124     'cust_pay_pending' => [],
 125
 126     #replace invnum and pkgnum with billpkgnum
 127     'cust_bill_pkg_detail' => [],
 128
 129     #usage_classes if we have none
 130     'usage_class' => [],
 131
 132     #phone_type if we have none
 133     'phone_type' => [],
 134
 135     #fixup access rights
 136     'access_right' => [],
 137
 138     #change recur_flat and enable_prorate
 139     'part_pkg_option' => [],
 140
 141     #add weights to pkg_category
 142     'pkg_category' => [],
 143
 144     #cdrbatch fixes
 145     'cdr' => [],
 146
 147     #otaker->usernum
 148     'cust_attachment' => [],
 149     #'cust_credit' => [],
 150     #'cust_main' => [],
 151     'cust_main_note' => [],
 152     #'cust_pay' => [],
 153     'cust_pay_void' => [],
 154     'cust_pkg' => [],
 155     #'cust_pkg_reason' => [],
 156     'cust_pkg_discount' => [],
 157     'cust_refund' => [],
 158     'banned_pay' => [],
 159
 160     #default namespace
 161     'payment_gateway' => [],
 162
 163     #migrate to templates
 164     'msg_template' => [],
 165
 166   ;
 167
 168   \%hash;
 169
 170 }
 171
 172 =item upgrade_schema
 173
 174 =cut
 175
 176 sub upgrade_schema {
 177   my %opt = @_;
 178
 179   my $data = upgrade_schema_data(%opt);
 180
 181   my $oldAutoCommit = $FS::UID::AutoCommit;
 182   local $FS::UID::AutoCommit = 0;
 183   local $FS::UID::AutoCommit = 0;
 184
 185   foreach my $table ( keys %$data ) {
 186
 187     my $class = "FS::$table";
 188     eval "use $class;";
 189     die $@ if $@;
 190
 191     if ( $class->can('_upgrade_schema') ) {
 192       warn "Upgrading $table schema...\n";
 193
 194       my $start = time;
 195
 196       $class->_upgrade_schema(%opt);
 197
 198       if ( $oldAutoCommit ) {
 199         warn "  committing\n";
 200         dbh->commit or die dbh->errstr;
 201       }
 202
 203       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 204       warn "  done in ". (time-$start). " seconds\n";
 205
 206     } else {
 207       warn "WARNING: asked for schema upgrade of $table,".
 208            " but FS::$table has no _upgrade_schema method\n";
 209     }
 210
 211   }
 212
 213 }
 214
 215 =item upgrade_schema_data
 216
 217 =cut
 218
 219 sub upgrade_schema_data {
 220   my %opt = @_;
 221
 222   tie my %hash, 'Tie::IxHash',
 223
 224     #fix classnum character(1)
 225     'cust_bill_pkg_detail' => [],
 226
 227   ;
 228
 229   \%hash;
 230
 231 }
 232
 233 sub upgrade_sqlradius {
 234   #my %opt = @_;
 235
 236   my $conf = new FS::Conf;
 237
 238   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
 239
 240   foreach my $part_export ( @part_export ) {
 241
 242     my $errmsg = 'Error adding FreesideStatus to '.
 243                  $part_export->option('datasrc'). ': ';
 244
 245     my $dbh = DBI->connect(
 246       ( map $part_export->option($_), qw ( datasrc username password ) ),
 247       { PrintError => 0, PrintWarn => 0 }
 248     ) or do {
 249       warn $errmsg.$DBI::errstr;
 250       next;
 251     };
 252
 253     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
 254     my $group = "UserName";
 255     $group .= ",Realm"
 256       if ref($part_export) =~ /withdomain/
 257       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
 258
 259     my $sth_alter = $dbh->prepare(
 260       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
 261     );
 262     if ( $sth_alter ) {
 263       if ( $sth_alter->execute ) {
 264         my $sth_update = $dbh->prepare(
 265          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
 266         ) or die $errmsg.$dbh->errstr;
 267         $sth_update->execute or die $errmsg.$sth_update->errstr;
 268       } else {
 269         my $error = $sth_alter->errstr;
 270         warn $errmsg.$error
 271           unless $error =~ /Duplicate column name/i  #mysql
 272               || $error =~ /already exists/i;        #Pg
 273 ;
 274       }
 275     } else {
 276       my $error = $dbh->errstr;
 277       warn $errmsg.$error; #unless $error =~ /exists/i;
 278     }
 279
 280     my $sth_index = $dbh->prepare(
 281       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
 282     );
 283     if ( $sth_index ) {
 284       unless ( $sth_index->execute ) {
 285         my $error = $sth_index->errstr;
 286         warn $errmsg.$error
 287           unless $error =~ /Duplicate key name/i #mysql
 288               || $error =~ /already exists/i;    #Pg
 289       }
 290     } else {
 291       my $error = $dbh->errstr;
 292       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
 293     }
 294
 295     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
 296       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
 297       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
 298
 299     my $sth = $dbh->prepare("SELECT UserName,
 300                                     Realm,
 301                                     $str2time max(AcctStartTime)),
 302                                     $str2time max(AcctStopTime))
 303                               FROM radacct
 304                               WHERE FreesideStatus = 'done'
 305                                 AND $times
 306                               GROUP BY $group
 307                             ")
 308       or die $errmsg.$dbh->errstr;
 309     $sth->execute() or die $errmsg.$sth->errstr;
 310
 311     while (my $row = $sth->fetchrow_arrayref ) {
 312       my ($username, $realm, $start, $stop) = @$row;
 313
 314       $username = lc($username) unless $conf->exists('username-uppercase');
 315
 316       my $exportnum = $part_export->exportnum;
 317       my $extra_sql = " AND exportnum = $exportnum ".
 318                       " AND exportsvcnum IS NOT NULL ";
 319
 320       if ( ref($part_export) =~ /withdomain/ ) {
 321         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
 322                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
 323       }
 324
 325       my $svc_acct = qsearchs({
 326         'select'    => 'svc_acct.*',
 327         'table'     => 'svc_acct',
 328         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
 329                        'LEFT JOIN export_svc USING ( svcpart )',
 330         'hashref'   => { 'username' => $username },
 331         'extra_sql' => $extra_sql,
 332       });
 333
 334       if ($svc_acct) {
 335         $svc_acct->last_login($start)
 336           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
 337         $svc_acct->last_logout($stop)
 338           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
 339       }
 340     }
 341   }
 342
 343 }
 344
 345 =back
 346
 347 =head1 BUGS
 348
 349 Sure.
 350
 351 =head1 SEE ALSO
 352
 353 =cut
 354
 355 1;
 356