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     #cust_main (remove paycvv from history, locations, cust_payby, etc)
 356     'cust_main' => [],
 357
 358     #contact -> cust_contact / prospect_contact
 359     'contact' => [],
 360
 361     #msgcat
 362     'msgcat' => [],
 363
 364     #reason type and reasons
 365     'reason_type'     => [],
 366     'cust_pkg_reason' => [],
 367
 368     #need part_pkg before cust_credit...
 369     'part_pkg' => [],
 370
 371     #customer credits
 372     'cust_credit' => [],
 373
 374     # reason / void_reason migration to reasonnum / void_reasonnum
 375     'cust_credit_void' => [],
 376     'cust_bill_void' => [],
 377     'cust_bill_pkg_void' => [],
 378
 379     #duplicate history records
 380     'h_cust_svc'  => [],
 381
 382     #populate cust_pay.otaker
 383     'cust_pay'    => [],
 384
 385     #populate part_pkg_taxclass for starters
 386     'part_pkg_taxclass' => [],
 387
 388     #remove bad pending records
 389     'cust_pay_pending' => [],
 390
 391     #replace invnum and pkgnum with billpkgnum
 392     'cust_bill_pkg_detail' => [],
 393
 394     #usage_classes if we have none
 395     'usage_class' => [],
 396
 397     #phone_type if we have none
 398     'phone_type' => [],
 399
 400     #fixup access rights
 401     'access_right' => [],
 402
 403     #change recur_flat and enable_prorate
 404     'part_pkg_option' => [],
 405
 406     #add weights to pkg_category
 407     'pkg_category' => [],
 408
 409     #cdrbatch fixes
 410     'cdr' => [],
 411
 412     #otaker->usernum
 413     'cust_attachment' => [],
 414     #'cust_credit' => [],
 415     #'cust_main' => [],
 416     'cust_main_note' => [],
 417     #'cust_pay' => [],
 418     'cust_pay_void' => [],
 419     'cust_pkg' => [],
 420     #'cust_pkg_reason' => [],
 421     'cust_pkg_discount' => [],
 422     'cust_refund' => [],
 423     'banned_pay' => [],
 424
 425     #default namespace
 426     'payment_gateway' => [],
 427
 428     #migrate to templates
 429     'msg_template' => [],
 430
 431     #return unprovisioned numbers to availability
 432     'phone_avail' => [],
 433
 434     #insert scripcondition
 435     'TicketSystem' => [],
 436
 437     #insert LATA data if not already present
 438     'lata' => [],
 439
 440     #insert MSA data if not already present
 441     'msa' => [],
 442
 443     # migrate to radius_group and groupnum instead of groupname
 444     'radius_usergroup' => [],
 445     'part_svc'         => [],
 446     'part_export'      => [],
 447
 448     #insert default tower_sector if not present
 449     'tower' => [],
 450
 451     #repair improperly deleted services
 452     'cust_svc' => [],
 453
 454     #routernum/blocknum
 455     'svc_broadband' => [],
 456
 457     #set up payment gateways if needed
 458     'pay_batch' => [],
 459
 460     #flag monthly tax exemptions
 461     'cust_tax_exempt_pkg' => [],
 462
 463     #kick off tax location history upgrade
 464     'cust_bill_pkg' => [],
 465
 466     #fix taxable line item links
 467     'cust_bill_pkg_tax_location' => [],
 468
 469     #populate state FIPS codes if not already done
 470     'state' => [],
 471
 472     #set default locations on quoted packages
 473     'quotation_pkg' => [],
 474
 475     #populate tax statuses
 476     'tax_status' => [],
 477
 478     #mark certain taxes as system-maintained
 479     'cust_main_county' => [],
 480   ;
 481
 482   \%hash;
 483
 484 }
 485
 486 =item upgrade_schema
 487
 488 =cut
 489
 490 sub upgrade_schema {
 491   my %opt = @_;
 492
 493   my $data = upgrade_schema_data(%opt);
 494
 495   my $oldAutoCommit = $FS::UID::AutoCommit;
 496   local $FS::UID::AutoCommit = 0;
 497   local $FS::UID::AutoCommit = 0;
 498
 499   foreach my $table ( keys %$data ) {
 500
 501     my $class = "FS::$table";
 502     eval "use $class;";
 503     die $@ if $@;
 504
 505     if ( $class->can('_upgrade_schema') ) {
 506       warn "Upgrading $table schema...\n";
 507
 508       my $start = time;
 509
 510       $class->_upgrade_schema(%opt);
 511
 512       if ( $oldAutoCommit ) {
 513         warn "  committing\n";
 514         dbh->commit or die dbh->errstr;
 515       }
 516
 517       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 518       warn "  done in ". (time-$start). " seconds\n";
 519
 520     } else {
 521       warn "WARNING: asked for schema upgrade of $table,".
 522            " but FS::$table has no _upgrade_schema method\n";
 523     }
 524
 525   }
 526
 527 }
 528
 529 =item upgrade_schema_data
 530
 531 =cut
 532
 533 sub upgrade_schema_data {
 534   my %opt = @_;
 535
 536   tie my %hash, 'Tie::IxHash',
 537
 538     #fix classnum character(1)
 539     'cust_bill_pkg_detail' => [],
 540     #add necessary columns to RT schema
 541     'TicketSystem' => [],
 542     #remove possible dangling records
 543     'password_history' => [],
 544     'cust_pay_pending' => [],
 545   ;
 546
 547   \%hash;
 548
 549 }
 550
 551 sub upgrade_sqlradius {
 552   #my %opt = @_;
 553
 554   my $conf = new FS::Conf;
 555
 556   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
 557
 558   foreach my $part_export ( @part_export ) {
 559
 560     my $errmsg = 'Error adding FreesideStatus to '.
 561                  $part_export->option('datasrc'). ': ';
 562
 563     my $dbh = DBI->connect(
 564       ( map $part_export->option($_), qw ( datasrc username password ) ),
 565       { PrintError => 0, PrintWarn => 0 }
 566     ) or do {
 567       warn $errmsg.$DBI::errstr;
 568       next;
 569     };
 570
 571     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
 572     my $group = "UserName";
 573     $group .= ",Realm"
 574       if ref($part_export) =~ /withdomain/
 575       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
 576
 577     my $sth_alter = $dbh->prepare(
 578       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
 579     );
 580     if ( $sth_alter ) {
 581       if ( $sth_alter->execute ) {
 582         my $sth_update = $dbh->prepare(
 583          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
 584         ) or die $errmsg.$dbh->errstr;
 585         $sth_update->execute or die $errmsg.$sth_update->errstr;
 586       } else {
 587         my $error = $sth_alter->errstr;
 588         warn $errmsg.$error
 589           unless $error =~ /Duplicate column name/i  #mysql
 590               || $error =~ /already exists/i;        #Pg
 591 ;
 592       }
 593     } else {
 594       my $error = $dbh->errstr;
 595       warn $errmsg.$error; #unless $error =~ /exists/i;
 596     }
 597
 598     my $sth_index = $dbh->prepare(
 599       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
 600     );
 601     if ( $sth_index ) {
 602       unless ( $sth_index->execute ) {
 603         my $error = $sth_index->errstr;
 604         warn $errmsg.$error
 605           unless $error =~ /Duplicate key name/i #mysql
 606               || $error =~ /already exists/i;    #Pg
 607       }
 608     } else {
 609       my $error = $dbh->errstr;
 610       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
 611     }
 612
 613     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
 614       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
 615       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
 616
 617     my $sth = $dbh->prepare("SELECT UserName,
 618                                     Realm,
 619                                     $str2time max(AcctStartTime)),
 620                                     $str2time max(AcctStopTime))
 621                               FROM radacct
 622                               WHERE FreesideStatus = 'done'
 623                                 AND $times
 624                               GROUP BY $group
 625                             ")
 626       or die $errmsg.$dbh->errstr;
 627     $sth->execute() or die $errmsg.$sth->errstr;
 628
 629     while (my $row = $sth->fetchrow_arrayref ) {
 630       my ($username, $realm, $start, $stop) = @$row;
 631
 632       $username = lc($username) unless $conf->exists('username-uppercase');
 633
 634       my $exportnum = $part_export->exportnum;
 635       my $extra_sql = " AND exportnum = $exportnum ".
 636                       " AND exportsvcnum IS NOT NULL ";
 637
 638       if ( ref($part_export) =~ /withdomain/ ) {
 639         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
 640                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
 641       }
 642
 643       my $svc_acct = qsearchs({
 644         'select'    => 'svc_acct.*',
 645         'table'     => 'svc_acct',
 646         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
 647                        'LEFT JOIN export_svc USING ( svcpart )',
 648         'hashref'   => { 'username' => $username },
 649         'extra_sql' => $extra_sql,
 650       });
 651
 652       if ($svc_acct) {
 653         $svc_acct->last_login($start)
 654           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
 655         $svc_acct->last_logout($stop)
 656           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
 657       }
 658     }
 659   }
 660
 661 }
 662
 663 =back
 664
 665 =head1 BUGS
 666
 667 Sure.
 668
 669 =head1 SEE ALSO
 670
 671 =cut
 672
 673 1;
 674