Merge branch 'master' of git.freeside.biz:/home/git/freeside
[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           if ( $payinfo eq $object->payinfo ) {
342             warn "error decrypting payinfo for $table: $payinfo\n";
343             next;
344           }
345           $object->payinfo($payinfo);
346           my $error = $object->replace;
347           die $error if $error;
348       }
349   }
350
351 }
352
353 =item upgrade_data
354
355 =cut
356
357 sub upgrade_data {
358   my %opt = @_;
359
360   tie my %hash, 'Tie::IxHash', 
361
362     #remap log levels
363         'log' => [],
364
365     #fix whitespace - before cust_main
366     'cust_location' => [],
367
368     # need before cust_main tokenization upgrade,
369     # blocks tokenization upgrade if deprecated features still in use
370     'agent_payment_gateway' => [],
371
372     #cust_main (tokenizes cards, remove paycvv from history, locations, cust_payby, etc)
373     # (handles payinfo encryption/tokenization across all relevant tables)
374     'cust_main' => [],
375
376     #contact -> cust_contact / prospect_contact
377     'contact' => [],
378
379     #msgcat
380     'msgcat' => [],
381
382     #reason type and reasons
383     'reason_type'     => [],
384     'cust_pkg_reason' => [],
385
386     #need part_pkg before cust_credit...
387     'part_pkg' => [],
388
389     #customer credits
390     'cust_credit' => [],
391
392     # reason / void_reason migration to reasonnum / void_reasonnum
393     'cust_credit_void' => [],
394     'cust_bill_void' => [],
395     # also fix some tax allocation records
396     'cust_bill_pkg_void' => [],
397
398     #duplicate history records
399     'h_cust_svc'  => [],
400
401     #populate cust_pay.otaker
402     'cust_pay'    => [],
403
404     #populate part_pkg_taxclass for starters
405     'part_pkg_taxclass' => [],
406
407     #remove bad pending records
408     'cust_pay_pending' => [],
409
410     #replace invnum and pkgnum with billpkgnum
411     'cust_bill_pkg_detail' => [],
412
413     #usage_classes if we have none
414     'usage_class' => [],
415
416     #phone_type if we have none
417     'phone_type' => [],
418
419     #fixup access rights
420     'access_right' => [],
421
422     #change recur_flat and enable_prorate
423     'part_pkg_option' => [],
424
425     #add weights to pkg_category
426     'pkg_category' => [],
427
428     #cdrbatch fixes
429     'cdr' => [],
430
431     #otaker->usernum
432     'cust_attachment' => [],
433     #'cust_credit' => [],
434     #'cust_main' => [],
435     'cust_main_note' => [],
436     #'cust_pay' => [],
437     'cust_pay_void' => [],
438     'cust_pkg' => [],
439     #'cust_pkg_reason' => [],
440     'cust_pkg_discount' => [],
441     'cust_refund' => [],
442     'banned_pay' => [],
443
444     #paycardtype
445     'cust_payby' => [],
446
447     #default namespace
448     'payment_gateway' => [],
449
450     #migrate to templates
451     'msg_template' => [],
452
453     #return unprovisioned numbers to availability
454     'phone_avail' => [],
455
456     #insert scripcondition
457     'TicketSystem' => [],
458     
459     #insert LATA data if not already present
460     'lata' => [],
461     
462     #insert MSA data if not already present
463     'msa' => [],
464
465     # migrate to radius_group and groupnum instead of groupname
466     'radius_usergroup' => [],
467     'part_svc'         => [],
468     'part_export'      => [],
469
470     #insert default tower_sector if not present
471     'tower' => [],
472
473     #repair improperly deleted services
474     'cust_svc' => [],
475
476     #routernum/blocknum
477     'svc_broadband' => [],
478
479     #set up payment gateways if needed
480     'pay_batch' => [],
481
482     #flag monthly tax exemptions
483     'cust_tax_exempt_pkg' => [],
484
485     #kick off tax location history upgrade
486     'cust_bill_pkg' => [],
487
488     #fix taxable line item links
489     'cust_bill_pkg_tax_location' => [],
490
491     #populate state FIPS codes if not already done
492     'state' => [],
493
494     #set default locations on quoted packages
495     'quotation_pkg' => [],
496
497     #populate tax statuses
498     'tax_status' => [],
499
500     #mark certain taxes as system-maintained,
501     # and fix whitespace
502     'cust_main_county' => [],
503
504     #'compliance solutions' -> 'compliance_solutions'
505     'tax_rate' => [],
506     'tax_rate_location' => [],
507
508     #upgrade part_event_condition_option agentnum to a multiple hash value
509     'part_event_condition_option' =>[],
510
511     #fix ip format
512     'svc_circuit' => [],
513
514     #fix ip format
515     'svc_hardware' => [],
516
517     #fix ip format
518     'svc_pbx' => [],
519
520     #fix ip format
521     'tower_sector' => [],
522
523
524   ;
525
526   \%hash;
527
528 }
529
530 =item upgrade_schema
531
532 =cut
533
534 sub upgrade_schema {
535   my %opt = @_;
536
537   my $data = upgrade_schema_data(%opt);
538
539   my $oldAutoCommit = $FS::UID::AutoCommit;
540   local $FS::UID::AutoCommit = 0;
541   local $FS::UID::AutoCommit = 0;
542
543   foreach my $table ( keys %$data ) {
544
545     my $class = "FS::$table";
546     eval "use $class;";
547     die $@ if $@;
548
549     if ( $class->can('_upgrade_schema') ) {
550       warn "Upgrading $table schema...\n";
551
552       my $start = time;
553
554       $class->_upgrade_schema(%opt);
555
556       if ( $oldAutoCommit ) {
557         warn "  committing\n";
558         dbh->commit or die dbh->errstr;
559       }
560       
561       #warn "\e[1K\rUpgrading $table... done in ". (time-$start). " seconds\n";
562       warn "  done in ". (time-$start). " seconds\n";
563
564     } else {
565       warn "WARNING: asked for schema upgrade of $table,".
566            " but FS::$table has no _upgrade_schema method\n";
567     }
568
569   }
570
571 }
572
573 =item upgrade_schema_data
574
575 =cut
576
577 sub upgrade_schema_data {
578   my %opt = @_;
579
580   #auto-find tables/classes with an _update_schema method?
581
582   tie my %hash, 'Tie::IxHash', 
583
584     #fix classnum character(1)
585     'cust_bill_pkg_detail' => [],
586     #add necessary columns to RT schema
587     'TicketSystem' => [],
588     #remove h_access_user_log if it exists (since our regular auto schema
589     # upgrade doesn't have the drop tables flag turned on) 
590     'access_user_log' => [],
591     #remove possible dangling records
592     'password_history' => [],
593     'cust_pay_pending' => [],
594     #remove records referencing removed things with their FKs
595     'pkg_referral' => [],
596     'cust_bill_pkg_discount' => [],
597     'cust_msg' => [],
598     'cust_bill_pay_batch' => [],
599     'cust_event_fee' => [],
600     'radius_attr' => [],
601     'queue_depend' => [],
602     'cust_main_invoice' => [],
603     #update records referencing removed things with their FKs
604     'cust_pkg' => [],
605   ;
606
607   \%hash;
608
609 }
610
611 sub upgrade_sqlradius {
612   #my %opt = @_;
613
614   my $conf = new FS::Conf;
615
616   my @part_export = FS::part_export::sqlradius->all_sqlradius_withaccounting();
617
618   foreach my $part_export ( @part_export ) {
619
620     my $errmsg = 'Error adding FreesideStatus to '.
621                  $part_export->option('datasrc'). ': ';
622
623     my $dbh = DBI->connect(
624       ( map $part_export->option($_), qw ( datasrc username password ) ),
625       { PrintError => 0, PrintWarn => 0 }
626     ) or do {
627       warn $errmsg.$DBI::errstr;
628       next;
629     };
630
631     my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
632     my $group = "UserName";
633     $group .= ",Realm"
634       if ref($part_export) =~ /withdomain/
635       || $dbh->{Driver}->{Name} =~ /^Pg/; #hmm
636
637     my $sth_alter = $dbh->prepare(
638       "ALTER TABLE radacct ADD COLUMN FreesideStatus varchar(32) NULL"
639     );
640     if ( $sth_alter ) {
641       if ( $sth_alter->execute ) {
642         my $sth_update = $dbh->prepare(
643          "UPDATE radacct SET FreesideStatus = 'done' WHERE FreesideStatus IS NULL"
644         ) or die $errmsg.$dbh->errstr;
645         $sth_update->execute or die $errmsg.$sth_update->errstr;
646       } else {
647         my $error = $sth_alter->errstr;
648         warn $errmsg.$error
649           unless $error =~ /Duplicate column name/i  #mysql
650               || $error =~ /already exists/i;        #Pg
651 ;
652       }
653     } else {
654       my $error = $dbh->errstr;
655       warn $errmsg.$error; #unless $error =~ /exists/i;
656     }
657
658     my $sth_index = $dbh->prepare(
659       "CREATE INDEX FreesideStatus ON radacct ( FreesideStatus )"
660     );
661     if ( $sth_index ) {
662       unless ( $sth_index->execute ) {
663         my $error = $sth_index->errstr;
664         warn $errmsg.$error
665           unless $error =~ /Duplicate key name/i #mysql
666               || $error =~ /already exists/i;    #Pg
667       }
668     } else {
669       my $error = $dbh->errstr;
670       warn $errmsg.$error. ' (preparing statement)';#unless $error =~ /exists/i;
671     }
672
673     my $times = ($dbh->{Driver}->{Name} =~ /^mysql/)
674       ? ' AcctStartTime != 0 AND AcctStopTime != 0 '
675       : ' AcctStartTime IS NOT NULL AND AcctStopTime IS NOT NULL ';
676
677     my $sth = $dbh->prepare("SELECT UserName,
678                                     Realm,
679                                     $str2time max(AcctStartTime)),
680                                     $str2time max(AcctStopTime))
681                               FROM radacct
682                               WHERE FreesideStatus = 'done'
683                                 AND $times
684                               GROUP BY $group
685                             ")
686       or die $errmsg.$dbh->errstr;
687     $sth->execute() or die $errmsg.$sth->errstr;
688   
689     while (my $row = $sth->fetchrow_arrayref ) {
690       my ($username, $realm, $start, $stop) = @$row;
691   
692       $username = lc($username) unless $conf->exists('username-uppercase');
693
694       my $exportnum = $part_export->exportnum;
695       my $extra_sql = " AND exportnum = $exportnum ".
696                       " AND exportsvcnum IS NOT NULL ";
697
698       if ( ref($part_export) =~ /withdomain/ ) {
699         $extra_sql = " AND '$realm' = ( SELECT domain FROM svc_domain
700                          WHERE svc_domain.svcnum = svc_acct.domsvc ) ";
701       }
702   
703       my $svc_acct = qsearchs({
704         'select'    => 'svc_acct.*',
705         'table'     => 'svc_acct',
706         'addl_from' => 'LEFT JOIN cust_svc   USING ( svcnum )'.
707                        'LEFT JOIN export_svc USING ( svcpart )',
708         'hashref'   => { 'username' => $username },
709         'extra_sql' => $extra_sql,
710       });
711
712       if ($svc_acct) {
713         $svc_acct->last_login($start)
714           if $start && (!$svc_acct->last_login || $start > $svc_acct->last_login);
715         $svc_acct->last_logout($stop)
716           if $stop && (!$svc_acct->last_logout || $stop > $svc_acct->last_logout);
717       }
718     }
719   }
720
721 }
722
723 =back
724
725 =head1 BUGS
726
727 Sure.
728
729 =head1 SEE ALSO
730
731 =cut
732
733 1;