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   enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
 174
 175 }
 176
 177 sub upgrade_overlimit_groups {
 178     my $conf = shift;
 179     my $agentnum = shift;
 180     my @groups = $conf->config('overlimit_groups',$agentnum);
 181     if(scalar(@groups)) {
 182         my $groups = join(',',@groups);
 183         my @groupnums;
 184         my $error = '';
 185         if ( $groups !~ /^[\d,]+$/ ) {
 186             foreach my $groupname ( @groups ) {
 187                 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
 188                 unless ( $g ) {
 189                     $g = new FS::radius_group {
 190                                     'groupname' => $groupname,
 191                                     'description' => $groupname,
 192                                     };
 193                     $error = $g->insert;
 194                     die $error if $error;
 195                 }
 196                 push @groupnums, $g->groupnum;
 197             }
 198             $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
 199         }
 200     }
 201 }
 202
 203 sub upgrade_invoice_from {
 204   my ($conf, $agentnum, $agentonly) = @_;
 205   if (
 206           ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
 207        && $conf->exists('invoice_from',$agentnum,$agentonly)
 208        && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
 209   ) {
 210     my $realemail = $1;
 211     $realemail =~ s/^\s*//; # remove leading spaces
 212     $realemail =~ s/\s*$//; # remove trailing spaces
 213     my $realname = $conf->config('invoice_from',$agentnum);
 214     $realname =~ s/\<.*\>//; # remove email address
 215     $realname =~ s/^\s*//; # remove leading spaces
 216     $realname =~ s/\s*$//; # remove trailing spaces
 217     # properly quote names that contain punctuation
 218     if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
 219       $realname = '"' . $realname . '"';
 220     }
 221     $conf->set('invoice_from_name', $realname, $agentnum);
 222     $conf->set('invoice_from', $realemail, $agentnum);
 223   }
 224 }
 225
 226 =item upgrade
 227
 228 =cut
 229
 230 sub upgrade {
 231   my %opt = @_;
 232
 233   my $data = upgrade_data(%opt);
 234
 235   my $oldAutoCommit = $FS::UID::AutoCommit;
 236   local $FS::UID::AutoCommit = 0;
 237   local $FS::UID::AutoCommit = 0;
 238
 239   local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
 240
 241
 242   foreach my $table ( keys %$data ) {
 243
 244     my $class = "FS::$table";
 245     eval "use $class;";
 246     die $@ if $@;
 247
 248     if ( $class->can('_upgrade_data') ) {
 249       warn "Upgrading $table...\n";
 250
 251       my $start = time;
 252
 253       $class->_upgrade_data(%opt);
 254
 255       # New interface for async upgrades: a class can declare a
 256       # "queueable_upgrade" method, which will run as part of the normal
 257       # upgrade, but if the -j option is passed, will instead be run from
 258       # the job queue.
 259       if ( $class->can('queueable_upgrade') ) {
 260         my $jobname = $class . '::queueable_upgrade';
 261         my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
 262         if ($num_jobs > 0) {
 263           warn "$class upgrade already scheduled.\n";
 264         } else {
 265           if ( $opt{'queue'} ) {
 266             warn "Scheduling $class upgrade.\n";
 267             my $job = FS::queue->new({ job => $jobname });
 268             $job->insert($class, %opt);
 269           } else {
 270             $class->queueable_upgrade(%opt);
 271           }
 272         } #$num_jobs == 0
 273       }
 274
 275       if ( $oldAutoCommit ) {
 276         warn "  committing\n";
 277         dbh->commit or die dbh->errstr;
 278       }
 279
 280       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 281       warn "  done in ". (time-$start). " seconds\n";
 282
 283     } else {
 284       warn "WARNING: asked for upgrade of $table,".
 285            " but FS::$table has no _upgrade_data method\n";
 286     }
 287
 288 #    my @records = @{ $data->{$table} };
 289 #
 290 #    foreach my $record ( @records ) {
 291 #      my $args = delete($record->{'_upgrade_args'}) || [];
 292 #      my $object = $class->new( $record );
 293 #      my $error = $object->insert( @$args );
 294 #      die "error inserting record into $table: $error\n"
 295 #        if $error;
 296 #    }
 297
 298   }
 299
 300   local($FS::cust_main::ignore_expired_card) = 1;
 301   #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
 302   local($FS::cust_main::ignore_banned_card) = 1;
 303   local($FS::cust_main::skip_fuzzyfiles) = 1;
 304
 305   local($FS::cust_payby::ignore_expired_card) = 1;
 306   local($FS::cust_payby::ignore_banned_card) = 1;
 307
 308   # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
 309   # kind of a weird spot for this, but it's better than duplicating
 310   # all this code in each class...
 311   my @decrypt_tables = qw( cust_payby cust_pay_void cust_pay cust_refund cust_pay_pending );
 312   foreach my $table ( @decrypt_tables ) {
 313       my @objects = qsearch({
 314         'table'     => $table,
 315         'hashref'   => {},
 316         'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
 317                        " AND LENGTH(payinfo) > 100",
 318       });
 319       foreach my $object ( @objects ) {
 320           my $payinfo = $object->decrypt($object->payinfo);
 321           die "error decrypting payinfo" if $payinfo eq $object->payinfo;
 322           $object->payinfo($payinfo);
 323           my $error = $object->replace;
 324           die $error if $error;
 325       }
 326   }
 327
 328 }
 329
 330 =item upgrade_data
 331
 332 =cut
 333
 334 sub upgrade_data {
 335   my %opt = @_;
 336
 337   tie my %hash, 'Tie::IxHash',
 338
 339     #cust_main (remove paycvv from history, locations, cust_payby, etc)
 340     'cust_main' => [],
 341
 342     #contact -> cust_contact / prospect_contact
 343     'contact' => [],
 344
 345     #msgcat
 346     'msgcat' => [],
 347
 348     #reason type and reasons
 349     'reason_type'     => [],
 350     'cust_pkg_reason' => [],
 351
 352     #need part_pkg before cust_credit...
 353     'part_pkg' => [],
 354
 355     #customer credits
 356     'cust_credit' => [],
 357
 358     # reason / void_reason migration to reasonnum / void_reasonnum
 359     'cust_credit_void' => [],
 360     'cust_bill_void' => [],
 361     'cust_bill_pkg_void' => [],
 362
 363     #duplicate history records
 364     'h_cust_svc'  => [],
 365
 366     #populate cust_pay.otaker
 367     'cust_pay'    => [],
 368
 369     #populate part_pkg_taxclass for starters
 370     'part_pkg_taxclass' => [],
 371
 372     #remove bad pending records
 373     'cust_pay_pending' => [],
 374
 375     #replace invnum and pkgnum with billpkgnum
 376     'cust_bill_pkg_detail' => [],
 377
 378     #usage_classes if we have none
 379     'usage_class' => [],
 380
 381     #phone_type if we have none
 382     'phone_type' => [],
 383
 384     #fixup access rights
 385     'access_right' => [],
 386
 387     #change recur_flat and enable_prorate
 388     'part_pkg_option' => [],
 389
 390     #add weights to pkg_category
 391     'pkg_category' => [],
 392
 393     #cdrbatch fixes
 394     'cdr' => [],
 395
 396     #otaker->usernum
 397     'cust_attachment' => [],
 398     #'cust_credit' => [],
 399     #'cust_main' => [],
 400     'cust_main_note' => [],
 401     #'cust_pay' => [],
 402     'cust_pay_void' => [],
 403     'cust_pkg' => [],
 404     #'cust_pkg_reason' => [],
 405     'cust_pkg_discount' => [],
 406     'cust_refund' => [],
 407     'banned_pay' => [],
 408
 409     #default namespace
 410     'payment_gateway' => [],
 411
 412     #migrate to templates
 413     'msg_template' => [],
 414
 415     #return unprovisioned numbers to availability
 416     'phone_avail' => [],
 417
 418     #insert scripcondition
 419     'TicketSystem' => [],
 420
 421     #insert LATA data if not already present
 422     'lata' => [],
 423
 424     #insert MSA data if not already present
 425     'msa' => [],
 426
 427     # migrate to radius_group and groupnum instead of groupname
 428     'radius_usergroup' => [],
 429     'part_svc'         => [],
 430     'part_export'      => [],
 431
 432     #insert default tower_sector if not present
 433     'tower' => [],
 434
 435     #repair improperly deleted services
 436     'cust_svc' => [],
 437
 438     #routernum/blocknum
 439     'svc_broadband' => [],
 440
 441     #set up payment gateways if needed
 442     'pay_batch' => [],
 443
 444     #flag monthly tax exemptions
 445     'cust_tax_exempt_pkg' => [],
 446
 447     #kick off tax location history upgrade
 448     'cust_bill_pkg' => [],
 449
 450     #fix taxable line item links
 451     'cust_bill_pkg_tax_location' => [],
 452
 453     #populate state FIPS codes if not already done
 454     'state' => [],
 455
 456     #set default locations on quoted packages
 457     'quotation_pkg' => [],
 458
 459     #populate tax statuses
 460     'tax_status' => [],
 461
 462     #mark certain taxes as system-maintained
 463     'cust_main_county' => [],
 464   ;
 465
 466   \%hash;
 467
 468 }
 469
 470 =item upgrade_schema
 471
 472 =cut
 473
 474 sub upgrade_schema {
 475   my %opt = @_;
 476
 477   my $data = upgrade_schema_data(%opt);
 478
 479   my $oldAutoCommit = $FS::UID::AutoCommit;
 480   local $FS::UID::AutoCommit = 0;
 481   local $FS::UID::AutoCommit = 0;
 482
 483   foreach my $table ( keys %$data ) {
 484
 485     my $class = "FS::$table";
 486     eval "use $class;";
 487     die $@ if $@;
 488
 489     if ( $class->can('_upgrade_schema') ) {
 490       warn "Upgrading $table schema...\n";
 491
 492       my $start = time;
 493
 494       $class->_upgrade_schema(%opt);
 495
 496       if ( $oldAutoCommit ) {
 497         warn "  committing\n";
 498         dbh->commit or die dbh->errstr;
 499       }
 500
 501       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
 502       warn "  done in ". (time-$start). " seconds\n";
 503
 504     } else {
 505       warn "WARNING: asked for schema upgrade of $table,".
 506            " but FS::$table has no _upgrade_schema method\n";
 507     }
 508
 509   }
 510
 511 }
 512
 513 =item upgrade_schema_data
 514
 515 =cut
 516
 517 sub upgrade_schema_data {
 518   my %opt = @_;
 519
 520   tie my %hash, 'Tie::IxHash',
 521
 522     #fix classnum character(1)
 523     'cust_bill_pkg_detail' => [],
 524     #add necessary columns to RT schema
 525     'TicketSystem' => [],
 526     #remove possible dangling records
 527     'password_history' => [],
 528     'cust_pay_pending' => [],
 529   ;
 530
 531   \%hash;
 532
 533 }
 534
 535 sub upgrade_sqlradius {
 536   #my %opt = @_;
 537
 538   my $conf = new FS::Conf;
 539
 540   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
 541
 542   foreach my $part_export ( @part_export ) {
 543
 544     my $errmsg = 'Error adding FreesideStatus to '.
 545                  $part_export->option('datasrc'). ': ';
 546
 547     my $dbh = DBI->connect(
 548       ( map $part_export->option($_), qw ( datasrc username password ) ),
 549       { PrintError => 0, PrintWarn => 0 }
 550     ) or do {
 551       warn $errmsg.$DBI::errstr;
 552       next;
 553     };
 554
 555     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
 556     my $group = "UserName";
 557     $group .= ",Realm"
 558       if ref($part_export) =~ /withdomain/
 559       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
 560
 561     my $sth_alter = $dbh->prepare(
 562       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
 563     );
 564     if ( $sth_alter ) {
 565       if ( $sth_alter->execute ) {
 566         my $sth_update = $dbh->prepare(
 567          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
 568         ) or die $errmsg.$dbh->errstr;
 569         $sth_update->execute or die $errmsg.$sth_update->errstr;
 570       } else {
 571         my $error = $sth_alter->errstr;
 572         warn $errmsg.$error
 573           unless $error =~ /Duplicate column name/i  #mysql
 574               || $error =~ /already exists/i;        #Pg
 575 ;
 576       }
 577     } else {
 578       my $error = $dbh->errstr;
 579       warn $errmsg.$error; #unless $error =~ /exists/i;
 580     }
 581
 582     my $sth_index = $dbh->prepare(
 583       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
 584     );
 585     if ( $sth_index ) {
 586       unless ( $sth_index->execute ) {
 587         my $error = $sth_index->errstr;
 588         warn $errmsg.$error
 589           unless $error =~ /Duplicate key name/i #mysql
 590               || $error =~ /already exists/i;    #Pg
 591       }
 592     } else {
 593       my $error = $dbh->errstr;
 594       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
 595     }
 596
 597     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
 598       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
 599       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
 600
 601     my $sth = $dbh->prepare("SELECT UserName,
 602                                     Realm,
 603                                     $str2time max(AcctStartTime)),
 604                                     $str2time max(AcctStopTime))
 605                               FROM radacct
 606                               WHERE FreesideStatus = 'done'
 607                                 AND $times
 608                               GROUP BY $group
 609                             ")
 610       or die $errmsg.$dbh->errstr;
 611     $sth->execute() or die $errmsg.$sth->errstr;
 612
 613     while (my $row = $sth->fetchrow_arrayref ) {
 614       my ($username, $realm, $start, $stop) = @$row;
 615
 616       $username = lc($username) unless $conf->exists('username-uppercase');
 617
 618       my $exportnum = $part_export->exportnum;
 619       my $extra_sql = " AND exportnum = $exportnum ".
 620                       " AND exportsvcnum IS NOT NULL ";
 621
 622       if ( ref($part_export) =~ /withdomain/ ) {
 623         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
 624                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
 625       }
 626
 627       my $svc_acct = qsearchs({
 628         'select'    => 'svc_acct.*',
 629         'table'     => 'svc_acct',
 630         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
 631                        'LEFT JOIN export_svc USING ( svcpart )',
 632         'hashref'   => { 'username' => $username },
 633         'extra_sql' => $extra_sql,
 634       });
 635
 636       if ($svc_acct) {
 637         $svc_acct->last_login($start)
 638           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
 639         $svc_acct->last_logout($stop)
 640           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
 641       }
 642     }
 643   }
 644
 645 }
 646
 647 =back
 648
 649 =head1 BUGS
 650
 651 Sure.
 652
 653 =head1 SEE ALSO
 654
 655 =cut
 656
 657 1;
 658