make non-blocking location upgrade optional, #28883
[freeside.git] / FS / bin / freeside-upgrade
index 24f577f..3755a81 100755 (executable)
@@ -1,23 +1,23 @@
 #!/usr/bin/perl -w
 
 use strict;
-use vars qw($opt_d $opt_s $opt_q $opt_v);
-use vars qw($DEBUG $DRY_RUN);
+use vars qw( $opt_d $opt_s $opt_q $opt_v $opt_r $opt_c $opt_j );
+use vars qw( $DEBUG $DRY_RUN );
 use Getopt::Std;
-use DBIx::DBSchema 0.31;
-use FS::UID qw(adminsuidsetup checkeuid datasrc );  #getsecrets);
+use DBIx::DBSchema 0.31; #0.39
+use FS::UID qw(adminsuidsetup checkeuid datasrc driver_name);
 use FS::CurrentUser;
 use FS::Schema qw( dbdef dbdef_dist reload_dbdef );
 use FS::Misc::prune qw(prune_applications);
 use FS::Conf;
 use FS::Record qw(qsearch);
-use FS::Upgrade qw(upgrade upgrade_sqlradius);
+use FS::Upgrade qw(upgrade_schema upgrade_config upgrade upgrade_sqlradius);
 
 my $start = time;
 
 die "Not running uid freeside!" unless checkeuid();
 
-getopts("dqs");
+getopts("dqrcsj");
 
 $DEBUG = !$opt_q;
 #$DEBUG = $opt_v;
@@ -30,6 +30,19 @@ $FS::UID::callback_hack = 1;
 my $dbh = adminsuidsetup($user);
 $FS::UID::callback_hack = 0;
 
+# pass command line opts through to upgrade* routines
+my %upgrade_opts = (
+  quiet   => $opt_q,
+  verbose => $opt_v,
+  queue   => $opt_j,
+  # others?
+);
+
+if ( driver_name =~ /^mysql/i ) { #until 0.39 is required above
+  eval "use DBIx::DBSchema 0.39;";
+  die $@ if $@;
+}
+
 #needs to match FS::Schema...
 my $dbdef_file = "%%%FREESIDE_CONF%%%/dbdef.". datasrc;
 
@@ -41,9 +54,9 @@ reload_dbdef($dbdef_file);
 warn "Upgrade startup completed in ". (time-$start). " seconds\n"; # if $DEBUG;
 $start = time;
 
-$DBIx::DBSchema::DEBUG = $DEBUG;
-$DBIx::DBSchema::Table::DEBUG = $DEBUG;
-$DBIx::DBSchema::Index::DEBUG = $DEBUG;
+#$DBIx::DBSchema::DEBUG = $DEBUG;
+#$DBIx::DBSchema::Table::DEBUG = $DEBUG;
+#$DBIx::DBSchema::Index::DEBUG = $DEBUG;
 
 my @bugfix = ();
 
@@ -56,24 +69,133 @@ if (dbdef->table('cust_main')->column('agent_custid') && ! $opt_s) {
       if (dbdef->table('h_cust_main')); 
 }
 
+if ( dbdef->table('cgp_rule_condition') &&
+     dbdef->table('cgp_rule_condition')->column('condition') 
+   )
+{
+  push @bugfix,
+   "ALTER TABLE ${_}cgp_rule_condition RENAME COLUMN condition TO conditionname"
+      for '', 'h_';
+
+}
+
+if ( dbdef->table('areacode') and
+     dbdef->table('areacode')->primary_key eq 'code' )
+{
+  if ( driver_name =~ /^mysql/i ) {
+    push @bugfix, 
+      'ALTER TABLE areacode DROP PRIMARY KEY',
+      'ALTER TABLE areacode ADD COLUMN (areanum int auto_increment primary key)';
+  }
+  else {
+    push @bugfix, 'ALTER TABLE areacode DROP CONSTRAINT areacode_pkey';
+  }
+}
+
+if ( dbdef->table('upgrade_journal') ) {
+  push @bugfix, "SELECT SETVAL( 'upgrade_journal_upgradenum_seq',
+                                ( SELECT MAX(upgradenum) FROM upgrade_journal )
+                              )
+                ";
+}
+
+if ( $DRY_RUN ) {
+  print
+    join(";\n", @bugfix ). ";\n";
+} elsif ( @bugfix ) {
+
+  foreach my $statement ( @bugfix ) {
+    warn "$statement\n";
+    $dbh->do( $statement )
+      or die "Error: ". $dbh->errstr. "\n executing: $statement";
+  }
+
+  upgrade_schema(%upgrade_opts);
+
+  dbdef_create($dbh, $dbdef_file);
+  delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
+  reload_dbdef($dbdef_file);
+
+}
+
 #you should have run fs-migrate-part_svc ages ago, when you upgraded
 #from 1.3 to 1.4... if not, it needs to be hooked into -upgrade here or
 #you'll lose all the part_svc settings it migrates to part_svc_column
 
