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 if ( $conf->exists('voip-cust_email_csv_cdr') ) {
164 $conf->set('voip_cdr_email_attach', 'csv');
165 $conf->delete('voip-cust_email_csv_cdr') ;
168 if ($conf->exists('unsuspendauto') && !$conf->config('unsuspend_balance')) {
169 $conf->set('unsuspend_balance','Zero');
170 $conf->delete('unsuspendauto');
173 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
177 sub upgrade_overlimit_groups {
179 my $agentnum = shift;
180 my @groups = $conf->config('overlimit_groups',$agentnum);
181 if(scalar(@groups)) {
182 my $groups = join(',',@groups);
185 if ( $groups !~ /^[\d,]+$/ ) {
186 foreach my $groupname ( @groups ) {
187 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
189 $g = new FS::radius_group {
190 'groupname' => $groupname,
191 'description' => $groupname,
194 die $error if $error;
196 push @groupnums, $g->groupnum;
198 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
203 sub upgrade_invoice_from {
204 my ($conf, $agentnum, $agentonly) = @_;
206 ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
207 && $conf->exists('invoice_from',$agentnum,$agentonly)
208 && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
211 $realemail =~ s/^\s*//; # remove leading spaces
212 $realemail =~ s/\s*$//; # remove trailing spaces
213 my $realname = $conf->config('invoice_from',$agentnum);
214 $realname =~ s/\<.*\>//; # remove email address
215 $realname =~ s/^\s*//; # remove leading spaces
216 $realname =~ s/\s*$//; # remove trailing spaces
217 # properly quote names that contain punctuation
218 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
219 $realname = '"' . $realname . '"';
221 $conf->set('invoice_from_name', $realname, $agentnum);
222 $conf->set('invoice_from', $realemail, $agentnum);
233 my $data = upgrade_data(%opt);
235 my $oldAutoCommit = $FS::UID::AutoCommit;
236 local $FS::UID::AutoCommit = 0;
237 local $FS::UID::AutoCommit = 0;
239 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
242 foreach my $table ( keys %$data ) {
244 my $class = "FS::$table";
248 if ( $class->can('_upgrade_data') ) {
249 warn "Upgrading $table...\n";
253 $class->_upgrade_data(%opt);
255 # New interface for async upgrades: a class can declare a
256 # "queueable_upgrade" method, which will run as part of the normal
257 # upgrade, but if the -j option is passed, will instead be run from
259 if ( $class->can('queueable_upgrade') ) {
260 my $jobname = $class . '::queueable_upgrade';
261 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
263 warn "$class upgrade already scheduled.\n";
265 if ( $opt{'queue'} ) {
266 warn "Scheduling $class upgrade.\n";
267 my $job = FS::queue->new({ job => $jobname });
268 $job->insert($class, %opt);
270 $class->queueable_upgrade(%opt);
275 if ( $oldAutoCommit ) {
276 warn " committing\n";
277 dbh->commit or die dbh->errstr;
280 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
281 warn " done in ". (time-$start). " seconds\n";
284 warn "WARNING: asked for upgrade of $table,".
285 " but FS::$table has no _upgrade_data method\n";
288 # my @records = @{ $data->{$table} };
290 # foreach my $record ( @records ) {
291 # my $args = delete($record->{'_upgrade_args'}) || [];
292 # my $object = $class->new( $record );
293 # my $error = $object->insert( @$args );
294 # die "error inserting record into $table: $error\n"
300 local($FS::cust_main::ignore_expired_card) = 1;
301 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
302 local($FS::cust_main::ignore_banned_card) = 1;
303 local($FS::cust_main::skip_fuzzyfiles) = 1;
305 local($FS::cust_payby::ignore_expired_card) = 1;
306 local($FS::cust_payby::ignore_banned_card) = 1;
308 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
309 # kind of a weird spot for this, but it's better than duplicating
310 # all this code in each class...
311 my @decrypt_tables = qw( cust_main cust_pay_void cust_pay cust_refund cust_pay_pending );
312 foreach my $table ( @decrypt_tables ) {
313 my @objects = qsearch({
316 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
317 " AND LENGTH(payinfo) > 100",
319 foreach my $object ( @objects ) {
320 my $payinfo = $object->decrypt($object->payinfo);
321 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
322 $object->payinfo($payinfo);
323 my $error = $object->replace;
324 die $error if $error;
337 tie my %hash, 'Tie::IxHash',
339 #payby conditions to new ones
340 'part_event_condition' => [],
342 #payby actions to new ones
345 #cust_main (remove paycvv from history, locations, cust_payby, etc)
348 #contact -> cust_contact / prospect_contact
354 #reason type and reasons
356 'cust_pkg_reason' => [],
358 #need part_pkg before cust_credit...
364 # reason / void_reason migration to reasonnum / void_reasonnum
365 'cust_credit_void' => [],
366 'cust_bill_void' => [],
367 'cust_bill_pkg_void' => [],
369 #duplicate history records
372 #populate cust_pay.otaker
375 #populate part_pkg_taxclass for starters
376 'part_pkg_taxclass' => [],
378 #remove bad pending records
379 'cust_pay_pending' => [],
381 #replace invnum and pkgnum with billpkgnum
382 'cust_bill_pkg_detail' => [],
384 #usage_classes if we have none
387 #phone_type if we have none
391 'access_right' => [],
393 #change recur_flat and enable_prorate
394 'part_pkg_option' => [],
396 #add weights to pkg_category
397 'pkg_category' => [],
403 'cust_attachment' => [],
404 #'cust_credit' => [],
406 'cust_main_note' => [],
408 'cust_pay_void' => [],
410 #'cust_pkg_reason' => [],
411 'cust_pkg_discount' => [],
416 'payment_gateway' => [],
418 #migrate to templates
419 'msg_template' => [],
421 #return unprovisioned numbers to availability
424 #insert scripcondition
425 'TicketSystem' => [],
427 #insert LATA data if not already present
430 #insert MSA data if not already present
433 # migrate to radius_group and groupnum instead of groupname
434 'radius_usergroup' => [],
438 #insert default tower_sector if not present
441 #repair improperly deleted services
445 'svc_broadband' => [],
447 #set up payment gateways if needed
450 #flag monthly tax exemptions
451 'cust_tax_exempt_pkg' => [],
453 #kick off tax location history upgrade
454 'cust_bill_pkg' => [],
456 #fix taxable line item links
457 'cust_bill_pkg_tax_location' => [],
459 #populate state FIPS codes if not already done
462 #set default locations on quoted packages
463 'quotation_pkg' => [],
465 #populate tax statuses
468 #mark certain taxes as system-maintained
469 'cust_main_county' => [],
483 my $data = upgrade_schema_data(%opt);
485 my $oldAutoCommit = $FS::UID::AutoCommit;
486 local $FS::UID::AutoCommit = 0;
487 local $FS::UID::AutoCommit = 0;
489 foreach my $table ( keys %$data ) {
491 my $class = "FS::$table";
495 if ( $class->can('_upgrade_schema') ) {
496 warn "Upgrading $table schema...\n";
500 $class->_upgrade_schema(%opt);
502 if ( $oldAutoCommit ) {
503 warn " committing\n";
504 dbh->commit or die dbh->errstr;
507 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
508 warn " done in ". (time-$start). " seconds\n";
511 warn "WARNING: asked for schema upgrade of $table,".
512 " but FS::$table has no _upgrade_schema method\n";
519 =item upgrade_schema_data
523 sub upgrade_schema_data {
526 tie my %hash, 'Tie::IxHash',
528 #fix classnum character(1)
529 'cust_bill_pkg_detail' => [],
530 #add necessary columns to RT schema
531 'TicketSystem' => [],
539 sub upgrade_sqlradius {
542 my $conf = new FS::Conf;
544 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
546 foreach my $part_export ( @part_export ) {
548 my $errmsg = 'Error adding FreesideStatus to '.
549 $part_export->option('datasrc'). ': ';
551 my $dbh = DBI->connect(
552 ( map $part_export->option($_), qw ( datasrc username password ) ),
553 { PrintError => 0, PrintWarn => 0 }
555 warn $errmsg.$DBI::errstr;
559 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
560 my $group = "UserName";
562 if ref($part_export) =~ /withdomain/
563 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
565 my $sth_alter = $dbh->prepare(
566 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
569 if ( $sth_alter->execute ) {
570 my $sth_update = $dbh->prepare(
571 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
572 ) or die $errmsg.$dbh->errstr;
573 $sth_update->execute or die $errmsg.$sth_update->errstr;
575 my $error = $sth_alter->errstr;
577 unless $error =~ /Duplicate column name/i #mysql
578 || $error =~ /already exists/i; #Pg
582 my $error = $dbh->errstr;
583 warn $errmsg.$error; #unless $error =~ /exists/i;
586 my $sth_index = $dbh->prepare(
587 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
590 unless ( $sth_index->execute ) {
591 my $error = $sth_index->errstr;
593 unless $error =~ /Duplicate key name/i #mysql
594 || $error =~ /already exists/i; #Pg
597 my $error = $dbh->errstr;
598 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
601 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
602 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
603 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
605 my $sth = $dbh->prepare("SELECT UserName,
607 $str2time max(AcctStartTime)),
608 $str2time max(AcctStopTime))
610 WHERE FreesideStatus = 'done'
614 or die $errmsg.$dbh->errstr;
615 $sth->execute() or die $errmsg.$sth->errstr;
617 while (my $row = $sth->fetchrow_arrayref ) {
618 my ($username, $realm, $start, $stop) = @$row;
620 $username = lc($username) unless $conf->exists('username-uppercase');
622 my $exportnum = $part_export->exportnum;
623 my $extra_sql = " AND exportnum = $exportnum ".
624 " AND exportsvcnum IS NOT NULL ";
626 if ( ref($part_export) =~ /withdomain/ ) {
627 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
628 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
631 my $svc_acct = qsearchs({
632 'select' => 'svc_acct.*',
633 'table' => 'svc_acct',
634 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
635 'LEFT JOIN export_svc USING ( svcpart )',
636 'hashref' => { 'username' => $username },
637 'extra_sql' => $extra_sql,
641 $svc_acct->last_login($start)
642 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
643 $svc_acct->last_logout($stop)
644 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);