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 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
161 sub upgrade_overlimit_groups {
163 my $agentnum = shift;
164 my @groups = $conf->config('overlimit_groups',$agentnum);
165 if(scalar(@groups)) {
166 my $groups = join(',',@groups);
169 if ( $groups !~ /^[\d,]+$/ ) {
170 foreach my $groupname ( @groups ) {
171 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
173 $g = new FS::radius_group {
174 'groupname' => $groupname,
175 'description' => $groupname,
178 die $error if $error;
180 push @groupnums, $g->groupnum;
182 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
187 sub upgrade_invoice_from {
188 my ($conf, $agentnum, $agentonly) = @_;
190 (!$conf->exists('invoice_from_name',$agentnum,$agentonly)) &&
191 ($conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/)
194 $realemail =~ s/^\s*//; # remove leading spaces
195 $realemail =~ s/\s*$//; # remove trailing spaces
196 my $realname = $conf->config('invoice_from',$agentnum);
197 $realname =~ s/\<.*\>//; # remove email address
198 $realname =~ s/^\s*//; # remove leading spaces
199 $realname =~ s/\s*$//; # remove trailing spaces
200 # properly quote names that contain punctuation
201 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
202 $realname = '"' . $realname . '"';
204 $conf->set('invoice_from_name', $realname, $agentnum);
205 $conf->set('invoice_from', $realemail, $agentnum);
216 my $data = upgrade_data(%opt);
218 my $oldAutoCommit = $FS::UID::AutoCommit;
219 local $FS::UID::AutoCommit = 0;
220 local $FS::UID::AutoCommit = 0;
222 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
225 foreach my $table ( keys %$data ) {
227 my $class = "FS::$table";
231 if ( $class->can('_upgrade_data') ) {
232 warn "Upgrading $table...\n";
236 $class->_upgrade_data(%opt);
238 # New interface for async upgrades: a class can declare a
239 # "queueable_upgrade" method, which will run as part of the normal
240 # upgrade, but if the -j option is passed, will instead be run from
242 if ( $class->can('queueable_upgrade') ) {
243 my $jobname = $class . '::queueable_upgrade';
244 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
246 warn "$class upgrade already scheduled.\n";
248 if ( $opt{'queue'} ) {
249 warn "Scheduling $class upgrade.\n";
250 my $job = FS::queue->new({ job => $jobname });
251 $job->insert($class, %opt);
253 $class->queueable_upgrade(%opt);
258 if ( $oldAutoCommit ) {
259 warn " committing\n";
260 dbh->commit or die dbh->errstr;
263 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
264 warn " done in ". (time-$start). " seconds\n";
267 warn "WARNING: asked for upgrade of $table,".
268 " but FS::$table has no _upgrade_data method\n";
271 # my @records = @{ $data->{$table} };
273 # foreach my $record ( @records ) {
274 # my $args = delete($record->{'_upgrade_args'}) || [];
275 # my $object = $class->new( $record );
276 # my $error = $object->insert( @$args );
277 # die "error inserting record into $table: $error\n"
283 local($FS::cust_main::ignore_expired_card) = 1;
284 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
285 local($FS::cust_main::ignore_banned_card) = 1;
286 local($FS::cust_main::skip_fuzzyfiles) = 1;
288 local($FS::cust_payby::ignore_expired_card) = 1;
289 local($FS::cust_payby::ignore_banned_card) = 1;
291 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
292 # kind of a weird spot for this, but it's better than duplicating
293 # all this code in each class...
294 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
295 foreach my $table ( @decrypt_tables ) {
296 my @objects = qsearch({
299 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
300 " AND LENGTH(payinfo) > 100",
302 foreach my $object ( @objects ) {
303 my $payinfo = $object->decrypt($object->payinfo);
304 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
305 $object->payinfo($payinfo);
306 my $error = $object->replace;
307 die $error if $error;
320 tie my %hash, 'Tie::IxHash',
322 #payby conditions to new ones
323 'part_event_condition' => [],
325 #payby actions to new ones
328 #cust_main (remove paycvv from history, locations, cust_payby, etc)
331 #contact -> cust_contact / prospect_contact
337 #reason type and reasons
339 'cust_pkg_reason' => [],
341 #need part_pkg before cust_credit...
347 #duplicate history records
350 #populate cust_pay.otaker
353 #populate part_pkg_taxclass for starters
354 'part_pkg_taxclass' => [],
356 #remove bad pending records
357 'cust_pay_pending' => [],
359 #replace invnum and pkgnum with billpkgnum
360 'cust_bill_pkg_detail' => [],
362 #usage_classes if we have none
365 #phone_type if we have none
369 'access_right' => [],
371 #change recur_flat and enable_prorate
372 'part_pkg_option' => [],
374 #add weights to pkg_category
375 'pkg_category' => [],
381 'cust_attachment' => [],
382 #'cust_credit' => [],
384 'cust_main_note' => [],
386 'cust_pay_void' => [],
388 #'cust_pkg_reason' => [],
389 'cust_pkg_discount' => [],
394 'payment_gateway' => [],
396 #migrate to templates
397 'msg_template' => [],
399 #return unprovisioned numbers to availability
402 #insert scripcondition
403 'TicketSystem' => [],
405 #insert LATA data if not already present
408 #insert MSA data if not already present
411 # migrate to radius_group and groupnum instead of groupname
412 'radius_usergroup' => [],
416 #insert default tower_sector if not present
419 #repair improperly deleted services
423 'svc_broadband' => [],
425 #set up payment gateways if needed
428 #flag monthly tax exemptions
429 'cust_tax_exempt_pkg' => [],
431 #kick off tax location history upgrade
432 'cust_bill_pkg' => [],
434 #fix taxable line item links
435 'cust_bill_pkg_tax_location' => [],
437 #populate state FIPS codes if not already done
440 #set default locations on quoted packages
441 'quotation_pkg' => [],
443 #populate tax statuses
458 my $data = upgrade_schema_data(%opt);
460 my $oldAutoCommit = $FS::UID::AutoCommit;
461 local $FS::UID::AutoCommit = 0;
462 local $FS::UID::AutoCommit = 0;
464 foreach my $table ( keys %$data ) {
466 my $class = "FS::$table";
470 if ( $class->can('_upgrade_schema') ) {
471 warn "Upgrading $table schema...\n";
475 $class->_upgrade_schema(%opt);
477 if ( $oldAutoCommit ) {
478 warn " committing\n";
479 dbh->commit or die dbh->errstr;
482 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
483 warn " done in ". (time-$start). " seconds\n";
486 warn "WARNING: asked for schema upgrade of $table,".
487 " but FS::$table has no _upgrade_schema method\n";
494 =item upgrade_schema_data
498 sub upgrade_schema_data {
501 tie my %hash, 'Tie::IxHash',
503 #fix classnum character(1)
504 'cust_bill_pkg_detail' => [],
505 #add necessary columns to RT schema
506 'TicketSystem' => [],
514 sub upgrade_sqlradius {
517 my $conf = new FS::Conf;
519 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
521 foreach my $part_export ( @part_export ) {
523 my $errmsg = 'Error adding FreesideStatus to '.
524 $part_export->option('datasrc'). ': ';
526 my $dbh = DBI->connect(
527 ( map $part_export->option($_), qw ( datasrc username password ) ),
528 { PrintError => 0, PrintWarn => 0 }
530 warn $errmsg.$DBI::errstr;
534 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
535 my $group = "UserName";
537 if ref($part_export) =~ /withdomain/
538 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
540 my $sth_alter = $dbh->prepare(
541 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
544 if ( $sth_alter->execute ) {
545 my $sth_update = $dbh->prepare(
546 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
547 ) or die $errmsg.$dbh->errstr;
548 $sth_update->execute or die $errmsg.$sth_update->errstr;
550 my $error = $sth_alter->errstr;
552 unless $error =~ /Duplicate column name/i #mysql
553 || $error =~ /already exists/i; #Pg
557 my $error = $dbh->errstr;
558 warn $errmsg.$error; #unless $error =~ /exists/i;
561 my $sth_index = $dbh->prepare(
562 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
565 unless ( $sth_index->execute ) {
566 my $error = $sth_index->errstr;
568 unless $error =~ /Duplicate key name/i #mysql
569 || $error =~ /already exists/i; #Pg
572 my $error = $dbh->errstr;
573 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
576 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
577 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
578 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
580 my $sth = $dbh->prepare("SELECT UserName,
582 $str2time max(AcctStartTime)),
583 $str2time max(AcctStopTime))
585 WHERE FreesideStatus = 'done'
589 or die $errmsg.$dbh->errstr;
590 $sth->execute() or die $errmsg.$sth->errstr;
592 while (my $row = $sth->fetchrow_arrayref ) {
593 my ($username, $realm, $start, $stop) = @$row;
595 $username = lc($username) unless $conf->exists('username-uppercase');
597 my $exportnum = $part_export->exportnum;
598 my $extra_sql = " AND exportnum = $exportnum ".
599 " AND exportsvcnum IS NOT NULL ";
601 if ( ref($part_export) =~ /withdomain/ ) {
602 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
603 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
606 my $svc_acct = qsearchs({
607 'select' => 'svc_acct.*',
608 'table' => 'svc_acct',
609 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
610 'LEFT JOIN export_svc USING ( svcpart )',
611 'hashref' => { 'username' => $username },
612 'extra_sql' => $extra_sql,
616 $svc_acct->last_login($start)
617 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
618 $svc_acct->last_logout($stop)
619 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);