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     #fixup access rights
 133     'access_right' => [],
 134
 135     #change recur_flat and enable_prorate
 136     'part_pkg_option' => [],
 137
 138     #add weights to pkg_category
 139     'pkg_category' => [],
 140
 141     #cdrbatch fixes
 142     'cdr' => [],
 143
 144     #default namespace
 145     'payment_gateway' => [],
 146
 147   ;
 148
 149   \%hash;
 150
 151 }
 152
 153 =item upgrade_schema
 154
 155 =cut
 156
 157 sub upgrade_schema {
 158   my %opt = @_;
 159
 160   my $data = upgrade_schema_data(%opt);
 161
 162   my $oldAutoCommit = $FS::UID::AutoCommit;
 163   local $FS::UID::AutoCommit = 0;
 164   local $FS::UID::AutoCommit = 0;
 165
 166   foreach my $table ( keys %$data ) {
 167
 168     my $class = "FS::$table";
 169     eval "use $class;";
 170     die $@ if $@;
 171
 172     if ( $class->can('_upgrade_schema') ) {
 173       warn "Upgrading $table schema...\n";
 174
 175       my $start = time;
 176
 177       $class->_upgrade_schema(%opt);
 178
 179       if ( $oldAutoCommit ) {
 180         warn "  committing\n";
 181         dbh->commit or die dbh->errstr;
 182       }
 183
 184       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 185       warn "  done in ". (time-$start). " seconds\n";
 186
 187     } else {
 188       warn "WARNING: asked for schema upgrade of $table,".
 189            " but FS::$table has no _upgrade_schema method\n";
 190     }
 191
 192   }
 193
 194 }
 195
 196 =item upgrade_schema_data
 197
 198 =cut
 199
 200 sub upgrade_schema_data {
 201   my %opt = @_;
 202
 203   tie my %hash, 'Tie::IxHash',
 204
 205     #fix classnum character(1)
 206     'cust_bill_pkg_detail' => [],
 207
 208   ;
 209
 210   \%hash;
 211
 212 }
 213
 214 sub upgrade_sqlradius {
 215   #my %opt = @_;
 216
 217   my $conf = new FS::Conf;
 218
 219   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
 220
 221   foreach my $part_export ( @part_export ) {
 222
 223     my $errmsg = 'Error adding FreesideStatus to '.
 224                  $part_export->option('datasrc'). ': ';
 225
 226     my $dbh = DBI->connect(
 227       ( map $part_export->option($_), qw ( datasrc username password ) ),
 228       { PrintError => 0, PrintWarn => 0 }
 229     ) or do {
 230       warn $errmsg.$DBI::errstr;
 231       next;
 232     };
 233
 234     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
 235     my $group = "UserName";
 236     $group .= ",Realm"
 237       if ref($part_export) =~ /withdomain/
 238       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
 239
 240     my $sth_alter = $dbh->prepare(
 241       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
 242     );
 243     if ( $sth_alter ) {
 244       if ( $sth_alter->execute ) {
 245         my $sth_update = $dbh->prepare(
 246          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
 247         ) or die $errmsg.$dbh->errstr;
 248         $sth_update->execute or die $errmsg.$sth_update->errstr;
 249       } else {
 250         my $error = $sth_alter->errstr;
 251         warn $errmsg.$error
 252           unless $error =~ /Duplicate column name/i  #mysql
 253               || $error =~ /already exists/i;        #Pg
 254 ;
 255       }
 256     } else {
 257       my $error = $dbh->errstr;
 258       warn $errmsg.$error; #unless $error =~ /exists/i;
 259     }
 260
 261     my $sth_index = $dbh->prepare(
 262       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
 263     );
 264     if ( $sth_index ) {
 265       unless ( $sth_index->execute ) {
 266         my $error = $sth_index->errstr;
 267         warn $errmsg.$error
 268           unless $error =~ /Duplicate key name/i #mysql
 269               || $error =~ /already exists/i;    #Pg
 270       }
 271     } else {
 272       my $error = $dbh->errstr;
 273       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
 274     }
 275
 276     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
 277       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
 278       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
 279
 280     my $sth = $dbh->prepare("SELECT UserName,
 281                                     Realm,
 282                                     $str2time max(AcctStartTime)),
 283                                     $str2time max(AcctStopTime))
 284                               FROM radacct
 285                               WHERE FreesideStatus = 'done'
 286                                 AND $times
 287                               GROUP BY $group
 288                             ")
 289       or die $errmsg.$dbh->errstr;
 290     $sth->execute() or die $errmsg.$sth->errstr;
 291
 292     while (my $row = $sth->fetchrow_arrayref ) {
 293       my ($username, $realm, $start, $stop) = @$row;
 294
 295       $username = lc($username) unless $conf->exists('username-uppercase');
 296
 297       my $exportnum = $part_export->exportnum;
 298       my $extra_sql = " AND exportnum = $exportnum ".
 299                       " AND exportsvcnum IS NOT NULL ";
 300
 301       if ( ref($part_export) =~ /withdomain/ ) {
 302         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
 303                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
 304       }
 305
 306       my $svc_acct = qsearchs({
 307         'select'    => 'svc_acct.*',
 308         'table'     => 'svc_acct',
 309         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
 310                        'LEFT JOIN export_svc USING ( svcpart )',
 311         'hashref'   => { 'username' => $username },
 312         'extra_sql' => $extra_sql,
 313       });
 314
 315       if ($svc_acct) {
 316         $svc_acct->last_login($start)
 317           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
 318         $svc_acct->last_logout($stop)
 319           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
 320       }
 321     }
 322   }
 323
 324 }
 325
 326 =back
 327
 328 =head1 BUGS
 329
 330 Sure.
 331
 332 =head1 SEE ALSO
 333
 334 =cut
 335
 336 1;
 337