4 use vars qw( @ISA @EXPORT_OK $DEBUG );
8 use FS::UID qw( dbh driver_name );
10 use FS::Record qw(qsearchs qsearch str2time_sql);
12 use FS::upgrade_journal;
15 $FS::svc_domain::whois_hack = 1;
17 @ISA = qw( Exporter );
18 @EXPORT_OK = qw( upgrade_schema upgrade_config upgrade upgrade_sqlradius );
24 FS::Upgrade - Database upgrade routines
32 Currently this module simply provides a place to store common subroutines for
47 my $conf = new FS::Conf;
49 $conf->touch('payment_receipt')
50 if $conf->exists('payment_receipt_email')
51 || $conf->config('payment_receipt_msgnum');
53 $conf->touch('geocode-require_nw_coordinates')
54 if $conf->exists('svc_broadband-require-nw-coordinates');
56 unless ( $conf->config('echeck-country') ) {
57 if ( $conf->exists('cust_main-require-bank-branch') ) {
58 $conf->set('echeck-country', 'CA');
59 } elsif ( $conf->exists('echeck-nonus') ) {
60 $conf->set('echeck-country', 'XX');
62 $conf->set('echeck-country', 'US');
66 upgrade_overlimit_groups($conf);
67 map { upgrade_overlimit_groups($conf,$_->agentnum) } qsearch('agent', {});
69 my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
70 $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
71 foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
72 qw( quotation_html quotation_latex quotation_latexnotes );
74 # change 'fslongtable' to 'longtable'
75 # in invoice and quotation main templates, and also in all secondary
78 qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
80 foreach my $c (@latex_confs) {
81 my $value = $c->value;
82 if (length($value) and $value =~ /fslongtable/) {
83 $value =~ s/fslongtable/longtable/g;
84 $conf->set($c->name, $value, $c->agentnum);
88 # if there's a USPS tools login, assume that's the standardization method
90 $conf->set('address_standardize_method', 'usps')
91 if $conf->exists('usps_webtools-userid')
92 && length($conf->config('usps_webtools-userid')) > 0
93 && ! $conf->exists('address_standardize_method');
95 # this option has been renamed/expanded
96 if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
97 $conf->touch('cust_main-enable_spouse');
98 $conf->delete('cust_main-enable_spouse_birthdate');
102 if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
103 $conf->touch('part_pkg-show_fcc_options');
104 $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
106 You have FCC Form 477 package options enabled.
108 Starting with the October 2014 filing date, the FCC has redesigned
109 Form 477 and introduced new service categories. See bin/convert-477-options
110 to update your package configuration for the new report.
112 If you need to continue using the old Form 477 report, turn on the
113 'old_fcc_report' configuration option.
117 # boolean invoice_sections_by_location option is now
118 # invoice_sections_method = 'location'
119 my @invoice_sections_confs =
120 qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
121 foreach my $c (@invoice_sections_confs) {
122 $c->name =~ /^(\w+)sections_by_location$/;
123 $conf->delete($c->name);
124 my $newname = $1.'sections_method';
125 $conf->set($newname, 'location');
128 # boolean enable_taxproducts is now enable_taxproducts = 'cch'
129 if ( $conf->exists('enable_taxproducts') and
130 $conf->config('enable_taxproducts') eq '' ) {
132 $conf->set('enable_taxproducts', 'cch');
136 # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
137 if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
138 $conf->set('tax-cust_exempt-groups-num_req', 'all');
139 $conf->delete('tax-cust_exempt-groups-require_individual_nums');
144 sub upgrade_overlimit_groups {
146 my $agentnum = shift;
147 my @groups = $conf->config('overlimit_groups',$agentnum);
148 if(scalar(@groups)) {
149 my $groups = join(',',@groups);
152 if ( $groups !~ /^[\d,]+$/ ) {
153 foreach my $groupname ( @groups ) {
154 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
156 $g = new FS::radius_group {
157 'groupname' => $groupname,
158 'description' => $groupname,
161 die $error if $error;
163 push @groupnums, $g->groupnum;
165 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
177 my $data = upgrade_data(%opt);
179 my $oldAutoCommit = $FS::UID::AutoCommit;
180 local $FS::UID::AutoCommit = 0;
181 local $FS::UID::AutoCommit = 0;
183 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
186 foreach my $table ( keys %$data ) {
188 my $class = "FS::$table";
192 if ( $class->can('_upgrade_data') ) {
193 warn "Upgrading $table...\n";
197 $class->_upgrade_data(%opt);
199 # New interface for async upgrades: a class can declare a
200 # "queueable_upgrade" method, which will run as part of the normal
201 # upgrade, but if the -j option is passed, will instead be run from
203 if ( $class->can('queueable_upgrade') ) {
204 my $jobname = $class . '::queueable_upgrade';
205 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
207 warn "$class upgrade already scheduled.\n";
209 if ( $opt{'queue'} ) {
210 warn "Scheduling $class upgrade.\n";
211 my $job = FS::queue->new({ job => $jobname });
212 $job->insert($class, %opt);
214 $class->queueable_upgrade(%opt);
219 if ( $oldAutoCommit ) {
220 warn " committing\n";
221 dbh->commit or die dbh->errstr;
224 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
225 warn " done in ". (time-$start). " seconds\n";
228 warn "WARNING: asked for upgrade of $table,".
229 " but FS::$table has no _upgrade_data method\n";
232 # my @records = @{ $data->{$table} };
234 # foreach my $record ( @records ) {
235 # my $args = delete($record->{'_upgrade_args'}) || [];
236 # my $object = $class->new( $record );
237 # my $error = $object->insert( @$args );
238 # die "error inserting record into $table: $error\n"
244 local($FS::cust_main::ignore_expired_card) = 1;
245 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
246 local($FS::cust_main::ignore_banned_card) = 1;
247 local($FS::cust_main::skip_fuzzyfiles) = 1;
249 local($FS::cust_payby::ignore_expired_card) = 1;
250 local($FS::cust_payby::ignore_banned_card) = 1;
252 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
253 # kind of a weird spot for this, but it's better than duplicating
254 # all this code in each class...
255 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
256 foreach my $table ( @decrypt_tables ) {
257 my @objects = qsearch({
260 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
261 " AND LENGTH(payinfo) > 100",
263 foreach my $object ( @objects ) {
264 my $payinfo = $object->decrypt($object->payinfo);
265 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
266 $object->payinfo($payinfo);
267 my $error = $object->replace;
268 die $error if $error;
281 tie my %hash, 'Tie::IxHash',
283 #cust_main (remove paycvv from history)
289 #reason type and reasons
291 'cust_pkg_reason' => [],
293 #need part_pkg before cust_credit...
299 #duplicate history records
302 #populate cust_pay.otaker
305 #populate part_pkg_taxclass for starters
306 'part_pkg_taxclass' => [],
308 #remove bad pending records
309 'cust_pay_pending' => [],
311 #replace invnum and pkgnum with billpkgnum
312 'cust_bill_pkg_detail' => [],
314 #usage_classes if we have none
317 #phone_type if we have none
321 'access_right' => [],
323 #change recur_flat and enable_prorate
324 'part_pkg_option' => [],
326 #add weights to pkg_category
327 'pkg_category' => [],
333 'cust_attachment' => [],
334 #'cust_credit' => [],
336 'cust_main_note' => [],
338 'cust_pay_void' => [],
340 #'cust_pkg_reason' => [],
341 'cust_pkg_discount' => [],
346 'payment_gateway' => [],
348 #migrate to templates
349 'msg_template' => [],
351 #return unprovisioned numbers to availability
354 #insert scripcondition
355 'TicketSystem' => [],
357 #insert LATA data if not already present
360 #insert MSA data if not already present
363 # migrate to radius_group and groupnum instead of groupname
364 'radius_usergroup' => [],
368 #insert default tower_sector if not present
371 #repair improperly deleted services
375 'svc_broadband' => [],
377 #set up payment gateways if needed
380 #flag monthly tax exemptions
381 'cust_tax_exempt_pkg' => [],
383 #kick off tax location history upgrade
384 'cust_bill_pkg' => [],
386 #fix taxable line item links
387 'cust_bill_pkg_tax_location' => [],
389 #populate state FIPS codes if not already done
392 #populate tax statuses
407 my $data = upgrade_schema_data(%opt);
409 my $oldAutoCommit = $FS::UID::AutoCommit;
410 local $FS::UID::AutoCommit = 0;
411 local $FS::UID::AutoCommit = 0;
413 foreach my $table ( keys %$data ) {
415 my $class = "FS::$table";
419 if ( $class->can('_upgrade_schema') ) {
420 warn "Upgrading $table schema...\n";
424 $class->_upgrade_schema(%opt);
426 if ( $oldAutoCommit ) {
427 warn " committing\n";
428 dbh->commit or die dbh->errstr;
431 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
432 warn " done in ". (time-$start). " seconds\n";
435 warn "WARNING: asked for schema upgrade of $table,".
436 " but FS::$table has no _upgrade_schema method\n";
443 =item upgrade_schema_data
447 sub upgrade_schema_data {
450 tie my %hash, 'Tie::IxHash',
452 #fix classnum character(1)
453 'cust_bill_pkg_detail' => [],
454 #add necessary columns to RT schema
455 'TicketSystem' => [],
463 sub upgrade_sqlradius {
466 my $conf = new FS::Conf;
468 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
470 foreach my $part_export ( @part_export ) {
472 my $errmsg = 'Error adding FreesideStatus to '.
473 $part_export->option('datasrc'). ': ';
475 my $dbh = DBI->connect(
476 ( map $part_export->option($_), qw ( datasrc username password ) ),
477 { PrintError => 0, PrintWarn => 0 }
479 warn $errmsg.$DBI::errstr;
483 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
484 my $group = "UserName";
486 if ref($part_export) =~ /withdomain/
487 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
489 my $sth_alter = $dbh->prepare(
490 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
493 if ( $sth_alter->execute ) {
494 my $sth_update = $dbh->prepare(
495 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
496 ) or die $errmsg.$dbh->errstr;
497 $sth_update->execute or die $errmsg.$sth_update->errstr;
499 my $error = $sth_alter->errstr;
501 unless $error =~ /Duplicate column name/i #mysql
502 || $error =~ /already exists/i; #Pg
506 my $error = $dbh->errstr;
507 warn $errmsg.$error; #unless $error =~ /exists/i;
510 my $sth_index = $dbh->prepare(
511 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
514 unless ( $sth_index->execute ) {
515 my $error = $sth_index->errstr;
517 unless $error =~ /Duplicate key name/i #mysql
518 || $error =~ /already exists/i; #Pg
521 my $error = $dbh->errstr;
522 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
525 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
526 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
527 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
529 my $sth = $dbh->prepare("SELECT UserName,
531 $str2time max(AcctStartTime)),
532 $str2time max(AcctStopTime))
534 WHERE FreesideStatus = 'done'
538 or die $errmsg.$dbh->errstr;
539 $sth->execute() or die $errmsg.$sth->errstr;
541 while (my $row = $sth->fetchrow_arrayref ) {
542 my ($username, $realm, $start, $stop) = @$row;
544 $username = lc($username) unless $conf->exists('username-uppercase');
546 my $exportnum = $part_export->exportnum;
547 my $extra_sql = " AND exportnum = $exportnum ".
548 " AND exportsvcnum IS NOT NULL ";
550 if ( ref($part_export) =~ /withdomain/ ) {
551 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
552 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
555 my $svc_acct = qsearchs({
556 'select' => 'svc_acct.*',
557 'table' => 'svc_acct',
558 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
559 'LEFT JOIN export_svc USING ( svcpart )',
560 'hashref' => { 'username' => $username },
561 'extra_sql' => $extra_sql,
565 $svc_acct->last_login($start)
566 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
567 $svc_acct->last_logout($stop)
568 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);