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