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 enable_taxproducts = 'cch'
137 if ( $conf->exists('enable_taxproducts') and
138 $conf->config('enable_taxproducts') eq '' ) {
140 $conf->set('enable_taxproducts', '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 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
154 sub upgrade_overlimit_groups {
156 my $agentnum = shift;
157 my @groups = $conf->config('overlimit_groups',$agentnum);
158 if(scalar(@groups)) {
159 my $groups = join(',',@groups);
162 if ( $groups !~ /^[\d,]+$/ ) {
163 foreach my $groupname ( @groups ) {
164 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
166 $g = new FS::radius_group {
167 'groupname' => $groupname,
168 'description' => $groupname,
171 die $error if $error;
173 push @groupnums, $g->groupnum;
175 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
180 sub upgrade_invoice_from {
181 my ($conf, $agentnum, $agentonly) = @_;
183 (!$conf->exists('invoice_from_name',$agentnum,$agentonly)) &&
184 ($conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/)
187 $realemail =~ s/^\s*//; # remove leading spaces
188 $realemail =~ s/\s*$//; # remove trailing spaces
189 my $realname = $conf->config('invoice_from',$agentnum);
190 $realname =~ s/\<.*\>//; # remove email address
191 $realname =~ s/^\s*//; # remove leading spaces
192 $realname =~ s/\s*$//; # remove trailing spaces
193 # properly quote names that contain punctuation
194 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
195 $realname = '"' . $realname . '"';
197 $conf->set('invoice_from_name', $realname, $agentnum);
198 $conf->set('invoice_from', $realemail, $agentnum);
209 my $data = upgrade_data(%opt);
211 my $oldAutoCommit = $FS::UID::AutoCommit;
212 local $FS::UID::AutoCommit = 0;
213 local $FS::UID::AutoCommit = 0;
215 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
218 foreach my $table ( keys %$data ) {
220 my $class = "FS::$table";
224 if ( $class->can('_upgrade_data') ) {
225 warn "Upgrading $table...\n";
229 $class->_upgrade_data(%opt);
231 # New interface for async upgrades: a class can declare a
232 # "queueable_upgrade" method, which will run as part of the normal
233 # upgrade, but if the -j option is passed, will instead be run from
235 if ( $class->can('queueable_upgrade') ) {
236 my $jobname = $class . '::queueable_upgrade';
237 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
239 warn "$class upgrade already scheduled.\n";
241 if ( $opt{'queue'} ) {
242 warn "Scheduling $class upgrade.\n";
243 my $job = FS::queue->new({ job => $jobname });
244 $job->insert($class, %opt);
246 $class->queueable_upgrade(%opt);
251 if ( $oldAutoCommit ) {
252 warn " committing\n";
253 dbh->commit or die dbh->errstr;
256 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
257 warn " done in ". (time-$start). " seconds\n";
260 warn "WARNING: asked for upgrade of $table,".
261 " but FS::$table has no _upgrade_data method\n";
264 # my @records = @{ $data->{$table} };
266 # foreach my $record ( @records ) {
267 # my $args = delete($record->{'_upgrade_args'}) || [];
268 # my $object = $class->new( $record );
269 # my $error = $object->insert( @$args );
270 # die "error inserting record into $table: $error\n"
276 local($FS::cust_main::ignore_expired_card) = 1;
277 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
278 local($FS::cust_main::ignore_banned_card) = 1;
279 local($FS::cust_main::skip_fuzzyfiles) = 1;
281 local($FS::cust_payby::ignore_expired_card) = 1;
282 local($FS::cust_payby::ignore_banned_card) = 1;
284 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
285 # kind of a weird spot for this, but it's better than duplicating
286 # all this code in each class...
287 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
288 foreach my $table ( @decrypt_tables ) {
289 my @objects = qsearch({
292 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
293 " AND LENGTH(payinfo) > 100",
295 foreach my $object ( @objects ) {
296 my $payinfo = $object->decrypt($object->payinfo);
297 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
298 $object->payinfo($payinfo);
299 my $error = $object->replace;
300 die $error if $error;
313 tie my %hash, 'Tie::IxHash',
315 #payby conditions to new ones
316 'part_event_condition' => [],
318 #payby actions to new ones
321 #cust_main (remove paycvv from history, locations, cust_payby, etc)
324 #contact -> cust_contact / prospect_contact
330 #reason type and reasons
332 'cust_pkg_reason' => [],
334 #need part_pkg before cust_credit...
340 #duplicate history records
343 #populate cust_pay.otaker
346 #populate part_pkg_taxclass for starters
347 'part_pkg_taxclass' => [],
349 #remove bad pending records
350 'cust_pay_pending' => [],
352 #replace invnum and pkgnum with billpkgnum
353 'cust_bill_pkg_detail' => [],
355 #usage_classes if we have none
358 #phone_type if we have none
362 'access_right' => [],
364 #change recur_flat and enable_prorate
365 'part_pkg_option' => [],
367 #add weights to pkg_category
368 'pkg_category' => [],
374 'cust_attachment' => [],
375 #'cust_credit' => [],
377 'cust_main_note' => [],
379 'cust_pay_void' => [],
381 #'cust_pkg_reason' => [],
382 'cust_pkg_discount' => [],
387 'payment_gateway' => [],
389 #migrate to templates
390 'msg_template' => [],
392 #return unprovisioned numbers to availability
395 #insert scripcondition
396 'TicketSystem' => [],
398 #insert LATA data if not already present
401 #insert MSA data if not already present
404 # migrate to radius_group and groupnum instead of groupname
405 'radius_usergroup' => [],
409 #insert default tower_sector if not present
412 #repair improperly deleted services
416 'svc_broadband' => [],
418 #set up payment gateways if needed
421 #flag monthly tax exemptions
422 'cust_tax_exempt_pkg' => [],
424 #kick off tax location history upgrade
425 'cust_bill_pkg' => [],
427 #fix taxable line item links
428 'cust_bill_pkg_tax_location' => [],
430 #populate state FIPS codes if not already done
433 #set default locations on quoted packages
434 'quotation_pkg' => [],
436 #populate tax statuses
451 my $data = upgrade_schema_data(%opt);
453 my $oldAutoCommit = $FS::UID::AutoCommit;
454 local $FS::UID::AutoCommit = 0;
455 local $FS::UID::AutoCommit = 0;
457 foreach my $table ( keys %$data ) {
459 my $class = "FS::$table";
463 if ( $class->can('_upgrade_schema') ) {
464 warn "Upgrading $table schema...\n";
468 $class->_upgrade_schema(%opt);
470 if ( $oldAutoCommit ) {
471 warn " committing\n";
472 dbh->commit or die dbh->errstr;
475 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
476 warn " done in ". (time-$start). " seconds\n";
479 warn "WARNING: asked for schema upgrade of $table,".
480 " but FS::$table has no _upgrade_schema method\n";
487 =item upgrade_schema_data
491 sub upgrade_schema_data {
494 tie my %hash, 'Tie::IxHash',
496 #fix classnum character(1)
497 'cust_bill_pkg_detail' => [],
498 #add necessary columns to RT schema
499 'TicketSystem' => [],
507 sub upgrade_sqlradius {
510 my $conf = new FS::Conf;
512 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
514 foreach my $part_export ( @part_export ) {
516 my $errmsg = 'Error adding FreesideStatus to '.
517 $part_export->option('datasrc'). ': ';
519 my $dbh = DBI->connect(
520 ( map $part_export->option($_), qw ( datasrc username password ) ),
521 { PrintError => 0, PrintWarn => 0 }
523 warn $errmsg.$DBI::errstr;
527 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
528 my $group = "UserName";
530 if ref($part_export) =~ /withdomain/
531 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
533 my $sth_alter = $dbh->prepare(
534 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
537 if ( $sth_alter->execute ) {
538 my $sth_update = $dbh->prepare(
539 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
540 ) or die $errmsg.$dbh->errstr;
541 $sth_update->execute or die $errmsg.$sth_update->errstr;
543 my $error = $sth_alter->errstr;
545 unless $error =~ /Duplicate column name/i #mysql
546 || $error =~ /already exists/i; #Pg
550 my $error = $dbh->errstr;
551 warn $errmsg.$error; #unless $error =~ /exists/i;
554 my $sth_index = $dbh->prepare(
555 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
558 unless ( $sth_index->execute ) {
559 my $error = $sth_index->errstr;
561 unless $error =~ /Duplicate key name/i #mysql
562 || $error =~ /already exists/i; #Pg
565 my $error = $dbh->errstr;
566 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
569 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
570 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
571 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
573 my $sth = $dbh->prepare("SELECT UserName,
575 $str2time max(AcctStartTime)),
576 $str2time max(AcctStopTime))
578 WHERE FreesideStatus = 'done'
582 or die $errmsg.$dbh->errstr;
583 $sth->execute() or die $errmsg.$sth->errstr;
585 while (my $row = $sth->fetchrow_arrayref ) {
586 my ($username, $realm, $start, $stop) = @$row;
588 $username = lc($username) unless $conf->exists('username-uppercase');
590 my $exportnum = $part_export->exportnum;
591 my $extra_sql = " AND exportnum = $exportnum ".
592 " AND exportsvcnum IS NOT NULL ";
594 if ( ref($part_export) =~ /withdomain/ ) {
595 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
596 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
599 my $svc_acct = qsearchs({
600 'select' => 'svc_acct.*',
601 'table' => 'svc_acct',
602 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
603 'LEFT JOIN export_svc USING ( svcpart )',
604 'hashref' => { 'username' => $username },
605 'extra_sql' => $extra_sql,
609 $svc_acct->last_login($start)
610 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
611 $svc_acct->last_logout($stop)
612 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);