X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_tax_location.pm;h=cccebafc9b00a9419cfed34a056197afd1d7a0ec;hp=11faa3f1f14ba8e36fae025df3058ca450763650;hb=57bb423fe457ba4e13726877f53bcdf944f828f8;hpb=4104f4e3d1b387296b16b4a035b4b7f42e0c5977 diff --git a/FS/FS/cust_tax_location.pm b/FS/FS/cust_tax_location.pm index 11faa3f1f..cccebafc9 100644 --- a/FS/FS/cust_tax_location.pm +++ b/FS/FS/cust_tax_location.pm @@ -3,6 +3,7 @@ package FS::cust_tax_location; use strict; use vars qw( @ISA ); use FS::Record qw( qsearch qsearchs dbh ); +use FS::Misc qw ( csv_from_fixed ); @ISA = qw(FS::Record); @@ -27,38 +28,48 @@ FS::cust_tax_location - Object methods for cust_tax_location records =head1 DESCRIPTION -An FS::cust_tax_location object represents a mapping between a customer and -a tax location. FS::cust_tax_location inherits from FS::Record. The -following fields are currently supported: +An FS::cust_tax_location object represents a classification rule for +determining a tax region code ('geocode') for a service location. These +records are used when editing customer locations to help the user choose the +correct tax jurisdiction code. The jurisdiction codes are actually defined +in L, and appear directly in records in +L. -=over 4 - -=item custlocationnum +FS::cust_tax_location is used in tax calculation (for CCH) to determine +"implied" geocodes for customers and locations that have a complete U.S. +ZIP+4 code and thus can be exactly placed in a jurisdiction. For those that +don't, the user is expected to choose the geocode when entering the customer +record. -primary key +FS::cust_tax_location inherits from FS::Record. The following fields are +currently supported: -=item data_vendor +=over 4 -a tax data vendor +=item custlocationnum - primary key -=item zip +=item data_vendor - a tax data vendor and "style" of record -=item state +=item country - the two-letter country code -=item plus4hi +=item state - the two-letter state code (though CCH uses this differently; +see QUIRKS) -the upper bound of the last 4 zip code digits +=item zip - an exact zip code (again, see QUIRKS) -=item plus4lo +=item ziplo - the lower bound of the zip code range (requires zip to be null) -the lower bound of the last 4 zip code digits +=item ziphi - the upper bound of the zip code range (requires zip to be null) -=item default_location +=item plus4lo - the lower bound of the last 4 zip code digits -'Y' when this record represents the default for zip +=item plus4hi - the upper bound of the last 4 zip code digits -=item geocode - the foreign key into FS::part_pkg_tax_rate and FS::tax_rate +=item default_location - 'Y' when this record represents the default. The UI +will list default locations before non-default locations. +=item geocode - the foreign key into L, +L, L, etc. =back @@ -112,28 +123,163 @@ sub check { my $error = $self->ut_numbern('custlocationnum') || $self->ut_text('data_vendor') - || $self->ut_number('zip') + || $self->ut_textn('city') + || $self->ut_textn('postalcity') + || $self->ut_textn('county') || $self->ut_text('state') - || $self->ut_number('plus4hi') - || $self->ut_number('plus4lo') - || $self->ut_enum('default', [ '', ' ', 'Y' ] ) - || $self->ut_number('geocode') + || $self->ut_numbern('plus4hi') + || $self->ut_numbern('plus4lo') + || $self->ut_enum('default_location', [ '', 'Y' ] ) + || $self->ut_enum('cityflag', [ '', 'I', 'O', 'B' ] ) + || $self->ut_alpha('geocode') ; + if ( $self->country ) { + $error ||= $self->ut_country('country') + || $self->ut_zip('ziphi', $self->country) + || $self->ut_zip('ziplo', $self->country); + } + return $error if $error; + + if ($self->state eq 'CN' && $self->data_vendor eq 'cch-zip' ) { + $error = "Illegal canadian zip" + unless $self->zip =~ /^[A-Z]$/; + } elsif ($self->state =~ /^E([B-DFGILNPR-UW])$/ && $self->data_vendor eq 'cch-zip' ) { + $error = "Illegal european zip" + unless $self->zip =~ /^E$1$/; + } elsif ($self->data_vendor =~ /^cch/) { + $error = $self->ut_numbern('zip', $self->state eq 'CN' ? 'CA' : 'US'); + } return $error if $error; $self->SUPER::check; } +# annoyingly incompatible with FS::Record::batch_import. sub batch_import { - my $param = shift; + my ($param, $job) = @_; my $fh = $param->{filehandle}; my $format = $param->{'format'}; + my $imported = 0; my @fields; - if ( $format eq 'cch' ) { - @fields = qw( zip state plus4lo plus4hi geocode default ); + my $hook; + + my @column_lengths = (); + my @column_callbacks = (); + if ( $format =~ /^cch-fixed/ ) { + $format =~ s/-fixed//; + my $f = $format; + my $update = 0; + $f =~ s/-update// && ($update = 1); + if ($f eq 'cch') { + push @column_lengths, qw( 5 2 4 4 10 1 ); + } elsif ( $f eq 'cch-zip' ) { + push @column_lengths, qw( 5 28 25 2 28 5 1 1 10 1 2 ); + } else { + return "Unknown format: $format"; + } + push @column_lengths, 1 if $update; + } + + my $line; + my ( $count, $last, $min_sec ) = (0, time, 5); #progressbar + if ( $job || scalar(@column_lengths) ) { + my $error = csv_from_fixed(\$fh, \$count, \@column_lengths); + return $error if $error; + } + + if ( $format eq 'cch' || $format eq 'cch-update' ) { + @fields = qw( zip state plus4lo plus4hi geocode default_location ); + push @fields, 'actionflag' if $format eq 'cch-update'; + + $imported++ if $format eq 'cch-update'; #empty file ok + + $hook = sub { + my $hash = shift; + + $hash->{'data_vendor'} = 'cch'; + $hash->{'default_location'} =~ s/ //g; + + if (exists($hash->{actionflag}) && $hash->{actionflag} eq 'D') { + delete($hash->{actionflag}); + + my @cust_tax_location = qsearch('cust_tax_location', $hash); + return "Can't find cust_tax_location to delete: ". + join(" ", map { "$_ => ". $hash->{$_} } @fields) + unless scalar(@cust_tax_location) || $param->{'delete_only'} ; + + foreach my $cust_tax_location (@cust_tax_location) { + my $error = $cust_tax_location->delete; + return $error if $error; + } + + delete($hash->{$_}) foreach (keys %$hash); + } + + delete($hash->{'actionflag'}); + + ''; + + }; + + } elsif ( $format eq 'cch-zip' || $format eq 'cch-update-zip' ) { + @fields = qw( zip city county state postalcity countyfips countydef default_location geocode cityflag unique ); + push @fields, 'actionflag' if $format eq 'cch-update-zip'; + + $imported++ if $format eq 'cch-update'; #empty file ok + + $hook = sub { + my $hash = shift; + + $hash->{'data_vendor'} = 'cch-zip'; + delete($hash->{$_}) foreach qw( countyfips countydef unique ); + + $hash->{'cityflag'} =~ s/ //g; + $hash->{'default_location'} =~ s/ //g; + + if (exists($hash->{actionflag}) && $hash->{actionflag} eq 'D') { + delete($hash->{actionflag}); + + my @cust_tax_location = qsearch('cust_tax_location', $hash); + return "Can't find cust_tax_location to delete: ". + join(" ", map { "$_ => ". $hash->{$_} } @fields) + unless scalar(@cust_tax_location) || $param->{'delete_only'} ; + + foreach my $cust_tax_location (@cust_tax_location) { + my $error = $cust_tax_location->delete; + return $error if $error; + } + + delete($hash->{$_}) foreach (keys %$hash); + } + + delete($hash->{'actionflag'}); + + ''; + + }; + + } elsif ( $format eq 'billsoft' ) { + + @fields = qw( geocode alt_location country state county city + ziplo ziphi ); + $hook = sub { + my $hash = shift; + $hash->{data_vendor} = 'billsoft'; + $hash->{default_location} = ($hash->{alt_location} ? '' : 'Y'); + $hash->{city} =~ s/[^\w ]//g; # remove asterisks and other bad things + $hash->{country} = substr($hash->{country}, 0, 2); + if ( $hash->{state} =~ /^ *$/ + or $hash->{county} =~ /^ *$/ + or $hash->{country} !~ /^US|CA$/ ) { + # remove whole-country rows, whole-state rows, and non-CAN/USA rows + %$hash = (); + } + ''; + }; + } elsif ( $format eq 'extended' ) { die "unimplemented\n"; @fields = qw( ); @@ -146,8 +292,6 @@ sub batch_import { my $csv = new Text::CSV_XS; - my $imported = 0; - local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; local $SIG{QUIT} = 'IGNORE'; @@ -159,22 +303,45 @@ sub batch_import { local $FS::UID::AutoCommit = 0; my $dbh = dbh; - my $line; while ( defined($line=<$fh>) ) { $csv->parse($line) or do { $dbh->rollback if $oldAutoCommit; return "can't parse: ". $csv->error_input(); }; + if ( $job ) { # progress bar + if ( time - $min_sec > $last ) { + my $error = $job->update_statustext( + int( 100 * $imported / $count ). ",Importing tax locations" + ); + die $error if $error; + $last = time; + } + } + my @columns = $csv->fields(); my %cust_tax_location = ( 'data_vendor' => $format );; foreach my $field ( @fields ) { $cust_tax_location{$field} = shift @columns; } + if ( scalar( @columns ) ) { + $dbh->rollback if $oldAutoCommit; + return "Unexpected trailing columns in line (wrong format?) importing cust_tax_location: $line"; + } + + my $error = &{$hook}(\%cust_tax_location); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + # $hook can delete the contents of the hash to prevent the row from + # being inserted + next unless scalar(keys %cust_tax_location); my $cust_tax_location = new FS::cust_tax_location( \%cust_tax_location ); - my $error = $cust_tax_location->insert; + $error = $cust_tax_location->insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; @@ -186,7 +353,7 @@ sub batch_import { $dbh->commit or die $dbh->errstr if $oldAutoCommit; - return "Empty file!" unless $imported; + return "Empty file!" unless ( $imported || $format =~ /^cch-update/ ); ''; #no error @@ -194,9 +361,52 @@ sub batch_import { =back +=head1 SUBROUTINES + +=over 4 + +=item process_batch_import JOB, PARAMS + +Starts a batch import given JOB (an L) and PARAMS (a +Base64-Storable hash). PARAMS should contain 'format' and 'uploaded_files'. + +Currently only usable for Billsoft imports; CCH's agglomeration of update +files need to be imported through L. + +=cut + +sub process_batch_import { + my $job = shift; + my $param = shift; + + my $files = $param->{'uploaded_files'}; + + my ($file) = ($files =~ /^zipfile:(.*)$/) + or die "No files provided.\n"; + + my $dir = $FS::UID::cache_dir . '/cache.' . $FS::UID::datasrc; + open ( $param->{'filehandle'}, '<', "$dir/$file" ) + or die "unable to open '$file': $!\n"; + + my $error = batch_import($param, $job); + die $error if $error; +} + +=back + +=head1 QUIRKS + +CCH doesn't have a "country" field; for addresses in Canada it uses state += 'CN', and zip = the one-letter postal code prefix for the province. Or +maybe that's just our CCH implementation. This doesn't apply to Billsoft, +and shouldn't apply to any other tax vendor that may somehow be implemented. + +CCH also has two styles of records in this table: cch and cch-zip. cch +records define a unique + =head1 BUGS -The author should be informed of any you find. +CCH clutter. =head1 SEE ALSO