4 use vars qw($opt_d $opt_s $opt_q $opt_v $opt_r);
5 use vars qw($DEBUG $DRY_RUN);
7 use DBIx::DBSchema 0.31; #0.39
8 use FS::UID qw(adminsuidsetup checkeuid datasrc driver_name); #getsecrets);
10 use FS::Schema qw( dbdef dbdef_dist reload_dbdef );
11 use FS::Misc::prune qw(prune_applications);
13 use FS::Record qw(qsearch);
14 use FS::Upgrade qw(upgrade_schema upgrade_config upgrade upgrade_sqlradius);
18 die "Not running uid freeside!" unless checkeuid();
27 my $user = shift or die &usage;
28 $FS::CurrentUser::upgrade_hack = 1;
29 $FS::UID::callback_hack = 1;
30 my $dbh = adminsuidsetup($user);
31 $FS::UID::callback_hack = 0;
33 if ( driver_name =~ /^mysql/i ) { #until 0.39 is required above
34 eval "use DBIx::DBSchema 0.39;";
38 #needs to match FS::Schema...
39 my $dbdef_file = "%%%FREESIDE_CONF%%%/dbdef.". datasrc;
41 dbdef_create($dbh, $dbdef_file);
43 delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
44 reload_dbdef($dbdef_file);
46 warn "Upgrade startup completed in ". (time-$start). " seconds\n"; # if $DEBUG;
49 #$DBIx::DBSchema::DEBUG = $DEBUG;
50 #$DBIx::DBSchema::Table::DEBUG = $DEBUG;
51 #$DBIx::DBSchema::Index::DEBUG = $DEBUG;
55 if (dbdef->table('cust_main')->column('agent_custid') && ! $opt_s) {
57 "UPDATE cust_main SET agent_custid = NULL where agent_custid = ''";
60 "UPDATE h_cust_main SET agent_custid = NULL where agent_custid = ''"
61 if (dbdef->table('h_cust_main'));
64 if ( dbdef->table('cgp_rule_condition') &&
65 dbdef->table('cgp_rule_condition')->column('condition')
69 "ALTER TABLE ${_}cgp_rule_condition RENAME COLUMN condition TO conditionname"
74 if ( dbdef->table('areacode') and
75 dbdef->table('areacode')->primary_key eq 'code' )
77 if ( driver_name =~ /^mysql/i ) {
79 'ALTER TABLE areacode DROP PRIMARY KEY',
80 'ALTER TABLE areacode ADD COLUMN (areanum int auto_increment primary key)';
83 push @bugfix, 'ALTER TABLE areacode DROP CONSTRAINT areacode_pkey';
89 join(";\n", @bugfix ). ";\n";
92 foreach my $statement ( @bugfix ) {
94 $dbh->do( $statement )
95 or die "Error: ". $dbh->errstr. "\n executing: $statement";
100 dbdef_create($dbh, $dbdef_file);
101 delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
102 reload_dbdef($dbdef_file);
106 #you should have run fs-migrate-part_svc ages ago, when you upgraded
107 #from 1.3 to 1.4... if not, it needs to be hooked into -upgrade here or
108 #you'll lose all the part_svc settings it migrates to part_svc_column
110 my @statements = dbdef->sql_update_schema( dbdef_dist(datasrc),
112 { 'nullify_default' => 1, },
115 #### NEW CUSTOM FIELDS (prevent columns from being dropped by upgrade)
116 my $cfsth = $dbh->prepare("SELECT * FROM part_virtual_field")
118 $cfsth->execute or die $cfsth->errstr;
120 # likely a very inefficient implementation of this
121 while ( $cf = $cfsth->fetchrow_hashref ) {
122 my $tbl = $cf->{'dbtable'};
123 my $name = $cf->{'name'};
124 @statements = grep { $_ !~ /^\s*ALTER\s+TABLE\s+$tbl\s+DROP\s+COLUMN\s+cf_$name\s*$/i }
129 grep { $_ !~ /^CREATE +INDEX +h_queue/i } #useless, holds up queue insertion
132 unless ( driver_name =~ /^mysql/i ) {
133 #not necessary under non-mysql, takes forever on big db
135 grep { $_ !~ /^ *ALTER +TABLE +h_queue +ALTER +COLUMN +job +TYPE +varchar\(512\) *$/i }
141 join(";\n", @statements ). ";\n";
144 foreach my $statement ( @statements ) {
146 $dbh->do( $statement )
147 or die "Error: ". $dbh->errstr. "\n executing: $statement";
150 # warn "Pre-schema change upgrades completed in ". (time-$start). " seconds\n"; # if $DEBUG;
153 # dbdef->update_schema( dbdef_dist(datasrc), $dbh );
156 warn "Schema upgrade completed in ". (time-$start). " seconds\n"; # if $DEBUG;
160 $hashref->{dry_run} = 1 if $DRY_RUN;
161 $hashref->{debug} = 1 if $DEBUG && $DRY_RUN;
162 prune_applications($hashref) unless $opt_s;
164 warn "Application pruning completed in ". (time-$start). " seconds\n"; # if $DEBUG;
167 print "\n" if $DRY_RUN;
169 if ( $dbh->{Driver}->{Name} =~ /^mysql/i && ! $opt_s ) {
171 foreach my $table (qw( svc_acct svc_phone )) {
173 my $sth = $dbh->prepare(
174 "SELECT COUNT(*) FROM duplicate_lock WHERE lockname = '$table'"
175 ) or die $dbh->errstr;
177 $sth->execute or die $sth->errstr;
179 unless ( $sth->fetchrow_arrayref->[0] ) {
181 $sth = $dbh->prepare(
182 "INSERT INTO duplicate_lock ( lockname ) VALUES ( '$table' )"
183 ) or die $dbh->errstr;
185 $sth->execute or die $sth->errstr;
191 warn "Duplication lock creation completed in ". (time-$start). " seconds\n"; # if $DEBUG;
196 $dbh->commit or die $dbh->errstr;
198 dbdef_create($dbh, $dbdef_file);
200 $dbh->disconnect or die $dbh->errstr;
202 delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
203 $FS::UID::AutoCommit = 0;
204 $FS::UID::callback_hack = 1;
205 $dbh = adminsuidsetup($user);
206 $FS::UID::callback_hack = 0;
207 unless ( $DRY_RUN || $opt_s ) {
208 my $dir = "%%%FREESIDE_CONF%%%/conf.". datasrc;
209 if (!scalar(qsearch('conf', {}))) {
210 my $error = FS::Conf::init_config($dir);
212 warn "CONFIGURATION UPGRADE FAILED\n";
213 $dbh->rollback or die $dbh->errstr;
218 $dbh->commit or die $dbh->errstr;
219 $dbh->disconnect or die $dbh->errstr;
221 $FS::UID::AutoCommit = 1;
223 $dbh = adminsuidsetup($user);
225 warn "Re-initialization with updated schema completed in ". (time-$start). " seconds\n"; # if $DEBUG;
229 unless $DRY_RUN || $opt_s;
231 $dbh->commit or die $dbh->errstr;
233 warn "Config updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
237 unless $DRY_RUN || $opt_s;
239 $dbh->commit or die $dbh->errstr;
241 warn "Table updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
245 unless $DRY_RUN || $opt_s || $opt_r;
247 warn "SQL RADIUS updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
250 $dbh->commit or die $dbh->errstr;
251 $dbh->disconnect or die $dbh->errstr;
253 warn "Final commit and disconnection completed in ". (time-$start). " seconds; upgrade done!\n"; # if $DEBUG;
257 sub dbdef_create { # reverse engineer the schema from the DB and save to file
258 my( $dbh, $file ) = @_;
259 my $dbdef = new_native DBIx::DBSchema $dbh;
264 die "Usage:\n freeside-upgrade [ -d ] [ -r ] [ -s ] [ -q | -v ] user\n";
269 freeside-upgrade - Upgrades database schema for new freeside verisons.
273 freeside-upgrade [ -d ] [ -r ] [ -s ] [ -q | -v ]
277 Reads your existing database schema and updates it to match the current schema,
278 adding any columns or tables necessary.
280 Also performs other upgrade functions:
284 =item Calls FS:: Misc::prune::prune_applications (probably unnecessary every upgrade, but simply won't find any records to change)
286 =item If necessary, moves your configuration information from the filesystem in /usr/local/etc/freeside/conf.<datasrc> to the database.
290 [ -d ]: Dry run; output SQL statements (to STDOUT) only, but do not execute
293 [ -q ]: Run quietly. This may become the default at some point.
295 [ -r ]: Skip sqlradius updates. Useful for occassions where the sqlradius
296 databases may be inaccessible.
298 [ -v ]: Run verbosely, sending debugging information to STDERR. This is the
301 [ -s ]: Schema changes only. Useful for Pg/slony slaves where the data
302 changes will be replicated from the Pg/slony master.