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 enable_taxproducts is now enable_taxproducts = 'cch'
129 if ( $conf->exists('enable_taxproducts') and
130 $conf->config('enable_taxproducts') eq '' ) {
132 $conf->set('enable_taxproducts', 'cch');
138 sub upgrade_overlimit_groups {
140 my $agentnum = shift;
141 my @groups = $conf->config('overlimit_groups',$agentnum);
142 if(scalar(@groups)) {
143 my $groups = join(',',@groups);
146 if ( $groups !~ /^[\d,]+$/ ) {
147 foreach my $groupname ( @groups ) {
148 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
150 $g = new FS::radius_group {
151 'groupname' => $groupname,
152 'description' => $groupname,
155 die $error if $error;
157 push @groupnums, $g->groupnum;
159 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
171 my $data = upgrade_data(%opt);
173 my $oldAutoCommit = $FS::UID::AutoCommit;
174 local $FS::UID::AutoCommit = 0;
175 local $FS::UID::AutoCommit = 0;
177 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
180 foreach my $table ( keys %$data ) {
182 my $class = "FS::$table";
186 if ( $class->can('_upgrade_data') ) {
187 warn "Upgrading $table...\n";
191 $class->_upgrade_data(%opt);
193 # New interface for async upgrades: a class can declare a
194 # "queueable_upgrade" method, which will run as part of the normal
195 # upgrade, but if the -j option is passed, will instead be run from
197 if ( $class->can('queueable_upgrade') ) {
198 my $jobname = $class . '::queueable_upgrade';
199 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
201 warn "$class upgrade already scheduled.\n";
203 if ( $opt{'queue'} ) {
204 warn "Scheduling $class upgrade.\n";
205 my $job = FS::queue->new({ job => $jobname });
206 $job->insert($class, %opt);
208 $class->queueable_upgrade(%opt);
213 if ( $oldAutoCommit ) {
214 warn " committing\n";
215 dbh->commit or die dbh->errstr;
218 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
219 warn " done in ". (time-$start). " seconds\n";
222 warn "WARNING: asked for upgrade of $table,".
223 " but FS::$table has no _upgrade_data method\n";
226 # my @records = @{ $data->{$table} };
228 # foreach my $record ( @records ) {
229 # my $args = delete($record->{'_upgrade_args'}) || [];
230 # my $object = $class->new( $record );
231 # my $error = $object->insert( @$args );
232 # die "error inserting record into $table: $error\n"
238 local($FS::cust_main::ignore_expired_card) = 1;
239 local($FS::cust_main::ignore_illegal_zip) = 1;
240 local($FS::cust_main::ignore_banned_card) = 1;
241 local($FS::cust_main::skip_fuzzyfiles) = 1;
243 local($FS::cust_payby::ignore_expired_card) = 1;
244 local($FS::cust_payby::ignore_banned_card) = 1;
246 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
247 # kind of a weird spot for this, but it's better than duplicating
248 # all this code in each class...
249 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
250 foreach my $table ( @decrypt_tables ) {
251 my @objects = qsearch({
254 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
255 " AND LENGTH(payinfo) > 100",
257 foreach my $object ( @objects ) {
258 my $payinfo = $object->decrypt($object->payinfo);
259 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
260 $object->payinfo($payinfo);
261 my $error = $object->replace;
262 die $error if $error;
275 tie my %hash, 'Tie::IxHash',
277 #cust_main (remove paycvv from history)
283 #reason type and reasons
285 'cust_pkg_reason' => [],
287 #need part_pkg before cust_credit...
293 #duplicate history records
296 #populate cust_pay.otaker
299 #populate part_pkg_taxclass for starters
300 'part_pkg_taxclass' => [],
302 #remove bad pending records
303 'cust_pay_pending' => [],
305 #replace invnum and pkgnum with billpkgnum
306 'cust_bill_pkg_detail' => [],
308 #usage_classes if we have none
311 #phone_type if we have none
315 'access_right' => [],
317 #change recur_flat and enable_prorate
318 'part_pkg_option' => [],
320 #add weights to pkg_category
321 'pkg_category' => [],
327 'cust_attachment' => [],
328 #'cust_credit' => [],
330 'cust_main_note' => [],
332 'cust_pay_void' => [],
334 #'cust_pkg_reason' => [],
335 'cust_pkg_discount' => [],
340 'payment_gateway' => [],
342 #migrate to templates
343 'msg_template' => [],
345 #return unprovisioned numbers to availability
348 #insert scripcondition
349 'TicketSystem' => [],
351 #insert LATA data if not already present
354 #insert MSA data if not already present
357 # migrate to radius_group and groupnum instead of groupname
358 'radius_usergroup' => [],
362 #insert default tower_sector if not present
365 #repair improperly deleted services
369 'svc_broadband' => [],
371 #set up payment gateways if needed
374 #flag monthly tax exemptions
375 'cust_tax_exempt_pkg' => [],
377 #kick off tax location history upgrade
378 'cust_bill_pkg' => [],
380 #fix taxable line item links
381 'cust_bill_pkg_tax_location' => [],
383 #populate state FIPS codes if not already done
386 #populate tax statuses
401 my $data = upgrade_schema_data(%opt);
403 my $oldAutoCommit = $FS::UID::AutoCommit;
404 local $FS::UID::AutoCommit = 0;
405 local $FS::UID::AutoCommit = 0;
407 foreach my $table ( keys %$data ) {
409 my $class = "FS::$table";
413 if ( $class->can('_upgrade_schema') ) {
414 warn "Upgrading $table schema...\n";
418 $class->_upgrade_schema(%opt);
420 if ( $oldAutoCommit ) {
421 warn " committing\n";
422 dbh->commit or die dbh->errstr;
425 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
426 warn " done in ". (time-$start). " seconds\n";
429 warn "WARNING: asked for schema upgrade of $table,".
430 " but FS::$table has no _upgrade_schema method\n";
437 =item upgrade_schema_data
441 sub upgrade_schema_data {
444 tie my %hash, 'Tie::IxHash',
446 #fix classnum character(1)
447 'cust_bill_pkg_detail' => [],
448 #add necessary columns to RT schema
449 'TicketSystem' => [],
457 sub upgrade_sqlradius {
460 my $conf = new FS::Conf;
462 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
464 foreach my $part_export ( @part_export ) {
466 my $errmsg = 'Error adding FreesideStatus to '.
467 $part_export->option('datasrc'). ': ';
469 my $dbh = DBI->connect(
470 ( map $part_export->option($_), qw ( datasrc username password ) ),
471 { PrintError => 0, PrintWarn => 0 }
473 warn $errmsg.$DBI::errstr;
477 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
478 my $group = "UserName";
480 if ref($part_export) =~ /withdomain/
481 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
483 my $sth_alter = $dbh->prepare(
484 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
487 if ( $sth_alter->execute ) {
488 my $sth_update = $dbh->prepare(
489 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
490 ) or die $errmsg.$dbh->errstr;
491 $sth_update->execute or die $errmsg.$sth_update->errstr;
493 my $error = $sth_alter->errstr;
495 unless $error =~ /Duplicate column name/i #mysql
496 || $error =~ /already exists/i; #Pg
500 my $error = $dbh->errstr;
501 warn $errmsg.$error; #unless $error =~ /exists/i;
504 my $sth_index = $dbh->prepare(
505 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
508 unless ( $sth_index->execute ) {
509 my $error = $sth_index->errstr;
511 unless $error =~ /Duplicate key name/i #mysql
512 || $error =~ /already exists/i; #Pg
515 my $error = $dbh->errstr;
516 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
519 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
520 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
521 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
523 my $sth = $dbh->prepare("SELECT UserName,
525 $str2time max(AcctStartTime)),
526 $str2time max(AcctStopTime))
528 WHERE FreesideStatus = 'done'
532 or die $errmsg.$dbh->errstr;
533 $sth->execute() or die $errmsg.$sth->errstr;
535 while (my $row = $sth->fetchrow_arrayref ) {
536 my ($username, $realm, $start, $stop) = @$row;
538 $username = lc($username) unless $conf->exists('username-uppercase');
540 my $exportnum = $part_export->exportnum;
541 my $extra_sql = " AND exportnum = $exportnum ".
542 " AND exportsvcnum IS NOT NULL ";
544 if ( ref($part_export) =~ /withdomain/ ) {
545 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
546 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
549 my $svc_acct = qsearchs({
550 'select' => 'svc_acct.*',
551 'table' => 'svc_acct',
552 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
553 'LEFT JOIN export_svc USING ( svcpart )',
554 'hashref' => { 'username' => $username },
555 'extra_sql' => $extra_sql,
559 $svc_acct->last_login($start)
560 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
561 $svc_acct->last_logout($stop)
562 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);