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 upgrade_overlimit_groups($conf);
67 map { upgrade_overlimit_groups($conf,$_->agentnum) } qsearch('agent', {});
69 my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
70 $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
71 foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
72 qw( quotation_html quotation_latex quotation_latexnotes );
74 # change 'fslongtable' to 'longtable'
75 # in invoice and quotation main templates, and also in all secondary
78 qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
80 foreach my $c (@latex_confs) {
81 my $value = $c->value;
82 if (length($value) and $value =~ /fslongtable/) {
83 $value =~ s/fslongtable/longtable/g;
84 $conf->set($c->name, $value, $c->agentnum);
88 # if there's a USPS tools login, assume that's the standardization method
90 $conf->set('address_standardize_method', 'usps')
91 if $conf->exists('usps_webtools-userid')
92 && length($conf->config('usps_webtools-userid')) > 0
93 && ! $conf->exists('address_standardize_method');
95 # this option has been renamed/expanded
96 if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
97 $conf->touch('cust_main-enable_spouse');
98 $conf->delete('cust_main-enable_spouse_birthdate');
102 if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
103 $conf->touch('part_pkg-show_fcc_options');
104 $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
106 You have FCC Form 477 package options enabled.
108 Starting with the October 2014 filing date, the FCC has redesigned
109 Form 477 and introduced new service categories. See bin/convert-477-options
110 to update your package configuration for the new report.
112 If you need to continue using the old Form 477 report, turn on the
113 'old_fcc_report' configuration option.
117 # boolean invoice_sections_by_location option is now
118 # invoice_sections_method = 'location'
119 my @invoice_sections_confs =
120 qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
121 foreach my $c (@invoice_sections_confs) {
122 $c->name =~ /^(\w+)sections_by_location$/;
123 $conf->delete($c->name);
124 my $newname = $1.'sections_method';
125 $conf->set($newname, 'location');
128 # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
129 if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
130 $conf->set('tax-cust_exempt-groups-num_req', 'all');
131 $conf->delete('tax-cust_exempt-groups-require_individual_nums');
136 sub upgrade_overlimit_groups {
138 my $agentnum = shift;
139 my @groups = $conf->config('overlimit_groups',$agentnum);
140 if(scalar(@groups)) {
141 my $groups = join(',',@groups);
144 if ( $groups !~ /^[\d,]+$/ ) {
145 foreach my $groupname ( @groups ) {
146 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
148 $g = new FS::radius_group {
149 'groupname' => $groupname,
150 'description' => $groupname,
153 die $error if $error;
155 push @groupnums, $g->groupnum;
157 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
169 my $data = upgrade_data(%opt);
171 my $oldAutoCommit = $FS::UID::AutoCommit;
172 local $FS::UID::AutoCommit = 0;
173 local $FS::UID::AutoCommit = 0;
175 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
178 foreach my $table ( keys %$data ) {
180 my $class = "FS::$table";
184 if ( $class->can('_upgrade_data') ) {
185 warn "Upgrading $table...\n";
189 $class->_upgrade_data(%opt);
191 # New interface for async upgrades: a class can declare a
192 # "queueable_upgrade" method, which will run as part of the normal
193 # upgrade, but if the -j option is passed, will instead be run from
195 if ( $class->can('queueable_upgrade') ) {
196 my $jobname = $class . '::queueable_upgrade';
197 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
199 warn "$class upgrade already scheduled.\n";
201 if ( $opt{'queue'} ) {
202 warn "Scheduling $class upgrade.\n";
203 my $job = FS::queue->new({ job => $jobname });
204 $job->insert($class, %opt);
206 $class->queueable_upgrade(%opt);
211 if ( $oldAutoCommit ) {
212 warn " committing\n";
213 dbh->commit or die dbh->errstr;
216 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
217 warn " done in ". (time-$start). " seconds\n";
220 warn "WARNING: asked for upgrade of $table,".
221 " but FS::$table has no _upgrade_data method\n";
224 # my @records = @{ $data->{$table} };
226 # foreach my $record ( @records ) {
227 # my $args = delete($record->{'_upgrade_args'}) || [];
228 # my $object = $class->new( $record );
229 # my $error = $object->insert( @$args );
230 # die "error inserting record into $table: $error\n"
236 local($FS::cust_main::ignore_expired_card) = 1;
237 local($FS::cust_main::ignore_illegal_zip) = 1;
238 local($FS::cust_main::ignore_banned_card) = 1;
239 local($FS::cust_main::skip_fuzzyfiles) = 1;
241 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
242 # kind of a weird spot for this, but it's better than duplicating
243 # all this code in each class...
244 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
245 foreach my $table ( @decrypt_tables ) {
246 my @objects = qsearch({
249 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
250 " AND LENGTH(payinfo) > 100",
252 foreach my $object ( @objects ) {
253 my $payinfo = $object->decrypt($object->payinfo);
254 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
255 $object->payinfo($payinfo);
256 my $error = $object->replace;
257 die $error if $error;
270 tie my %hash, 'Tie::IxHash',
272 #cust_main (remove paycvv from history)
278 #reason type and reasons
280 'cust_pkg_reason' => [],
282 #need part_pkg before cust_credit...
288 #duplicate history records
291 #populate cust_pay.otaker
294 #populate part_pkg_taxclass for starters
295 'part_pkg_taxclass' => [],
297 #remove bad pending records
298 'cust_pay_pending' => [],
300 #replace invnum and pkgnum with billpkgnum
301 'cust_bill_pkg_detail' => [],
303 #usage_classes if we have none
306 #phone_type if we have none
310 'access_right' => [],
312 #change recur_flat and enable_prorate
313 'part_pkg_option' => [],
315 #add weights to pkg_category
316 'pkg_category' => [],
322 'cust_attachment' => [],
323 #'cust_credit' => [],
325 'cust_main_note' => [],
327 'cust_pay_void' => [],
329 #'cust_pkg_reason' => [],
330 'cust_pkg_discount' => [],
335 'payment_gateway' => [],
337 #migrate to templates
338 'msg_template' => [],
340 #return unprovisioned numbers to availability
343 #insert scripcondition
344 'TicketSystem' => [],
346 #insert LATA data if not already present
349 #insert MSA data if not already present
352 # migrate to radius_group and groupnum instead of groupname
353 'radius_usergroup' => [],
357 #insert default tower_sector if not present
360 #repair improperly deleted services
364 'svc_broadband' => [],
366 #set up payment gateways if needed
369 #flag monthly tax exemptions
370 'cust_tax_exempt_pkg' => [],
372 #kick off tax location history upgrade
373 'cust_bill_pkg' => [],
375 #fix taxable line item links
376 'cust_bill_pkg_tax_location' => [],
378 #populate state FIPS codes if not already done
393 my $data = upgrade_schema_data(%opt);
395 my $oldAutoCommit = $FS::UID::AutoCommit;
396 local $FS::UID::AutoCommit = 0;
397 local $FS::UID::AutoCommit = 0;
399 foreach my $table ( keys %$data ) {
401 my $class = "FS::$table";
405 if ( $class->can('_upgrade_schema') ) {
406 warn "Upgrading $table schema...\n";
410 $class->_upgrade_schema(%opt);
412 if ( $oldAutoCommit ) {
413 warn " committing\n";
414 dbh->commit or die dbh->errstr;
417 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
418 warn " done in ". (time-$start). " seconds\n";
421 warn "WARNING: asked for schema upgrade of $table,".
422 " but FS::$table has no _upgrade_schema method\n";
429 =item upgrade_schema_data
433 sub upgrade_schema_data {
436 tie my %hash, 'Tie::IxHash',
438 #fix classnum character(1)
439 'cust_bill_pkg_detail' => [],
440 #add necessary columns to RT schema
441 'TicketSystem' => [],
449 sub upgrade_sqlradius {
452 my $conf = new FS::Conf;
454 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
456 foreach my $part_export ( @part_export ) {
458 my $errmsg = 'Error adding FreesideStatus to '.
459 $part_export->option('datasrc'). ': ';
461 my $dbh = DBI->connect(
462 ( map $part_export->option($_), qw ( datasrc username password ) ),
463 { PrintError => 0, PrintWarn => 0 }
465 warn $errmsg.$DBI::errstr;
469 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
470 my $group = "UserName";
472 if ref($part_export) =~ /withdomain/
473 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
475 my $sth_alter = $dbh->prepare(
476 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
479 if ( $sth_alter->execute ) {
480 my $sth_update = $dbh->prepare(
481 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
482 ) or die $errmsg.$dbh->errstr;
483 $sth_update->execute or die $errmsg.$sth_update->errstr;
485 my $error = $sth_alter->errstr;
487 unless $error =~ /Duplicate column name/i #mysql
488 || $error =~ /already exists/i; #Pg
492 my $error = $dbh->errstr;
493 warn $errmsg.$error; #unless $error =~ /exists/i;
496 my $sth_index = $dbh->prepare(
497 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
500 unless ( $sth_index->execute ) {
501 my $error = $sth_index->errstr;
503 unless $error =~ /Duplicate key name/i #mysql
504 || $error =~ /already exists/i; #Pg
507 my $error = $dbh->errstr;
508 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
511 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
512 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
513 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
515 my $sth = $dbh->prepare("SELECT UserName,
517 $str2time max(AcctStartTime)),
518 $str2time max(AcctStopTime))
520 WHERE FreesideStatus = 'done'
524 or die $errmsg.$dbh->errstr;
525 $sth->execute() or die $errmsg.$sth->errstr;
527 while (my $row = $sth->fetchrow_arrayref ) {
528 my ($username, $realm, $start, $stop) = @$row;
530 $username = lc($username) unless $conf->exists('username-uppercase');
532 my $exportnum = $part_export->exportnum;
533 my $extra_sql = " AND exportnum = $exportnum ".
534 " AND exportsvcnum IS NOT NULL ";
536 if ( ref($part_export) =~ /withdomain/ ) {
537 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
538 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
541 my $svc_acct = qsearchs({
542 'select' => 'svc_acct.*',
543 'table' => 'svc_acct',
544 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
545 'LEFT JOIN export_svc USING ( svcpart )',
546 'hashref' => { 'username' => $username },
547 'extra_sql' => $extra_sql,
551 $svc_acct->last_login($start)
552 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
553 $svc_acct->last_logout($stop)
554 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);