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;
13 use FS::Setup qw( enable_banned_pay_pad );
16 $FS::svc_domain::whois_hack = 1;
18 @ISA = qw( Exporter );
19 @EXPORT_OK = qw( upgrade_schema upgrade_config upgrade upgrade_sqlradius );
25 FS::Upgrade - Database upgrade routines
33 Currently this module simply provides a place to store common subroutines for
48 my $conf = new FS::Conf;
50 $conf->touch('payment_receipt')
51 if $conf->exists('payment_receipt_email')
52 || $conf->config('payment_receipt_msgnum');
54 $conf->touch('geocode-require_nw_coordinates')
55 if $conf->exists('svc_broadband-require-nw-coordinates');
57 unless ( $conf->config('echeck-country') ) {
58 if ( $conf->exists('cust_main-require-bank-branch') ) {
59 $conf->set('echeck-country', 'CA');
60 } elsif ( $conf->exists('echeck-nonus') ) {
61 $conf->set('echeck-country', 'XX');
63 $conf->set('echeck-country', 'US');
67 my @agents = qsearch('agent', {});
69 upgrade_overlimit_groups($conf);
70 map { upgrade_overlimit_groups($conf,$_->agentnum) } @agents;
72 upgrade_invoice_from($conf);
73 foreach my $agent (@agents) {
74 upgrade_invoice_from($conf,$agent->agentnum,1);
77 my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
78 $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
79 foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
80 qw( quotation_html quotation_latex quotation_latexnotes );
82 # change 'fslongtable' to 'longtable'
83 # in invoice and quotation main templates, and also in all secondary
86 qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
88 foreach my $c (@latex_confs) {
89 my $value = $c->value;
90 if (length($value) and $value =~ /fslongtable/) {
91 $value =~ s/fslongtable/longtable/g;
92 $conf->set($c->name, $value, $c->agentnum);
96 # if there's a USPS tools login, assume that's the standardization method
98 $conf->set('address_standardize_method', 'usps')
99 if $conf->exists('usps_webtools-userid')
100 && length($conf->config('usps_webtools-userid')) > 0
101 && ! $conf->exists('address_standardize_method');
103 # this option has been renamed/expanded
104 if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
105 $conf->touch('cust_main-enable_spouse');
106 $conf->delete('cust_main-enable_spouse_birthdate');
110 if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
111 $conf->touch('part_pkg-show_fcc_options');
112 $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
114 You have FCC Form 477 package options enabled.
116 Starting with the October 2014 filing date, the FCC has redesigned
117 Form 477 and introduced new service categories. See bin/convert-477-options
118 to update your package configuration for the new report.
120 If you need to continue using the old Form 477 report, turn on the
121 'old_fcc_report' configuration option.
125 # boolean invoice_sections_by_location option is now
126 # invoice_sections_method = 'location'
127 my @invoice_sections_confs =
128 qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
129 foreach my $c (@invoice_sections_confs) {
130 $c->name =~ /^(\w+)sections_by_location$/;
131 $conf->delete($c->name);
132 my $newname = $1.'sections_method';
133 $conf->set($newname, 'location');
136 # boolean enable_taxproducts is now tax_data_vendor = 'cch'
137 if ( $conf->exists('enable_taxproducts') ) {
139 $conf->delete('enable_taxproducts');
140 $conf->set('tax_data_vendor', 'cch');
144 # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
145 if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
146 $conf->set('tax-cust_exempt-groups-num_req', 'all');
147 $conf->delete('tax-cust_exempt-groups-require_individual_nums');
150 # boolean+text previous_balance-exclude_from_total is now two separate options
151 my $total_new_charges = $conf->config('previous_balance-exclude_from_total');
152 if (length($total_new_charges) > 0) {
153 $conf->set('previous_balance-text-total_new_charges', $total_new_charges);
154 $conf->set('previous_balance-exclude_from_total', '');
157 # switch from specifying an email address to boolean check
158 if ( $conf->exists('batch-errors_to') ) {
159 $conf->touch('batch-errors_not_fatal');
160 $conf->delete('batch-errors_to');
163 if ( $conf->exists('voip-cust_email_csv_cdr') ) {
164 $conf->set('voip_cdr_email_attach', 'csv');
165 $conf->delete('voip-cust_email_csv_cdr') ;
168 if ($conf->exists('unsuspendauto') && !$conf->config('unsuspend_balance')) {
169 $conf->set('unsuspend_balance','Zero');
170 $conf->delete('unsuspendauto');
173 if ($conf->config('cust-fields') =~ / \| Payment Type/) {
174 my $cust_fields = $conf->config('cust-fields');
175 # so we can potentially use 'Payment Types' or somesuch in the future
176 $cust_fields =~ s/ \| Payment Type( \|)/$1/;
177 $cust_fields =~ s/ \| Payment Type$//;
178 $conf->set('cust-fields',$cust_fields);
181 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
183 # if translate-auto-insert is enabled for a locale, ensure that invoice
184 # terms are in the msgcat (is there a better place for this?)
185 if (my $auto_locale = $conf->config('translate-auto-insert')) {
186 my $lh = FS::L10N->get_handle($auto_locale);
187 foreach (@FS::Conf::invoice_terms) {
188 $lh->maketext($_) if length($_);
193 sub upgrade_overlimit_groups {
195 my $agentnum = shift;
196 my @groups = $conf->config('overlimit_groups',$agentnum);
197 if(scalar(@groups)) {
198 my $groups = join(',',@groups);
201 if ( $groups !~ /^[\d,]+$/ ) {
202 foreach my $groupname ( @groups ) {
203 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
205 $g = new FS::radius_group {
206 'groupname' => $groupname,
207 'description' => $groupname,
210 die $error if $error;
212 push @groupnums, $g->groupnum;
214 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
219 sub upgrade_invoice_from {
220 my ($conf, $agentnum, $agentonly) = @_;
222 ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
223 && $conf->exists('invoice_from',$agentnum,$agentonly)
224 && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
227 $realemail =~ s/^\s*//; # remove leading spaces
228 $realemail =~ s/\s*$//; # remove trailing spaces
229 my $realname = $conf->config('invoice_from',$agentnum);
230 $realname =~ s/\<.*\>//; # remove email address
231 $realname =~ s/^\s*//; # remove leading spaces
232 $realname =~ s/\s*$//; # remove trailing spaces
233 # properly quote names that contain punctuation
234 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
235 $realname = '"' . $realname . '"';
237 $conf->set('invoice_from_name', $realname, $agentnum);
238 $conf->set('invoice_from', $realemail, $agentnum);
249 my $data = upgrade_data(%opt);
251 my $oldAutoCommit = $FS::UID::AutoCommit;
252 local $FS::UID::AutoCommit = 0;
253 local $FS::UID::AutoCommit = 0;
255 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
258 foreach my $table ( keys %$data ) {
260 my $class = "FS::$table";
264 if ( $class->can('_upgrade_data') ) {
265 warn "Upgrading $table...\n";
269 $class->_upgrade_data(%opt);
271 # New interface for async upgrades: a class can declare a
272 # "queueable_upgrade" method, which will run as part of the normal
273 # upgrade, but if the -j option is passed, will instead be run from
275 if ( $class->can('queueable_upgrade') ) {
276 my $jobname = $class . '::queueable_upgrade';
277 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
279 warn "$class upgrade already scheduled.\n";
281 if ( $opt{'queue'} ) {
282 warn "Scheduling $class upgrade.\n";
283 my $job = FS::queue->new({ job => $jobname });
284 $job->insert($class, %opt);
286 $class->queueable_upgrade(%opt);
291 if ( $oldAutoCommit ) {
292 warn " committing\n";
293 dbh->commit or die dbh->errstr;
296 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
297 warn " done in ". (time-$start). " seconds\n";
300 warn "WARNING: asked for upgrade of $table,".
301 " but FS::$table has no _upgrade_data method\n";
304 # my @records = @{ $data->{$table} };
306 # foreach my $record ( @records ) {
307 # my $args = delete($record->{'_upgrade_args'}) || [];
308 # my $object = $class->new( $record );
309 # my $error = $object->insert( @$args );
310 # die "error inserting record into $table: $error\n"
316 local($FS::cust_main::ignore_expired_card) = 1;
317 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
318 local($FS::cust_main::ignore_banned_card) = 1;
319 local($FS::cust_main::skip_fuzzyfiles) = 1;
321 local($FS::cust_payby::ignore_expired_card) = 1;
322 local($FS::cust_payby::ignore_banned_card) = 1;
324 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
325 # kind of a weird spot for this, but it's better than duplicating
326 # all this code in each class...
327 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
328 foreach my $table ( @decrypt_tables ) {
329 my @objects = qsearch({
332 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
333 " AND LENGTH(payinfo) > 100",
335 foreach my $object ( @objects ) {
336 my $payinfo = $object->decrypt($object->payinfo);
337 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
338 $object->payinfo($payinfo);
339 my $error = $object->replace;
340 die $error if $error;
353 tie my %hash, 'Tie::IxHash',
358 #payby conditions to new ones
359 'part_event_condition' => [],
361 #payby actions to new ones
364 #fix whitespace - before cust_main
365 'cust_location' => [],
367 #cust_main (remove paycvv from history, locations, cust_payby, etc)
370 #contact -> cust_contact / prospect_contact
376 #reason type and reasons
378 'cust_pkg_reason' => [],
380 #need part_pkg before cust_credit...
386 # reason / void_reason migration to reasonnum / void_reasonnum
387 'cust_credit_void' => [],
388 'cust_bill_void' => [],
389 # also fix some tax allocation records
390 'cust_bill_pkg_void' => [],
392 #duplicate history records
395 #populate cust_pay.otaker
398 #populate part_pkg_taxclass for starters
399 'part_pkg_taxclass' => [],
401 #remove bad pending records
402 'cust_pay_pending' => [],
404 #replace invnum and pkgnum with billpkgnum
405 'cust_bill_pkg_detail' => [],
407 #usage_classes if we have none
410 #phone_type if we have none
414 'access_right' => [],
416 #change recur_flat and enable_prorate
417 'part_pkg_option' => [],
419 #add weights to pkg_category
420 'pkg_category' => [],
426 'cust_attachment' => [],
427 #'cust_credit' => [],
429 'cust_main_note' => [],
431 'cust_pay_void' => [],
433 #'cust_pkg_reason' => [],
434 'cust_pkg_discount' => [],
442 'payment_gateway' => [],
444 #migrate to templates
445 'msg_template' => [],
447 #return unprovisioned numbers to availability
450 #insert scripcondition
451 'TicketSystem' => [],
453 #insert LATA data if not already present
456 #insert MSA data if not already present
459 # migrate to radius_group and groupnum instead of groupname
460 'radius_usergroup' => [],
464 #insert default tower_sector if not present
467 #repair improperly deleted services
471 'svc_broadband' => [],
473 #set up payment gateways if needed
476 #flag monthly tax exemptions
477 'cust_tax_exempt_pkg' => [],
479 #kick off tax location history upgrade
480 'cust_bill_pkg' => [],
482 #fix taxable line item links
483 'cust_bill_pkg_tax_location' => [],
485 #populate state FIPS codes if not already done
488 #set default locations on quoted packages
489 'quotation_pkg' => [],
491 #populate tax statuses
494 #mark certain taxes as system-maintained,
496 'cust_main_county' => [],
510 my $data = upgrade_schema_data(%opt);
512 my $oldAutoCommit = $FS::UID::AutoCommit;
513 local $FS::UID::AutoCommit = 0;
514 local $FS::UID::AutoCommit = 0;
516 foreach my $table ( keys %$data ) {
518 my $class = "FS::$table";
522 if ( $class->can('_upgrade_schema') ) {
523 warn "Upgrading $table schema...\n";
527 $class->_upgrade_schema(%opt);
529 if ( $oldAutoCommit ) {
530 warn " committing\n";
531 dbh->commit or die dbh->errstr;
534 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
535 warn " done in ". (time-$start). " seconds\n";
538 warn "WARNING: asked for schema upgrade of $table,".
539 " but FS::$table has no _upgrade_schema method\n";
546 =item upgrade_schema_data
550 sub upgrade_schema_data {
553 tie my %hash, 'Tie::IxHash',
555 #fix classnum character(1)
556 'cust_bill_pkg_detail' => [],
557 #add necessary columns to RT schema
558 'TicketSystem' => [],
559 #remove possible dangling records
560 'password_history' => [],
561 'cust_pay_pending' => [],
568 sub upgrade_sqlradius {
571 my $conf = new FS::Conf;
573 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
575 foreach my $part_export ( @part_export ) {
577 my $errmsg = 'Error adding FreesideStatus to '.
578 $part_export->option('datasrc'). ': ';
580 my $dbh = DBI->connect(
581 ( map $part_export->option($_), qw ( datasrc username password ) ),
582 { PrintError => 0, PrintWarn => 0 }
584 warn $errmsg.$DBI::errstr;
588 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
589 my $group = "UserName";
591 if ref($part_export) =~ /withdomain/
592 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
594 my $sth_alter = $dbh->prepare(
595 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
598 if ( $sth_alter->execute ) {
599 my $sth_update = $dbh->prepare(
600 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
601 ) or die $errmsg.$dbh->errstr;
602 $sth_update->execute or die $errmsg.$sth_update->errstr;
604 my $error = $sth_alter->errstr;
606 unless $error =~ /Duplicate column name/i #mysql
607 || $error =~ /already exists/i; #Pg
611 my $error = $dbh->errstr;
612 warn $errmsg.$error; #unless $error =~ /exists/i;
615 my $sth_index = $dbh->prepare(
616 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
619 unless ( $sth_index->execute ) {
620 my $error = $sth_index->errstr;
622 unless $error =~ /Duplicate key name/i #mysql
623 || $error =~ /already exists/i; #Pg
626 my $error = $dbh->errstr;
627 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
630 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
631 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
632 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
634 my $sth = $dbh->prepare("SELECT UserName,
636 $str2time max(AcctStartTime)),
637 $str2time max(AcctStopTime))
639 WHERE FreesideStatus = 'done'
643 or die $errmsg.$dbh->errstr;
644 $sth->execute() or die $errmsg.$sth->errstr;
646 while (my $row = $sth->fetchrow_arrayref ) {
647 my ($username, $realm, $start, $stop) = @$row;
649 $username = lc($username) unless $conf->exists('username-uppercase');
651 my $exportnum = $part_export->exportnum;
652 my $extra_sql = " AND exportnum = $exportnum ".
653 " AND exportsvcnum IS NOT NULL ";
655 if ( ref($part_export) =~ /withdomain/ ) {
656 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
657 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
660 my $svc_acct = qsearchs({
661 'select' => 'svc_acct.*',
662 'table' => 'svc_acct',
663 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
664 'LEFT JOIN export_svc USING ( svcpart )',
665 'hashref' => { 'username' => $username },
666 'extra_sql' => $extra_sql,
670 $svc_acct->last_login($start)
671 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
672 $svc_acct->last_logout($stop)
673 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);