summaryrefslogtreecommitdiff
path: root/FS/FS/state.pm
blob: 671a93b44c5ca84cb225a637012568cf1e7bfa8b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
package FS::state;

use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
use Locale::SubCountry;

=head1 NAME

FS::state - Object methods for state/province records

=head1 SYNOPSIS

  use FS::state;

  $record = new FS::state \%hash;
  $record = new FS::state { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::state object represents a state, province, or other top-level 
subdivision of a sovereign nation.  FS::state inherits from FS::Record.  
The following fields are currently supported:

=over 4

=item statenum

primary key

=item country

two-letter country code

=item state

state code/abbreviation/name (as used in cust_location.state)

=item fips

FIPS 10-4 code (not including country code)

=back

=head1 METHODS

=cut

sub table { 'state'; }

# no external API; this table maintains itself

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('statenum')
    || $self->ut_alpha('country')
    || $self->ut_alpha('state')
    || $self->ut_alpha('fips')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=cut

sub _upgrade_data {
  warn "Updating state and country codes...\n";
  my %existing;
  foreach my $state (qsearch('state')) {
    $existing{$state->country} ||= {};
    $existing{$state->country}{$state->state} = $state;
  }
  my $world = Locale::SubCountry::World->new;
  foreach my $country_code ($world->all_codes) {
    my $country = Locale::SubCountry->new($country_code);
    next unless $country->has_sub_countries;
    $existing{$country} ||= {};
    foreach my $state_code ($country->all_codes) {
      my $fips = $country->FIPS10_4_code($state_code);
      # we really only need U.S. state codes at this point, so if there's
      # no FIPS code, ignore it.
      next if !$fips or $fips eq 'unknown' or $fips =~ /\W/;
      my $this_state = $existing{$country_code}{$state_code};
      if ($this_state) {
        if ($this_state->fips ne $fips) { # this should never happen...
          $this_state->set(fips => $fips);
          my $error = $this_state->replace;
          die "error updating $country_code/$state_code:\n$error\n" if $error;
        }
        delete $existing{$country_code}{$state_code};
      } else {
        $this_state = FS::state->new({
          country => $country_code,
          state   => $state_code,
          fips    => $fips,
        });
        my $error = $this_state->insert;
        die "error inserting $country_code/$state_code:\n$error\n" if $error;
      }
    }
    # clean up states that no longer exist (does this ever happen?)
    foreach my $state (values %{ $existing{$country_code} }) {
      my $error = $state->delete;
      die "error removing expired state ".$state->country.'/'.$state->state.
          "\n$error\n" if $error;
    }
  } # foreach $country_code
  '';
}

=head1 BUGS

=head1 SEE ALSO

L<FS::Record>

=cut

1;