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');
130 sub upgrade_overlimit_groups {
132 my $agentnum = shift;
133 my @groups = $conf->config('overlimit_groups',$agentnum);
134 if(scalar(@groups)) {
135 my $groups = join(',',@groups);
138 if ( $groups !~ /^[\d,]+$/ ) {
139 foreach my $groupname ( @groups ) {
140 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
142 $g = new FS::radius_group {
143 'groupname' => $groupname,
144 'description' => $groupname,
147 die $error if $error;
149 push @groupnums, $g->groupnum;
151 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
163 my $data = upgrade_data(%opt);
165 my $oldAutoCommit = $FS::UID::AutoCommit;
166 local $FS::UID::AutoCommit = 0;
167 local $FS::UID::AutoCommit = 0;
169 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
172 foreach my $table ( keys %$data ) {
174 my $class = "FS::$table";
178 if ( $class->can('_upgrade_data') ) {
179 warn "Upgrading $table...\n";
183 $class->_upgrade_data(%opt);
185 # New interface for async upgrades: a class can declare a
186 # "queueable_upgrade" method, which will run as part of the normal
187 # upgrade, but if the -j option is passed, will instead be run from
189 if ( $class->can('queueable_upgrade') ) {
190 my $jobname = $class . '::queueable_upgrade';
191 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
193 warn "$class upgrade already scheduled.\n";
195 if ( $opt{'queue'} ) {
196 warn "Scheduling $class upgrade.\n";
197 my $job = FS::queue->new({ job => $jobname });
198 $job->insert($class, %opt);
200 $class->queueable_upgrade(%opt);
205 if ( $oldAutoCommit ) {
206 warn " committing\n";
207 dbh->commit or die dbh->errstr;
210 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
211 warn " done in ". (time-$start). " seconds\n";
214 warn "WARNING: asked for upgrade of $table,".
215 " but FS::$table has no _upgrade_data method\n";
218 # my @records = @{ $data->{$table} };
220 # foreach my $record ( @records ) {
221 # my $args = delete($record->{'_upgrade_args'}) || [];
222 # my $object = $class->new( $record );
223 # my $error = $object->insert( @$args );
224 # die "error inserting record into $table: $error\n"
230 local($FS::cust_main::ignore_expired_card) = 1;
231 local($FS::cust_main::ignore_illegal_zip) = 1;
232 local($FS::cust_main::ignore_banned_card) = 1;
233 local($FS::cust_main::skip_fuzzyfiles) = 1;
235 local($FS::cust_payby::ignore_expired_card) = 1;
236 local($FS::cust_payby::ignore_banned_card) = 1;
238 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
239 # kind of a weird spot for this, but it's better than duplicating
240 # all this code in each class...
241 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
242 foreach my $table ( @decrypt_tables ) {
243 my @objects = qsearch({
246 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
247 " AND LENGTH(payinfo) > 100",
249 foreach my $object ( @objects ) {
250 my $payinfo = $object->decrypt($object->payinfo);
251 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
252 $object->payinfo($payinfo);
253 my $error = $object->replace;
254 die $error if $error;
267 tie my %hash, 'Tie::IxHash',
269 #cust_main (remove paycvv from history)
275 #reason type and reasons
277 'cust_pkg_reason' => [],
279 #need part_pkg before cust_credit...
285 #duplicate history records
288 #populate cust_pay.otaker
291 #populate part_pkg_taxclass for starters
292 'part_pkg_taxclass' => [],
294 #remove bad pending records
295 'cust_pay_pending' => [],
297 #replace invnum and pkgnum with billpkgnum
298 'cust_bill_pkg_detail' => [],
300 #usage_classes if we have none
303 #phone_type if we have none
307 'access_right' => [],
309 #change recur_flat and enable_prorate
310 'part_pkg_option' => [],
312 #add weights to pkg_category
313 'pkg_category' => [],
319 'cust_attachment' => [],
320 #'cust_credit' => [],
322 'cust_main_note' => [],
324 'cust_pay_void' => [],
326 #'cust_pkg_reason' => [],
327 'cust_pkg_discount' => [],
332 'payment_gateway' => [],
334 #migrate to templates
335 'msg_template' => [],
337 #return unprovisioned numbers to availability
340 #insert scripcondition
341 'TicketSystem' => [],
343 #insert LATA data if not already present
346 #insert MSA data if not already present
349 # migrate to radius_group and groupnum instead of groupname
350 'radius_usergroup' => [],
354 #insert default tower_sector if not present
357 #repair improperly deleted services
361 'svc_broadband' => [],
363 #set up payment gateways if needed
366 #flag monthly tax exemptions
367 'cust_tax_exempt_pkg' => [],
369 #kick off tax location history upgrade
370 'cust_bill_pkg' => [],
372 #fix taxable line item links
373 'cust_bill_pkg_tax_location' => [],
375 #populate state FIPS codes if not already done
390 my $data = upgrade_schema_data(%opt);
392 my $oldAutoCommit = $FS::UID::AutoCommit;
393 local $FS::UID::AutoCommit = 0;
394 local $FS::UID::AutoCommit = 0;
396 foreach my $table ( keys %$data ) {
398 my $class = "FS::$table";
402 if ( $class->can('_upgrade_schema') ) {
403 warn "Upgrading $table schema...\n";
407 $class->_upgrade_schema(%opt);
409 if ( $oldAutoCommit ) {
410 warn " committing\n";
411 dbh->commit or die dbh->errstr;
414 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
415 warn " done in ". (time-$start). " seconds\n";
418 warn "WARNING: asked for schema upgrade of $table,".
419 " but FS::$table has no _upgrade_schema method\n";
426 =item upgrade_schema_data
430 sub upgrade_schema_data {
433 tie my %hash, 'Tie::IxHash',
435 #fix classnum character(1)
436 'cust_bill_pkg_detail' => [],
437 #add necessary columns to RT schema
438 'TicketSystem' => [],
446 sub upgrade_sqlradius {
449 my $conf = new FS::Conf;
451 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
453 foreach my $part_export ( @part_export ) {
455 my $errmsg = 'Error adding FreesideStatus to '.
456 $part_export->option('datasrc'). ': ';
458 my $dbh = DBI->connect(
459 ( map $part_export->option($_), qw ( datasrc username password ) ),
460 { PrintError => 0, PrintWarn => 0 }
462 warn $errmsg.$DBI::errstr;
466 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
467 my $group = "UserName";
469 if ref($part_export) =~ /withdomain/
470 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
472 my $sth_alter = $dbh->prepare(
473 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
476 if ( $sth_alter->execute ) {
477 my $sth_update = $dbh->prepare(
478 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
479 ) or die $errmsg.$dbh->errstr;
480 $sth_update->execute or die $errmsg.$sth_update->errstr;
482 my $error = $sth_alter->errstr;
484 unless $error =~ /Duplicate column name/i #mysql
485 || $error =~ /already exists/i; #Pg
489 my $error = $dbh->errstr;
490 warn $errmsg.$error; #unless $error =~ /exists/i;
493 my $sth_index = $dbh->prepare(
494 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
497 unless ( $sth_index->execute ) {
498 my $error = $sth_index->errstr;
500 unless $error =~ /Duplicate key name/i #mysql
501 || $error =~ /already exists/i; #Pg
504 my $error = $dbh->errstr;
505 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
508 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
509 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
510 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
512 my $sth = $dbh->prepare("SELECT UserName,
514 $str2time max(AcctStartTime)),
515 $str2time max(AcctStopTime))
517 WHERE FreesideStatus = 'done'
521 or die $errmsg.$dbh->errstr;
522 $sth->execute() or die $errmsg.$sth->errstr;
524 while (my $row = $sth->fetchrow_arrayref ) {
525 my ($username, $realm, $start, $stop) = @$row;
527 $username = lc($username) unless $conf->exists('username-uppercase');
529 my $exportnum = $part_export->exportnum;
530 my $extra_sql = " AND exportnum = $exportnum ".
531 " AND exportsvcnum IS NOT NULL ";
533 if ( ref($part_export) =~ /withdomain/ ) {
534 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
535 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
538 my $svc_acct = qsearchs({
539 'select' => 'svc_acct.*',
540 'table' => 'svc_acct',
541 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
542 'LEFT JOIN export_svc USING ( svcpart )',
543 'hashref' => { 'username' => $username },
544 'extra_sql' => $extra_sql,
548 $svc_acct->last_login($start)
549 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
550 $svc_acct->last_logout($stop)
551 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);