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 tax_data_vendor = 'cch'
137 if ( $conf->exists('enable_taxproducts') ) {
139 $conf->delete('enable_taxproducts');
140 $conf->set('tax_data_vendor', '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 # boolean+text previous_balance-exclude_from_total is now two separate options
151 my $total_new_charges = $conf->config('previous_balance-exclude_from_total');
152 if (length($total_new_charges) > 0) {
153 $conf->set('previous_balance-text-total_new_charges', $total_new_charges);
154 $conf->set('previous_balance-exclude_from_total', '');
157 # switch from specifying an email address to boolean check
158 if ( $conf->exists('batch-errors_to') ) {
159 $conf->touch('batch-errors_not_fatal');
160 $conf->delete('batch-errors_to');
163 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
167 sub upgrade_overlimit_groups {
169 my $agentnum = shift;
170 my @groups = $conf->config('overlimit_groups',$agentnum);
171 if(scalar(@groups)) {
172 my $groups = join(',',@groups);
175 if ( $groups !~ /^[\d,]+$/ ) {
176 foreach my $groupname ( @groups ) {
177 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
179 $g = new FS::radius_group {
180 'groupname' => $groupname,
181 'description' => $groupname,
184 die $error if $error;
186 push @groupnums, $g->groupnum;
188 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
193 sub upgrade_invoice_from {
194 my ($conf, $agentnum, $agentonly) = @_;
196 (!$conf->exists('invoice_from_name',$agentnum,$agentonly)) &&
197 ($conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/)
200 $realemail =~ s/^\s*//; # remove leading spaces
201 $realemail =~ s/\s*$//; # remove trailing spaces
202 my $realname = $conf->config('invoice_from',$agentnum);
203 $realname =~ s/\<.*\>//; # remove email address
204 $realname =~ s/^\s*//; # remove leading spaces
205 $realname =~ s/\s*$//; # remove trailing spaces
206 # properly quote names that contain punctuation
207 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
208 $realname = '"' . $realname . '"';
210 $conf->set('invoice_from_name', $realname, $agentnum);
211 $conf->set('invoice_from', $realemail, $agentnum);
222 my $data = upgrade_data(%opt);
224 my $oldAutoCommit = $FS::UID::AutoCommit;
225 local $FS::UID::AutoCommit = 0;
226 local $FS::UID::AutoCommit = 0;
228 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
231 foreach my $table ( keys %$data ) {
233 my $class = "FS::$table";
237 if ( $class->can('_upgrade_data') ) {
238 warn "Upgrading $table...\n";
242 $class->_upgrade_data(%opt);
244 # New interface for async upgrades: a class can declare a
245 # "queueable_upgrade" method, which will run as part of the normal
246 # upgrade, but if the -j option is passed, will instead be run from
248 if ( $class->can('queueable_upgrade') ) {
249 my $jobname = $class . '::queueable_upgrade';
250 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
252 warn "$class upgrade already scheduled.\n";
254 if ( $opt{'queue'} ) {
255 warn "Scheduling $class upgrade.\n";
256 my $job = FS::queue->new({ job => $jobname });
257 $job->insert($class, %opt);
259 $class->queueable_upgrade(%opt);
264 if ( $oldAutoCommit ) {
265 warn " committing\n";
266 dbh->commit or die dbh->errstr;
269 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
270 warn " done in ". (time-$start). " seconds\n";
273 warn "WARNING: asked for upgrade of $table,".
274 " but FS::$table has no _upgrade_data method\n";
277 # my @records = @{ $data->{$table} };
279 # foreach my $record ( @records ) {
280 # my $args = delete($record->{'_upgrade_args'}) || [];
281 # my $object = $class->new( $record );
282 # my $error = $object->insert( @$args );
283 # die "error inserting record into $table: $error\n"
289 local($FS::cust_main::ignore_expired_card) = 1;
290 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
291 local($FS::cust_main::ignore_banned_card) = 1;
292 local($FS::cust_main::skip_fuzzyfiles) = 1;
294 local($FS::cust_payby::ignore_expired_card) = 1;
295 local($FS::cust_payby::ignore_banned_card) = 1;
297 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
298 # kind of a weird spot for this, but it's better than duplicating
299 # all this code in each class...
300 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
301 foreach my $table ( @decrypt_tables ) {
302 my @objects = qsearch({
305 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
306 " AND LENGTH(payinfo) > 100",
308 foreach my $object ( @objects ) {
309 my $payinfo = $object->decrypt($object->payinfo);
310 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
311 $object->payinfo($payinfo);
312 my $error = $object->replace;
313 die $error if $error;
326 tie my %hash, 'Tie::IxHash',
328 #payby conditions to new ones
329 'part_event_condition' => [],
331 #payby actions to new ones
334 #cust_main (remove paycvv from history, locations, cust_payby, etc)
337 #contact -> cust_contact / prospect_contact
343 #reason type and reasons
345 'cust_pkg_reason' => [],
347 #need part_pkg before cust_credit...
353 #duplicate history records
356 #populate cust_pay.otaker
359 #populate part_pkg_taxclass for starters
360 'part_pkg_taxclass' => [],
362 #remove bad pending records
363 'cust_pay_pending' => [],
365 #replace invnum and pkgnum with billpkgnum
366 'cust_bill_pkg_detail' => [],
368 #usage_classes if we have none
371 #phone_type if we have none
375 'access_right' => [],
377 #change recur_flat and enable_prorate
378 'part_pkg_option' => [],
380 #add weights to pkg_category
381 'pkg_category' => [],
387 'cust_attachment' => [],
388 #'cust_credit' => [],
390 'cust_main_note' => [],
392 'cust_pay_void' => [],
394 #'cust_pkg_reason' => [],
395 'cust_pkg_discount' => [],
400 'payment_gateway' => [],
402 #migrate to templates
403 'msg_template' => [],
405 #return unprovisioned numbers to availability
408 #insert scripcondition
409 'TicketSystem' => [],
411 #insert LATA data if not already present
414 #insert MSA data if not already present
417 # migrate to radius_group and groupnum instead of groupname
418 'radius_usergroup' => [],
422 #insert default tower_sector if not present
425 #repair improperly deleted services
429 'svc_broadband' => [],
431 #set up payment gateways if needed
434 #flag monthly tax exemptions
435 'cust_tax_exempt_pkg' => [],
437 #kick off tax location history upgrade
438 'cust_bill_pkg' => [],
440 #fix taxable line item links
441 'cust_bill_pkg_tax_location' => [],
443 #populate state FIPS codes if not already done
446 #set default locations on quoted packages
447 'quotation_pkg' => [],
449 #populate tax statuses
464 my $data = upgrade_schema_data(%opt);
466 my $oldAutoCommit = $FS::UID::AutoCommit;
467 local $FS::UID::AutoCommit = 0;
468 local $FS::UID::AutoCommit = 0;
470 foreach my $table ( keys %$data ) {
472 my $class = "FS::$table";
476 if ( $class->can('_upgrade_schema') ) {
477 warn "Upgrading $table schema...\n";
481 $class->_upgrade_schema(%opt);
483 if ( $oldAutoCommit ) {
484 warn " committing\n";
485 dbh->commit or die dbh->errstr;
488 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
489 warn " done in ". (time-$start). " seconds\n";
492 warn "WARNING: asked for schema upgrade of $table,".
493 " but FS::$table has no _upgrade_schema method\n";
500 =item upgrade_schema_data
504 sub upgrade_schema_data {
507 tie my %hash, 'Tie::IxHash',
509 #fix classnum character(1)
510 'cust_bill_pkg_detail' => [],
511 #add necessary columns to RT schema
512 'TicketSystem' => [],
520 sub upgrade_sqlradius {
523 my $conf = new FS::Conf;
525 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
527 foreach my $part_export ( @part_export ) {
529 my $errmsg = 'Error adding FreesideStatus to '.
530 $part_export->option('datasrc'). ': ';
532 my $dbh = DBI->connect(
533 ( map $part_export->option($_), qw ( datasrc username password ) ),
534 { PrintError => 0, PrintWarn => 0 }
536 warn $errmsg.$DBI::errstr;
540 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
541 my $group = "UserName";
543 if ref($part_export) =~ /withdomain/
544 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
546 my $sth_alter = $dbh->prepare(
547 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
550 if ( $sth_alter->execute ) {
551 my $sth_update = $dbh->prepare(
552 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
553 ) or die $errmsg.$dbh->errstr;
554 $sth_update->execute or die $errmsg.$sth_update->errstr;
556 my $error = $sth_alter->errstr;
558 unless $error =~ /Duplicate column name/i #mysql
559 || $error =~ /already exists/i; #Pg
563 my $error = $dbh->errstr;
564 warn $errmsg.$error; #unless $error =~ /exists/i;
567 my $sth_index = $dbh->prepare(
568 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
571 unless ( $sth_index->execute ) {
572 my $error = $sth_index->errstr;
574 unless $error =~ /Duplicate key name/i #mysql
575 || $error =~ /already exists/i; #Pg
578 my $error = $dbh->errstr;
579 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
582 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
583 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
584 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
586 my $sth = $dbh->prepare("SELECT UserName,
588 $str2time max(AcctStartTime)),
589 $str2time max(AcctStopTime))
591 WHERE FreesideStatus = 'done'
595 or die $errmsg.$dbh->errstr;
596 $sth->execute() or die $errmsg.$sth->errstr;
598 while (my $row = $sth->fetchrow_arrayref ) {
599 my ($username, $realm, $start, $stop) = @$row;
601 $username = lc($username) unless $conf->exists('username-uppercase');
603 my $exportnum = $part_export->exportnum;
604 my $extra_sql = " AND exportnum = $exportnum ".
605 " AND exportsvcnum IS NOT NULL ";
607 if ( ref($part_export) =~ /withdomain/ ) {
608 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
609 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
612 my $svc_acct = qsearchs({
613 'select' => 'svc_acct.*',
614 'table' => 'svc_acct',
615 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
616 'LEFT JOIN export_svc USING ( svcpart )',
617 'hashref' => { 'username' => $username },
618 'extra_sql' => $extra_sql,
622 $svc_acct->last_login($start)
623 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
624 $svc_acct->last_logout($stop)
625 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);