tax engine refactoring for Avalara and Billsoft tax vendors, #25718
[freeside.git] / FS / FS / Upgrade.pm
index 40d3473..d76379f 100644 (file)
@@ -4,9 +4,12 @@ use strict;
 use vars qw( @ISA @EXPORT_OK $DEBUG );
 use Exporter;
 use Tie::IxHash;
+use File::Slurp;
 use FS::UID qw( dbh driver_name );
 use FS::Conf;
 use FS::Record qw(qsearchs qsearch str2time_sql);
+use FS::queue;
+use FS::upgrade_journal;
 
 use FS::svc_domain;
 $FS::svc_domain::whois_hack = 1;
@@ -47,9 +50,89 @@ sub upgrade_config {
     if $conf->exists('payment_receipt_email')
     || $conf->config('payment_receipt_msgnum');
 
+  $conf->touch('geocode-require_nw_coordinates')
+    if $conf->exists('svc_broadband-require-nw-coordinates');
+
+  unless ( $conf->config('echeck-country') ) {
+    if ( $conf->exists('cust_main-require-bank-branch') ) {
+      $conf->set('echeck-country', 'CA');
+    } elsif ( $conf->exists('echeck-nonus') ) {
+      $conf->set('echeck-country', 'XX');
+    } else {
+      $conf->set('echeck-country', 'US');
+    }
+  }
+
   upgrade_overlimit_groups($conf);
   map { upgrade_overlimit_groups($conf,$_->agentnum) } qsearch('agent', {});
-  
+
+  my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
+  $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
+    foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
+      qw( quotation_html quotation_latex quotation_latexnotes );
+
+  # change 'fslongtable' to 'longtable'
+  # in invoice and quotation main templates, and also in all secondary 
+  # invoice templates
+  my @latex_confs =
+    qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
+
+  foreach my $c (@latex_confs) {
+    my $value = $c->value;
+    if (length($value) and $value =~ /fslongtable/) {
+      $value =~ s/fslongtable/longtable/g;
+      $conf->set($c->name, $value, $c->agentnum);
+    }
+  }
+
+  # if there's a USPS tools login, assume that's the standardization method
+  # you want to use
+  $conf->set('address_standardize_method', 'usps')
+    if $conf->exists('usps_webtools-userid')
+    && length($conf->config('usps_webtools-userid')) > 0
+    && ! $conf->exists('address_standardize_method');
+
+  # this option has been renamed/expanded
+  if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
+    $conf->touch('cust_main-enable_spouse');
+    $conf->delete('cust_main-enable_spouse_birthdate');
+  }
+
+  # renamed/repurposed
+  if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
+    $conf->touch('part_pkg-show_fcc_options');
+    $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
+    warn "
+You have FCC Form 477 package options enabled.
+
+Starting with the October 2014 filing date, the FCC has redesigned 
+Form 477 and introduced new service categories.  See bin/convert-477-options
+to update your package configuration for the new report.
+
+If you need to continue using the old Form 477 report, turn on the
+'old_fcc_report' configuration option.
+";
+  }
+
+  # boolean invoice_sections_by_location option is now
+  # invoice_sections_method = 'location'
+  my @invoice_sections_confs =
+    qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
+  foreach my $c (@invoice_sections_confs) {
+    $c->name =~ /^(\w+)sections_by_location$/;
+    $conf->delete($c->name);
+    my $newname = $1.'sections_method';
+    $conf->set($newname, 'location');
+  }
+
+  # boolean enable_taxproducts is now enable_taxproducts = 'cch'
+  if ( $conf->exists('enable_taxproducts') and
+       $conf->config('enable_taxproducts') eq '' ) {
+
+    $conf->set('enable_taxproducts', 'cch');
+
+  }
+
 }
 
 sub upgrade_overlimit_groups {
@@ -91,6 +174,9 @@ sub upgrade {
   local $FS::UID::AutoCommit = 0;
   local $FS::UID::AutoCommit = 0;
 
+  local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
+
+
   foreach my $table ( keys %$data ) {
 
     my $class = "FS::$table";
@@ -104,6 +190,26 @@ sub upgrade {
 
       $class->_upgrade_data(%opt);
 
+      # New interface for async upgrades: a class can declare a 
+      # "queueable_upgrade" method, which will run as part of the normal 
+      # upgrade, but if the -j option is passed, will instead be run from 
+      # the job queue.
+      if ( $class->can('queueable_upgrade') ) {
+        my $jobname = $class . '::queueable_upgrade';
+        my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
+        if ($num_jobs > 0) {
+          warn "$class upgrade already scheduled.\n";
+        } else {
+          if ( $opt{'queue'} ) {
+            warn "Scheduling $class upgrade.\n";
+            my $job = FS::queue->new({ job => $jobname });
+            $job->insert($class, %opt);
+          } else {
+            $class->queueable_upgrade(%opt);
+          }
+        } #$num_jobs == 0
+      }
+
       if ( $oldAutoCommit ) {
         warn "  committing\n";
         dbh->commit or die dbh->errstr;
@@ -129,15 +235,25 @@ sub upgrade {
 
   }
 
-  # decrypt all payinfo where payby = BILL
+  local($FS::cust_main::ignore_expired_card) = 1;
+  local($FS::cust_main::ignore_illegal_zip) = 1;
+  local($FS::cust_main::ignore_banned_card) = 1;
+  local($FS::cust_main::skip_fuzzyfiles) = 1;
+
+  local($FS::cust_payby::ignore_expired_card) = 1;
+  local($FS::cust_payby::ignore_banned_card) = 1;
+
+  # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
   # kind of a weird spot for this, but it's better than duplicating
   # all this code in each class...
   my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
   foreach my $table ( @decrypt_tables ) {
-      my @objects = qsearch({   'table'     => $table,
-                                'hashref'   => { 'payby' => 'BILL', },
-                                'extra_sql' => 'AND LENGTH(payinfo) > 100',
-                              });
+      my @objects = qsearch({
+        'table'     => $table,
+        'hashref'   => {},
+        'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
+                       " AND LENGTH(payinfo) > 100",
+      });
       foreach my $object ( @objects ) {
           my $payinfo = $object->decrypt($object->payinfo);
           die "error decrypting payinfo" if $payinfo eq $object->payinfo;
@@ -243,6 +359,32 @@ sub upgrade_data {
     'part_svc'         => [],
     'part_export'      => [],
 
+    #insert default tower_sector if not present
+    'tower' => [],
+
+    #repair improperly deleted services
+    'cust_svc' => [],
+
+    #routernum/blocknum
+    'svc_broadband' => [],
+
+    #set up payment gateways if needed
+    'pay_batch' => [],
+
+    #flag monthly tax exemptions
+    'cust_tax_exempt_pkg' => [],
+
+    #kick off tax location history upgrade
+    'cust_bill_pkg' => [],
+
+    #fix taxable line item links
+    'cust_bill_pkg_tax_location' => [],
+
+    #populate state FIPS codes if not already done
+    'state' => [],
+
+    #populate tax statuses
+    'tax_status' => [],
   ;
 
   \%hash;
@@ -303,6 +445,8 @@ sub upgrade_schema_data {
 
     #fix classnum character(1)
     'cust_bill_pkg_detail' => [],
+    #add necessary columns to RT schema
+    'TicketSystem' => [],
 
   ;