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 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
172 sub upgrade_overlimit_groups {
174 my $agentnum = shift;
175 my @groups = $conf->config('overlimit_groups',$agentnum);
176 if(scalar(@groups)) {
177 my $groups = join(',',@groups);
180 if ( $groups !~ /^[\d,]+$/ ) {
181 foreach my $groupname ( @groups ) {
182 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
184 $g = new FS::radius_group {
185 'groupname' => $groupname,
186 'description' => $groupname,
189 die $error if $error;
191 push @groupnums, $g->groupnum;
193 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
198 sub upgrade_invoice_from {
199 my ($conf, $agentnum, $agentonly) = @_;
201 (!$conf->exists('invoice_from_name',$agentnum,$agentonly)) &&
202 ($conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/)
205 $realemail =~ s/^\s*//; # remove leading spaces
206 $realemail =~ s/\s*$//; # remove trailing spaces
207 my $realname = $conf->config('invoice_from',$agentnum);
208 $realname =~ s/\<.*\>//; # remove email address
209 $realname =~ s/^\s*//; # remove leading spaces
210 $realname =~ s/\s*$//; # remove trailing spaces
211 # properly quote names that contain punctuation
212 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
213 $realname = '"' . $realname . '"';
215 $conf->set('invoice_from_name', $realname, $agentnum);
216 $conf->set('invoice_from', $realemail, $agentnum);
227 my $data = upgrade_data(%opt);
229 my $oldAutoCommit = $FS::UID::AutoCommit;
230 local $FS::UID::AutoCommit = 0;
231 local $FS::UID::AutoCommit = 0;
233 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
236 foreach my $table ( keys %$data ) {
238 my $class = "FS::$table";
242 if ( $class->can('_upgrade_data') ) {
243 warn "Upgrading $table...\n";
247 $class->_upgrade_data(%opt);
249 # New interface for async upgrades: a class can declare a
250 # "queueable_upgrade" method, which will run as part of the normal
251 # upgrade, but if the -j option is passed, will instead be run from
253 if ( $class->can('queueable_upgrade') ) {
254 my $jobname = $class . '::queueable_upgrade';
255 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
257 warn "$class upgrade already scheduled.\n";
259 if ( $opt{'queue'} ) {
260 warn "Scheduling $class upgrade.\n";
261 my $job = FS::queue->new({ job => $jobname });
262 $job->insert($class, %opt);
264 $class->queueable_upgrade(%opt);
269 if ( $oldAutoCommit ) {
270 warn " committing\n";
271 dbh->commit or die dbh->errstr;
274 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
275 warn " done in ". (time-$start). " seconds\n";
278 warn "WARNING: asked for upgrade of $table,".
279 " but FS::$table has no _upgrade_data method\n";
282 # my @records = @{ $data->{$table} };
284 # foreach my $record ( @records ) {
285 # my $args = delete($record->{'_upgrade_args'}) || [];
286 # my $object = $class->new( $record );
287 # my $error = $object->insert( @$args );
288 # die "error inserting record into $table: $error\n"
294 local($FS::cust_main::ignore_expired_card) = 1;
295 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
296 local($FS::cust_main::ignore_banned_card) = 1;
297 local($FS::cust_main::skip_fuzzyfiles) = 1;
299 local($FS::cust_payby::ignore_expired_card) = 1;
300 local($FS::cust_payby::ignore_banned_card) = 1;
302 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
303 # kind of a weird spot for this, but it's better than duplicating
304 # all this code in each class...
305 my @decrypt_tables = qw( cust_payby cust_pay_void cust_pay cust_refund cust_pay_pending );
306 foreach my $table ( @decrypt_tables ) {
307 my @objects = qsearch({
310 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
311 " AND LENGTH(payinfo) > 100",
313 foreach my $object ( @objects ) {
314 my $payinfo = $object->decrypt($object->payinfo);
315 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
316 $object->payinfo($payinfo);
317 my $error = $object->replace;
318 die $error if $error;
331 tie my %hash, 'Tie::IxHash',
333 #cust_main (remove paycvv from history, locations, cust_payby, etc)
336 #contact -> cust_contact / prospect_contact
342 #reason type and reasons
344 'cust_pkg_reason' => [],
346 #need part_pkg before cust_credit...
352 # reason / void_reason migration to reasonnum / void_reasonnum
353 'cust_credit_void' => [],
354 'cust_bill_void' => [],
355 'cust_bill_pkg_void' => [],
357 #duplicate history records
360 #populate cust_pay.otaker
363 #populate part_pkg_taxclass for starters
364 'part_pkg_taxclass' => [],
366 #remove bad pending records
367 'cust_pay_pending' => [],
369 #replace invnum and pkgnum with billpkgnum
370 'cust_bill_pkg_detail' => [],
372 #usage_classes if we have none
375 #phone_type if we have none
379 'access_right' => [],
381 #change recur_flat and enable_prorate
382 'part_pkg_option' => [],
384 #add weights to pkg_category
385 'pkg_category' => [],
391 'cust_attachment' => [],
392 #'cust_credit' => [],
394 'cust_main_note' => [],
396 'cust_pay_void' => [],
398 #'cust_pkg_reason' => [],
399 'cust_pkg_discount' => [],
404 'payment_gateway' => [],
406 #migrate to templates
407 'msg_template' => [],
409 #return unprovisioned numbers to availability
412 #insert scripcondition
413 'TicketSystem' => [],
415 #insert LATA data if not already present
418 #insert MSA data if not already present
421 # migrate to radius_group and groupnum instead of groupname
422 'radius_usergroup' => [],
426 #insert default tower_sector if not present
429 #repair improperly deleted services
433 'svc_broadband' => [],
435 #set up payment gateways if needed
438 #flag monthly tax exemptions
439 'cust_tax_exempt_pkg' => [],
441 #kick off tax location history upgrade
442 'cust_bill_pkg' => [],
444 #fix taxable line item links
445 'cust_bill_pkg_tax_location' => [],
447 #populate state FIPS codes if not already done
450 #set default locations on quoted packages
451 'quotation_pkg' => [],
453 #populate tax statuses
468 my $data = upgrade_schema_data(%opt);
470 my $oldAutoCommit = $FS::UID::AutoCommit;
471 local $FS::UID::AutoCommit = 0;
472 local $FS::UID::AutoCommit = 0;
474 foreach my $table ( keys %$data ) {
476 my $class = "FS::$table";
480 if ( $class->can('_upgrade_schema') ) {
481 warn "Upgrading $table schema...\n";
485 $class->_upgrade_schema(%opt);
487 if ( $oldAutoCommit ) {
488 warn " committing\n";
489 dbh->commit or die dbh->errstr;
492 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
493 warn " done in ". (time-$start). " seconds\n";
496 warn "WARNING: asked for schema upgrade of $table,".
497 " but FS::$table has no _upgrade_schema method\n";
504 =item upgrade_schema_data
508 sub upgrade_schema_data {
511 tie my %hash, 'Tie::IxHash',
513 #fix classnum character(1)
514 'cust_bill_pkg_detail' => [],
515 #add necessary columns to RT schema
516 'TicketSystem' => [],
524 sub upgrade_sqlradius {
527 my $conf = new FS::Conf;
529 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
531 foreach my $part_export ( @part_export ) {
533 my $errmsg = 'Error adding FreesideStatus to '.
534 $part_export->option('datasrc'). ': ';
536 my $dbh = DBI->connect(
537 ( map $part_export->option($_), qw ( datasrc username password ) ),
538 { PrintError => 0, PrintWarn => 0 }
540 warn $errmsg.$DBI::errstr;
544 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
545 my $group = "UserName";
547 if ref($part_export) =~ /withdomain/
548 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
550 my $sth_alter = $dbh->prepare(
551 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
554 if ( $sth_alter->execute ) {
555 my $sth_update = $dbh->prepare(
556 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
557 ) or die $errmsg.$dbh->errstr;
558 $sth_update->execute or die $errmsg.$sth_update->errstr;
560 my $error = $sth_alter->errstr;
562 unless $error =~ /Duplicate column name/i #mysql
563 || $error =~ /already exists/i; #Pg
567 my $error = $dbh->errstr;
568 warn $errmsg.$error; #unless $error =~ /exists/i;
571 my $sth_index = $dbh->prepare(
572 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
575 unless ( $sth_index->execute ) {
576 my $error = $sth_index->errstr;
578 unless $error =~ /Duplicate key name/i #mysql
579 || $error =~ /already exists/i; #Pg
582 my $error = $dbh->errstr;
583 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
586 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
587 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
588 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
590 my $sth = $dbh->prepare("SELECT UserName,
592 $str2time max(AcctStartTime)),
593 $str2time max(AcctStopTime))
595 WHERE FreesideStatus = 'done'
599 or die $errmsg.$dbh->errstr;
600 $sth->execute() or die $errmsg.$sth->errstr;
602 while (my $row = $sth->fetchrow_arrayref ) {
603 my ($username, $realm, $start, $stop) = @$row;
605 $username = lc($username) unless $conf->exists('username-uppercase');
607 my $exportnum = $part_export->exportnum;
608 my $extra_sql = " AND exportnum = $exportnum ".
609 " AND exportsvcnum IS NOT NULL ";
611 if ( ref($part_export) =~ /withdomain/ ) {
612 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
613 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
616 my $svc_acct = qsearchs({
617 'select' => 'svc_acct.*',
618 'table' => 'svc_acct',
619 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
620 'LEFT JOIN export_svc USING ( svcpart )',
621 'hashref' => { 'username' => $username },
622 'extra_sql' => $extra_sql,
626 $svc_acct->last_login($start)
627 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
628 $svc_acct->last_logout($stop)
629 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);