4 use vars qw( $opt_d $opt_s $opt_q $opt_v $opt_r $opt_c $opt_j $opt_a );
5 use vars qw( $DEBUG $DRY_RUN );
7 use DBD::Pg qw(:async); #for -a
8 use DBIx::DBSchema 0.31; #0.39
9 use FS::UID qw(adminsuidsetup checkeuid datasrc driver_name);
11 use FS::Schema qw( dbdef dbdef_dist reload_dbdef );
12 use FS::Misc::prune qw(prune_applications);
14 use FS::Record qw(qsearch);
15 use FS::Upgrade qw(upgrade_schema upgrade_config upgrade upgrade_sqlradius);
19 die "Not running uid freeside!" unless checkeuid();
28 my $user = shift or die &usage;
29 $FS::CurrentUser::upgrade_hack = 1;
30 $FS::UID::callback_hack = 1;
31 my $dbh = adminsuidsetup($user);
32 $FS::UID::callback_hack = 0;
34 # pass command line opts through to upgrade* routines
42 if ( driver_name =~ /^mysql/i ) { #until 0.39 is required above
43 eval "use DBIx::DBSchema 0.39;";
47 #needs to match FS::Schema...
48 my $dbdef_file = "%%%FREESIDE_CONF%%%/dbdef.". datasrc;
50 dbdef_create($dbh, $dbdef_file);
52 delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
53 reload_dbdef($dbdef_file);
55 warn "Upgrade startup completed in ". (time-$start). " seconds\n"; # if $DEBUG;
58 #$DBIx::DBSchema::DEBUG = $DEBUG;
59 #$DBIx::DBSchema::Table::DEBUG = $DEBUG;
60 #$DBIx::DBSchema::Index::DEBUG = $DEBUG;
64 if (dbdef->table('cust_main')->column('agent_custid') && ! $opt_s) {
66 "UPDATE cust_main SET agent_custid = NULL where agent_custid = ''";
69 "UPDATE h_cust_main SET agent_custid = NULL where agent_custid = ''"
70 if (dbdef->table('h_cust_main'));
73 if ( dbdef->table('cgp_rule_condition') &&
74 dbdef->table('cgp_rule_condition')->column('condition')
78 "ALTER TABLE ${_}cgp_rule_condition RENAME COLUMN condition TO conditionname"
83 if ( dbdef->table('areacode') and
84 dbdef->table('areacode')->primary_key eq 'code' )
86 if ( driver_name =~ /^mysql/i ) {
88 'ALTER TABLE areacode DROP PRIMARY KEY',
89 'ALTER TABLE areacode ADD COLUMN (areanum int auto_increment primary key)';
92 push @bugfix, 'ALTER TABLE areacode DROP CONSTRAINT areacode_pkey';
96 if ( dbdef->table('upgrade_journal') ) {
97 push @bugfix, "SELECT SETVAL( 'upgrade_journal_upgradenum_seq',
98 ( SELECT MAX(upgradenum) FROM upgrade_journal )
105 join(";\n", @bugfix ). ";\n";
106 } elsif ( @bugfix ) {
108 foreach my $statement ( @bugfix ) {
110 $dbh->do( $statement )
111 or die "Error: ". $dbh->errstr. "\n executing: $statement";
114 upgrade_schema(%upgrade_opts);
116 dbdef_create($dbh, $dbdef_file);
117 delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
118 reload_dbdef($dbdef_file);
122 #you should have run fs-migrate-part_svc ages ago, when you upgraded
123 #from 1.3 to 1.4... if not, it needs to be hooked into -upgrade here or
124 #you'll lose all the part_svc settings it migrates to part_svc_column
126 my $conf = new FS::Conf;
128 my $dbdef_dist = dbdef_dist(
130 { 'queue-no_history' => $conf->exists('queue-no_history') },
133 my @statements = dbdef->sql_update_schema( $dbdef_dist,
135 { 'nullify_default' => 1, },
138 #### NEW CUSTOM FIELDS:
139 # 1. prevent new custom field columns from being dropped by upgrade
140 # 2. migrate old virtual fields to real fields (new custom fields)
142 my $cfsth = $dbh->prepare("SELECT * FROM part_virtual_field")
144 $cfsth->execute or die $cfsth->errstr;
146 while ( $cf = $cfsth->fetchrow_hashref ) {
147 my $tbl = $cf->{'dbtable'};
148 my $name = $cf->{'name'};
149 $name = lc($name) unless driver_name =~ /^mysql/i;
151 @statements = grep { $_ !~ /^\s*ALTER\s+TABLE\s+(h_|)$tbl\s+DROP\s+COLUMN\s+cf_$name\s*$/i }
154 "ALTER TABLE $tbl ADD COLUMN cf_$name varchar(".$cf->{'length'}.")"
155 unless (dbdef->table($tbl) && dbdef->table($tbl)->column("cf_$name"));
157 "ALTER TABLE h_$tbl ADD COLUMN cf_$name varchar(".$cf->{'length'}.")"
158 unless (dbdef->table("h_$tbl") && dbdef->table("h_$tbl")->column("cf_$name"));
160 warn "Custom fields schema upgrade completed";
163 grep { $_ !~ /^CREATE +INDEX +h_queue/i } #useless, holds up queue insertion
166 unless ( driver_name =~ /^mysql/i ) {
167 #not necessary under non-mysql, takes forever on big db
169 grep { $_ !~ /^ *ALTER +TABLE +h_queue +ALTER +COLUMN +job +TYPE +varchar\(512\) *$/i }
176 grep { $_ !~ /^ *ALTER +TABLE +(h_)?cdr /i }
180 grep { $_ !~ /^ *CREATE +INDEX +(h_)?cdr\d+ /i }
185 my $MAX_HANDLES; # undef for now, set it if you want a limit
189 join(";\n", @statements ). ";\n";
193 my @phases = map { [] } 0..4;
194 my $fsupgrade_idx = 1;
196 foreach (@statements) {
197 if ( /^ *(CREATE|ALTER) +TABLE/ ) {
198 # phase 0: CREATE TABLE, ALTER TABLE
199 push @{ $phases[0] }, $_;
200 } elsif ( /^ *ALTER +INDEX.* RENAME TO dbs_temp(\d+)/ ) {
201 # phase 1: rename index to dbs_temp%d
202 # (see DBIx::DBSchema::Table)
203 # but in this case, uniqueify all the dbs_temps. This method only works
204 # because they are in the right order to begin with...
205 my $dbstemp_idx = $1;
206 s/dbs_temp$dbstemp_idx/fsupgrade_temp$fsupgrade_idx/;
207 $idx_map{ $dbstemp_idx } = $fsupgrade_idx;
208 push @{ $phases[1] }, $_;
210 } elsif ( /^ *(CREATE|DROP)( +UNIQUE)? +INDEX/ ) {
211 # phase 2: create/drop indices
212 push @{ $phases[2] }, $_;
213 } elsif ( /^ *ALTER +INDEX +dbs_temp(\d+) +RENAME/ ) {
214 # phase 3: rename temp indices back to real ones
215 my $dbstemp_idx = $1;
216 my $mapped_idx = $idx_map{ $dbstemp_idx }
217 or die "unable to remap dbs_temp$1 RENAME statement";
218 s/dbs_temp$dbstemp_idx/fsupgrade_temp$mapped_idx/;
219 push @{ $phases[3] }, $_;
221 # phase 4: everything else (CREATE SEQUENCE, SELECT SETVAL, etc.)
222 push @{ $phases[4] }, $_;
228 foreach my $phase (@phases) {
229 warn "Starting schema changes, phase $i...\n";
230 while (@$phase or @busy) {
231 # check status of all running tasks
234 for my $clone (@busy) {
235 if ( $clone->pg_ready ) {
237 my $rv = $clone->pg_result && $clone->commit;
238 $failed_clone = $clone if !$rv;
241 push @newbusy, $clone;
244 if ( $failed_clone ) {
245 my $errstr = $failed_clone->errstr;
246 foreach my $clone (@newbusy, $failed_clone) {
247 $clone->pg_cancel if $clone->{pg_async_status} == 1;
253 if (my $statement = $phase->[0]) {
256 $clone = shift(@free);
257 } elsif ( !$MAX_HANDLES or
258 scalar(@free) + scalar(@busy) < $MAX_HANDLES ) {
259 $clone = $dbh->clone; # this will fail if over the server limit
263 my $rv = $clone->do($statement, {pg_async => PG_ASYNC});
266 shift @{ $phase }; # and actually take the statement off the queue
268 } # else I don't know, wait and retry
269 } # else too many handles, wait and retry
271 # all statements are dispatched
272 warn "Waiting for phase $i to complete\n";
275 } # while @$phase or @busy
278 warn "Schema changes complete.\n";
280 # warn "Pre-schema change upgrades completed in ". (time-$start). " seconds\n"; # if $DEBUG;
283 # dbdef->update_schema( dbdef_dist(datasrc), $dbh );
284 } else { # normal case, run statements sequentially
285 foreach my $statement ( @statements ) {
287 $dbh->do( $statement )
288 or die "Error: ". $dbh->errstr. "\n executing: $statement";
292 warn "Schema upgrade completed in ". (time-$start). " seconds\n"; # if $DEBUG;
296 $hashref->{dry_run} = 1 if $DRY_RUN;
297 $hashref->{debug} = 1 if $DEBUG && $DRY_RUN;
298 prune_applications($hashref) unless $opt_s;
300 warn "Application pruning completed in ". (time-$start). " seconds\n"; # if $DEBUG;
303 print "\n" if $DRY_RUN;
305 if ( $dbh->{Driver}->{Name} =~ /^mysql/i && ! $opt_s ) {
307 foreach my $table (qw( svc_acct svc_phone )) {
309 my $sth = $dbh->prepare(
310 "SELECT COUNT(*) FROM duplicate_lock WHERE lockname = '$table'"
311 ) or die $dbh->errstr;
313 $sth->execute or die $sth->errstr;
315 unless ( $sth->fetchrow_arrayref->[0] ) {
317 $sth = $dbh->prepare(
318 "INSERT INTO duplicate_lock ( lockname ) VALUES ( '$table' )"
319 ) or die $dbh->errstr;
321 $sth->execute or die $sth->errstr;
327 warn "Duplication lock creation completed in ". (time-$start). " seconds\n"; # if $DEBUG;
332 $dbh->commit or die $dbh->errstr;
334 dbdef_create($dbh, $dbdef_file);
336 $dbh->disconnect or die $dbh->errstr;
338 delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
339 $FS::UID::AutoCommit = 0;
340 $FS::UID::callback_hack = 1;
341 $dbh = adminsuidsetup($user);
342 $FS::UID::callback_hack = 0;
343 unless ( $DRY_RUN || $opt_s ) {
344 my $dir = "%%%FREESIDE_CONF%%%/conf.". datasrc;
345 if (!scalar(qsearch('conf', {}))) {
346 my $error = FS::Conf::init_config($dir);
348 warn "CONFIGURATION UPGRADE FAILED\n";
349 $dbh->rollback or die $dbh->errstr;
354 $dbh->commit or die $dbh->errstr;
355 $dbh->disconnect or die $dbh->errstr;
357 $FS::UID::AutoCommit = 1;
359 $dbh = adminsuidsetup($user);
361 warn "Re-initialization with updated schema completed in ". (time-$start). " seconds\n"; # if $DEBUG;
364 #### NEW CUSTOM FIELDS:
365 # 3. migrate old virtual field data to the new custom fields
367 $cfsth = $dbh->prepare("SELECT * FROM virtual_field left join part_virtual_field using (vfieldpart)")
369 $cfsth->execute or die $cfsth->errstr;
371 while ( $cf = $cfsth->fetchrow_hashref ) {
372 my $tbl = $cf->{'dbtable'};
373 my $name = $cf->{'name'};
374 my $dtable = dbdef->table($tbl);
375 next unless $dtable && $dtable->primary_key; # XXX: warn first?
376 my $pkey = $dtable->primary_key;
377 next unless $dtable->column($pkey)->type =~ /int/i; # XXX: warn first?
378 push @cfst, "UPDATE $tbl set cf_$name = '".$cf->{'value'}."' WHERE $pkey = ".$cf->{'recnum'};
379 push @cfst, "DELETE FROM virtual_field WHERE vfieldnum = ".$cf->{'vfieldnum'};
381 foreach my $cfst ( @cfst ) {
384 or die "Error: ". $dbh->errstr. "\n executing: $cfst";
386 warn "Custom fields data upgrade completed";
388 upgrade_config(%upgrade_opts)
389 unless $DRY_RUN || $opt_s;
391 $dbh->commit or die $dbh->errstr;
393 warn "Config updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
396 upgrade(%upgrade_opts)
397 unless $DRY_RUN || $opt_s;
399 $dbh->commit or die $dbh->errstr;
401 warn "Table updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
404 upgrade_sqlradius(%upgrade_opts)
405 unless $DRY_RUN || $opt_s || $opt_r;
407 warn "SQL RADIUS updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
410 $dbh->commit or die $dbh->errstr;
411 $dbh->disconnect or die $dbh->errstr;
413 warn "Final commit and disconnection completed in ". (time-$start). " seconds; upgrade done!\n"; # if $DEBUG;
417 sub dbdef_create { # reverse engineer the schema from the DB and save to file
418 my( $dbh, $file ) = @_;
419 my $dbdef = new_native DBIx::DBSchema $dbh;
424 die "Usage:\n freeside-upgrade [ -d ] [ -q | -v ] [ -r ] [ -c ] [ -s ] [ -j ] [ -a ] user\n";
429 freeside-upgrade - Upgrades database schema for new freeside verisons.
433 freeside-upgrade [ -d ] [ -q | -v ] [ -r ] [ -c ] [ -s ] [ -j ] [ -a ]
437 Reads your existing database schema and updates it to match the current schema,
438 adding any columns or tables necessary.
440 Also performs other upgrade functions:
444 =item Calls FS:: Misc::prune::prune_applications (probably unnecessary every upgrade, but simply won't find any records to change)
446 =item If necessary, moves your configuration information from the filesystem in /usr/local/etc/freeside/conf.<datasrc> to the database.
450 [ -d ]: Dry run; output SQL statements (to STDOUT) only, but do not execute
453 [ -q ]: Run quietly. This may become the default at some point.
455 [ -v ]: Run verbosely, sending debugging information to STDERR. This is the
458 [ -s ]: Schema changes only. Useful for Pg/slony slaves where the data
460 [ -r ]: Skip sqlradius updates. Useful for occassions where the sqlradius
461 databases may be inaccessible.
463 [ -c ]: Skip cdr and h_cdr updates.
465 changes will be replicated from the Pg/slony master.
467 [ -j ]: Run certain upgrades asychronously from the job queue. Currently
468 used only for the 2.x -> 3.x cust_location, cust_pay and part_pkg
469 upgrades. This may cause odd behavior before the upgrade is
470 complete, so it's recommended only for very large cust_main, cust_pay
471 and/or part_pkg tables that take too long to upgrade.
473 [ -a ]: Run schema changes in parallel (Pg only). DBIx::DBSchema minimum
474 version 0.41 recommended. Recommended only for large databases and
475 powerful database servers, to reduce upgrade time.