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 File::Slurp;
   8 use FS::UID qw( dbh driver_name );
   9 use FS::Conf;
  10 use FS::Record qw(qsearchs qsearch str2time_sql);
  11 use FS::upgrade_journal;
  12
  13 use FS::svc_domain;
  14 $FS::svc_domain::whois_hack = 1;
  15
  16 @ISA = qw( Exporter );
  17 @EXPORT_OK = qw( upgrade_schema upgrade_config upgrade upgrade_sqlradius );
  18
  19 $DEBUG = 1;
  20
  21 =head1 NAME
  22
  23 FS::Upgrade - Database upgrade routines
  24
  25 =head1 SYNOPSIS
  26
  27   use FS::Upgrade;
  28
  29 =head1 DESCRIPTION
  30
  31 Currently this module simply provides a place to store common subroutines for
  32 database upgrades.
  33
  34 =head1 SUBROUTINES
  35
  36 =over 4
  37
  38 =item upgrade_config
  39
  40 =cut
  41
  42 #config upgrades
  43 sub upgrade_config {
  44   my %opt = @_;
  45
  46   my $conf = new FS::Conf;
  47
  48   $conf->touch('payment_receipt')
  49     if $conf->exists('payment_receipt_email')
  50     || $conf->config('payment_receipt_msgnum');
  51
  52   $conf->touch('geocode-require_nw_coordinates')
  53     if $conf->exists('svc_broadband-require-nw-coordinates');
  54
  55   unless ( $conf->config('echeck-country') ) {
  56     if ( $conf->exists('cust_main-require-bank-branch') ) {
  57       $conf->set('echeck-country', 'CA');
  58     } elsif ( $conf->exists('echeck-nonus') ) {
  59       $conf->set('echeck-country', 'XX');
  60     } else {
  61       $conf->set('echeck-country', 'US');
  62     }
  63   }
  64
  65   upgrade_overlimit_groups($conf);
  66   map { upgrade_overlimit_groups($conf,$_->agentnum) } qsearch('agent', {});
  67
  68   my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
  69   $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
  70     foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
  71       qw( quotation_html quotation_latex quotation_latexnotes );
  72
  73   # change 'fslongtable' to 'longtable'
  74   # in invoice and quotation main templates, and also in all secondary
  75   # invoice templates
  76   my @latex_confs =
  77     qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
  78
  79   foreach my $c (@latex_confs) {
  80     my $value = $c->value;
  81     if (length($value) and $value =~ /fslongtable/) {
  82       $value =~ s/fslongtable/longtable/g;
  83       $conf->set($c->name, $value, $c->agentnum);
  84     }
  85   }
  86
  87   # if there's a USPS tools login, assume that's the standardization method
  88   # you want to use
  89   if ( length($conf->config('usps_webtools-userid')) > 0 and
  90        !$conf->exists('address_standardize_method') ) {
  91     $conf->set('address_standardize_method', 'usps');
  92   }
  93
  94 }
  95
  96 sub upgrade_overlimit_groups {
  97     my $conf = shift;
  98     my $agentnum = shift;
  99     my @groups = $conf->config('overlimit_groups',$agentnum);
 100     if(scalar(@groups)) {
 101         my $groups = join(',',@groups);
 102         my @groupnums;
 103         my $error = '';
 104         if ( $groups !~ /^[\d,]+$/ ) {
 105             foreach my $groupname ( @groups ) {
 106                 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
 107                 unless ( $g ) {
 108                     $g = new FS::radius_group {
 109                                     'groupname' => $groupname,
 110                                     'description' => $groupname,
 111                                     };
 112                     $error = $g->insert;
 113                     die $error if $error;
 114                 }
 115                 push @groupnums, $g->groupnum;
 116             }
 117             $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
 118         }
 119     }
 120 }
 121
 122 =item upgrade
 123
 124 =cut
 125
 126 sub upgrade {
 127   my %opt = @_;
 128
 129   my $data = upgrade_data(%opt);
 130
 131   my $oldAutoCommit = $FS::UID::AutoCommit;
 132   local $FS::UID::AutoCommit = 0;
 133   local $FS::UID::AutoCommit = 0;
 134
 135   foreach my $table ( keys %$data ) {
 136
 137     my $class = "FS::$table";
 138     eval "use $class;";
 139     die $@ if $@;
 140
 141     if ( $class->can('_upgrade_data') ) {
 142       warn "Upgrading $table...\n";
 143
 144       my $start = time;
 145
 146       $class->_upgrade_data(%opt);
 147
 148       if ( $oldAutoCommit ) {
 149         warn "  committing\n";
 150         dbh->commit or die dbh->errstr;
 151       }
 152
 153       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 154       warn "  done in ". (time-$start). " seconds\n";
 155
 156     } else {
 157       warn "WARNING: asked for upgrade of $table,".
 158            " but FS::$table has no _upgrade_data method\n";
 159     }
 160
 161 #    my @records = @{ $data->{$table} };
 162 #
 163 #    foreach my $record ( @records ) {
 164 #      my $args = delete($record->{'_upgrade_args'}) || [];
 165 #      my $object = $class->new( $record );
 166 #      my $error = $object->insert( @$args );
 167 #      die "error inserting record into $table: $error\n"
 168 #        if $error;
 169 #    }
 170
 171   }
 172
 173   local($FS::cust_main::ignore_expired_card) = 1;
 174   local($FS::cust_main::ignore_illegal_zip) = 1;
 175   local($FS::cust_main::ignore_banned_card) = 1;
 176   local($FS::cust_main::skip_fuzzyfiles) = 1;
 177
 178   # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
 179   # kind of a weird spot for this, but it's better than duplicating
 180   # all this code in each class...
 181   my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
 182   foreach my $table ( @decrypt_tables ) {
 183       my @objects = qsearch({
 184         'table'     => $table,
 185         'hashref'   => {},
 186         'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
 187                        " AND LENGTH(payinfo) > 100",
 188       });
 189       foreach my $object ( @objects ) {
 190           my $payinfo = $object->decrypt($object->payinfo);
 191           die "error decrypting payinfo" if $payinfo eq $object->payinfo;
 192           $object->payinfo($payinfo);
 193           my $error = $object->replace;
 194           die $error if $error;
 195       }
 196   }
 197
 198 }
 199
 200 =item upgrade_data
 201
 202 =cut
 203
 204 sub upgrade_data {
 205   my %opt = @_;
 206
 207   tie my %hash, 'Tie::IxHash',
 208
 209     #cust_main (remove paycvv from history)
 210     'cust_main' => [],
 211
 212     #msgcat
 213     'msgcat' => [],
 214
 215     #reason type and reasons
 216     'reason_type'     => [],
 217     'cust_pkg_reason' => [],
 218
 219     #need part_pkg before cust_credit...
 220     'part_pkg' => [],
 221
 222     #customer credits
 223     'cust_credit' => [],
 224
 225     #duplicate history records
 226     'h_cust_svc'  => [],
 227
 228     #populate cust_pay.otaker
 229     'cust_pay'    => [],
 230
 231     #populate part_pkg_taxclass for starters
 232     'part_pkg_taxclass' => [],
 233
 234     #remove bad pending records
 235     'cust_pay_pending' => [],
 236
 237     #replace invnum and pkgnum with billpkgnum
 238     'cust_bill_pkg_detail' => [],
 239
 240     #usage_classes if we have none
 241     'usage_class' => [],
 242
 243     #phone_type if we have none
 244     'phone_type' => [],
 245
 246     #fixup access rights
 247     'access_right' => [],
 248
 249     #change recur_flat and enable_prorate
 250     'part_pkg_option' => [],
 251
 252     #add weights to pkg_category
 253     'pkg_category' => [],
 254
 255     #cdrbatch fixes
 256     'cdr' => [],
 257
 258     #otaker->usernum
 259     'cust_attachment' => [],
 260     #'cust_credit' => [],
 261     #'cust_main' => [],
 262     'cust_main_note' => [],
 263     #'cust_pay' => [],
 264     'cust_pay_void' => [],
 265     'cust_pkg' => [],
 266     #'cust_pkg_reason' => [],
 267     'cust_pkg_discount' => [],
 268     'cust_refund' => [],
 269     'banned_pay' => [],
 270
 271     #default namespace
 272     'payment_gateway' => [],
 273
 274     #migrate to templates
 275     'msg_template' => [],
 276
 277     #return unprovisioned numbers to availability
 278     'phone_avail' => [],
 279
 280     #insert scripcondition
 281     'TicketSystem' => [],
 282
 283     #insert LATA data if not already present
 284     'lata' => [],
 285
 286     #insert MSA data if not already present
 287     'msa' => [],
 288
 289     # migrate to radius_group and groupnum instead of groupname
 290     'radius_usergroup' => [],
 291     'part_svc'         => [],
 292     'part_export'      => [],
 293
 294     #insert default tower_sector if not present
 295     'tower' => [],
 296
 297     #repair improperly deleted services
 298     'cust_svc' => [],
 299
 300     #routernum/blocknum
 301     'svc_broadband' => [],
 302
 303     #set up payment gateways if needed
 304     'pay_batch' => [],
 305
 306     #flag monthly tax exemptions
 307     'cust_tax_exempt_pkg' => [],
 308
 309     #kick off tax location history upgrade
 310     'cust_bill_pkg' => [],
 311
 312     #fix taxable line item links
 313     'cust_bill_pkg_tax_location' => [],
 314   ;
 315
 316   \%hash;
 317
 318 }
 319
 320 =item upgrade_schema
 321
 322 =cut
 323
 324 sub upgrade_schema {
 325   my %opt = @_;
 326
 327   my $data = upgrade_schema_data(%opt);
 328
 329   my $oldAutoCommit = $FS::UID::AutoCommit;
 330   local $FS::UID::AutoCommit = 0;
 331   local $FS::UID::AutoCommit = 0;
 332
 333   foreach my $table ( keys %$data ) {
 334
 335     my $class = "FS::$table";
 336     eval "use $class;";
 337     die $@ if $@;
 338
 339     if ( $class->can('_upgrade_schema') ) {
 340       warn "Upgrading $table schema...\n";
 341
 342       my $start = time;
 343
 344       $class->_upgrade_schema(%opt);
 345
 346       if ( $oldAutoCommit ) {
 347         warn "  committing\n";
 348         dbh->commit or die dbh->errstr;
 349       }
 350
 351       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 352       warn "  done in ". (time-$start). " seconds\n";
 353
 354     } else {
 355       warn "WARNING: asked for schema upgrade of $table,".
 356            " but FS::$table has no _upgrade_schema method\n";
 357     }
 358
 359   }
 360
 361 }
 362
 363 =item upgrade_schema_data
 364
 365 =cut
 366
 367 sub upgrade_schema_data {
 368   my %opt = @_;
 369
 370   tie my %hash, 'Tie::IxHash',
 371
 372     #fix classnum character(1)
 373     'cust_bill_pkg_detail' => [],
 374     #add necessary columns to RT schema
 375     'TicketSystem' => [],
 376
 377   ;
 378
 379   \%hash;
 380
 381 }
 382
 383 sub upgrade_sqlradius {
 384   #my %opt = @_;
 385
 386   my $conf = new FS::Conf;
 387
 388   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
 389
 390   foreach my $part_export ( @part_export ) {
 391
 392     my $errmsg = 'Error adding FreesideStatus to '.
 393                  $part_export->option('datasrc'). ': ';
 394
 395     my $dbh = DBI->connect(
 396       ( map $part_export->option($_), qw ( datasrc username password ) ),
 397       { PrintError => 0, PrintWarn => 0 }
 398     ) or do {
 399       warn $errmsg.$DBI::errstr;
 400       next;
 401     };
 402
 403     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
 404     my $group = "UserName";
 405     $group .= ",Realm"
 406       if ref($part_export) =~ /withdomain/
 407       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
 408
 409     my $sth_alter = $dbh->prepare(
 410       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
 411     );
 412     if ( $sth_alter ) {
 413       if ( $sth_alter->execute ) {
 414         my $sth_update = $dbh->prepare(
 415          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
 416         ) or die $errmsg.$dbh->errstr;
 417         $sth_update->execute or die $errmsg.$sth_update->errstr;
 418       } else {
 419         my $error = $sth_alter->errstr;
 420         warn $errmsg.$error
 421           unless $error =~ /Duplicate column name/i  #mysql
 422               || $error =~ /already exists/i;        #Pg
 423 ;
 424       }
 425     } else {
 426       my $error = $dbh->errstr;
 427       warn $errmsg.$error; #unless $error =~ /exists/i;
 428     }
 429
 430     my $sth_index = $dbh->prepare(
 431       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
 432     );
 433     if ( $sth_index ) {
 434       unless ( $sth_index->execute ) {
 435         my $error = $sth_index->errstr;
 436         warn $errmsg.$error
 437           unless $error =~ /Duplicate key name/i #mysql
 438               || $error =~ /already exists/i;    #Pg
 439       }
 440     } else {
 441       my $error = $dbh->errstr;
 442       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
 443     }
 444
 445     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
 446       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
 447       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
 448
 449     my $sth = $dbh->prepare("SELECT UserName,
 450                                     Realm,
 451                                     $str2time max(AcctStartTime)),
 452                                     $str2time max(AcctStopTime))
 453                               FROM radacct
 454                               WHERE FreesideStatus = 'done'
 455                                 AND $times
 456                               GROUP BY $group
 457                             ")
 458       or die $errmsg.$dbh->errstr;
 459     $sth->execute() or die $errmsg.$sth->errstr;
 460
 461     while (my $row = $sth->fetchrow_arrayref ) {
 462       my ($username, $realm, $start, $stop) = @$row;
 463
 464       $username = lc($username) unless $conf->exists('username-uppercase');
 465
 466       my $exportnum = $part_export->exportnum;
 467       my $extra_sql = " AND exportnum = $exportnum ".
 468                       " AND exportsvcnum IS NOT NULL ";
 469
 470       if ( ref($part_export) =~ /withdomain/ ) {
 471         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
 472                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
 473       }
 474
 475       my $svc_acct = qsearchs({
 476         'select'    => 'svc_acct.*',
 477         'table'     => 'svc_acct',
 478         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
 479                        'LEFT JOIN export_svc USING ( svcpart )',
 480         'hashref'   => { 'username' => $username },
 481         'extra_sql' => $extra_sql,
 482       });
 483
 484       if ($svc_acct) {
 485         $svc_acct->last_login($start)
 486           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
 487         $svc_acct->last_logout($stop)
 488           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
 489       }
 490     }
 491   }
 492
 493 }
 494
 495 =back
 496
 497 =head1 BUGS
 498
 499 Sure.
 500
 501 =head1 SEE ALSO
 502
 503 =cut
 504
 505 1;
 506