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->config('password-generated-characters') ) {
170 'abcdefghijkmnpqrstuvwxyzABCDEFGHIJKLMNPQRSTUVWXYZ23456789()#.,' ;
171 $conf->set('password-generated-characters', $pw_set);
174 if ($conf->exists('unsuspendauto') && !$conf->config('unsuspend_balance')) {
175 $conf->set('unsuspend_balance','Zero');
176 $conf->delete('unsuspendauto');
179 enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
183 sub upgrade_overlimit_groups {
185 my $agentnum = shift;
186 my @groups = $conf->config('overlimit_groups',$agentnum);
187 if(scalar(@groups)) {
188 my $groups = join(',',@groups);
191 if ( $groups !~ /^[\d,]+$/ ) {
192 foreach my $groupname ( @groups ) {
193 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
195 $g = new FS::radius_group {
196 'groupname' => $groupname,
197 'description' => $groupname,
200 die $error if $error;
202 push @groupnums, $g->groupnum;
204 $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
209 sub upgrade_invoice_from {
210 my ($conf, $agentnum, $agentonly) = @_;
212 (!$conf->exists('invoice_from_name',$agentnum,$agentonly)) &&
213 ($conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/)
216 $realemail =~ s/^\s*//; # remove leading spaces
217 $realemail =~ s/\s*$//; # remove trailing spaces
218 my $realname = $conf->config('invoice_from',$agentnum);
219 $realname =~ s/\<.*\>//; # remove email address
220 $realname =~ s/^\s*//; # remove leading spaces
221 $realname =~ s/\s*$//; # remove trailing spaces
222 # properly quote names that contain punctuation
223 if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
224 $realname = '"' . $realname . '"';
226 $conf->set('invoice_from_name', $realname, $agentnum);
227 $conf->set('invoice_from', $realemail, $agentnum);
238 my $data = upgrade_data(%opt);
240 my $oldAutoCommit = $FS::UID::AutoCommit;
241 local $FS::UID::AutoCommit = 0;
242 local $FS::UID::AutoCommit = 0;
244 local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
247 foreach my $table ( keys %$data ) {
249 my $class = "FS::$table";
253 if ( $class->can('_upgrade_data') ) {
254 warn "Upgrading $table...\n";
258 $class->_upgrade_data(%opt);
260 # New interface for async upgrades: a class can declare a
261 # "queueable_upgrade" method, which will run as part of the normal
262 # upgrade, but if the -j option is passed, will instead be run from
264 if ( $class->can('queueable_upgrade') ) {
265 my $jobname = $class . '::queueable_upgrade';
266 my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
268 warn "$class upgrade already scheduled.\n";
270 if ( $opt{'queue'} ) {
271 warn "Scheduling $class upgrade.\n";
272 my $job = FS::queue->new({ job => $jobname });
273 $job->insert($class, %opt);
275 $class->queueable_upgrade(%opt);
280 if ( $oldAutoCommit ) {
281 warn " committing\n";
282 dbh->commit or die dbh->errstr;
285 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
286 warn " done in ". (time-$start). " seconds\n";
289 warn "WARNING: asked for upgrade of $table,".
290 " but FS::$table has no _upgrade_data method\n";
293 # my @records = @{ $data->{$table} };
295 # foreach my $record ( @records ) {
296 # my $args = delete($record->{'_upgrade_args'}) || [];
297 # my $object = $class->new( $record );
298 # my $error = $object->insert( @$args );
299 # die "error inserting record into $table: $error\n"
305 local($FS::cust_main::ignore_expired_card) = 1;
306 #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
307 local($FS::cust_main::ignore_banned_card) = 1;
308 local($FS::cust_main::skip_fuzzyfiles) = 1;
310 local($FS::cust_payby::ignore_expired_card) = 1;
311 local($FS::cust_payby::ignore_banned_card) = 1;
313 # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
314 # kind of a weird spot for this, but it's better than duplicating
315 # all this code in each class...
316 my @decrypt_tables = qw( cust_payby cust_pay_void cust_pay cust_refund cust_pay_pending );
317 foreach my $table ( @decrypt_tables ) {
318 my @objects = qsearch({
321 'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
322 " AND LENGTH(payinfo) > 100",
324 foreach my $object ( @objects ) {
325 my $payinfo = $object->decrypt($object->payinfo);
326 die "error decrypting payinfo" if $payinfo eq $object->payinfo;
327 $object->payinfo($payinfo);
328 my $error = $object->replace;
329 die $error if $error;
342 tie my %hash, 'Tie::IxHash',
344 #cust_main (remove paycvv from history, locations, cust_payby, etc)
347 #contact -> cust_contact / prospect_contact
353 #reason type and reasons
355 'cust_pkg_reason' => [],
357 #need part_pkg before cust_credit...
363 # reason / void_reason migration to reasonnum / void_reasonnum
364 'cust_credit_void' => [],
365 'cust_bill_void' => [],
366 'cust_bill_pkg_void' => [],
368 #duplicate history records
371 #populate cust_pay.otaker
374 #populate part_pkg_taxclass for starters
375 'part_pkg_taxclass' => [],
377 #remove bad pending records
378 'cust_pay_pending' => [],
380 #replace invnum and pkgnum with billpkgnum
381 'cust_bill_pkg_detail' => [],
383 #usage_classes if we have none
386 #phone_type if we have none
390 'access_right' => [],
392 #change recur_flat and enable_prorate
393 'part_pkg_option' => [],
395 #add weights to pkg_category
396 'pkg_category' => [],
402 'cust_attachment' => [],
403 #'cust_credit' => [],
405 'cust_main_note' => [],
407 'cust_pay_void' => [],
409 #'cust_pkg_reason' => [],
410 'cust_pkg_discount' => [],
415 'payment_gateway' => [],
417 #migrate to templates
418 'msg_template' => [],
420 #return unprovisioned numbers to availability
423 #insert scripcondition
424 'TicketSystem' => [],
426 #insert LATA data if not already present
429 #insert MSA data if not already present
432 # migrate to radius_group and groupnum instead of groupname
433 'radius_usergroup' => [],
437 #insert default tower_sector if not present
440 #repair improperly deleted services
444 'svc_broadband' => [],
446 #set up payment gateways if needed
449 #flag monthly tax exemptions
450 'cust_tax_exempt_pkg' => [],
452 #kick off tax location history upgrade
453 'cust_bill_pkg' => [],
455 #fix taxable line item links
456 'cust_bill_pkg_tax_location' => [],
458 #populate state FIPS codes if not already done
461 #set default locations on quoted packages
462 'quotation_pkg' => [],
464 #populate tax statuses
467 #mark certain taxes as system-maintained
468 'cust_main_county' => [],
482 my $data = upgrade_schema_data(%opt);
484 my $oldAutoCommit = $FS::UID::AutoCommit;
485 local $FS::UID::AutoCommit = 0;
486 local $FS::UID::AutoCommit = 0;
488 foreach my $table ( keys %$data ) {
490 my $class = "FS::$table";
494 if ( $class->can('_upgrade_schema') ) {
495 warn "Upgrading $table schema...\n";
499 $class->_upgrade_schema(%opt);
501 if ( $oldAutoCommit ) {
502 warn " committing\n";
503 dbh->commit or die dbh->errstr;
506 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
507 warn " done in ". (time-$start). " seconds\n";
510 warn "WARNING: asked for schema upgrade of $table,".
511 " but FS::$table has no _upgrade_schema method\n";
518 =item upgrade_schema_data
522 sub upgrade_schema_data {
525 tie my %hash, 'Tie::IxHash',
527 #fix classnum character(1)
528 'cust_bill_pkg_detail' => [],
529 #add necessary columns to RT schema
530 'TicketSystem' => [],
538 sub upgrade_sqlradius {
541 my $conf = new FS::Conf;
543 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
545 foreach my $part_export ( @part_export ) {
547 my $errmsg = 'Error adding FreesideStatus to '.
548 $part_export->option('datasrc'). ': ';
550 my $dbh = DBI->connect(
551 ( map $part_export->option($_), qw ( datasrc username password ) ),
552 { PrintError => 0, PrintWarn => 0 }
554 warn $errmsg.$DBI::errstr;
558 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
559 my $group = "UserName";
561 if ref($part_export) =~ /withdomain/
562 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
564 my $sth_alter = $dbh->prepare(
565 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
568 if ( $sth_alter->execute ) {
569 my $sth_update = $dbh->prepare(
570 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
571 ) or die $errmsg.$dbh->errstr;
572 $sth_update->execute or die $errmsg.$sth_update->errstr;
574 my $error = $sth_alter->errstr;
576 unless $error =~ /Duplicate column name/i #mysql
577 || $error =~ /already exists/i; #Pg
581 my $error = $dbh->errstr;
582 warn $errmsg.$error; #unless $error =~ /exists/i;
585 my $sth_index = $dbh->prepare(
586 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
589 unless ( $sth_index->execute ) {
590 my $error = $sth_index->errstr;
592 unless $error =~ /Duplicate key name/i #mysql
593 || $error =~ /already exists/i; #Pg
596 my $error = $dbh->errstr;
597 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
600 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
601 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
602 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
604 my $sth = $dbh->prepare("SELECT UserName,
606 $str2time max(AcctStartTime)),
607 $str2time max(AcctStopTime))
609 WHERE FreesideStatus = 'done'
613 or die $errmsg.$dbh->errstr;
614 $sth->execute() or die $errmsg.$sth->errstr;
616 while (my $row = $sth->fetchrow_arrayref ) {
617 my ($username, $realm, $start, $stop) = @$row;
619 $username = lc($username) unless $conf->exists('username-uppercase');
621 my $exportnum = $part_export->exportnum;
622 my $extra_sql = " AND exportnum = $exportnum ".
623 " AND exportsvcnum IS NOT NULL ";
625 if ( ref($part_export) =~ /withdomain/ ) {
626 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
627 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
630 my $svc_acct = qsearchs({
631 'select' => 'svc_acct.*',
632 'table' => 'svc_acct',
633 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
634 'LEFT JOIN export_svc USING ( svcpart )',
635 'hashref' => { 'username' => $username },
636 'extra_sql' => $extra_sql,
640 $svc_acct->last_login($start)
641 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
642 $svc_acct->last_logout($stop)
643 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);