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