FS/FS/cust_tax_location.pm

   1 package FS::cust_tax_location;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs dbh );
   6 use FS::Misc qw ( csv_from_fixed );
   7
   8 @ISA = qw(FS::Record);
   9
  10 =head1 NAME
  11
  12 FS::cust_tax_location - Object methods for cust_tax_location records
  13
  14 =head1 SYNOPSIS
  15
  16   use FS::cust_tax_location;
  17
  18   $record = new FS::cust_tax_location \%hash;
  19   $record = new FS::cust_tax_location { 'column' => 'value' };
  20
  21   $error = $record->insert;
  22
  23   $error = $new_record->replace($old_record);
  24
  25   $error = $record->delete;
  26
  27   $error = $record->check;
  28
  29 =head1 DESCRIPTION
  30
  31 An FS::cust_tax_location object represents a mapping between a customer and
  32 a tax location.  FS::cust_tax_location inherits from FS::Record.  The
  33 following fields are currently supported:
  34
  35 =over 4
  36
  37 =item custlocationnum
  38
  39 primary key
  40
  41 =item data_vendor
  42
  43 a tax data vendor
  44
  45 =item zip
  46
  47 =item state
  48
  49 =item plus4hi
  50
  51 the upper bound of the last 4 zip code digits
  52
  53 =item plus4lo
  54
  55 the lower bound of the last 4 zip code digits
  56
  57 =item default_location
  58
  59 'Y' when this record represents the default for zip
  60
  61 =item geocode - the foreign key into FS::part_pkg_tax_rate and FS::tax_rate
  62
  63
  64 =back
  65
  66 =head1 METHODS
  67
  68 =over 4
  69
  70 =item new HASHREF
  71
  72 Creates a new cust_tax_location.  To add the cust_tax_location to the database,
  73 see L<"insert">.
  74
  75 Note that this stores the hash reference, not a distinct copy of the hash it
  76 points to.  You can ask the object for a copy with the I<hash> method.
  77
  78 =cut
  79
  80 sub table { 'cust_tax_location'; }
  81
  82 =item insert
  83
  84 Adds this record to the database.  If there is an error, returns the error,
  85 otherwise returns false.
  86
  87 =cut
  88
  89 =item delete
  90
  91 Delete this record from the database.
  92
  93 =cut
  94
  95 =item replace OLD_RECORD
  96
  97 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  98 returns the error, otherwise returns false.
  99
 100 =cut
 101
 102 =item check
 103
 104 Checks all fields to make sure this is a valid cust_tax_location.  If there is
 105 an error, returns the error, otherwise returns false.  Called by the insert
 106 and replace methods.
 107
 108 =cut
 109
 110 sub check {
 111   my $self = shift;
 112
 113   my $error =
 114     $self->ut_numbern('custlocationnum')
 115     || $self->ut_text('data_vendor')
 116     || $self->ut_textn('city')
 117     || $self->ut_textn('postalcity')
 118     || $self->ut_textn('county')
 119     || $self->ut_text('state')
 120     || $self->ut_numbern('plus4hi')
 121     || $self->ut_numbern('plus4lo')
 122     || $self->ut_enum('default_location', [ '', 'Y' ] )
 123     || $self->ut_enum('cityflag', [ '', 'I', 'O', 'B' ] )
 124     || $self->ut_alpha('geocode')
 125   ;
 126   return $error if $error;
 127
 128   #ugh!  cch canada weirdness and more
 129   if ($self->state eq 'CN' && $self->data_vendor eq 'cch-zip' ) {
 130     $error = "Illegal cch canadian zip"
 131      unless $self->zip =~ /^[A-Z]$/;
 132   } elsif ($self->state =~ /^E([B-DFGILNPR-UW])$/ && $self->data_vendor eq 'cch-zip' ) {
 133     $error = "Illegal cch european zip"
 134      unless $self->zip =~ /^E$1$/;
 135   } else {
 136     $error = $self->ut_number('zip', $self->state eq 'CN' ? 'CA' : 'US');
 137   }
 138   return $error if $error;
 139
 140   #ugh!  cch canada weirdness and more
 141   return "must specify either city/county or plus4lo/plus4hi"
 142     unless ( $self->plus4lo && $self->plus4hi ||
 143              ( $self->city ||
 144                $self->state eq 'CN' ||
 145                $self->state =~ /^E([B-DFGILNPR-UW])$/
 146              ) && $self->county
 147            );
 148
 149   $self->SUPER::check;
 150 }
 151
 152
 153 sub batch_import {
 154   my ($param, $job) = @_;
 155
 156   my $fh = $param->{filehandle};
 157   my $format = $param->{'format'};
 158
 159   my $imported = 0;
 160   my @fields;
 161   my $hook;
 162
 163   my @column_lengths = ();
 164   my @column_callbacks = ();
 165   if ( $format =~ /^cch-fixed/ ) {
 166     $format =~ s/-fixed//;
 167     my $f = $format;
 168     my $update = 0;
 169     $f =~ s/-update// && ($update = 1);
 170     if ($f eq 'cch') {
 171       push @column_lengths, qw( 5 2 4 4 10 1 );
 172     } elsif ( $f eq 'cch-zip' ) {
 173       push @column_lengths, qw( 5 28 25 2 28 5 1 1 10 1 2 );
 174     } else {
 175       return "Unknown format: $format";
 176     }
 177     push @column_lengths, 1 if $update;
 178   }
 179
 180   my $line;
 181   my ( $count, $last, $min_sec ) = (0, time, 5); #progressbar
 182   if ( $job || scalar(@column_lengths) ) {
 183     my $error = csv_from_fixed(\$fh, \$count, \@column_lengths);
 184     return $error if $error;
 185   }
 186
 187   if ( $format eq 'cch' || $format eq 'cch-update' ) {
 188     @fields = qw( zip state plus4lo plus4hi geocode default_location );
 189     push @fields, 'actionflag' if $format eq 'cch-update';
 190
 191     $imported++ if $format eq 'cch-update'; #empty file ok
 192
 193     $hook = sub {
 194       my $hash = shift;
 195
 196       $hash->{'data_vendor'} = 'cch';
 197       $hash->{'default_location'} =~ s/ //g;
 198
 199       if (exists($hash->{actionflag}) && $hash->{actionflag} eq 'D') {
 200         delete($hash->{actionflag});
 201
 202         my @cust_tax_location = qsearch('cust_tax_location', $hash);
 203         return "Can't find cust_tax_location to delete: ".
 204                join(" ", map { "$_ => ". $hash->{$_} } @fields)
 205           unless scalar(@cust_tax_location) || $param->{'delete_only'} ;
 206
 207         foreach my $cust_tax_location (@cust_tax_location) {
 208           my $error = $cust_tax_location->delete;
 209           return $error if $error;
 210         }
 211
 212         delete($hash->{$_}) foreach (keys %$hash);
 213       }
 214
 215       delete($hash->{'actionflag'});
 216
 217       '';
 218
 219     };
 220
 221   } elsif ( $format eq 'cch-zip' || $format eq 'cch-update-zip' ) {
 222     @fields = qw( zip city county state postalcity countyfips countydef default_location geocode cityflag unique );
 223     push @fields, 'actionflag' if $format eq 'cch-update-zip';
 224
 225     $imported++ if $format eq 'cch-update'; #empty file ok
 226
 227     $hook = sub {
 228       my $hash = shift;
 229
 230       $hash->{'data_vendor'} = 'cch-zip';
 231       delete($hash->{$_}) foreach qw( countyfips countydef unique );
 232
 233       $hash->{'cityflag'} =~ s/ //g;
 234       $hash->{'default_location'} =~ s/ //g;
 235
 236       if (exists($hash->{actionflag}) && $hash->{actionflag} eq 'D') {
 237         delete($hash->{actionflag});
 238
 239         my @cust_tax_location = qsearch('cust_tax_location', $hash);
 240         return "Can't find cust_tax_location to delete: ".
 241                join(" ", map { "$_ => ". $hash->{$_} } @fields)
 242           unless scalar(@cust_tax_location) || $param->{'delete_only'} ;
 243
 244         foreach my $cust_tax_location (@cust_tax_location) {
 245           my $error = $cust_tax_location->delete;
 246           return $error if $error;
 247         }
 248
 249         delete($hash->{$_}) foreach (keys %$hash);
 250       }
 251
 252       delete($hash->{'actionflag'});
 253
 254       '';
 255
 256     };
 257
 258   } elsif ( $format eq 'extended' ) {
 259     die "unimplemented\n";
 260     @fields = qw( );
 261   } else {
 262     die "unknown format $format";
 263   }
 264
 265   eval "use Text::CSV_XS;";
 266   die $@ if $@;
 267
 268   my $csv = new Text::CSV_XS;
 269
 270   local $SIG{HUP} = 'IGNORE';
 271   local $SIG{INT} = 'IGNORE';
 272   local $SIG{QUIT} = 'IGNORE';
 273   local $SIG{TERM} = 'IGNORE';
 274   local $SIG{TSTP} = 'IGNORE';
 275   local $SIG{PIPE} = 'IGNORE';
 276
 277   my $oldAutoCommit = $FS::UID::AutoCommit;
 278   local $FS::UID::AutoCommit = 0;
 279   my $dbh = dbh;
 280
 281   while ( defined($line=<$fh>) ) {
 282     $csv->parse($line) or do {
 283       $dbh->rollback if $oldAutoCommit;
 284       return "can't parse: ". $csv->error_input();
 285     };
 286
 287     if ( $job ) {  # progress bar
 288       if ( time - $min_sec > $last ) {
 289         my $error = $job->update_statustext(
 290           int( 100 * $imported / $count ). ",Importing locations"
 291         );
 292         die $error if $error;
 293         $last = time;
 294       }
 295     }
 296
 297     my @columns = $csv->fields();
 298
 299     my %cust_tax_location = ( 'data_vendor' => $format );;
 300     foreach my $field ( @fields ) {
 301       $cust_tax_location{$field} = shift @columns;
 302     }
 303     if ( scalar( @columns ) ) {
 304       $dbh->rollback if $oldAutoCommit;
 305       return "Unexpected trailing columns in line (wrong format?) importing cust_tax_location: $line";
 306     }
 307
 308     my $error = &{$hook}(\%cust_tax_location);
 309     if ( $error ) {
 310       $dbh->rollback if $oldAutoCommit;
 311       return $error;
 312     }
 313
 314     next unless scalar(keys %cust_tax_location);
 315
 316     my $cust_tax_location = new FS::cust_tax_location( \%cust_tax_location );
 317     $error = $cust_tax_location->insert;
 318
 319     if ( $error ) {
 320       $dbh->rollback if $oldAutoCommit;
 321       return "can't insert cust_tax_location for $line: $error";
 322     }
 323
 324     $imported++;
 325   }
 326
 327   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 328
 329   return "Empty file!" unless ( $imported || $format =~ /^cch-update/ );
 330
 331   ''; #no error
 332
 333 }
 334
 335 =back
 336
 337 =head1 BUGS
 338
 339 The author should be informed of any you find.
 340
 341 =head1 SEE ALSO
 342
 343 L<FS::Record>, schema.html from the base documentation.
 344
 345 =cut
 346
 347 1;
 348