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::queue;
  12 use FS::upgrade_journal;
  13
  14 use FS::svc_domain;
  15 $FS::svc_domain::whois_hack = 1;
  16
  17 @ISA = qw( Exporter );
  18 @EXPORT_OK = qw( upgrade_schema upgrade_config upgrade upgrade_sqlradius );
  19
  20 $DEBUG = 1;
  21
  22 =head1 NAME
  23
  24 FS::Upgrade - Database upgrade routines
  25
  26 =head1 SYNOPSIS
  27
  28   use FS::Upgrade;
  29
  30 =head1 DESCRIPTION
  31
  32 Currently this module simply provides a place to store common subroutines for
  33 database upgrades.
  34
  35 =head1 SUBROUTINES
  36
  37 =over 4
  38
  39 =item upgrade_config
  40
  41 =cut
  42
  43 #config upgrades
  44 sub upgrade_config {
  45   my %opt = @_;
  46
  47   my $conf = new FS::Conf;
  48
  49   $conf->touch('payment_receipt')
  50     if $conf->exists('payment_receipt_email')
  51     || $conf->config('payment_receipt_msgnum');
  52
  53   $conf->touch('geocode-require_nw_coordinates')
  54     if $conf->exists('svc_broadband-require-nw-coordinates');
  55
  56   unless ( $conf->config('echeck-country') ) {
  57     if ( $conf->exists('cust_main-require-bank-branch') ) {
  58       $conf->set('echeck-country', 'CA');
  59     } elsif ( $conf->exists('echeck-nonus') ) {
  60       $conf->set('echeck-country', 'XX');
  61     } else {
  62       $conf->set('echeck-country', 'US');
  63     }
  64   }
  65
  66   my @agents = qsearch('agent', {});
  67
  68   upgrade_overlimit_groups($conf);
  69   map { upgrade_overlimit_groups($conf,$_->agentnum) } @agents;
  70
  71   upgrade_invoice_from($conf);
  72   foreach my $agent (@agents) {
  73     upgrade_invoice_from($conf,$agent->agentnum,1);
  74   }
  75
  76   my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
  77   $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
  78     foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
  79       qw( quotation_html quotation_latex quotation_latexnotes );
  80
  81   # change 'fslongtable' to 'longtable'
  82   # in invoice and quotation main templates, and also in all secondary
  83   # invoice templates
  84   my @latex_confs =
  85     qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
  86
  87   foreach my $c (@latex_confs) {
  88     my $value = $c->value;
  89     if (length($value) and $value =~ /fslongtable/) {
  90       $value =~ s/fslongtable/longtable/g;
  91       $conf->set($c->name, $value, $c->agentnum);
  92     }
  93   }
  94
  95   # if there's a USPS tools login, assume that's the standardization method
  96   # you want to use
  97   $conf->set('address_standardize_method', 'usps')
  98     if $conf->exists('usps_webtools-userid')
  99     && length($conf->config('usps_webtools-userid')) > 0
 100     && ! $conf->exists('address_standardize_method');
 101
 102   # this option has been renamed/expanded
 103   if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
 104     $conf->touch('cust_main-enable_spouse');
 105     $conf->delete('cust_main-enable_spouse_birthdate');
 106   }
 107
 108   # renamed/repurposed
 109   if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
 110     $conf->touch('part_pkg-show_fcc_options');
 111     $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
 112     warn "
 113 You have FCC Form 477 package options enabled.
 114
 115 Starting with the October 2014 filing date, the FCC has redesigned
 116 Form 477 and introduced new service categories.  See bin/convert-477-options
 117 to update your package configuration for the new report.
 118
 119 If you need to continue using the old Form 477 report, turn on the
 120 'old_fcc_report' configuration option.
 121 ";
 122   }
 123
 124   # boolean invoice_sections_by_location option is now
 125   # invoice_sections_method = 'location'
 126   my @invoice_sections_confs =
 127     qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
 128   foreach my $c (@invoice_sections_confs) {
 129     $c->name =~ /^(\w+)sections_by_location$/;
 130     $conf->delete($c->name);
 131     my $newname = $1.'sections_method';
 132     $conf->set($newname, 'location');
 133   }
 134
 135   # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
 136   if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
 137     $conf->set('tax-cust_exempt-groups-num_req', 'all');
 138     $conf->delete('tax-cust_exempt-groups-require_individual_nums');
 139   }
 140
 141   # boolean+text previous_balance-exclude_from_total is now two separate options
 142   my $total_new_charges = $conf->config('previous_balance-exclude_from_total');
 143   if (length($total_new_charges) > 0) {
 144     $conf->set('previous_balance-text-total_new_charges', $total_new_charges);
 145     $conf->set('previous_balance-exclude_from_total', '');
 146   }
 147
 148   if ( $conf->exists('voip-cust_email_csv_cdr') ) {
 149     $conf->set('voip_cdr_email_attach', 'csv');
 150     $conf->delete('voip-cust_email_csv_cdr') ;
 151   }
 152
 153   if ( !$conf->config('password-generated-characters') ) {
 154     my $pw_set =
 155       'abcdefghijkmnpqrstuvwxyzABCDEFGHIJKLMNPQRSTUVWXYZ23456789()#.,' ;
 156     $conf->set('password-generated-characters', $pw_set);
 157   }
 158
 159   if ($conf->exists('unsuspendauto') && !$conf->config('unsuspend_balance')) {
 160     $conf->set('unsuspend_balance','Zero');
 161     $conf->delete('unsuspendauto');
 162   }
 163
 164   # if translate-auto-insert is enabled for a locale, ensure that invoice
 165   # terms are in the msgcat (is there a better place for this?)
 166   if (my $auto_locale = $conf->config('translate-auto-insert')) {
 167     my $lh = FS::L10N->get_handle($auto_locale);
 168     foreach (@FS::Conf::invoice_terms) {
 169       $lh->maketext($_) if length($_);
 170     }
 171   }
 172 }
 173
 174 sub upgrade_overlimit_groups {
 175     my $conf = shift;
 176     my $agentnum = shift;
 177     my @groups = $conf->config('overlimit_groups',$agentnum);
 178     if(scalar(@groups)) {
 179         my $groups = join(',',@groups);
 180         my @groupnums;
 181         my $error = '';
 182         if ( $groups !~ /^[\d,]+$/ ) {
 183             foreach my $groupname ( @groups ) {
 184                 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
 185                 unless ( $g ) {
 186                     $g = new FS::radius_group {
 187                                     'groupname' => $groupname,
 188                                     'description' => $groupname,
 189                                     };
 190                     $error = $g->insert;
 191                     die $error if $error;
 192                 }
 193                 push @groupnums, $g->groupnum;
 194             }
 195             $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
 196         }
 197     }
 198 }
 199
 200 sub upgrade_invoice_from {
 201   my ($conf, $agentnum, $agentonly) = @_;
 202   if (
 203       (!$conf->exists('invoice_from_name',$agentnum,$agentonly)) &&
 204       ($conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/)
 205   ) {
 206     my $realemail = $1;
 207     $realemail =~ s/^\s*//; # remove leading spaces
 208     $realemail =~ s/\s*$//; # remove trailing spaces
 209     my $realname = $conf->config('invoice_from',$agentnum);
 210     $realname =~ s/\<.*\>//; # remove email address
 211     $realname =~ s/^\s*//; # remove leading spaces
 212     $realname =~ s/\s*$//; # remove trailing spaces
 213     # properly quote names that contain punctuation
 214     if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
 215       $realname = '"' . $realname . '"';
 216     }
 217     $conf->set('invoice_from_name', $realname, $agentnum);
 218     $conf->set('invoice_from', $realemail, $agentnum);
 219   }
 220 }
 221
 222 =item upgrade
 223
 224 =cut
 225
 226 sub upgrade {
 227   my %opt = @_;
 228
 229   my $data = upgrade_data(%opt);
 230
 231   my $oldAutoCommit = $FS::UID::AutoCommit;
 232   local $FS::UID::AutoCommit = 0;
 233   local $FS::UID::AutoCommit = 0;
 234
 235   local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
 236
 237
 238   foreach my $table ( keys %$data ) {
 239
 240     my $class = "FS::$table";
 241     eval "use $class;";
 242     die $@ if $@;
 243
 244     if ( $class->can('_upgrade_data') ) {
 245       warn "Upgrading $table...\n";
 246
 247       my $start = time;
 248
 249       $class->_upgrade_data(%opt);
 250
 251       # New interface for async upgrades: a class can declare a
 252       # "queueable_upgrade" method, which will run as part of the normal
 253       # upgrade, but if the -j option is passed, will instead be run from
 254       # the job queue.
 255       if ( $class->can('queueable_upgrade') ) {
 256         my $jobname = $class . '::queueable_upgrade';
 257         my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
 258         if ($num_jobs > 0) {
 259           warn "$class upgrade already scheduled.\n";
 260         } else {
 261           if ( $opt{'queue'} ) {
 262             warn "Scheduling $class upgrade.\n";
 263             my $job = FS::queue->new({ job => $jobname });
 264             $job->insert($class, %opt);
 265           } else {
 266             $class->queueable_upgrade(%opt);
 267           }
 268         } #$num_jobs == 0
 269       }
 270
 271       if ( $oldAutoCommit ) {
 272         warn "  committing\n";
 273         dbh->commit or die dbh->errstr;
 274       }
 275
 276       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 277       warn "  done in ". (time-$start). " seconds\n";
 278
 279     } else {
 280       warn "WARNING: asked for upgrade of $table,".
 281            " but FS::$table has no _upgrade_data method\n";
 282     }
 283
 284 #    my @records = @{ $data->{$table} };
 285 #
 286 #    foreach my $record ( @records ) {
 287 #      my $args = delete($record->{'_upgrade_args'}) || [];
 288 #      my $object = $class->new( $record );
 289 #      my $error = $object->insert( @$args );
 290 #      die "error inserting record into $table: $error\n"
 291 #        if $error;
 292 #    }
 293
 294   }
 295
 296   local($FS::cust_main::ignore_expired_card) = 1;
 297   local($FS::cust_main::ignore_illegal_zip) = 1;
 298   local($FS::cust_main::ignore_banned_card) = 1;
 299   local($FS::cust_main::skip_fuzzyfiles) = 1;
 300
 301   # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
 302   # kind of a weird spot for this, but it's better than duplicating
 303   # all this code in each class...
 304   my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
 305   foreach my $table ( @decrypt_tables ) {
 306       my @objects = qsearch({
 307         'table'     => $table,
 308         'hashref'   => {},
 309         'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
 310                        " AND LENGTH(payinfo) > 100",
 311       });
 312       foreach my $object ( @objects ) {
 313           my $payinfo = $object->decrypt($object->payinfo);
 314           die "error decrypting payinfo" if $payinfo eq $object->payinfo;
 315           $object->payinfo($payinfo);
 316           my $error = $object->replace;
 317           die $error if $error;
 318       }
 319   }
 320
 321 }
 322
 323 =item upgrade_data
 324
 325 =cut
 326
 327 sub upgrade_data {
 328   my %opt = @_;
 329
 330   tie my %hash, 'Tie::IxHash',
 331
 332     #fix whitespace - before cust_main
 333     'cust_location' => [],
 334
 335     #cust_main (remove paycvv from history)
 336     'cust_main' => [],
 337
 338     #msgcat
 339     'msgcat' => [],
 340
 341     #reason type and reasons
 342     'reason_type'     => [],
 343     'cust_pkg_reason' => [],
 344
 345     #need part_pkg before cust_credit...
 346     'part_pkg' => [],
 347
 348     #customer credits
 349     'cust_credit' => [],
 350
 351     # fix some tax allocation records
 352     'cust_bill_pkg_void' => [],
 353
 354     #duplicate history records
 355     'h_cust_svc'  => [],
 356
 357     #populate cust_pay.otaker
 358     'cust_pay'    => [],
 359
 360     #populate part_pkg_taxclass for starters
 361     'part_pkg_taxclass' => [],
 362
 363     #remove bad pending records
 364     'cust_pay_pending' => [],
 365
 366     #replace invnum and pkgnum with billpkgnum
 367     'cust_bill_pkg_detail' => [],
 368
 369     #usage_classes if we have none
 370     'usage_class' => [],
 371
 372     #phone_type if we have none
 373     'phone_type' => [],
 374
 375     #fixup access rights
 376     'access_right' => [],
 377
 378     #change recur_flat and enable_prorate
 379     'part_pkg_option' => [],
 380
 381     #add weights to pkg_category
 382     'pkg_category' => [],
 383
 384     #cdrbatch fixes
 385     'cdr' => [],
 386
 387     #otaker->usernum
 388     'cust_attachment' => [],
 389     #'cust_credit' => [],
 390     #'cust_main' => [],
 391     'cust_main_note' => [],
 392     #'cust_pay' => [],
 393     'cust_pay_void' => [],
 394     'cust_pkg' => [],
 395     #'cust_pkg_reason' => [],
 396     'cust_pkg_discount' => [],
 397     'cust_refund' => [],
 398     'banned_pay' => [],
 399
 400     #default namespace
 401     'payment_gateway' => [],
 402
 403     #migrate to templates
 404     'msg_template' => [],
 405
 406     #return unprovisioned numbers to availability
 407     'phone_avail' => [],
 408
 409     #insert scripcondition
 410     'TicketSystem' => [],
 411
 412     #insert LATA data if not already present
 413     'lata' => [],
 414
 415     #insert MSA data if not already present
 416     'msa' => [],
 417
 418     # migrate to radius_group and groupnum instead of groupname
 419     'radius_usergroup' => [],
 420     'part_svc'         => [],
 421     'part_export'      => [],
 422
 423     #insert default tower_sector if not present
 424     'tower' => [],
 425
 426     #repair improperly deleted services
 427     'cust_svc' => [],
 428
 429     #routernum/blocknum
 430     'svc_broadband' => [],
 431
 432     #set up payment gateways if needed
 433     'pay_batch' => [],
 434
 435     #flag monthly tax exemptions
 436     'cust_tax_exempt_pkg' => [],
 437
 438     #kick off tax location history upgrade
 439     'cust_bill_pkg' => [],
 440
 441     #fix taxable line item links
 442     'cust_bill_pkg_tax_location' => [],
 443
 444     #populate state FIPS codes if not already done
 445     'state' => [],
 446
 447     #set default locations on quoted packages
 448     'quotation_pkg' => [],
 449
 450     #mark certain taxes as system-maintained,
 451     # and fix whitespace
 452     'cust_main_county' => [],
 453   ;
 454
 455   \%hash;
 456
 457 }
 458
 459 =item upgrade_schema
 460
 461 =cut
 462
 463 sub upgrade_schema {
 464   my %opt = @_;
 465
 466   my $data = upgrade_schema_data(%opt);
 467
 468   my $oldAutoCommit = $FS::UID::AutoCommit;
 469   local $FS::UID::AutoCommit = 0;
 470   local $FS::UID::AutoCommit = 0;
 471
 472   foreach my $table ( keys %$data ) {
 473
 474     my $class = "FS::$table";
 475     eval "use $class;";
 476     die $@ if $@;
 477
 478     if ( $class->can('_upgrade_schema') ) {
 479       warn "Upgrading $table schema...\n";
 480
 481       my $start = time;
 482
 483       $class->_upgrade_schema(%opt);
 484
 485       if ( $oldAutoCommit ) {
 486         warn "  committing\n";
 487         dbh->commit or die dbh->errstr;
 488       }
 489
 490       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 491       warn "  done in ". (time-$start). " seconds\n";
 492
 493     } else {
 494       warn "WARNING: asked for schema upgrade of $table,".
 495            " but FS::$table has no _upgrade_schema method\n";
 496     }
 497
 498   }
 499
 500 }
 501
 502 =item upgrade_schema_data
 503
 504 =cut
 505
 506 sub upgrade_schema_data {
 507   my %opt = @_;
 508
 509   tie my %hash, 'Tie::IxHash',
 510
 511     #fix classnum character(1)
 512     'cust_bill_pkg_detail' => [],
 513     #add necessary columns to RT schema
 514     'TicketSystem' => [],
 515     #remove possible dangling records
 516     'password_history' => [],
 517     'cust_pay_pending' => [],
 518   ;
 519
 520   \%hash;
 521
 522 }
 523
 524 sub upgrade_sqlradius {
 525   #my %opt = @_;
 526
 527   my $conf = new FS::Conf;
 528
 529   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
 530
 531   foreach my $part_export ( @part_export ) {
 532
 533     my $errmsg = 'Error adding FreesideStatus to '.
 534                  $part_export->option('datasrc'). ': ';
 535
 536     my $dbh = DBI->connect(
 537       ( map $part_export->option($_), qw ( datasrc username password ) ),
 538       { PrintError => 0, PrintWarn => 0 }
 539     ) or do {
 540       warn $errmsg.$DBI::errstr;
 541       next;
 542     };
 543
 544     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
 545     my $group = "UserName";
 546     $group .= ",Realm"
 547       if ref($part_export) =~ /withdomain/
 548       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
 549
 550     my $sth_alter = $dbh->prepare(
 551       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
 552     );
 553     if ( $sth_alter ) {
 554       if ( $sth_alter->execute ) {
 555         my $sth_update = $dbh->prepare(
 556          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
 557         ) or die $errmsg.$dbh->errstr;
 558         $sth_update->execute or die $errmsg.$sth_update->errstr;
 559       } else {
 560         my $error = $sth_alter->errstr;
 561         warn $errmsg.$error
 562           unless $error =~ /Duplicate column name/i  #mysql
 563               || $error =~ /already exists/i;        #Pg
 564 ;
 565       }
 566     } else {
 567       my $error = $dbh->errstr;
 568       warn $errmsg.$error; #unless $error =~ /exists/i;
 569     }
 570
 571     my $sth_index = $dbh->prepare(
 572       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
 573     );
 574     if ( $sth_index ) {
 575       unless ( $sth_index->execute ) {
 576         my $error = $sth_index->errstr;
 577         warn $errmsg.$error
 578           unless $error =~ /Duplicate key name/i #mysql
 579               || $error =~ /already exists/i;    #Pg
 580       }
 581     } else {
 582       my $error = $dbh->errstr;
 583       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
 584     }
 585
 586     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
 587       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
 588       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
 589
 590     my $sth = $dbh->prepare("SELECT UserName,
 591                                     Realm,
 592                                     $str2time max(AcctStartTime)),
 593                                     $str2time max(AcctStopTime))
 594                               FROM radacct
 595                               WHERE FreesideStatus = 'done'
 596                                 AND $times
 597                               GROUP BY $group
 598                             ")
 599       or die $errmsg.$dbh->errstr;
 600     $sth->execute() or die $errmsg.$sth->errstr;
 601
 602     while (my $row = $sth->fetchrow_arrayref ) {
 603       my ($username, $realm, $start, $stop) = @$row;
 604
 605       $username = lc($username) unless $conf->exists('username-uppercase');
 606
 607       my $exportnum = $part_export->exportnum;
 608       my $extra_sql = " AND exportnum = $exportnum ".
 609                       " AND exportsvcnum IS NOT NULL ";
 610
 611       if ( ref($part_export) =~ /withdomain/ ) {
 612         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
 613                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
 614       }
 615
 616       my $svc_acct = qsearchs({
 617         'select'    => 'svc_acct.*',
 618         'table'     => 'svc_acct',
 619         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
 620                        'LEFT JOIN export_svc USING ( svcpart )',
 621         'hashref'   => { 'username' => $username },
 622         'extra_sql' => $extra_sql,
 623       });
 624
 625       if ($svc_acct) {
 626         $svc_acct->last_login($start)
 627           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
 628         $svc_acct->last_logout($stop)
 629           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
 630       }
 631     }
 632   }
 633
 634 }
 635
 636 =back
 637
 638 =head1 BUGS
 639
 640 Sure.
 641
 642 =head1 SEE ALSO
 643
 644 =cut
 645
 646 1;
 647