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