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