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 (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 if ($conf->config('cust-fields') =~ / \| Payment Type/) {
178 my $cust_fields = $conf->config('cust-fields');
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($_);
197 sub upgrade_overlimit_groups {
199 my $agentnum = shift;
200 my @groups = $conf->config('overlimit_groups',$agentnum);
201 if(scalar(@groups)) {
202 my $groups = join(',',@groups);
205 if ( $groups !~ /^[\d,]+$/ ) {
206 foreach my $groupname ( @groups ) {
207 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
209 $g = new FS::radius_group {
210 'groupname' => $groupname,
211 'description' => $groupname,
214 die $error if $error;
216 push @groupnums, $g->groupnum;
218 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
223 sub upgrade_invoice_from {
224 my ($conf, $agentnum, $agentonly) = @_;
226 ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
227 && $conf->exists('invoice_from',$agentnum,$agentonly)
228 && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
231 $realemail =~ s/^\s*//; # remove leading spaces
232 $realemail =~ s/\s*$//; # remove trailing spaces
233 my $realname = $conf->config('invoice_from',$agentnum);
234 $realname =~ s/\<.*\>//; # remove email address
235 $realname =~ s/^\s*//; # remove leading spaces
236 $realname =~ s/\s*$//; # remove trailing spaces
237 # properly quote names that contain punctuation
238 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
239 $realname = '"' . $realname . '"';
241 $conf->set('invoice_from_name', $realname, $agentnum);
242 $conf->set('invoice_from', $realemail, $agentnum);
253 my $data = upgrade_data(%opt);
255 my $oldAutoCommit = $FS::UID::AutoCommit;
256 local $FS::UID::AutoCommit = 0;
257 local $FS::UID::AutoCommit = 0;
259 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
262 foreach my $table ( keys %$data ) {
264 my $class = "FS::$table";
268 if ( $class->can('_upgrade_data') ) {
269 warn "Upgrading $table...\n";
273 $class->_upgrade_data(%opt);
275 # New interface for async upgrades: a class can declare a
276 # "queueable_upgrade" method, which will run as part of the normal
277 # upgrade, but if the -j option is passed, will instead be run from
279 if ( $class->can('queueable_upgrade') ) {
280 my $jobname = $class . '::queueable_upgrade';
281 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
283 warn "$class upgrade already scheduled.\n";
285 if ( $opt{'queue'} ) {
286 warn "Scheduling $class upgrade.\n";
287 my $job = FS::queue->new({ job => $jobname });
288 $job->insert($class, %opt);
290 $class->queueable_upgrade(%opt);
295 if ( $oldAutoCommit ) {
296 warn " committing\n";
297 dbh->commit or die dbh->errstr;
300 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
301 warn " done in ". (time-$start). " seconds\n";
304 warn "WARNING: asked for upgrade of $table,".
305 " but FS::$table has no _upgrade_data method\n";
308 # my @records = @{ $data->{$table} };
310 # foreach my $record ( @records ) {
311 # my $args = delete($record->{'_upgrade_args'}) || [];
312 # my $object = $class->new( $record );
313 # my $error = $object->insert( @$args );
314 # die "error inserting record into $table: $error\n"
320 local($FS::cust_main::ignore_expired_card) = 1;
321 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
322 local($FS::cust_main::ignore_banned_card) = 1;
323 local($FS::cust_main::skip_fuzzyfiles) = 1;
325 local($FS::cust_payby::ignore_expired_card) = 1;
326 local($FS::cust_payby::ignore_banned_card) = 1;
328 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
329 # kind of a weird spot for this, but it's better than duplicating
330 # all this code in each class...
331 my @decrypt_tables = qw( cust_payby cust_pay_void cust_pay cust_refund cust_pay_pending );
332 foreach my $table ( @decrypt_tables ) {
333 my @objects = qsearch({
336 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
337 " AND LENGTH(payinfo) > 100",
339 foreach my $object ( @objects ) {
340 my $payinfo = $object->decrypt($object->payinfo);
341 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
342 $object->payinfo($payinfo);
343 my $error = $object->replace;
344 die $error if $error;
357 tie my %hash, 'Tie::IxHash',
362 #fix whitespace - before cust_main
363 'cust_location' => [],
365 # need before cust_main tokenization upgrade,
366 # blocks tokenization upgrade if deprecated features still in use
367 'agent_payment_gateway' => [],
369 #cust_main (tokenizes cards, remove paycvv from history, locations, cust_payby, etc)
370 # (handles payinfo encryption/tokenization across all relevant tables)
373 #contact -> cust_contact / prospect_contact
379 #reason type and reasons
381 'cust_pkg_reason' => [],
383 #need part_pkg before cust_credit...
389 # reason / void_reason migration to reasonnum / void_reasonnum
390 'cust_credit_void' => [],
391 'cust_bill_void' => [],
392 # also fix some tax allocation records
393 'cust_bill_pkg_void' => [],
395 #duplicate history records
398 #populate cust_pay.otaker
401 #populate part_pkg_taxclass for starters
402 'part_pkg_taxclass' => [],
404 #remove bad pending records
405 'cust_pay_pending' => [],
407 #replace invnum and pkgnum with billpkgnum
408 'cust_bill_pkg_detail' => [],
410 #usage_classes if we have none
413 #phone_type if we have none
417 'access_right' => [],
419 #change recur_flat and enable_prorate
420 'part_pkg_option' => [],
422 #add weights to pkg_category
423 'pkg_category' => [],
429 'cust_attachment' => [],
430 #'cust_credit' => [],
432 'cust_main_note' => [],
434 'cust_pay_void' => [],
436 #'cust_pkg_reason' => [],
437 'cust_pkg_discount' => [],
445 'payment_gateway' => [],
447 #migrate to templates
448 'msg_template' => [],
450 #return unprovisioned numbers to availability
453 #insert scripcondition
454 'TicketSystem' => [],
456 #insert LATA data if not already present
459 #insert MSA data if not already present
462 # migrate to radius_group and groupnum instead of groupname
463 'radius_usergroup' => [],
467 #insert default tower_sector if not present
470 #repair improperly deleted services
474 'svc_broadband' => [],
476 #set up payment gateways if needed
479 #flag monthly tax exemptions
480 'cust_tax_exempt_pkg' => [],
482 #kick off tax location history upgrade
483 'cust_bill_pkg' => [],
485 #fix taxable line item links
486 'cust_bill_pkg_tax_location' => [],
488 #populate state FIPS codes if not already done
491 #set default locations on quoted packages
492 'quotation_pkg' => [],
494 #populate tax statuses
497 #mark certain taxes as system-maintained,
499 'cust_main_county' => [],
513 my $data = upgrade_schema_data(%opt);
515 my $oldAutoCommit = $FS::UID::AutoCommit;
516 local $FS::UID::AutoCommit = 0;
517 local $FS::UID::AutoCommit = 0;
519 foreach my $table ( keys %$data ) {
521 my $class = "FS::$table";
525 if ( $class->can('_upgrade_schema') ) {
526 warn "Upgrading $table schema...\n";
530 $class->_upgrade_schema(%opt);
532 if ( $oldAutoCommit ) {
533 warn " committing\n";
534 dbh->commit or die dbh->errstr;
537 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
538 warn " done in ". (time-$start). " seconds\n";
541 warn "WARNING: asked for schema upgrade of $table,".
542 " but FS::$table has no _upgrade_schema method\n";
549 =item upgrade_schema_data
553 sub upgrade_schema_data {
556 #auto-find tables/classes with an _update_schema method?
558 tie my %hash, 'Tie::IxHash',
560 #fix classnum character(1)
561 'cust_bill_pkg_detail' => [],
562 #add necessary columns to RT schema
563 'TicketSystem' => [],
564 #remove h_access_user_log if it exists (since our regular auto schema
565 # upgrade doesn't have the drop tables flag turned on)
566 'access_user_log' => [],
567 #remove possible dangling records
568 'password_history' => [],
569 'cust_pay_pending' => [],
570 #remove records referencing removed things with their FKs
571 'pkg_referral' => [],
572 'cust_bill_pkg_discount' => [],
574 'cust_bill_pay_batch' => [],
575 'cust_event_fee' => [],
577 'queue_depend' => [],
578 'cust_main_invoice' => [],
579 #update records referencing removed things with their FKs
587 sub upgrade_sqlradius {
590 my $conf = new FS::Conf;
592 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
594 foreach my $part_export ( @part_export ) {
596 my $errmsg = 'Error adding FreesideStatus to '.
597 $part_export->option('datasrc'). ': ';
599 my $dbh = DBI->connect(
600 ( map $part_export->option($_), qw ( datasrc username password ) ),
601 { PrintError => 0, PrintWarn => 0 }
603 warn $errmsg.$DBI::errstr;
607 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
608 my $group = "UserName";
610 if ref($part_export) =~ /withdomain/
611 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
613 my $sth_alter = $dbh->prepare(
614 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
617 if ( $sth_alter->execute ) {
618 my $sth_update = $dbh->prepare(
619 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
620 ) or die $errmsg.$dbh->errstr;
621 $sth_update->execute or die $errmsg.$sth_update->errstr;
623 my $error = $sth_alter->errstr;
625 unless $error =~ /Duplicate column name/i #mysql
626 || $error =~ /already exists/i; #Pg
630 my $error = $dbh->errstr;
631 warn $errmsg.$error; #unless $error =~ /exists/i;
634 my $sth_index = $dbh->prepare(
635 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
638 unless ( $sth_index->execute ) {
639 my $error = $sth_index->errstr;
641 unless $error =~ /Duplicate key name/i #mysql
642 || $error =~ /already exists/i; #Pg
645 my $error = $dbh->errstr;
646 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
649 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
650 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
651 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
653 my $sth = $dbh->prepare("SELECT UserName,
655 $str2time max(AcctStartTime)),
656 $str2time max(AcctStopTime))
658 WHERE FreesideStatus = 'done'
662 or die $errmsg.$dbh->errstr;
663 $sth->execute() or die $errmsg.$sth->errstr;
665 while (my $row = $sth->fetchrow_arrayref ) {
666 my ($username, $realm, $start, $stop) = @$row;
668 $username = lc($username) unless $conf->exists('username-uppercase');
670 my $exportnum = $part_export->exportnum;
671 my $extra_sql = " AND exportnum = $exportnum ".
672 " AND exportsvcnum IS NOT NULL ";
674 if ( ref($part_export) =~ /withdomain/ ) {
675 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
676 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
679 my $svc_acct = qsearchs({
680 'select' => 'svc_acct.*',
681 'table' => 'svc_acct',
682 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
683 'LEFT JOIN export_svc USING ( svcpart )',
684 'hashref' => { 'username' => $username },
685 'extra_sql' => $extra_sql,
689 $svc_acct->last_login($start)
690 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
691 $svc_acct->last_logout($stop)
692 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);