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');
211 sub upgrade_overlimit_groups {
213 my $agentnum = shift;
214 my @groups = $conf->config('overlimit_groups',$agentnum);
215 if(scalar(@groups)) {
216 my $groups = join(',',@groups);
219 if ( $groups !~ /^[\d,]+$/ ) {
220 foreach my $groupname ( @groups ) {
221 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
223 $g = new FS::radius_group {
224 'groupname' => $groupname,
225 'description' => $groupname,
228 die $error if $error;
230 push @groupnums, $g->groupnum;
232 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
237 sub upgrade_invoice_from {
238 my ($conf, $agentnum, $agentonly) = @_;
240 ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
241 && $conf->exists('invoice_from',$agentnum,$agentonly)
242 && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
245 $realemail =~ s/^\s*//; # remove leading spaces
246 $realemail =~ s/\s*$//; # remove trailing spaces
247 my $realname = $conf->config('invoice_from',$agentnum);
248 $realname =~ s/\<.*\>//; # remove email address
249 $realname =~ s/^\s*//; # remove leading spaces
250 $realname =~ s/\s*$//; # remove trailing spaces
251 # properly quote names that contain punctuation
252 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
253 $realname = '"' . $realname . '"';
255 $conf->set('invoice_from_name', $realname, $agentnum);
256 $conf->set('invoice_from', $realemail, $agentnum);
267 my $data = upgrade_data(%opt);
269 my $oldAutoCommit = $FS::UID::AutoCommit;
270 local $FS::UID::AutoCommit = 0;
271 local $FS::UID::AutoCommit = 0;
273 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
276 foreach my $table ( keys %$data ) {
278 my $class = "FS::$table";
282 if ( $class->can('_upgrade_data') ) {
283 warn "Upgrading $table...\n";
287 $class->_upgrade_data(%opt);
289 # New interface for async upgrades: a class can declare a
290 # "queueable_upgrade" method, which will run as part of the normal
291 # upgrade, but if the -j option is passed, will instead be run from
293 if ( $class->can('queueable_upgrade') ) {
294 my $jobname = $class . '::queueable_upgrade';
295 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
297 warn "$class upgrade already scheduled.\n";
299 if ( $opt{'queue'} ) {
300 warn "Scheduling $class upgrade.\n";
301 my $job = FS::queue->new({ job => $jobname });
302 $job->insert($class, %opt);
304 $class->queueable_upgrade(%opt);
309 if ( $oldAutoCommit ) {
310 warn " committing\n";
311 dbh->commit or die dbh->errstr;
314 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
315 warn " done in ". (time-$start). " seconds\n";
318 warn "WARNING: asked for upgrade of $table,".
319 " but FS::$table has no _upgrade_data method\n";
322 # my @records = @{ $data->{$table} };
324 # foreach my $record ( @records ) {
325 # my $args = delete($record->{'_upgrade_args'}) || [];
326 # my $object = $class->new( $record );
327 # my $error = $object->insert( @$args );
328 # die "error inserting record into $table: $error\n"
334 local($FS::cust_main::ignore_expired_card) = 1;
335 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
336 local($FS::cust_main::ignore_banned_card) = 1;
337 local($FS::cust_main::skip_fuzzyfiles) = 1;
339 local($FS::cust_payby::ignore_expired_card) = 1;
340 local($FS::cust_payby::ignore_banned_card) = 1;
342 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
343 # kind of a weird spot for this, but it's better than duplicating
344 # all this code in each class...
345 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
346 foreach my $table ( @decrypt_tables ) {
347 my @objects = qsearch({
350 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
351 " AND LENGTH(payinfo) > 100",
353 foreach my $object ( @objects ) {
354 my $payinfo = $object->decrypt($object->payinfo);
355 if ( $payinfo eq $object->payinfo ) {
356 warn "error decrypting payinfo for $table: $payinfo\n";
359 $object->payinfo($payinfo);
360 my $error = $object->replace;
361 die $error if $error;
374 tie my %hash, 'Tie::IxHash',
379 #payby conditions to new ones
380 'part_event_condition' => [],
382 #payby actions to new ones
385 #fix whitespace - before cust_main
386 'cust_location' => [],
388 # need before cust_main tokenization upgrade,
389 # blocks tokenization upgrade if deprecated features still in use
390 'agent_payment_gateway' => [],
392 #remove bad source_paynum before cust_main
395 #cust_main (tokenizes cards, remove paycvv from history, locations, cust_payby, etc)
396 # (handles payinfo encryption/tokenization across all relevant tables)
399 #contact -> cust_contact / prospect_contact
405 #reason type and reasons
407 'cust_pkg_reason' => [],
409 #need part_pkg before cust_credit...
415 # reason / void_reason migration to reasonnum / void_reasonnum
416 'cust_credit_void' => [],
417 'cust_bill_void' => [],
418 # also fix some tax allocation records
419 'cust_bill_pkg_void' => [],
421 #duplicate history records
424 #populate cust_pay.otaker
427 #populate part_pkg_taxclass for starters
428 'part_pkg_taxclass' => [],
430 #remove bad pending records
431 'cust_pay_pending' => [],
433 #replace invnum and pkgnum with billpkgnum
434 'cust_bill_pkg_detail' => [],
436 #usage_classes if we have none
439 #phone_type if we have none
443 'access_right' => [],
445 #change recur_flat and enable_prorate
446 'part_pkg_option' => [],
448 #add weights to pkg_category
449 'pkg_category' => [],
455 'cust_attachment' => [],
456 #'cust_credit' => [],
458 'cust_main_note' => [],
460 'cust_pay_void' => [],
462 #'cust_pkg_reason' => [],
463 'cust_pkg_discount' => [],
464 #'cust_refund' => [],
471 'payment_gateway' => [],
473 #migrate to templates
474 'msg_template' => [],
476 #return unprovisioned numbers to availability
479 #insert scripcondition
480 'TicketSystem' => [],
482 #insert LATA data if not already present
485 #insert MSA data if not already present
488 # migrate to radius_group and groupnum instead of groupname
489 'radius_usergroup' => [],
493 #insert default tower_sector if not present
496 #repair improperly deleted services
500 'svc_broadband' => [],
502 #set up payment gateways if needed
505 #flag monthly tax exemptions
506 'cust_tax_exempt_pkg' => [],
508 #kick off tax location history upgrade
509 'cust_bill_pkg' => [],
511 #fix taxable line item links
512 'cust_bill_pkg_tax_location' => [],
514 #populate state FIPS codes if not already done
517 #set default locations on quoted packages
518 'quotation_pkg' => [],
520 #populate tax statuses
523 #mark certain taxes as system-maintained,
525 'cust_main_county' => [],
527 #'compliance solutions' -> 'compliance_solutions'
529 'tax_rate_location' => [],
531 #upgrade part_event_condition_option agentnum to a multiple hash value
532 'part_event_condition_option' =>[],
538 'svc_hardware' => [],
544 'tower_sector' => [],
560 my $data = upgrade_schema_data(%opt);
562 my $oldAutoCommit = $FS::UID::AutoCommit;
563 local $FS::UID::AutoCommit = 0;
564 local $FS::UID::AutoCommit = 0;
566 foreach my $table ( keys %$data ) {
568 my $class = "FS::$table";
572 if ( $class->can('_upgrade_schema') ) {
573 warn "Upgrading $table schema...\n";
577 $class->_upgrade_schema(%opt);
579 if ( $oldAutoCommit ) {
580 warn " committing\n";
581 dbh->commit or die dbh->errstr;
584 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
585 warn " done in ". (time-$start). " seconds\n";
588 warn "WARNING: asked for schema upgrade of $table,".
589 " but FS::$table has no _upgrade_schema method\n";
596 =item upgrade_schema_data
600 sub upgrade_schema_data {
603 #auto-find tables/classes with an _update_schema method?
605 tie my %hash, 'Tie::IxHash',
607 #fix classnum character(1)
608 'cust_bill_pkg_detail' => [],
609 #add necessary columns to RT schema
610 'TicketSystem' => [],
611 #remove h_access_user_log if it exists (since our regular auto schema
612 # upgrade doesn't have the drop tables flag turned on)
613 'access_user_log' => [],
614 #remove possible dangling records
615 'password_history' => [],
616 'cust_pay_pending' => [],
617 #remove records referencing removed things with their FKs
618 'pkg_referral' => [],
619 'cust_bill_pkg_discount' => [],
621 'cust_bill_pay_batch' => [],
622 'cust_event_fee' => [],
624 'queue_depend' => [],
625 'cust_main_invoice' => [],
626 #update records referencing removed things with their FKs
634 sub upgrade_sqlradius {
637 my $conf = new FS::Conf;
639 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
641 foreach my $part_export ( @part_export ) {
643 my $errmsg = 'Error adding FreesideStatus to '.
644 $part_export->option('datasrc'). ': ';
646 my $dbh = FS::DBI->connect(
647 ( map $part_export->option($_), qw ( datasrc username password ) ),
648 { PrintError => 0, PrintWarn => 0 }
650 warn $errmsg.$FS::DBI::errstr;
654 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
655 my $group = "UserName";
657 if ref($part_export) =~ /withdomain/
658 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
660 my $sth_alter = $dbh->prepare(
661 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
664 if ( $sth_alter->execute ) {
665 my $sth_update = $dbh->prepare(
666 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
667 ) or die $errmsg.$dbh->errstr;
668 $sth_update->execute or die $errmsg.$sth_update->errstr;
670 my $error = $sth_alter->errstr;
672 unless $error =~ /Duplicate column name/i #mysql
673 || $error =~ /already exists/i; #Pg
677 my $error = $dbh->errstr;
678 warn $errmsg.$error; #unless $error =~ /exists/i;
681 my $sth_index = $dbh->prepare(
682 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
685 unless ( $sth_index->execute ) {
686 my $error = $sth_index->errstr;
688 unless $error =~ /Duplicate key name/i #mysql
689 || $error =~ /already exists/i; #Pg
692 my $error = $dbh->errstr;
693 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
696 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
697 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
698 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
700 my $sth = $dbh->prepare("SELECT UserName,
702 $str2time max(AcctStartTime)),
703 $str2time max(AcctStopTime))
705 WHERE FreesideStatus = 'done'
709 or die $errmsg.$dbh->errstr;
710 $sth->execute() or die $errmsg.$sth->errstr;
712 while (my $row = $sth->fetchrow_arrayref ) {
713 my ($username, $realm, $start, $stop) = @$row;
715 $username = lc($username) unless $conf->exists('username-uppercase');
717 my $exportnum = $part_export->exportnum;
718 my $extra_sql = " AND exportnum = $exportnum ".
719 " AND exportsvcnum IS NOT NULL ";
721 if ( ref($part_export) =~ /withdomain/ ) {
722 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
723 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
726 my $svc_acct = qsearchs({
727 'select' => 'svc_acct.*',
728 'table' => 'svc_acct',
729 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
730 'LEFT JOIN export_svc USING ( svcpart )',
731 'hashref' => { 'username' => $username },
732 'extra_sql' => $extra_sql,
736 $svc_acct->last_login($start)
737 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
738 $svc_acct->last_logout($stop)
739 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);