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_main 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 #payby conditions to new ones
345 'part_event_condition' => [],
347 #payby actions to new ones
350 #cust_main (remove paycvv from history, locations, cust_payby, etc)
353 #contact -> cust_contact / prospect_contact
359 #reason type and reasons
361 'cust_pkg_reason' => [],
363 #need part_pkg before cust_credit...
369 # reason / void_reason migration to reasonnum / void_reasonnum
370 'cust_credit_void' => [],
371 'cust_bill_void' => [],
372 'cust_bill_pkg_void' => [],
374 #duplicate history records
377 #populate cust_pay.otaker
380 #populate part_pkg_taxclass for starters
381 'part_pkg_taxclass' => [],
383 #remove bad pending records
384 'cust_pay_pending' => [],
386 #replace invnum and pkgnum with billpkgnum
387 'cust_bill_pkg_detail' => [],
389 #usage_classes if we have none
392 #phone_type if we have none
396 'access_right' => [],
398 #change recur_flat and enable_prorate
399 'part_pkg_option' => [],
401 #add weights to pkg_category
402 'pkg_category' => [],
408 'cust_attachment' => [],
409 #'cust_credit' => [],
411 'cust_main_note' => [],
413 'cust_pay_void' => [],
415 #'cust_pkg_reason' => [],
416 'cust_pkg_discount' => [],
421 'payment_gateway' => [],
423 #migrate to templates
424 'msg_template' => [],
426 #return unprovisioned numbers to availability
429 #insert scripcondition
430 'TicketSystem' => [],
432 #insert LATA data if not already present
435 #insert MSA data if not already present
438 # migrate to radius_group and groupnum instead of groupname
439 'radius_usergroup' => [],
443 #insert default tower_sector if not present
446 #repair improperly deleted services
450 'svc_broadband' => [],
452 #set up payment gateways if needed
455 #flag monthly tax exemptions
456 'cust_tax_exempt_pkg' => [],
458 #kick off tax location history upgrade
459 'cust_bill_pkg' => [],
461 #fix taxable line item links
462 'cust_bill_pkg_tax_location' => [],
464 #populate state FIPS codes if not already done
467 #set default locations on quoted packages
468 'quotation_pkg' => [],
470 #populate tax statuses
473 #mark certain taxes as system-maintained
474 'cust_main_county' => [],
488 my $data = upgrade_schema_data(%opt);
490 my $oldAutoCommit = $FS::UID::AutoCommit;
491 local $FS::UID::AutoCommit = 0;
492 local $FS::UID::AutoCommit = 0;
494 foreach my $table ( keys %$data ) {
496 my $class = "FS::$table";
500 if ( $class->can('_upgrade_schema') ) {
501 warn "Upgrading $table schema...\n";
505 $class->_upgrade_schema(%opt);
507 if ( $oldAutoCommit ) {
508 warn " committing\n";
509 dbh->commit or die dbh->errstr;
512 #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
513 warn " done in ". (time-$start). " seconds\n";
516 warn "WARNING: asked for schema upgrade of $table,".
517 " but FS::$table has no _upgrade_schema method\n";
524 =item upgrade_schema_data
528 sub upgrade_schema_data {
531 tie my %hash, 'Tie::IxHash',
533 #fix classnum character(1)
534 'cust_bill_pkg_detail' => [],
535 #add necessary columns to RT schema
536 'TicketSystem' => [],
544 sub upgrade_sqlradius {
547 my $conf = new FS::Conf;
549 my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
551 foreach my $part_export ( @part_export ) {
553 my $errmsg = 'Error adding FreesideStatus to '.
554 $part_export->option('datasrc'). ': ';
556 my $dbh = DBI->connect(
557 ( map $part_export->option($_), qw ( datasrc username password ) ),
558 { PrintError => 0, PrintWarn => 0 }
560 warn $errmsg.$DBI::errstr;
564 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
565 my $group = "UserName";
567 if ref($part_export) =~ /withdomain/
568 || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
570 my $sth_alter = $dbh->prepare(
571 "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
574 if ( $sth_alter->execute ) {
575 my $sth_update = $dbh->prepare(
576 "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
577 ) or die $errmsg.$dbh->errstr;
578 $sth_update->execute or die $errmsg.$sth_update->errstr;
580 my $error = $sth_alter->errstr;
582 unless $error =~ /Duplicate column name/i #mysql
583 || $error =~ /already exists/i; #Pg
587 my $error = $dbh->errstr;
588 warn $errmsg.$error; #unless $error =~ /exists/i;
591 my $sth_index = $dbh->prepare(
592 "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
595 unless ( $sth_index->execute ) {
596 my $error = $sth_index->errstr;
598 unless $error =~ /Duplicate key name/i #mysql
599 || $error =~ /already exists/i; #Pg
602 my $error = $dbh->errstr;
603 warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
606 my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
607 ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
608 : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
610 my $sth = $dbh->prepare("SELECT UserName,
612 $str2time max(AcctStartTime)),
613 $str2time max(AcctStopTime))
615 WHERE FreesideStatus = 'done'
619 or die $errmsg.$dbh->errstr;
620 $sth->execute() or die $errmsg.$sth->errstr;
622 while (my $row = $sth->fetchrow_arrayref ) {
623 my ($username, $realm, $start, $stop) = @$row;
625 $username = lc($username) unless $conf->exists('username-uppercase');
627 my $exportnum = $part_export->exportnum;
628 my $extra_sql = " AND exportnum = $exportnum ".
629 " AND exportsvcnum IS NOT NULL ";
631 if ( ref($part_export) =~ /withdomain/ ) {
632 $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
633 WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
636 my $svc_acct = qsearchs({
637 'select' => 'svc_acct.*',
638 'table' => 'svc_acct',
639 'addl_from' => 'LEFT JOIN cust_svc USING ( svcnum )'.
640 'LEFT JOIN export_svc USING ( svcpart )',
641 'hashref' => { 'username' => $username },
642 'extra_sql' => $extra_sql,
646 $svc_acct->last_login($start)
647 if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
648 $svc_acct->last_logout($stop)
649 if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);