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 # to simplify tokenization upgrades
51 die "Conf selfservice-payment_gateway no longer supported"
52 if $conf->config('selfservice-payment_gateway');
54 $conf->touch('payment_receipt')
55 if $conf->exists('payment_receipt_email')
56 || $conf->config('payment_receipt_msgnum');
58 $conf->touch('geocode-require_nw_coordinates')
59 if $conf->exists('svc_broadband-require-nw-coordinates');
61 unless ( $conf->config('echeck-country') ) {
62 if ( $conf->exists('cust_main-require-bank-branch') ) {
63 $conf->set('echeck-country', 'CA');
64 } elsif ( $conf->exists('echeck-nonus') ) {
65 $conf->set('echeck-country', 'XX');
67 $conf->set('echeck-country', 'US');
71 my @agents = qsearch('agent', {});
73 upgrade_overlimit_groups($conf);
74 map { upgrade_overlimit_groups($conf,$_->agentnum) } @agents;
76 upgrade_invoice_from($conf);
77 foreach my $agent (@agents) {
78 upgrade_invoice_from($conf,$agent->agentnum,1);
81 my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
82 $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
83 foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
84 qw( quotation_html quotation_latex quotation_latexnotes );
86 # change 'fslongtable' to 'longtable'
87 # in invoice and quotation main templates, and also in all secondary
90 qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
92 foreach my $c (@latex_confs) {
93 my $value = $c->value;
94 if (length($value) and $value =~ /fslongtable/) {
95 $value =~ s/fslongtable/longtable/g;
96 $conf->set($c->name, $value, $c->agentnum);
100 # if there's a USPS tools login, assume that's the standardization method
102 $conf->set('address_standardize_method', 'usps')
103 if $conf->exists('usps_webtools-userid')
104 && length($conf->config('usps_webtools-userid')) > 0
105 && ! $conf->exists('address_standardize_method');
107 # this option has been renamed/expanded
108 if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
109 $conf->touch('cust_main-enable_spouse');
110 $conf->delete('cust_main-enable_spouse_birthdate');
114 if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
115 $conf->touch('part_pkg-show_fcc_options');
116 $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
118 You have FCC Form 477 package options enabled.
120 Starting with the October 2014 filing date, the FCC has redesigned
121 Form 477 and introduced new service categories. See bin/convert-477-options
122 to update your package configuration for the new report.
124 If you need to continue using the old Form 477 report, turn on the
125 'old_fcc_report' configuration option.
129 # boolean invoice_sections_by_location option is now
130 # invoice_sections_method = 'location'
131 my @invoice_sections_confs =
132 qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
133 foreach my $c (@invoice_sections_confs) {
134 $c->name =~ /^(\w+)sections_by_location$/;
135 $conf->delete($c->name);
136 my $newname = $1.'sections_method';
137 $conf->set($newname, 'location');
140 # boolean enable_taxproducts is now tax_data_vendor = 'cch'
141 if ( $conf->exists('enable_taxproducts') ) {
143 $conf->delete('enable_taxproducts');
144 $conf->set('tax_data_vendor', 'cch');
148 # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
149 if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
150 $conf->set('tax-cust_exempt-groups-num_req', 'all');
151 $conf->delete('tax-cust_exempt-groups-require_individual_nums');
154 # boolean+text previous_balance-exclude_from_total is now two separate options
155 my $total_new_charges = $conf->config('previous_balance-exclude_from_total');
156 if ( defined $total_new_charges && length($total_new_charges) > 0 ) {
157 $conf->set('previous_balance-text-total_new_charges', $total_new_charges);
158 $conf->set('previous_balance-exclude_from_total', '');
161 # switch from specifying an email address to boolean check
162 if ( $conf->exists('batch-errors_to') ) {
163 $conf->touch('batch-errors_not_fatal');
164 $conf->delete('batch-errors_to');
167 if ( $conf->exists('voip-cust_email_csv_cdr') ) {
168 $conf->set('voip_cdr_email_attach', 'csv');
169 $conf->delete('voip-cust_email_csv_cdr') ;
172 if ($conf->exists('unsuspendauto') && !$conf->config('unsuspend_balance')) {
173 $conf->set('unsuspend_balance','Zero');
174 $conf->delete('unsuspendauto');
177 my $cust_fields = $conf->config('cust-fields');
178 if ( defined $cust_fields && $cust_fields =~ / \| Payment Type/ ) {
179 # so we can potentially use 'Payment Types' or somesuch in the future
180 $cust_fields =~ s/ \| Payment Type( \|)/$1/;
181 $cust_fields =~ s/ \| Payment Type$//;
182 $conf->set('cust-fields',$cust_fields);
185 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
187 # if translate-auto-insert is enabled for a locale, ensure that invoice
188 # terms are in the msgcat (is there a better place for this?)
189 if (my $auto_locale = $conf->config('translate-auto-insert')) {
190 my $lh = FS::L10N->get_handle($auto_locale);
191 foreach (@FS::Conf::invoice_terms) {
192 $lh->maketext($_) if length($_);
196 unless ( FS::upgrade_journal->is_done('deprecate_unmask_ss') ) {
197 if ( $conf->config_bool( 'unmask_ss' )) {
198 warn "'unmask_ssn' deprecated from global configuration\n";
199 for my $access_group ( qsearch( access_group => {} )) {
200 $access_group->grant_access_right( 'Unmask customer SSN' );
201 warn " - 'Unmask customer SSN' access right granted to '" .
202 $access_group->groupname . "' employee group\n";
205 FS::upgrade_journal->set_done('deprecate_unmask_ss');
210 sub upgrade_overlimit_groups {
212 my $agentnum = shift;
213 my @groups = $conf->config('overlimit_groups',$agentnum);
214 if(scalar(@groups)) {
215 my $groups = join(',',@groups);
218 if ( $groups !~ /^[\d,]+$/ ) {
219 foreach my $groupname ( @groups ) {
220 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
222 $g = new FS::radius_group {
223 'groupname' => $groupname,
224 'description' => $groupname,
227 die $error if $error;
229 push @groupnums, $g->groupnum;
231 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
236 sub upgrade_invoice_from {
237 my ($conf, $agentnum, $agentonly) = @_;
239 ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
240 && $conf->exists('invoice_from',$agentnum,$agentonly)
241 && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
244 $realemail =~ s/^\s*//; # remove leading spaces
245 $realemail =~ s/\s*$//; # remove trailing spaces
246 my $realname = $conf->config('invoice_from',$agentnum);
247 $realname =~ s/\<.*\>//; # remove email address
248 $realname =~ s/^\s*//; # remove leading spaces
249 $realname =~ s/\s*$//; # remove trailing spaces
250 # properly quote names that contain punctuation
251 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
252 $realname = '"' . $realname . '"';
254 $conf->set('invoice_from_name', $realname, $agentnum);
255 $conf->set('invoice_from', $realemail, $agentnum);
266 my $data = upgrade_data(%opt);
268 my $oldAutoCommit = $FS::UID::AutoCommit;
269 local $FS::UID::AutoCommit = 0;
270 local $FS::UID::AutoCommit = 0;
272 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
275 foreach my $table ( keys %$data ) {
277 my $class = "FS::$table";
281 if ( $class->can('_upgrade_data') ) {
282 warn "Upgrading $table...\n";
286 $class->_upgrade_data(%opt);
288 # New interface for async upgrades: a class can declare a
289 # "queueable_upgrade" method, which will run as part of the normal
290 # upgrade, but if the -j option is passed, will instead be run from
292 if ( $class->can('queueable_upgrade') ) {
293 my $jobname = $class . '::queueable_upgrade';
294 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
296 warn "$class upgrade already scheduled.\n";
298 if ( $opt{'queue'} ) {
299 warn "Scheduling $class upgrade.\n";
300 my $job = FS::queue->new({ job => $jobname });
301 $job->insert($class, %opt);
303 $class->queueable_upgrade(%opt);
308 if ( $oldAutoCommit ) {
309 warn " committing\n";
310 dbh->commit or die dbh->errstr;
313 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
314 warn " done in ". (time-$start). " seconds\n";
317 warn "WARNING: asked for upgrade of $table,".
318 " but FS::$table has no _upgrade_data method\n";
321 # my @records = @{ $data->{$table} };
323 # foreach my $record ( @records ) {
324 # my $args = delete($record->{'_upgrade_args'}) || [];
325 # my $object = $class->new( $record );
326 # my $error = $object->insert( @$args );
327 # die "error inserting record into $table: $error\n"
333 local($FS::cust_main::ignore_expired_card) = 1;
334 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
335 local($FS::cust_main::ignore_banned_card) = 1;
336 local($FS::cust_main::skip_fuzzyfiles) = 1;
338 local($FS::cust_payby::ignore_expired_card) = 1;
339 local($FS::cust_payby::ignore_banned_card) = 1;
341 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
342 # kind of a weird spot for this, but it's better than duplicating
343 # all this code in each class...
344 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
345 foreach my $table ( @decrypt_tables ) {
346 my @objects = qsearch({
349 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
350 " AND LENGTH(payinfo) > 100",
352 foreach my $object ( @objects ) {
353 my $payinfo = $object->decrypt($object->payinfo);
354 if ( $payinfo eq $object->payinfo ) {
355 warn "error decrypting payinfo for $table: $payinfo\n";
358 $object->payinfo($payinfo);
359 my $error = $object->replace;
360 die $error if $error;
373 tie my %hash, 'Tie::IxHash',
378 #payby conditions to new ones
379 'part_event_condition' => [],
381 #payby actions to new ones
384 #fix whitespace - before cust_main
385 'cust_location' => [],
387 # need before cust_main tokenization upgrade,
388 # blocks tokenization upgrade if deprecated features still in use
389 'agent_payment_gateway' => [],
391 #remove bad source_paynum before cust_main
394 #cust_main (tokenizes cards, remove paycvv from history, locations, cust_payby, etc)
395 # (handles payinfo encryption/tokenization across all relevant tables)
398 #contact -> cust_contact / prospect_contact
404 #reason type and reasons
406 'cust_pkg_reason' => [],
408 #need part_pkg before cust_credit...
414 # reason / void_reason migration to reasonnum / void_reasonnum
415 'cust_credit_void' => [],
416 'cust_bill_void' => [],
417 # also fix some tax allocation records
418 'cust_bill_pkg_void' => [],
420 #duplicate history records
423 #populate cust_pay.otaker
426 #populate part_pkg_taxclass for starters
427 'part_pkg_taxclass' => [],
429 #remove bad pending records
430 'cust_pay_pending' => [],
432 #replace invnum and pkgnum with billpkgnum
433 'cust_bill_pkg_detail' => [],
435 #usage_classes if we have none
438 #phone_type if we have none
442 'access_right' => [],
444 #change recur_flat and enable_prorate
445 'part_pkg_option' => [],
447 #add weights to pkg_category
448 'pkg_category' => [],
454 'cust_attachment' => [],
455 #'cust_credit' => [],
457 'cust_main_note' => [],
459 'cust_pay_void' => [],
461 #'cust_pkg_reason' => [],
462 'cust_pkg_discount' => [],
463 #'cust_refund' => [],
470 'payment_gateway' => [],
472 #migrate to templates
473 'msg_template' => [],
475 #return unprovisioned numbers to availability
478 #insert scripcondition
479 'TicketSystem' => [],
481 #insert LATA data if not already present
484 #insert MSA data if not already present
487 # migrate to radius_group and groupnum instead of groupname
488 'radius_usergroup' => [],
492 #insert default tower_sector if not present
495 #repair improperly deleted services
499 'svc_broadband' => [],
501 #set up payment gateways if needed
504 #flag monthly tax exemptions
505 'cust_tax_exempt_pkg' => [],
507 #kick off tax location history upgrade
508 'cust_bill_pkg' => [],
510 #fix taxable line item links
511 'cust_bill_pkg_tax_location' => [],
513 #populate state FIPS codes if not already done
516 #set default locations on quoted packages
517 'quotation_pkg' => [],
519 #populate tax statuses
522 #mark certain taxes as system-maintained,
524 'cust_main_county' => [],
526 #'compliance solutions' -> 'compliance_solutions'
528 'tax_rate_location' => [],
530 #upgrade part_event_condition_option agentnum to a multiple hash value
531 'part_event_condition_option' =>[],
537 'svc_hardware' => [],
543 'tower_sector' => [],
559 my $data = upgrade_schema_data(%opt);
561 my $oldAutoCommit = $FS::UID::AutoCommit;
562 local $FS::UID::AutoCommit = 0;
563 local $FS::UID::AutoCommit = 0;
565 foreach my $table ( keys %$data ) {
567 my $class = "FS::$table";
571 if ( $class->can('_upgrade_schema') ) {
572 warn "Upgrading $table schema...\n";
576 $class->_upgrade_schema(%opt);
578 if ( $oldAutoCommit ) {
579 warn " committing\n";
580 dbh->commit or die dbh->errstr;
583 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
584 warn " done in ". (time-$start). " seconds\n";
587 warn "WARNING: asked for schema upgrade of $table,".
588 " but FS::$table has no _upgrade_schema method\n";
595 =item upgrade_schema_data
599 sub upgrade_schema_data {
602 #auto-find tables/classes with an _update_schema method?
604 tie my %hash, 'Tie::IxHash',
606 #fix classnum character(1)
607 'cust_bill_pkg_detail' => [],
608 #add necessary columns to RT schema
609 'TicketSystem' => [],
610 #remove h_access_user_log if it exists (since our regular auto schema
611 # upgrade doesn't have the drop tables flag turned on)
612 'access_user_log' => [],
613 #remove possible dangling records
614 'password_history' => [],
615 'cust_pay_pending' => [],
616 #remove records referencing removed things with their FKs
617 'pkg_referral' => [],
618 'cust_bill_pkg_discount' => [],
620 'cust_bill_pay_batch' => [],
621 'cust_event_fee' => [],
623 'queue_depend' => [],
624 'cust_main_invoice' => [],
625 #update records referencing removed things with their FKs
633 sub upgrade_sqlradius {
636 my $conf = new FS::Conf;
638 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
640 foreach my $part_export ( @part_export ) {
642 my $errmsg = 'Error adding FreesideStatus to '.
643 $part_export->option('datasrc'). ': ';
645 my $dbh = DBI->connect(
646 ( map $part_export->option($_), qw ( datasrc username password ) ),
647 { PrintError => 0, PrintWarn => 0 }
649 warn $errmsg.$DBI::errstr;
653 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
654 my $group = "UserName";
656 if ref($part_export) =~ /withdomain/
657 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
659 my $sth_alter = $dbh->prepare(
660 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
663 if ( $sth_alter->execute ) {
664 my $sth_update = $dbh->prepare(
665 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
666 ) or die $errmsg.$dbh->errstr;
667 $sth_update->execute or die $errmsg.$sth_update->errstr;
669 my $error = $sth_alter->errstr;
671 unless $error =~ /Duplicate column name/i #mysql
672 || $error =~ /already exists/i; #Pg
676 my $error = $dbh->errstr;
677 warn $errmsg.$error; #unless $error =~ /exists/i;
680 my $sth_index = $dbh->prepare(
681 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
684 unless ( $sth_index->execute ) {
685 my $error = $sth_index->errstr;
687 unless $error =~ /Duplicate key name/i #mysql
688 || $error =~ /already exists/i; #Pg
691 my $error = $dbh->errstr;
692 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
695 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
696 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
697 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
699 my $sth = $dbh->prepare("SELECT UserName,
701 $str2time max(AcctStartTime)),
702 $str2time max(AcctStopTime))
704 WHERE FreesideStatus = 'done'
708 or die $errmsg.$dbh->errstr;
709 $sth->execute() or die $errmsg.$sth->errstr;
711 while (my $row = $sth->fetchrow_arrayref ) {
712 my ($username, $realm, $start, $stop) = @$row;
714 $username = lc($username) unless $conf->exists('username-uppercase');
716 my $exportnum = $part_export->exportnum;
717 my $extra_sql = " AND exportnum = $exportnum ".
718 " AND exportsvcnum IS NOT NULL ";
720 if ( ref($part_export) =~ /withdomain/ ) {
721 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
722 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
725 my $svc_acct = qsearchs({
726 'select' => 'svc_acct.*',
727 'table' => 'svc_acct',
728 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
729 'LEFT JOIN export_svc USING ( svcpart )',
730 'hashref' => { 'username' => $username },
731 'extra_sql' => $extra_sql,
735 $svc_acct->last_login($start)
736 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
737 $svc_acct->last_logout($stop)
738 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);