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 );
17 $FS::svc_domain::whois_hack = 1;
19 @ISA = qw( Exporter );
20 @EXPORT_OK = qw( upgrade_schema upgrade_config upgrade upgrade_sqlradius );
26 FS::Upgrade - Database upgrade routines
34 Currently this module simply provides a place to store common subroutines for
49 my $conf = new FS::Conf;
51 # to simplify tokenization upgrades
52 die "Conf selfservice-payment_gateway no longer supported"
53 if $conf->config('selfservice-payment_gateway');
55 $conf->touch('payment_receipt')
56 if $conf->exists('payment_receipt_email')
57 || $conf->config('payment_receipt_msgnum');
59 $conf->touch('geocode-require_nw_coordinates')
60 if $conf->exists('svc_broadband-require-nw-coordinates');
62 unless ( $conf->config('echeck-country') ) {
63 if ( $conf->exists('cust_main-require-bank-branch') ) {
64 $conf->set('echeck-country', 'CA');
65 } elsif ( $conf->exists('echeck-nonus') ) {
66 $conf->set('echeck-country', 'XX');
68 $conf->set('echeck-country', 'US');
72 my @agents = qsearch('agent', {});
74 upgrade_overlimit_groups($conf);
75 map { upgrade_overlimit_groups($conf,$_->agentnum) } @agents;
77 upgrade_invoice_from($conf);
78 foreach my $agent (@agents) {
79 upgrade_invoice_from($conf,$agent->agentnum,1);
82 my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
83 $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
84 foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
85 qw( quotation_html quotation_latex quotation_latexnotes );
87 # change 'fslongtable' to 'longtable'
88 # in invoice and quotation main templates, and also in all secondary
91 qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
93 foreach my $c (@latex_confs) {
94 my $value = $c->value;
95 if (length($value) and $value =~ /fslongtable/) {
96 $value =~ s/fslongtable/longtable/g;
97 $conf->set($c->name, $value, $c->agentnum);
101 # if there's a USPS tools login, assume that's the standardization method
103 $conf->set('address_standardize_method', 'usps')
104 if $conf->exists('usps_webtools-userid')
105 && length($conf->config('usps_webtools-userid')) > 0
106 && ! $conf->exists('address_standardize_method');
108 # this option has been renamed/expanded
109 if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
110 $conf->touch('cust_main-enable_spouse');
111 $conf->delete('cust_main-enable_spouse_birthdate');
115 if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
116 $conf->touch('part_pkg-show_fcc_options');
117 $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
119 You have FCC Form 477 package options enabled.
121 Starting with the October 2014 filing date, the FCC has redesigned
122 Form 477 and introduced new service categories. See bin/convert-477-options
123 to update your package configuration for the new report.
125 If you need to continue using the old Form 477 report, turn on the
126 'old_fcc_report' configuration option.
130 # boolean invoice_sections_by_location option is now
131 # invoice_sections_method = 'location'
132 my @invoice_sections_confs =
133 qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
134 foreach my $c (@invoice_sections_confs) {
135 $c->name =~ /^(\w+)sections_by_location$/;
136 $conf->delete($c->name);
137 my $newname = $1.'sections_method';
138 $conf->set($newname, 'location');
141 # boolean enable_taxproducts is now tax_data_vendor = 'cch'
142 if ( $conf->exists('enable_taxproducts') ) {
144 $conf->delete('enable_taxproducts');
145 $conf->set('tax_data_vendor', 'cch');
149 # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
150 if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
151 $conf->set('tax-cust_exempt-groups-num_req', 'all');
152 $conf->delete('tax-cust_exempt-groups-require_individual_nums');
155 # boolean+text previous_balance-exclude_from_total is now two separate options
156 my $total_new_charges = $conf->config('previous_balance-exclude_from_total');
157 if ( defined $total_new_charges && length($total_new_charges) > 0 ) {
158 $conf->set('previous_balance-text-total_new_charges', $total_new_charges);
159 $conf->set('previous_balance-exclude_from_total', '');
162 # switch from specifying an email address to boolean check
163 if ( $conf->exists('batch-errors_to') ) {
164 $conf->touch('batch-errors_not_fatal');
165 $conf->delete('batch-errors_to');
168 if ( $conf->exists('voip-cust_email_csv_cdr') ) {
169 $conf->set('voip_cdr_email_attach', 'csv');
170 $conf->delete('voip-cust_email_csv_cdr') ;
173 if ($conf->exists('unsuspendauto') && !$conf->config('unsuspend_balance')) {
174 $conf->set('unsuspend_balance','Zero');
175 $conf->delete('unsuspendauto');
178 my $cust_fields = $conf->config('cust-fields');
179 if ( defined $cust_fields && $cust_fields =~ / \| Payment Type/ ) {
180 # so we can potentially use 'Payment Types' or somesuch in the future
181 $cust_fields =~ s/ \| Payment Type( \|)/$1/;
182 $cust_fields =~ s/ \| Payment Type$//;
183 $conf->set('cust-fields',$cust_fields);
186 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
188 # if translate-auto-insert is enabled for a locale, ensure that invoice
189 # terms are in the msgcat (is there a better place for this?)
190 if (my $auto_locale = $conf->config('translate-auto-insert')) {
191 my $lh = FS::L10N->get_handle($auto_locale);
192 foreach (@FS::Conf::invoice_terms) {
193 $lh->maketext($_) if length($_);
197 unless ( FS::upgrade_journal->is_done('deprecate_unmask_ss') ) {
198 if ( $conf->config_bool( 'unmask_ss' )) {
199 warn "'unmask_ssn' deprecated from global configuration\n";
200 for my $access_group ( qsearch( access_group => {} )) {
201 $access_group->grant_access_right( 'Unmask customer SSN' );
202 warn " - 'Unmask customer SSN' access right granted to '" .
203 $access_group->groupname . "' employee group\n";
206 FS::upgrade_journal->set_done('deprecate_unmask_ss');
209 # Rename agent-disable_counts as config-disable_counts, flag now
210 # affects several configuration pages
211 for my $row ( qsearch( conf => { name => 'agent-disable_counts' } )) {
212 $row->name('config-disable_counts');
218 sub upgrade_overlimit_groups {
220 my $agentnum = shift;
221 my @groups = $conf->config('overlimit_groups',$agentnum);
222 if(scalar(@groups)) {
223 my $groups = join(',',@groups);
226 if ( $groups !~ /^[\d,]+$/ ) {
227 foreach my $groupname ( @groups ) {
228 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
230 $g = new FS::radius_group {
231 'groupname' => $groupname,
232 'description' => $groupname,
235 die $error if $error;
237 push @groupnums, $g->groupnum;
239 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
244 sub upgrade_invoice_from {
245 my ($conf, $agentnum, $agentonly) = @_;
247 ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
248 && $conf->exists('invoice_from',$agentnum,$agentonly)
249 && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
252 $realemail =~ s/^\s*//; # remove leading spaces
253 $realemail =~ s/\s*$//; # remove trailing spaces
254 my $realname = $conf->config('invoice_from',$agentnum);
255 $realname =~ s/\<.*\>//; # remove email address
256 $realname =~ s/^\s*//; # remove leading spaces
257 $realname =~ s/\s*$//; # remove trailing spaces
258 # properly quote names that contain punctuation
259 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
260 $realname = '"' . $realname . '"';
262 $conf->set('invoice_from_name', $realname, $agentnum);
263 $conf->set('invoice_from', $realemail, $agentnum);
274 my $data = upgrade_data(%opt);
276 my $oldAutoCommit = $FS::UID::AutoCommit;
277 local $FS::UID::AutoCommit = 0;
278 local $FS::UID::AutoCommit = 0;
280 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
283 foreach my $table ( keys %$data ) {
285 my $class = "FS::$table";
289 if ( $class->can('_upgrade_data') ) {
290 warn "Upgrading $table...\n";
294 $class->_upgrade_data(%opt);
296 # New interface for async upgrades: a class can declare a
297 # "queueable_upgrade" method, which will run as part of the normal
298 # upgrade, but if the -j option is passed, will instead be run from
300 if ( $class->can('queueable_upgrade') ) {
301 my $jobname = $class . '::queueable_upgrade';
302 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
304 warn "$class upgrade already scheduled.\n";
306 if ( $opt{'queue'} ) {
307 warn "Scheduling $class upgrade.\n";
308 my $job = FS::queue->new({ job => $jobname });
309 $job->insert($class, %opt);
311 $class->queueable_upgrade(%opt);
316 if ( $oldAutoCommit ) {
317 warn " committing\n";
318 dbh->commit or die dbh->errstr;
321 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
322 warn " done in ". (time-$start). " seconds\n";
325 warn "WARNING: asked for upgrade of $table,".
326 " but FS::$table has no _upgrade_data method\n";
329 # my @records = @{ $data->{$table} };
331 # foreach my $record ( @records ) {
332 # my $args = delete($record->{'_upgrade_args'}) || [];
333 # my $object = $class->new( $record );
334 # my $error = $object->insert( @$args );
335 # die "error inserting record into $table: $error\n"
341 local($FS::cust_main::ignore_expired_card) = 1;
342 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
343 local($FS::cust_main::ignore_banned_card) = 1;
344 local($FS::cust_main::skip_fuzzyfiles) = 1;
346 local($FS::cust_payby::ignore_expired_card) = 1;
347 local($FS::cust_payby::ignore_banned_card) = 1;
349 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
350 # kind of a weird spot for this, but it's better than duplicating
351 # all this code in each class...
352 my @decrypt_tables = qw( cust_payby cust_pay_void cust_pay cust_refund cust_pay_pending );
353 foreach my $table ( @decrypt_tables ) {
354 my @objects = qsearch({
357 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
358 " AND LENGTH(payinfo) > 100",
360 foreach my $object ( @objects ) {
361 my $payinfo = $object->decrypt($object->payinfo);
362 if ( $payinfo eq $object->payinfo ) {
363 warn "error decrypting payinfo for $table: $payinfo\n";
366 $object->payinfo($payinfo);
367 my $error = $object->replace;
368 die $error if $error;
381 tie my %hash, 'Tie::IxHash',
386 #fix whitespace - before cust_main
387 'cust_location' => [],
389 # need before cust_main tokenization upgrade,
390 # blocks tokenization upgrade if deprecated features still in use
391 'agent_payment_gateway' => [],
393 #remove bad source_paynum before cust_main
396 #cust_main (tokenizes cards, remove paycvv from history, locations, cust_payby, etc)
397 # (handles payinfo encryption/tokenization across all relevant tables)
400 #contact -> cust_contact / prospect_contact
406 #reason type and reasons
408 'cust_pkg_reason' => [],
410 #need part_pkg before cust_credit...
416 # reason / void_reason migration to reasonnum / void_reasonnum
417 'cust_credit_void' => [],
418 'cust_bill_void' => [],
419 # also fix some tax allocation records
420 'cust_bill_pkg_void' => [],
422 #duplicate history records
425 #populate cust_pay.otaker
428 #populate part_pkg_taxclass for starters
429 'part_pkg_taxclass' => [],
431 #remove bad pending records
432 'cust_pay_pending' => [],
434 #replace invnum and pkgnum with billpkgnum
435 'cust_bill_pkg_detail' => [],
437 #usage_classes if we have none
440 #phone_type if we have none
444 'access_right' => [],
446 #change recur_flat and enable_prorate
447 'part_pkg_option' => [],
449 #add weights to pkg_category
450 'pkg_category' => [],
456 'cust_attachment' => [],
457 #'cust_credit' => [],
459 'cust_main_note' => [],
461 'cust_pay_void' => [],
463 #'cust_pkg_reason' => [],
464 'cust_pkg_discount' => [],
465 #'cust_refund' => [],
472 'payment_gateway' => [],
474 #migrate to templates
475 'msg_template' => [],
477 #return unprovisioned numbers to availability
480 #insert scripcondition
481 'TicketSystem' => [],
483 #insert LATA data if not already present
486 #insert MSA data if not already present
489 # migrate to radius_group and groupnum instead of groupname
490 'radius_usergroup' => [],
494 #insert default tower_sector if not present
497 #repair improperly deleted services
501 'svc_broadband' => [],
503 #set up payment gateways if needed
506 #flag monthly tax exemptions
507 'cust_tax_exempt_pkg' => [],
509 #kick off tax location history upgrade
510 'cust_bill_pkg' => [],
512 #fix taxable line item links
513 'cust_bill_pkg_tax_location' => [],
515 #populate state FIPS codes if not already done
518 #set default locations on quoted packages
519 'quotation_pkg' => [],
521 #populate tax statuses
524 #mark certain taxes as system-maintained,
526 'cust_main_county' => [],
528 #'compliance solutions' -> 'compliance_solutions'
530 'tax_rate_location' => [],
532 #upgrade part_event_condition_option agentnum to a multiple hash value
533 'part_event_condition_option' =>[],
539 'svc_hardware' => [],
545 'tower_sector' => [],
561 my $data = upgrade_schema_data(%opt);
563 my $oldAutoCommit = $FS::UID::AutoCommit;
564 local $FS::UID::AutoCommit = 0;
565 local $FS::UID::AutoCommit = 0;
567 foreach my $table ( keys %$data ) {
569 my $class = "FS::$table";
573 if ( $class->can('_upgrade_schema') ) {
574 warn "Upgrading $table schema...\n";
578 $class->_upgrade_schema(%opt);
580 if ( $oldAutoCommit ) {
581 warn " committing\n";
582 dbh->commit or die dbh->errstr;
585 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
586 warn " done in ". (time-$start). " seconds\n";
589 warn "WARNING: asked for schema upgrade of $table,".
590 " but FS::$table has no _upgrade_schema method\n";
597 =item upgrade_schema_data
601 sub upgrade_schema_data {
604 #auto-find tables/classes with an _update_schema method?
606 tie my %hash, 'Tie::IxHash',
608 #fix classnum character(1)
609 'cust_bill_pkg_detail' => [],
610 #add necessary columns to RT schema
611 'TicketSystem' => [],
612 #remove h_access_user_log if it exists (since our regular auto schema
613 # upgrade doesn't have the drop tables flag turned on)
614 'access_user_log' => [],
615 #remove possible dangling records
616 'password_history' => [],
617 'cust_pay_pending' => [],
618 #remove records referencing removed things with their FKs
619 'pkg_referral' => [],
620 'cust_bill_pkg_discount' => [],
622 'cust_bill_pay_batch' => [],
623 'cust_event_fee' => [],
625 'queue_depend' => [],
626 'cust_main_invoice' => [],
627 #update records referencing removed things with their FKs
635 sub upgrade_sqlradius {
638 my $conf = new FS::Conf;
640 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
642 foreach my $part_export ( @part_export ) {
644 my $errmsg = 'Error adding FreesideStatus to '.
645 $part_export->option('datasrc'). ': ';
647 my $dbh = FS::DBI->connect(
648 ( map $part_export->option($_), qw ( datasrc username password ) ),
649 { PrintError => 0, PrintWarn => 0 }
651 warn $errmsg.$FS::DBI::errstr;
655 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
656 my $group = "UserName";
658 if ref($part_export) =~ /withdomain/
659 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
661 my $sth_alter = $dbh->prepare(
662 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
665 if ( $sth_alter->execute ) {
666 my $sth_update = $dbh->prepare(
667 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
668 ) or die $errmsg.$dbh->errstr;
669 $sth_update->execute or die $errmsg.$sth_update->errstr;
671 my $error = $sth_alter->errstr;
673 unless $error =~ /Duplicate column name/i #mysql
674 || $error =~ /already exists/i; #Pg
678 my $error = $dbh->errstr;
679 warn $errmsg.$error; #unless $error =~ /exists/i;
682 my $sth_index = $dbh->prepare(
683 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
686 unless ( $sth_index->execute ) {
687 my $error = $sth_index->errstr;
689 unless $error =~ /Duplicate key name/i #mysql
690 || $error =~ /already exists/i; #Pg
693 my $error = $dbh->errstr;
694 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
697 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
698 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
699 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
701 my $sth = $dbh->prepare("SELECT UserName,
703 $str2time max(AcctStartTime)),
704 $str2time max(AcctStopTime))
706 WHERE FreesideStatus = 'done'
710 or die $errmsg.$dbh->errstr;
711 $sth->execute() or die $errmsg.$sth->errstr;
713 while (my $row = $sth->fetchrow_arrayref ) {
714 my ($username, $realm, $start, $stop) = @$row;
716 $username = lc($username) unless $conf->exists('username-uppercase');
718 my $exportnum = $part_export->exportnum;
719 my $extra_sql = " AND exportnum = $exportnum ".
720 " AND exportsvcnum IS NOT NULL ";
722 if ( ref($part_export) =~ /withdomain/ ) {
723 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
724 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
727 my $svc_acct = qsearchs({
728 'select' => 'svc_acct.*',
729 'table' => 'svc_acct',
730 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
731 'LEFT JOIN export_svc USING ( svcpart )',
732 'hashref' => { 'username' => $username },
733 'extra_sql' => $extra_sql,
737 $svc_acct->last_login($start)
738 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
739 $svc_acct->last_logout($stop)
740 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);