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);
182 $conf->set('note-classes','Enabled')
183 if $conf->exists('note-classes')
184 and grep {$_ eq $conf->config('note-classes')} ('1','2');
185 $conf->set('note-classes','')
186 if $conf->exists('note-classes')
187 and '0' eq $conf->config('note-classes');
189 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
191 # if translate-auto-insert is enabled for a locale, ensure that invoice
192 # terms are in the msgcat (is there a better place for this?)
193 if (my $auto_locale = $conf->config('translate-auto-insert')) {
194 my $lh = FS::L10N->get_handle($auto_locale);
195 foreach (@FS::Conf::invoice_terms) {
196 $lh->maketext($_) if length($_);
201 sub upgrade_overlimit_groups {
203 my $agentnum = shift;
204 my @groups = $conf->config('overlimit_groups',$agentnum);
205 if(scalar(@groups)) {
206 my $groups = join(',',@groups);
209 if ( $groups !~ /^[\d,]+$/ ) {
210 foreach my $groupname ( @groups ) {
211 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
213 $g = new FS::radius_group {
214 'groupname' => $groupname,
215 'description' => $groupname,
218 die $error if $error;
220 push @groupnums, $g->groupnum;
222 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
227 sub upgrade_invoice_from {
228 my ($conf, $agentnum, $agentonly) = @_;
230 ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
231 && $conf->exists('invoice_from',$agentnum,$agentonly)
232 && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
235 $realemail =~ s/^\s*//; # remove leading spaces
236 $realemail =~ s/\s*$//; # remove trailing spaces
237 my $realname = $conf->config('invoice_from',$agentnum);
238 $realname =~ s/\<.*\>//; # remove email address
239 $realname =~ s/^\s*//; # remove leading spaces
240 $realname =~ s/\s*$//; # remove trailing spaces
241 # properly quote names that contain punctuation
242 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
243 $realname = '"' . $realname . '"';
245 $conf->set('invoice_from_name', $realname, $agentnum);
246 $conf->set('invoice_from', $realemail, $agentnum);
257 my $data = upgrade_data(%opt);
259 my $oldAutoCommit = $FS::UID::AutoCommit;
260 local $FS::UID::AutoCommit = 0;
261 local $FS::UID::AutoCommit = 0;
263 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
266 foreach my $table ( keys %$data ) {
268 my $class = "FS::$table";
272 if ( $class->can('_upgrade_data') ) {
273 warn "Upgrading $table...\n";
277 $class->_upgrade_data(%opt);
279 # New interface for async upgrades: a class can declare a
280 # "queueable_upgrade" method, which will run as part of the normal
281 # upgrade, but if the -j option is passed, will instead be run from
283 if ( $class->can('queueable_upgrade') ) {
284 my $jobname = $class . '::queueable_upgrade';
285 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
287 warn "$class upgrade already scheduled.\n";
289 if ( $opt{'queue'} ) {
290 warn "Scheduling $class upgrade.\n";
291 my $job = FS::queue->new({ job => $jobname });
292 $job->insert($class, %opt);
294 $class->queueable_upgrade(%opt);
299 if ( $oldAutoCommit ) {
300 warn " committing\n";
301 dbh->commit or die dbh->errstr;
304 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
305 warn " done in ". (time-$start). " seconds\n";
308 warn "WARNING: asked for upgrade of $table,".
309 " but FS::$table has no _upgrade_data method\n";
312 # my @records = @{ $data->{$table} };
314 # foreach my $record ( @records ) {
315 # my $args = delete($record->{'_upgrade_args'}) || [];
316 # my $object = $class->new( $record );
317 # my $error = $object->insert( @$args );
318 # die "error inserting record into $table: $error\n"
324 local($FS::cust_main::ignore_expired_card) = 1;
325 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
326 local($FS::cust_main::ignore_banned_card) = 1;
327 local($FS::cust_main::skip_fuzzyfiles) = 1;
329 local($FS::cust_payby::ignore_expired_card) = 1;
330 local($FS::cust_payby::ignore_banned_card) = 1;
332 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
333 # kind of a weird spot for this, but it's better than duplicating
334 # all this code in each class...
335 my @decrypt_tables = qw( cust_payby cust_pay_void cust_pay cust_refund cust_pay_pending );
336 foreach my $table ( @decrypt_tables ) {
337 my @objects = qsearch({
340 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
341 " AND LENGTH(payinfo) > 100",
343 foreach my $object ( @objects ) {
344 my $payinfo = $object->decrypt($object->payinfo);
345 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
346 $object->payinfo($payinfo);
347 my $error = $object->replace;
348 die $error if $error;
361 tie my %hash, 'Tie::IxHash',
366 #fix whitespace - before cust_main
367 'cust_location' => [],
369 #cust_main (remove paycvv from history, locations, cust_payby, etc)
372 #contact -> cust_contact / prospect_contact
378 #reason type and reasons
380 'cust_pkg_reason' => [],
382 #need part_pkg before cust_credit...
388 # reason / void_reason migration to reasonnum / void_reasonnum
389 'cust_credit_void' => [],
390 'cust_bill_void' => [],
391 'cust_bill_pkg_void' => [],
393 #duplicate history records
396 #populate cust_pay.otaker
399 #populate part_pkg_taxclass for starters
400 'part_pkg_taxclass' => [],
402 #remove bad pending records
403 'cust_pay_pending' => [],
405 #replace invnum and pkgnum with billpkgnum
406 'cust_bill_pkg_detail' => [],
408 #usage_classes if we have none
411 #phone_type if we have none
415 'access_right' => [],
417 #change recur_flat and enable_prorate
418 'part_pkg_option' => [],
420 #add weights to pkg_category
421 'pkg_category' => [],
427 'cust_attachment' => [],
428 #'cust_credit' => [],
430 'cust_main_note' => [],
432 'cust_pay_void' => [],
434 #'cust_pkg_reason' => [],
435 'cust_pkg_discount' => [],
443 'payment_gateway' => [],
445 #migrate to templates
446 'msg_template' => [],
448 #return unprovisioned numbers to availability
451 #insert scripcondition
452 'TicketSystem' => [],
454 #insert LATA data if not already present
457 #insert MSA data if not already present
460 # migrate to radius_group and groupnum instead of groupname
461 'radius_usergroup' => [],
465 #insert default tower_sector if not present
468 #repair improperly deleted services
472 'svc_broadband' => [],
474 #set up payment gateways if needed
477 #flag monthly tax exemptions
478 'cust_tax_exempt_pkg' => [],
480 #kick off tax location history upgrade
481 'cust_bill_pkg' => [],
483 #fix taxable line item links
484 'cust_bill_pkg_tax_location' => [],
486 #populate state FIPS codes if not already done
489 #set default locations on quoted packages
490 'quotation_pkg' => [],
492 #populate tax statuses
495 #mark certain taxes as system-maintained,
497 'cust_main_county' => [],
511 my $data = upgrade_schema_data(%opt);
513 my $oldAutoCommit = $FS::UID::AutoCommit;
514 local $FS::UID::AutoCommit = 0;
515 local $FS::UID::AutoCommit = 0;
517 foreach my $table ( keys %$data ) {
519 my $class = "FS::$table";
523 if ( $class->can('_upgrade_schema') ) {
524 warn "Upgrading $table schema...\n";
528 $class->_upgrade_schema(%opt);
530 if ( $oldAutoCommit ) {
531 warn " committing\n";
532 dbh->commit or die dbh->errstr;
535 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
536 warn " done in ". (time-$start). " seconds\n";
539 warn "WARNING: asked for schema upgrade of $table,".
540 " but FS::$table has no _upgrade_schema method\n";
547 =item upgrade_schema_data
551 sub upgrade_schema_data {
554 tie my %hash, 'Tie::IxHash',
556 #fix classnum character(1)
557 'cust_bill_pkg_detail' => [],
558 #add necessary columns to RT schema
559 'TicketSystem' => [],
560 #remove possible dangling records
561 'password_history' => [],
562 'cust_pay_pending' => [],
569 sub upgrade_sqlradius {
572 my $conf = new FS::Conf;
574 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
576 foreach my $part_export ( @part_export ) {
578 my $errmsg = 'Error adding FreesideStatus to '.
579 $part_export->option('datasrc'). ': ';
581 my $dbh = DBI->connect(
582 ( map $part_export->option($_), qw ( datasrc username password ) ),
583 { PrintError => 0, PrintWarn => 0 }
585 warn $errmsg.$DBI::errstr;
589 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
590 my $group = "UserName";
592 if ref($part_export) =~ /withdomain/
593 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
595 my $sth_alter = $dbh->prepare(
596 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
599 if ( $sth_alter->execute ) {
600 my $sth_update = $dbh->prepare(
601 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
602 ) or die $errmsg.$dbh->errstr;
603 $sth_update->execute or die $errmsg.$sth_update->errstr;
605 my $error = $sth_alter->errstr;
607 unless $error =~ /Duplicate column name/i #mysql
608 || $error =~ /already exists/i; #Pg
612 my $error = $dbh->errstr;
613 warn $errmsg.$error; #unless $error =~ /exists/i;
616 my $sth_index = $dbh->prepare(
617 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
620 unless ( $sth_index->execute ) {
621 my $error = $sth_index->errstr;
623 unless $error =~ /Duplicate key name/i #mysql
624 || $error =~ /already exists/i; #Pg
627 my $error = $dbh->errstr;
628 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
631 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
632 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
633 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
635 my $sth = $dbh->prepare("SELECT UserName,
637 $str2time max(AcctStartTime)),
638 $str2time max(AcctStopTime))
640 WHERE FreesideStatus = 'done'
644 or die $errmsg.$dbh->errstr;
645 $sth->execute() or die $errmsg.$sth->errstr;
647 while (my $row = $sth->fetchrow_arrayref ) {
648 my ($username, $realm, $start, $stop) = @$row;
650 $username = lc($username) unless $conf->exists('username-uppercase');
652 my $exportnum = $part_export->exportnum;
653 my $extra_sql = " AND exportnum = $exportnum ".
654 " AND exportsvcnum IS NOT NULL ";
656 if ( ref($part_export) =~ /withdomain/ ) {
657 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
658 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
661 my $svc_acct = qsearchs({
662 'select' => 'svc_acct.*',
663 'table' => 'svc_acct',
664 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
665 'LEFT JOIN export_svc USING ( svcpart )',
666 'hashref' => { 'username' => $username },
667 'extra_sql' => $extra_sql,
671 $svc_acct->last_login($start)
672 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
673 $svc_acct->last_logout($stop)
674 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);