db993725ccbeb962c26b9139fc59a3f751165bae
[freeside.git] / FS / FS / Upgrade.pm
1 package FS::Upgrade;
2
3 use strict;
4 use vars qw( @ISA @EXPORT_OK $DEBUG );
5 use Exporter;
6 use Tie::IxHash;
7 use File::Slurp;
8 use FS::UID qw( dbh driver_name );
9 use FS::Conf;
10 use FS::Record qw(qsearchs qsearch str2time_sql);
11 use FS::queue;
12 use FS::upgrade_journal;
13 use FS::Setup qw( enable_banned_pay_pad );
14
15 use FS::svc_domain;
16 $FS::svc_domain::whois_hack = 1;
17
18 @ISA = qw( Exporter );
19 @EXPORT_OK = qw( upgrade_schema upgrade_config upgrade upgrade_sqlradius );
20
21 $DEBUG = 1;
22
23 =head1 NAME
24
25 FS::Upgrade - Database upgrade routines
26
27 =head1 SYNOPSIS
28
29   use FS::Upgrade;
30
31 =head1 DESCRIPTION
32
33 Currently this module simply provides a place to store common subroutines for
34 database upgrades.
35
36 =head1 SUBROUTINES
37
38 =over 4
39
40 =item upgrade_config
41
42 =cut
43
44 #config upgrades
45 sub upgrade_config {
46   my %opt = @_;
47
48   my $conf = new FS::Conf;
49
50   # to simplify tokenization upgrades
51   die "Conf selfservice-payment_gateway no longer supported"
52     if $conf->config('selfservice-payment_gateway');
53
54   $conf->touch('payment_receipt')
55     if $conf->exists('payment_receipt_email')
56     || $conf->config('payment_receipt_msgnum');
57
58   $conf->touch('geocode-require_nw_coordinates')
59     if $conf->exists('svc_broadband-require-nw-coordinates');
60
61   unless ( $conf->config('echeck-country') ) {
62     if ( $conf->exists('cust_main-require-bank-branch') ) {
63       $conf->set('echeck-country', 'CA');
64     } elsif ( $conf->exists('echeck-nonus') ) {
65       $conf->set('echeck-country', 'XX');
66     } else {
67       $conf->set('echeck-country', 'US');
68     }
69   }
70
71   my @agents = qsearch('agent', {});
72
73   upgrade_overlimit_groups($conf);
74   map { upgrade_overlimit_groups($conf,$_->agentnum) } @agents;
75
76   upgrade_invoice_from($conf);
77   foreach my $agent (@agents) {
78     upgrade_invoice_from($conf,$agent->agentnum,1);
79   }
80
81   my $DIST_CONF = '/usr/local/etc/freeside/default_conf/';#DIST_CONF in Makefile
82   $conf->set($_, scalar(read_file( "$DIST_CONF/$_" )) )
83     foreach grep { ! $conf->exists($_) && -s "$DIST_CONF/$_" }
84       qw( quotation_html quotation_latex quotation_latexnotes );
85
86   # change 'fslongtable' to 'longtable'
87   # in invoice and quotation main templates, and also in all secondary 
88   # invoice templates
89   my @latex_confs =
90     qsearch('conf', { 'name' => {op=>'LIKE', value=>'%latex%'} });
91
92   foreach my $c (@latex_confs) {
93     my $value = $c->value;
94     if (length($value) and $value =~ /fslongtable/) {
95       $value =~ s/fslongtable/longtable/g;
96       $conf->set($c->name, $value, $c->agentnum);
97     }
98   }
99
100   # if there's a USPS tools login, assume that's the standardization method
101   # you want to use
102   $conf->set('address_standardize_method', 'usps')
103     if $conf->exists('usps_webtools-userid')
104     && length($conf->config('usps_webtools-userid')) > 0
105     && ! $conf->exists('address_standardize_method');
106
107   # this option has been renamed/expanded
108   if ( $conf->exists('cust_main-enable_spouse_birthdate') ) {
109     $conf->touch('cust_main-enable_spouse');
110     $conf->delete('cust_main-enable_spouse_birthdate');
111   }
112
113   # renamed/repurposed
114   if ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent') ) {
115     $conf->touch('part_pkg-show_fcc_options');
116     $conf->delete('cust_pkg-show_fcc_voice_grade_equivalent');
117     warn "
118 You have FCC Form 477 package options enabled.
119
120 Starting with the October 2014 filing date, the FCC has redesigned 
121 Form 477 and introduced new service categories.  See bin/convert-477-options
122 to update your package configuration for the new report.
123
124 If you need to continue using the old Form 477 report, turn on the
125 'old_fcc_report' configuration option.
126 ";
127   }
128
129   # boolean invoice_sections_by_location option is now
130   # invoice_sections_method = 'location'
131   my @invoice_sections_confs =
132     qsearch('conf', { 'name' => { op=>'LIKE', value=>'%sections_by_location' } });
133   foreach my $c (@invoice_sections_confs) {
134     $c->name =~ /^(\w+)sections_by_location$/;
135     $conf->delete($c->name);
136     my $newname = $1.'sections_method';
137     $conf->set($newname, 'location');
138   }
139
140   # boolean enable_taxproducts is now tax_data_vendor = 'cch'
141   if ( $conf->exists('enable_taxproducts') ) {
142
143     $conf->delete('enable_taxproducts');
144     $conf->set('tax_data_vendor', 'cch');
145
146   }
147
148   # boolean tax-cust_exempt-groups-require_individual_nums is now -num_req all
149   if ( $conf->exists('tax-cust_exempt-groups-require_individual_nums') ) {
150     $conf->set('tax-cust_exempt-groups-num_req', 'all');
151     $conf->delete('tax-cust_exempt-groups-require_individual_nums');
152   }
153
154   # boolean+text previous_balance-exclude_from_total is now two separate options
155   my $total_new_charges = $conf->config('previous_balance-exclude_from_total');
156   if (length($total_new_charges) > 0) {
157     $conf->set('previous_balance-text-total_new_charges', $total_new_charges);
158     $conf->set('previous_balance-exclude_from_total', '');
159   }
160
161   # switch from specifying an email address to boolean check
162   if ( $conf->exists('batch-errors_to') ) {
163     $conf->touch('batch-errors_not_fatal');
164     $conf->delete('batch-errors_to');
165   }
166
167   if ( $conf->exists('voip-cust_email_csv_cdr') ) {
168     $conf->set('voip_cdr_email_attach', 'csv');
169     $conf->delete('voip-cust_email_csv_cdr') ;
170   }
171
172   if ($conf->exists('unsuspendauto') && !$conf->config('unsuspend_balance')) {
173     $conf->set('unsuspend_balance','Zero');
174     $conf->delete('unsuspendauto');
175   }
176
177   if ($conf->config('cust-fields') =~ / \| Payment Type/) {
178     my $cust_fields = $conf->config('cust-fields');
179     # so we can potentially use 'Payment Types' or somesuch in the future
180     $cust_fields =~ s/ \| Payment Type( \|)/$1/;
181     $cust_fields =~ s/ \| Payment Type$//;
182     $conf->set('cust-fields',$cust_fields);
183   }
184
185   enable_banned_pay_pad() unless length($conf->config('banned_pay-pad'));
186
187   # if translate-auto-insert is enabled for a locale, ensure that invoice
188   # terms are in the msgcat (is there a better place for this?)
189   if (my $auto_locale = $conf->config('translate-auto-insert')) {
190     my $lh = FS::L10N->get_handle($auto_locale);
191     foreach (@FS::Conf::invoice_terms) {
192       $lh->maketext($_) if length($_);
193     }
194   }
195 }
196
197 sub upgrade_overlimit_groups {
198     my $conf = shift;
199     my $agentnum = shift;
200     my @groups = $conf->config('overlimit_groups',$agentnum); 
201     if(scalar(@groups)) {
202         my $groups = join(',',@groups);
203         my @groupnums;
204         my $error = '';
205         if ( $groups !~ /^[\d,]+$/ ) {
206             foreach my $groupname ( @groups ) {
207                 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
208                 unless ( $g ) {
209                     $g = new FS::radius_group {
210                                     'groupname' => $groupname,
211                                     'description' => $groupname,
212                                     };
213                     $error = $g->insert;
214                     die $error if $error;
215                 }
216                 push @groupnums, $g->groupnum;
217             }
218             $conf->set('overlimit_groups',join("\n",@groupnums),$agentnum);
219         }
220     }
221 }
222
223 sub upgrade_invoice_from {
224   my ($conf, $agentnum, $agentonly) = @_;
225   if (
226           ! $conf->exists('invoice_from_name',$agentnum,$agentonly)
227        && $conf->exists('invoice_from',$agentnum,$agentonly)
228        && $conf->config('invoice_from',$agentnum,$agentonly) =~ /\<(.*)\>/
229   ) {
230     my $realemail = $1;
231     $realemail =~ s/^\s*//; # remove leading spaces
232     $realemail =~ s/\s*$//; # remove trailing spaces
233     my $realname = $conf->config('invoice_from',$agentnum);
234     $realname =~ s/\<.*\>//; # remove email address
235     $realname =~ s/^\s*//; # remove leading spaces
236     $realname =~ s/\s*$//; # remove trailing spaces
237     # properly quote names that contain punctuation
238     if (($realname =~ /[^[:alnum:][:space:]]/) && ($realname !~ /^\".*\"$/)) {
239       $realname = '"' . $realname . '"';
240     }
241     $conf->set('invoice_from_name', $realname, $agentnum);
242     $conf->set('invoice_from', $realemail, $agentnum);
243   }
244 }
245
246 =item upgrade
247
248 =cut
249
250 sub upgrade {
251   my %opt = @_;
252
253   my $data = upgrade_data(%opt);
254
255   my $oldAutoCommit = $FS::UID::AutoCommit;
256   local $FS::UID::AutoCommit = 0;
257   local $FS::UID::AutoCommit = 0;
258
259   local $FS::cust_pkg::upgrade = 1; #go away after setup+start dates cleaned up for old customers
260
261
262   foreach my $table ( keys %$data ) {
263
264     my $class = "FS::$table";
265     eval "use $class;";
266     die $@ if $@;
267
268     if ( $class->can('_upgrade_data') ) {
269       warn "Upgrading $table...\n";
270
271       my $start = time;
272
273       $class->_upgrade_data(%opt);
274
275       # New interface for async upgrades: a class can declare a 
276       # "queueable_upgrade" method, which will run as part of the normal 
277       # upgrade, but if the -j option is passed, will instead be run from 
278       # the job queue.
279       if ( $class->can('queueable_upgrade') ) {
280         my $jobname = $class . '::queueable_upgrade';
281         my $num_jobs = FS::queue->count("job = '$jobname' and status != 'failed'");
282         if ($num_jobs > 0) {
283           warn "$class upgrade already scheduled.\n";
284         } else {
285           if ( $opt{'queue'} ) {
286             warn "Scheduling $class upgrade.\n";
287             my $job = FS::queue->new({ job => $jobname });
288             $job->insert($class, %opt);
289           } else {
290             $class->queueable_upgrade(%opt);
291           }
292         } #$num_jobs == 0
293       }
294
295       if ( $oldAutoCommit ) {
296         warn "  committing\n";
297         dbh->commit or die dbh->errstr;
298       }
299       
300       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
301       warn "  done in ". (time-$start). " seconds\n";
302
303     } else {
304       warn "WARNING: asked for upgrade of $table,".
305            " but FS::$table has no _upgrade_data method\n";
306     }
307
308 #    my @records = @{ $data->{$table} };
309 #
310 #    foreach my $record ( @records ) {
311 #      my $args = delete($record->{'_upgrade_args'}) || [];
312 #      my $object = $class->new( $record );
313 #      my $error = $object->insert( @$args );
314 #      die "error inserting record into $table: $error\n"
315 #        if $error;
316 #    }
317
318   }
319
320   local($FS::cust_main::ignore_expired_card) = 1;
321   #this is long-gone... would need to set an equivalent in cust_location #local($FS::cust_main::ignore_illegal_zip) = 1;
322   local($FS::cust_main::ignore_banned_card) = 1;
323   local($FS::cust_main::skip_fuzzyfiles) = 1;
324
325   local($FS::cust_payby::ignore_expired_card) = 1;
326   local($FS::cust_payby::ignore_banned_card) = 1;
327
328   # decrypt inadvertantly-encrypted payinfo where payby != CARD,DCRD,CHEK,DCHK
329   # kind of a weird spot for this, but it's better than duplicating
330   # all this code in each class...
331   my @decrypt_tables = qw( cust_payby cust_pay_void cust_pay cust_refund cust_pay_pending );
332   foreach my $table ( @decrypt_tables ) {
333       my @objects = qsearch({
334         'table'     => $table,
335         'hashref'   => {},
336         'extra_sql' => "WHERE payby NOT IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
337                        " AND LENGTH(payinfo) > 100",
338       });
339       foreach my $object ( @objects ) {
340           my $payinfo = $object->decrypt($object->payinfo);
341           die "error decrypting payinfo" if $payinfo eq $object->payinfo;
342           $object->payinfo($payinfo);
343           my $error = $object->replace;
344           die $error if $error;
345       }
346   }
347
348 }
349
350 =item upgrade_data
351
352 =cut
353
354 sub upgrade_data {
355   my %opt = @_;
356
357   tie my %hash, 'Tie::IxHash', 
358
359     #remap log levels
360         'log' => [],
361
362     #fix whitespace - before cust_main
363     'cust_location' => [],
364
365     # need before cust_main tokenization upgrade,
366     # blocks tokenization upgrade if deprecated features still in use
367     'agent_payment_gateway' => [],
368
369     #cust_main (tokenizes cards, remove paycvv from history, locations, cust_payby, etc)
370     # (handles payinfo encryption/tokenization across all relevant tables)
371     'cust_main' => [],
372
373     #contact -> cust_contact / prospect_contact
374     'contact' => [],
375
376     #msgcat
377     'msgcat' => [],
378
379     #reason type and reasons
380     'reason_type'     => [],
381     'cust_pkg_reason' => [],
382
383     #need part_pkg before cust_credit...
384     'part_pkg' => [],
385
386     #customer credits
387     'cust_credit' => [],
388
389     # reason / void_reason migration to reasonnum / void_reasonnum
390     'cust_credit_void' => [],
391     'cust_bill_void' => [],
392     # also fix some tax allocation records
393     'cust_bill_pkg_void' => [],
394
395     #duplicate history records
396     'h_cust_svc'  => [],
397
398     #populate cust_pay.otaker
399     'cust_pay'    => [],
400
401     #populate part_pkg_taxclass for starters
402     'part_pkg_taxclass' => [],
403
404     #remove bad pending records
405     'cust_pay_pending' => [],
406
407     #replace invnum and pkgnum with billpkgnum
408     'cust_bill_pkg_detail' => [],
409
410     #usage_classes if we have none
411     'usage_class' => [],
412
413     #phone_type if we have none
414     'phone_type' => [],
415
416     #fixup access rights
417     'access_right' => [],
418
419     #change recur_flat and enable_prorate
420     'part_pkg_option' => [],
421
422     #add weights to pkg_category
423     'pkg_category' => [],
424
425     #cdrbatch fixes
426     'cdr' => [],
427
428     #otaker->usernum
429     'cust_attachment' => [],
430     #'cust_credit' => [],
431     #'cust_main' => [],
432     'cust_main_note' => [],
433     #'cust_pay' => [],
434     'cust_pay_void' => [],
435     'cust_pkg' => [],
436     #'cust_pkg_reason' => [],
437     'cust_pkg_discount' => [],
438     'cust_refund' => [],
439     'banned_pay' => [],
440
441     #paycardtype
442     'cust_payby' => [],
443
444     #default namespace
445     'payment_gateway' => [],
446
447     #migrate to templates
448     'msg_template' => [],
449
450     #return unprovisioned numbers to availability
451     'phone_avail' => [],
452
453     #insert scripcondition
454     'TicketSystem' => [],
455     
456     #insert LATA data if not already present
457     'lata' => [],
458     
459     #insert MSA data if not already present
460     'msa' => [],
461
462     # migrate to radius_group and groupnum instead of groupname
463     'radius_usergroup' => [],
464     'part_svc'         => [],
465     'part_export'      => [],
466
467     #insert default tower_sector if not present
468     'tower' => [],
469
470     #repair improperly deleted services
471     'cust_svc' => [],
472
473     #routernum/blocknum
474     'svc_broadband' => [],
475
476     #set up payment gateways if needed
477     'pay_batch' => [],
478
479     #flag monthly tax exemptions
480     'cust_tax_exempt_pkg' => [],
481
482     #kick off tax location history upgrade
483     'cust_bill_pkg' => [],
484
485     #fix taxable line item links
486     'cust_bill_pkg_tax_location' => [],
487
488     #populate state FIPS codes if not already done
489     'state' => [],
490
491     #set default locations on quoted packages
492     'quotation_pkg' => [],
493
494     #populate tax statuses
495     'tax_status' => [],
496
497     #mark certain taxes as system-maintained,
498     # and fix whitespace
499     'cust_main_county' => [],
500   ;
501
502   \%hash;
503
504 }
505
506 =item upgrade_schema
507
508 =cut
509
510 sub upgrade_schema {
511   my %opt = @_;
512
513   my $data = upgrade_schema_data(%opt);
514
515   my $oldAutoCommit = $FS::UID::AutoCommit;
516   local $FS::UID::AutoCommit = 0;
517   local $FS::UID::AutoCommit = 0;
518
519   foreach my $table ( keys %$data ) {
520
521     my $class = "FS::$table";
522     eval "use $class;";
523     die $@ if $@;
524
525     if ( $class->can('_upgrade_schema') ) {
526       warn "Upgrading $table schema...\n";
527
528       my $start = time;
529
530       $class->_upgrade_schema(%opt);
531
532       if ( $oldAutoCommit ) {
533         warn "  committing\n";
534         dbh->commit or die dbh->errstr;
535       }
536       
537       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
538       warn "  done in ". (time-$start). " seconds\n";
539
540     } else {
541       warn "WARNING: asked for schema upgrade of $table,".
542            " but FS::$table has no _upgrade_schema method\n";
543     }
544
545   }
546
547 }
548
549 =item upgrade_schema_data
550
551 =cut
552
553 sub upgrade_schema_data {
554   my %opt = @_;
555
556   #auto-find tables/classes with an _update_schema method?
557
558   tie my %hash, 'Tie::IxHash', 
559
560     #fix classnum character(1)
561     'cust_bill_pkg_detail' => [],
562     #add necessary columns to RT schema
563     'TicketSystem' => [],
564     #remove possible dangling records
565     'password_history' => [],
566     'cust_pay_pending' => [],
567     #remove records referencing removed things with their FKs
568     'pkg_referral' => [],
569     'cust_bill_pkg_discount' => [],
570     'cust_msg' => [],
571     'cust_bill_pay_batch' => [],
572     #update records referencing removed things with their FKs
573     'cust_pkg' => [],
574   ;
575
576   \%hash;
577
578 }
579
580 sub upgrade_sqlradius {
581   #my %opt = @_;
582
583   my $conf = new FS::Conf;
584
585   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
586
587   foreach my $part_export ( @part_export ) {
588
589     my $errmsg = 'Error adding FreesideStatus to '.
590                  $part_export->option('datasrc'). ': ';
591
592     my $dbh = DBI->connect(
593       ( map $part_export->option($_), qw ( datasrc username password ) ),
594       { PrintError => 0, PrintWarn => 0 }
595     ) or do {
596       warn $errmsg.$DBI::errstr;
597       next;
598     };
599
600     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
601     my $group = "UserName";
602     $group .= ",Realm"
603       if ref($part_export) =~ /withdomain/
604       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
605
606     my $sth_alter = $dbh->prepare(
607       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
608     );
609     if ( $sth_alter ) {
610       if ( $sth_alter->execute ) {
611         my $sth_update = $dbh->prepare(
612          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
613         ) or die $errmsg.$dbh->errstr;
614         $sth_update->execute or die $errmsg.$sth_update->errstr;
615       } else {
616         my $error = $sth_alter->errstr;
617         warn $errmsg.$error
618           unless $error =~ /Duplicate column name/i  #mysql
619               || $error =~ /already exists/i;        #Pg
620 ;
621       }
622     } else {
623       my $error = $dbh->errstr;
624       warn $errmsg.$error; #unless $error =~ /exists/i;
625     }
626
627     my $sth_index = $dbh->prepare(
628       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
629     );
630     if ( $sth_index ) {
631       unless ( $sth_index->execute ) {
632         my $error = $sth_index->errstr;
633         warn $errmsg.$error
634           unless $error =~ /Duplicate key name/i #mysql
635               || $error =~ /already exists/i;    #Pg
636       }
637     } else {
638       my $error = $dbh->errstr;
639       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
640     }
641
642     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
643       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
644       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
645
646     my $sth = $dbh->prepare("SELECT UserName,
647                                     Realm,
648                                     $str2time max(AcctStartTime)),
649                                     $str2time max(AcctStopTime))
650                               FROM radacct
651                               WHERE FreesideStatus = 'done'
652                                 AND $times
653                               GROUP BY $group
654                             ")
655       or die $errmsg.$dbh->errstr;
656     $sth->execute() or die $errmsg.$sth->errstr;
657   
658     while (my $row = $sth->fetchrow_arrayref ) {
659       my ($username, $realm, $start, $stop) = @$row;
660   
661       $username = lc($username) unless $conf->exists('username-uppercase');
662
663       my $exportnum = $part_export->exportnum;
664       my $extra_sql = " AND exportnum = $exportnum ".
665                       " AND exportsvcnum IS NOT NULL ";
666
667       if ( ref($part_export) =~ /withdomain/ ) {
668         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
669                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
670       }
671   
672       my $svc_acct = qsearchs({
673         'select'    => 'svc_acct.*',
674         'table'     => 'svc_acct',
675         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
676                        'LEFT JOIN export_svc USING ( svcpart )',
677         'hashref'   => { 'username' => $username },
678         'extra_sql' => $extra_sql,
679       });
680
681       if ($svc_acct) {
682         $svc_acct->last_login($start)
683           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
684         $svc_acct->last_logout($stop)
685           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
686       }
687     }
688   }
689
690 }
691
692 =back
693
694 =head1 BUGS
695
696 Sure.
697
698 =head1 SEE ALSO
699
700 =cut
701
702 1;
703