4 use vars qw( $opt_d $opt_s $opt_q $opt_v $opt_r $opt_c );
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);
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';
87 if ( dbdef->table('upgrade_journal') ) {
88 push @bugfix, "SELECT SETVAL( 'upgrade_journal_upgradenum_seq',
89 ( SELECT MAX(upgradenum) FROM upgrade_journal )
96 join(";\n", @bugfix ). ";\n";
99 foreach my $statement ( @bugfix ) {
101 $dbh->do( $statement )
102 or die "Error: ". $dbh->errstr. "\n executing: $statement";
107 dbdef_create($dbh, $dbdef_file);
108 delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
109 reload_dbdef($dbdef_file);
113 #you should have run fs-migrate-part_svc ages ago, when you upgraded
114 #from 1.3 to 1.4... if not, it needs to be hooked into -upgrade here or
115 #you'll lose all the part_svc settings it migrates to part_svc_column
117 my $conf = new FS::Conf;
119 my $dbdef_dist = dbdef_dist(
121 { 'queue-no_history' => $conf->exists('queue-no_history') },
124 my @statements = dbdef->sql_update_schema( $dbdef_dist,
126 { 'nullify_default' => 1, },
129 #### NEW CUSTOM FIELDS:
130 # 1. prevent new custom field columns from being dropped by upgrade
131 # 2. migrate old virtual fields to real fields (new custom fields)
133 my $cfsth = $dbh->prepare("SELECT * FROM part_virtual_field")
135 $cfsth->execute or die $cfsth->errstr;
137 while ( $cf = $cfsth->fetchrow_hashref ) {
138 my $tbl = $cf->{'dbtable'};
139 my $name = $cf->{'name'};
140 $name = lc($name) unless driver_name =~ /^mysql/i;
142 @statements = grep { $_ !~ /^\s*ALTER\s+TABLE\s+(h_|)$tbl\s+DROP\s+COLUMN\s+cf_$name\s*$/i }
145 "ALTER TABLE $tbl ADD COLUMN cf_$name varchar(".$cf->{'length'}.")"
146 unless (dbdef->table($tbl) && dbdef->table($tbl)->column("cf_$name"));
148 "ALTER TABLE h_$tbl ADD COLUMN cf_$name varchar(".$cf->{'length'}.")"
149 unless (dbdef->table("h_$tbl") && dbdef->table("h_$tbl")->column("cf_$name"));
151 warn "Custom fields schema upgrade completed";
154 grep { $_ !~ /^CREATE +INDEX +h_queue/i } #useless, holds up queue insertion
157 unless ( driver_name =~ /^mysql/i ) {
158 #not necessary under non-mysql, takes forever on big db
160 grep { $_ !~ /^ *ALTER +TABLE +h_queue +ALTER +COLUMN +job +TYPE +varchar\(512\) *$/i }
167 grep { $_ !~ /^ *ALTER +TABLE +(h_)?cdr /i }
171 grep { $_ !~ /^ *CREATE +INDEX +(h_)?cdr\d+ /i }
178 join(";\n", @statements ). ";\n";
181 foreach my $statement ( @statements ) {
183 $dbh->do( $statement )
184 or die "Error: ". $dbh->errstr. "\n executing: $statement";
187 # warn "Pre-schema change upgrades completed in ". (time-$start). " seconds\n"; # if $DEBUG;
190 # dbdef->update_schema( dbdef_dist(datasrc), $dbh );
193 warn "Schema upgrade completed in ". (time-$start). " seconds\n"; # if $DEBUG;
197 $hashref->{dry_run} = 1 if $DRY_RUN;
198 $hashref->{debug} = 1 if $DEBUG && $DRY_RUN;
199 prune_applications($hashref) unless $opt_s;
201 warn "Application pruning completed in ". (time-$start). " seconds\n"; # if $DEBUG;
204 print "\n" if $DRY_RUN;
206 if ( $dbh->{Driver}->{Name} =~ /^mysql/i && ! $opt_s ) {
208 foreach my $table (qw( svc_acct svc_phone )) {
210 my $sth = $dbh->prepare(
211 "SELECT COUNT(*) FROM duplicate_lock WHERE lockname = '$table'"
212 ) or die $dbh->errstr;
214 $sth->execute or die $sth->errstr;
216 unless ( $sth->fetchrow_arrayref->[0] ) {
218 $sth = $dbh->prepare(
219 "INSERT INTO duplicate_lock ( lockname ) VALUES ( '$table' )"
220 ) or die $dbh->errstr;
222 $sth->execute or die $sth->errstr;
228 warn "Duplication lock creation completed in ". (time-$start). " seconds\n"; # if $DEBUG;
233 $dbh->commit or die $dbh->errstr;
235 dbdef_create($dbh, $dbdef_file);
237 $dbh->disconnect or die $dbh->errstr;
239 delete $FS::Schema::dbdef_cache{$dbdef_file}; #force an actual reload
240 $FS::UID::AutoCommit = 0;
241 $FS::UID::callback_hack = 1;
242 $dbh = adminsuidsetup($user);
243 $FS::UID::callback_hack = 0;
244 unless ( $DRY_RUN || $opt_s ) {
245 my $dir = "%%%FREESIDE_CONF%%%/conf.". datasrc;
246 if (!scalar(qsearch('conf', {}))) {
247 my $error = FS::Conf::init_config($dir);
249 warn "CONFIGURATION UPGRADE FAILED\n";
250 $dbh->rollback or die $dbh->errstr;
255 $dbh->commit or die $dbh->errstr;
256 $dbh->disconnect or die $dbh->errstr;
258 $FS::UID::AutoCommit = 1;
260 $dbh = adminsuidsetup($user);
262 warn "Re-initialization with updated schema completed in ". (time-$start). " seconds\n"; # if $DEBUG;
265 #### NEW CUSTOM FIELDS:
266 # 3. migrate old virtual field data to the new custom fields
268 $cfsth = $dbh->prepare("SELECT * FROM virtual_field left join part_virtual_field using (vfieldpart)")
270 $cfsth->execute or die $cfsth->errstr;
272 while ( $cf = $cfsth->fetchrow_hashref ) {
273 my $tbl = $cf->{'dbtable'};
274 my $name = $cf->{'name'};
275 my $dtable = dbdef->table($tbl);
276 next unless $dtable && $dtable->primary_key; # XXX: warn first?
277 my $pkey = $dtable->primary_key;
278 next unless $dtable->column($pkey)->type =~ /int/i; # XXX: warn first?
279 push @cfst, "UPDATE $tbl set cf_$name = '".$cf->{'value'}."' WHERE $pkey = ".$cf->{'recnum'};
280 push @cfst, "DELETE FROM virtual_field WHERE vfieldnum = ".$cf->{'vfieldnum'};
282 foreach my $cfst ( @cfst ) {
285 or die "Error: ". $dbh->errstr. "\n executing: $cfst";
287 warn "Custom fields data upgrade completed";
290 unless $DRY_RUN || $opt_s;
292 $dbh->commit or die $dbh->errstr;
294 warn "Config updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
298 unless $DRY_RUN || $opt_s;
300 $dbh->commit or die $dbh->errstr;
302 warn "Table updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
306 unless $DRY_RUN || $opt_s || $opt_r;
308 warn "SQL RADIUS updates completed in ". (time-$start). " seconds\n"; # if $DEBUG;
311 $dbh->commit or die $dbh->errstr;
312 $dbh->disconnect or die $dbh->errstr;
314 warn "Final commit and disconnection completed in ". (time-$start). " seconds; upgrade done!\n"; # if $DEBUG;
318 sub dbdef_create { # reverse engineer the schema from the DB and save to file
319 my( $dbh, $file ) = @_;
320 my $dbdef = new_native DBIx::DBSchema $dbh;
325 die "Usage:\n freeside-upgrade [ -d ] [ -r ] [ -s ] [ -q | -v ] user\n";
330 freeside-upgrade - Upgrades database schema for new freeside verisons.
334 freeside-upgrade [ -d ] [ -r ] [ -c ] [ -s ] [ -q | -v ]
338 Reads your existing database schema and updates it to match the current schema,
339 adding any columns or tables necessary.
341 Also performs other upgrade functions:
345 =item Calls FS:: Misc::prune::prune_applications (probably unnecessary every upgrade, but simply won't find any records to change)
347 =item If necessary, moves your configuration information from the filesystem in /usr/local/etc/freeside/conf.<datasrc> to the database.
351 [ -d ]: Dry run; output SQL statements (to STDOUT) only, but do not execute
354 [ -q ]: Run quietly. This may become the default at some point.
356 [ -r ]: Skip sqlradius updates. Useful for occassions where the sqlradius
357 databases may be inaccessible.
359 [ -c ]: Skip cdr and h_cdr updates.
361 [ -v ]: Run verbosely, sending debugging information to STDERR. This is the
364 [ -s ]: Schema changes only. Useful for Pg/slony slaves where the data
365 changes will be replicated from the Pg/slony master.