+my $conf = new FS::Conf;
+
+my $dbdef_dist = dbdef_dist(
+  datasrc,
+  { 'queue-no_history' => $conf->exists('queue-no_history') },
+);
+
+my @statements = dbdef->sql_update_schema( $dbdef_dist,
+                                           $dbh,
+                                           { 'nullify_default' => 1, },
+                                         );
+
+#### NEW CUSTOM FIELDS:
+# 1. prevent new custom field columns from being dropped by upgrade
+# 2. migrate old virtual fields to real fields (new custom fields)
+####
+my $cfsth = $dbh->prepare("SELECT * FROM part_virtual_field") 
+                                                         or die $dbh->errstr;
+$cfsth->execute or die $cfsth->errstr;
+my $cf; 
+while ( $cf = $cfsth->fetchrow_hashref ) {
+    my $tbl = $cf->{'dbtable'};
+    my $name = $cf->{'name'};
+    $name = lc($name) unless driver_name =~ /^mysql/i;
+
+    @statements = grep { $_ !~ /^\s*ALTER\s+TABLE\s+(h_|)$tbl\s+DROP\s+COLUMN\s+cf_$name\s*$/i }
+                                                                    @statements;
+    push @statements, 
+        "ALTER TABLE $tbl ADD COLUMN cf_$name varchar(".$cf->{'length'}.")"
+     unless (dbdef->table($tbl) && dbdef->table($tbl)->column("cf_$name"));
+    push @statements, 
+        "ALTER TABLE h_$tbl ADD COLUMN cf_$name varchar(".$cf->{'length'}.")"
+     unless (dbdef->table("h_$tbl") && dbdef->table("h_$tbl")->column("cf_$name"));
+}
+warn "Custom fields schema upgrade completed";
+
+@statements = 
+  grep { $_ !~ /^CREATE +INDEX +h_queue/i } #useless, holds up queue insertion
+       @statements;
+
+unless ( driver_name =~ /^mysql/i ) {
+  #not necessary under non-mysql, takes forever on big db
+  @statements =
+    grep { $_ !~ /^ *ALTER +TABLE +h_queue +ALTER +COLUMN +job +TYPE +varchar\(512\) *$/i }
+         @statements;
+}
+
+if ( $opt_c ) {
+
+  @statements =
+    grep { $_ !~ /^ *ALTER +TABLE +(h_)?cdr /i }
+         @statements;
+
+  @statements =
+    grep { $_ !~ /^ *CREATE +INDEX +(h_)?cdr\d+ /i }
+         @statements;
+
+}
+
 if ( $DRY_RUN ) {
   print
-    join(";\n", @bugfix, dbdef->sql_update_schema( dbdef_dist(datasrc), $dbh ) ). ";\n";
+    join(";\n", @statements ). ";\n";
   exit;
 } else {
-  foreach my $statement ( @bugfix ) {
+  foreach my $statement ( @statements ) {
+    warn "$statement\n";
     $dbh->do( $statement )
       or die "Error: ". $dbh->errstr. "\n executing: $statement";
   }
 
-  warn "Pre-schema change upgrades completed in ". (time-$start). " seconds\n"; # if $DEBUG;
-  $start = time;
+#  warn "Pre-schema change upgrades completed in ". (time-$start). " seconds\n"; # if $DEBUG;
+#  $start = time;
 
-  dbdef->update_schema( dbdef_dist(datasrc), $dbh );
+#  dbdef->update_schema( dbdef_dist(datasrc), $dbh );
 }
 
 warn "Schema upgrade completed in ". (time-$start). " seconds\n"; # if $DEBUG;
@@ -141,19 +263,55 @@ unless ( $DRY_RUN || $opt_s ) {
 $dbh->commit or die $dbh->errstr;
 $dbh->disconnect or die $dbh->errstr;
 
+$FS::UID::AutoCommit = 1;
+
 $dbh = adminsuidsetup($user);
 
 warn "Re-initialization with updated schema completed in ". (time-$start). " seconds\n"; # if $DEBUG;
 $start = time;
 
-upgrade()
+#### NEW CUSTOM FIELDS:
+# 3. migrate old virtual field data to the new custom fields
+####
+$cfsth = $dbh->prepare("SELECT * FROM virtual_field left join part_virtual_field using (vfieldpart)")
+                                                         or die $dbh->errstr;
+$cfsth->execute or die $cfsth->errstr;
+my @cfst;
+while ( $cf = $cfsth->fetchrow_hashref ) {
+    my $tbl = $cf->{'dbtable'};
+    my $name = $cf->{'name'};
+    my $dtable = dbdef->table($tbl);
+    next unless $dtable && $dtable->primary_key; # XXX: warn first?
+    my $pkey = $dtable->primary_key;
+    next unless $dtable->column($pkey)->type =~ /int/i; # XXX: warn first?
+    push @cfst, "UPDATE $tbl set cf_$name = '".$cf->{'value'}."' WHERE $pkey = ".$cf->{'recnum'};
+    push @cfst, "DELETE FROM virtual_field WHERE vfieldnum = ".$cf->{'vfieldnum'};
+}
+foreach my $cfst ( @cfst ) {
+    warn "$cfst\n";
+    $dbh->do( $cfst )
+      or die "Error: ". $dbh->errstr. "\n executing: $cfst";
+}
+warn "Custom fields data upgrade completed";
+
+upgrade_config(%upgrade_opts)
+  unless $DRY_RUN || $opt_s;
+
+$dbh->commit or die $dbh->errstr;
+
+warn "Config updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
+$start = time;
+
+upgrade(%upgrade_opts)
   unless $DRY_RUN || $opt_s;
 
+$dbh->commit or die $dbh->errstr;
+
 warn "Table updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
 $start = time;
 
-upgrade_sqlradius()
-  unless $DRY_RUN || $opt_s;
+upgrade_sqlradius(%upgrade_opts)
+  unless $DRY_RUN || $opt_s || $opt_r;
 
 warn "SQL RADIUS updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
 $start = time;
@@ -161,7 +319,7 @@ $start = time;
 $dbh->commit or die $dbh->errstr;
 $dbh->disconnect or die $dbh->errstr;
 
-warn "Commit and disconnection completed in ". (time-$start). " seconds; upgrade done!\n"; # if $DEBUG;
+warn "Final commit and disconnection completed in ". (time-$start). " seconds; upgrade done!\n"; # if $DEBUG;
 
 ###
 
@@ -172,7 +330,7 @@ sub dbdef_create { # reverse engineer the schema from the DB and save to file
 }
 
 sub usage {
-  die "Usage:\n  freeside-upgrade [ -d ] [ -s ] [ -q | -v ] user\n"; 
+  die "Usage:\n  freeside-upgrade [ -d ] [ -r ] [ -s ] [ -q | -v ] user\n"; 
 }
 
 =head1 NAME
@@ -181,7 +339,7 @@ freeside-upgrade - Upgrades database schema for new freeside verisons.
 
 =head1 SYNOPSIS
 
-  freeside-upgrade [ -d ] [ -s ] [ -q | -v ]
+  freeside-upgrade [ -d ] [ -r ] [ -c ] [ -s ] [ -q | -v ]
 
 =head1 DESCRIPTION
 
@@ -203,12 +361,22 @@ Also performs other upgrade functions:
 
   [ -q ]: Run quietly.  This may become the default at some point.
 
+  [ -r ]: Skip sqlradius updates.  Useful for occassions where the sqlradius
+          databases may be inaccessible.
+
+  [ -c ]: Skip cdr and h_cdr updates.
+
   [ -v ]: Run verbosely, sending debugging information to STDERR.  This is the
           current default.
 
   [ -s ]: Schema changes only.  Useful for Pg/slony slaves where the data
           changes will be replicated from the Pg/slony master.
 
+  [ -j ]: Run certain upgrades asychronously from the job queue.  Currently 
+          used only for the 2.x -> 3.x cust_location upgrade.  This may cause
+          odd behavior before the upgrade is complete, so it's recommended 
+          only for very large cust_main tables that take too long to upgrade.
+
 =head1 SEE ALSO
 
 =cut