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;
15 $FS::svc_domain::whois_hack = 1;
17 @ISA = qw( Exporter );
18 @EXPORT_OK = qw( upgrade_schema upgrade_config upgrade upgrade_sqlradius );
24 FS::Upgrade - Database upgrade routines
32 Currently this module simply provides a place to store common subroutines for
47 my $conf = new FS::Conf;
49 $conf->touch('payment_receipt')
50 if $conf->exists('payment_receipt_email')
51 || $conf->config('payment_receipt_msgnum');
53 $conf->touch('geocode-require_nw_coordinates')
54 if $conf->exists('svc_broadband-require-nw-coordinates');
56 unless ( $conf->config('echeck-country') ) {
57 if ( $conf->exists('cust_main-require-bank-branch') ) {
58 $conf->set('echeck-country', 'CA');
59 } elsif ( $conf->exists('echeck-nonus') ) {
60 $conf->set('echeck-country', 'XX');
62 $conf->set('echeck-country', 'US');
66 my @agents = qsearch('agent', {});
68 upgrade_overlimit_groups($conf);
69 map { upgrade_overlimit_groups($conf,$_->agentnum) } @agents;
71 upgrade_invoice_from($conf);
72 foreach my $agent (@agents) {
73 upgrade_invoice_from($conf,$agent->agentnum);
76 my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
77 $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
78 foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
79 qw( quotation_html quotation_latex quotation_latexnotes );
81 # change 'fslongtable' to 'longtable'
82 # in invoice and quotation main templates, and also in all secondary
85 qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
87 foreach my $c (@latex_confs) {
88 my $value = $c->value;
89 if (length($value) and $value =~ /fslongtable/) {
90 $value =~ s/fslongtable/longtable/g;
91 $conf->set($c->name, $value, $c->agentnum);
95 # if there's a USPS tools login, assume that's the standardization method
97 $conf->set('address_standardize_method', 'usps')
98 if $conf->exists('usps_webtools-userid')
99 && length($conf->config('usps_webtools-userid')) > 0
100 && ! $conf->exists('address_standardize_method');
102 # this option has been renamed/expanded
103 if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
104 $conf->touch('cust_main-enable_spouse');
105 $conf->delete('cust_main-enable_spouse_birthdate');
109 if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
110 $conf->touch('part_pkg-show_fcc_options');
111 $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
113 You have FCC Form 477 package options enabled.
115 Starting with the October 2014 filing date, the FCC has redesigned
116 Form 477 and introduced new service categories. See bin/convert-477-options
117 to update your package configuration for the new report.
119 If you need to continue using the old Form 477 report, turn on the
120 'old_fcc_report' configuration option.
124 # boolean invoice_sections_by_location option is now
125 # invoice_sections_method = 'location'
126 my @invoice_sections_confs =
127 qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
128 foreach my $c (@invoice_sections_confs) {
129 $c->name =~ /^(\w+)sections_by_location$/;
130 $conf->delete($c->name);
131 my $newname = $1.'sections_method';
132 $conf->set($newname, 'location');
135 # boolean enable_taxproducts is now enable_taxproducts = 'cch'
136 if ( $conf->exists('enable_taxproducts') and
137 $conf->config('enable_taxproducts') eq '' ) {
139 $conf->set('enable_taxproducts', 'cch');
143 # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
144 if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
145 $conf->set('tax-cust_exempt-groups-num_req', 'all');
146 $conf->delete('tax-cust_exempt-groups-require_individual_nums');
151 sub upgrade_overlimit_groups {
153 my $agentnum = shift;
154 my @groups = $conf->config('overlimit_groups',$agentnum);
155 if(scalar(@groups)) {
156 my $groups = join(',',@groups);
159 if ( $groups !~ /^[\d,]+$/ ) {
160 foreach my $groupname ( @groups ) {
161 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
163 $g = new FS::radius_group {
164 'groupname' => $groupname,
165 'description' => $groupname,
168 die $error if $error;
170 push @groupnums, $g->groupnum;
172 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
177 sub upgrade_invoice_from {
178 my ($conf, $agentnum) = @_;
180 (!$conf->config('invoice_from_name',$agentnum)) &&
181 ($conf->config('invoice_from',$agentnum) =~ /\<(.*)\>/)
184 $realemail =~ s/^\s*//; # remove leading spaces
185 $realemail =~ s/\s*$//; # remove trailing spaces
186 my $realname = $conf->config('invoice_from',$agentnum);
187 $realname =~ s/\<.*\>//; # remove email address
188 $realname =~ s/^\s*//; # remove leading spaces
189 $realname =~ s/\s*$//; # remove trailing spaces
190 # properly quote names that contain punctuation
191 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
192 $realname = '"' . $realname . '"';
194 $conf->set('invoice_from_name', $realname, $agentnum);
195 $conf->set('invoice_from', $realemail, $agentnum);
206 my $data = upgrade_data(%opt);
208 my $oldAutoCommit = $FS::UID::AutoCommit;
209 local $FS::UID::AutoCommit = 0;
210 local $FS::UID::AutoCommit = 0;
212 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
215 foreach my $table ( keys %$data ) {
217 my $class = "FS::$table";
221 if ( $class->can('_upgrade_data') ) {
222 warn "Upgrading $table...\n";
226 $class->_upgrade_data(%opt);
228 # New interface for async upgrades: a class can declare a
229 # "queueable_upgrade" method, which will run as part of the normal
230 # upgrade, but if the -j option is passed, will instead be run from
232 if ( $class->can('queueable_upgrade') ) {
233 my $jobname = $class . '::queueable_upgrade';
234 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
236 warn "$class upgrade already scheduled.\n";
238 if ( $opt{'queue'} ) {
239 warn "Scheduling $class upgrade.\n";
240 my $job = FS::queue->new({ job => $jobname });
241 $job->insert($class, %opt);
243 $class->queueable_upgrade(%opt);
248 if ( $oldAutoCommit ) {
249 warn " committing\n";
250 dbh->commit or die dbh->errstr;
253 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
254 warn " done in ". (time-$start). " seconds\n";
257 warn "WARNING: asked for upgrade of $table,".
258 " but FS::$table has no _upgrade_data method\n";
261 # my @records = @{ $data->{$table} };
263 # foreach my $record ( @records ) {
264 # my $args = delete($record->{'_upgrade_args'}) || [];
265 # my $object = $class->new( $record );
266 # my $error = $object->insert( @$args );
267 # die "error inserting record into $table: $error\n"
273 local($FS::cust_main::ignore_expired_card) = 1;
274 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
275 local($FS::cust_main::ignore_banned_card) = 1;
276 local($FS::cust_main::skip_fuzzyfiles) = 1;
278 local($FS::cust_payby::ignore_expired_card) = 1;
279 local($FS::cust_payby::ignore_banned_card) = 1;
281 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
282 # kind of a weird spot for this, but it's better than duplicating
283 # all this code in each class...
284 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
285 foreach my $table ( @decrypt_tables ) {
286 my @objects = qsearch({
289 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
290 " AND LENGTH(payinfo) > 100",
292 foreach my $object ( @objects ) {
293 my $payinfo = $object->decrypt($object->payinfo);
294 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
295 $object->payinfo($payinfo);
296 my $error = $object->replace;
297 die $error if $error;
310 tie my %hash, 'Tie::IxHash',
312 #cust_main (remove paycvv from history)
318 #reason type and reasons
320 'cust_pkg_reason' => [],
322 #need part_pkg before cust_credit...
328 #duplicate history records
331 #populate cust_pay.otaker
334 #populate part_pkg_taxclass for starters
335 'part_pkg_taxclass' => [],
337 #remove bad pending records
338 'cust_pay_pending' => [],
340 #replace invnum and pkgnum with billpkgnum
341 'cust_bill_pkg_detail' => [],
343 #usage_classes if we have none
346 #phone_type if we have none
350 'access_right' => [],
352 #change recur_flat and enable_prorate
353 'part_pkg_option' => [],
355 #add weights to pkg_category
356 'pkg_category' => [],
362 'cust_attachment' => [],
363 #'cust_credit' => [],
365 'cust_main_note' => [],
367 'cust_pay_void' => [],
369 #'cust_pkg_reason' => [],
370 'cust_pkg_discount' => [],
375 'payment_gateway' => [],
377 #migrate to templates
378 'msg_template' => [],
380 #return unprovisioned numbers to availability
383 #insert scripcondition
384 'TicketSystem' => [],
386 #insert LATA data if not already present
389 #insert MSA data if not already present
392 # migrate to radius_group and groupnum instead of groupname
393 'radius_usergroup' => [],
397 #insert default tower_sector if not present
400 #repair improperly deleted services
404 'svc_broadband' => [],
406 #set up payment gateways if needed
409 #flag monthly tax exemptions
410 'cust_tax_exempt_pkg' => [],
412 #kick off tax location history upgrade
413 'cust_bill_pkg' => [],
415 #fix taxable line item links
416 'cust_bill_pkg_tax_location' => [],
418 #populate state FIPS codes if not already done
421 #populate tax statuses
436 my $data = upgrade_schema_data(%opt);
438 my $oldAutoCommit = $FS::UID::AutoCommit;
439 local $FS::UID::AutoCommit = 0;
440 local $FS::UID::AutoCommit = 0;
442 foreach my $table ( keys %$data ) {
444 my $class = "FS::$table";
448 if ( $class->can('_upgrade_schema') ) {
449 warn "Upgrading $table schema...\n";
453 $class->_upgrade_schema(%opt);
455 if ( $oldAutoCommit ) {
456 warn " committing\n";
457 dbh->commit or die dbh->errstr;
460 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
461 warn " done in ". (time-$start). " seconds\n";
464 warn "WARNING: asked for schema upgrade of $table,".
465 " but FS::$table has no _upgrade_schema method\n";
472 =item upgrade_schema_data
476 sub upgrade_schema_data {
479 tie my %hash, 'Tie::IxHash',
481 #fix classnum character(1)
482 'cust_bill_pkg_detail' => [],
483 #add necessary columns to RT schema
484 'TicketSystem' => [],
492 sub upgrade_sqlradius {
495 my $conf = new FS::Conf;
497 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
499 foreach my $part_export ( @part_export ) {
501 my $errmsg = 'Error adding FreesideStatus to '.
502 $part_export->option('datasrc'). ': ';
504 my $dbh = DBI->connect(
505 ( map $part_export->option($_), qw ( datasrc username password ) ),
506 { PrintError => 0, PrintWarn => 0 }
508 warn $errmsg.$DBI::errstr;
512 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
513 my $group = "UserName";
515 if ref($part_export) =~ /withdomain/
516 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
518 my $sth_alter = $dbh->prepare(
519 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
522 if ( $sth_alter->execute ) {
523 my $sth_update = $dbh->prepare(
524 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
525 ) or die $errmsg.$dbh->errstr;
526 $sth_update->execute or die $errmsg.$sth_update->errstr;
528 my $error = $sth_alter->errstr;
530 unless $error =~ /Duplicate column name/i #mysql
531 || $error =~ /already exists/i; #Pg
535 my $error = $dbh->errstr;
536 warn $errmsg.$error; #unless $error =~ /exists/i;
539 my $sth_index = $dbh->prepare(
540 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
543 unless ( $sth_index->execute ) {
544 my $error = $sth_index->errstr;
546 unless $error =~ /Duplicate key name/i #mysql
547 || $error =~ /already exists/i; #Pg
550 my $error = $dbh->errstr;
551 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
554 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
555 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
556 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
558 my $sth = $dbh->prepare("SELECT UserName,
560 $str2time max(AcctStartTime)),
561 $str2time max(AcctStopTime))
563 WHERE FreesideStatus = 'done'
567 or die $errmsg.$dbh->errstr;
568 $sth->execute() or die $errmsg.$sth->errstr;
570 while (my $row = $sth->fetchrow_arrayref ) {
571 my ($username, $realm, $start, $stop) = @$row;
573 $username = lc($username) unless $conf->exists('username-uppercase');
575 my $exportnum = $part_export->exportnum;
576 my $extra_sql = " AND exportnum = $exportnum ".
577 " AND exportsvcnum IS NOT NULL ";
579 if ( ref($part_export) =~ /withdomain/ ) {
580 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
581 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
584 my $svc_acct = qsearchs({
585 'select' => 'svc_acct.*',
586 'table' => 'svc_acct',
587 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
588 'LEFT JOIN export_svc USING ( svcpart )',
589 'hashref' => { 'username' => $username },
590 'extra_sql' => $extra_sql,
594 $svc_acct->last_login($start)
595 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
596 $svc_acct->last_logout($stop)
597 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);