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_number('zip')
 117     || $self->ut_text('state')
 118     || $self->ut_number('plus4hi')
 119     || $self->ut_number('plus4lo')
 120     || $self->ut_enum('default', [ '', ' ', 'Y' ] )
 121     || $self->ut_number('geocode')
 122   ;
 123   return $error if $error;
 124
 125   $self->SUPER::check;
 126 }
 127
 128
 129 sub batch_import {
 130   my ($param, $job) = @_;
 131
 132   my $fh = $param->{filehandle};
 133   my $format = $param->{'format'};
 134
 135   my $imported = 0;
 136   my @fields;
 137   my $hook;
 138
 139   my @column_lengths = ();
 140   my @column_callbacks = ();
 141   if ( $format eq 'cch-fixed' || $format eq 'cch-fixed-update' ) {
 142     $format =~ s/-fixed//;
 143     push @column_lengths, qw( 5 2 4 4 10 1 );
 144     push @column_lengths, 1 if $format eq 'cch-update';
 145   }
 146
 147   my $line;
 148   my ( $count, $last, $min_sec ) = (0, time, 5); #progressbar
 149   if ( $job || scalar(@column_callbacks) ) {
 150     my $error = csv_from_fixed(\$fh, \$count, \@column_lengths);
 151     return $error if $error;
 152   }
 153
 154   if ( $format eq 'cch' || $format eq 'cch-update' ) {
 155     @fields = qw( zip state plus4lo plus4hi geocode default );
 156     push @fields, 'actionflag' if $format eq 'cch-update';
 157
 158     $imported++ if $format eq 'cch-update'; #empty file ok
 159
 160     $hook = sub {
 161       my $hash = shift;
 162
 163       $hash->{'data_vendor'} = 'cch';
 164
 165       if (exists($hash->{actionflag}) && $hash->{actionflag} eq 'D') {
 166         delete($hash->{actionflag});
 167
 168         my $cust_tax_location = qsearchs('cust_tax_location', $hash);
 169         return "Can't find cust_tax_location to delete: ".
 170                join(" ", map { "$_ => ". $hash->{$_} } @fields)
 171           unless $cust_tax_location;
 172
 173         my $error = $cust_tax_location->delete;
 174         return $error if $error;
 175
 176         delete($hash->{$_}) foreach (keys %$hash);
 177       }
 178
 179       delete($hash->{'actionflag'});
 180
 181       '';
 182
 183     };
 184
 185   } elsif ( $format eq 'extended' ) {
 186     die "unimplemented\n";
 187     @fields = qw( );
 188   } else {
 189     die "unknown format $format";
 190   }
 191
 192   eval "use Text::CSV_XS;";
 193   die $@ if $@;
 194
 195   my $csv = new Text::CSV_XS;
 196
 197   local $SIG{HUP} = 'IGNORE';
 198   local $SIG{INT} = 'IGNORE';
 199   local $SIG{QUIT} = 'IGNORE';
 200   local $SIG{TERM} = 'IGNORE';
 201   local $SIG{TSTP} = 'IGNORE';
 202   local $SIG{PIPE} = 'IGNORE';
 203
 204   my $oldAutoCommit = $FS::UID::AutoCommit;
 205   local $FS::UID::AutoCommit = 0;
 206   my $dbh = dbh;
 207
 208   while ( defined($line=<$fh>) ) {
 209     $csv->parse($line) or do {
 210       $dbh->rollback if $oldAutoCommit;
 211       return "can't parse: ". $csv->error_input();
 212     };
 213
 214     if ( $job ) {  # progress bar
 215       if ( time - $min_sec > $last ) {
 216         my $error = $job->update_statustext(
 217           int( 100 * $imported / $count )
 218         );
 219         die $error if $error;
 220         $last = time;
 221       }
 222     }
 223
 224     my @columns = $csv->fields();
 225
 226     my %cust_tax_location = ( 'data_vendor' => $format );;
 227     foreach my $field ( @fields ) {
 228       $cust_tax_location{$field} = shift @columns;
 229     }
 230     if ( scalar( @columns ) ) {
 231       $dbh->rollback if $oldAutoCommit;
 232       return "Unexpected trailing columns in line (wrong format?): $line";
 233     }
 234
 235     my $error = &{$hook}(\%cust_tax_location);
 236     if ( $error ) {
 237       $dbh->rollback if $oldAutoCommit;
 238       return $error;
 239     }
 240
 241     next unless scalar(keys %cust_tax_location);
 242
 243     my $cust_tax_location = new FS::cust_tax_location( \%cust_tax_location );
 244     $error = $cust_tax_location->insert;
 245
 246     if ( $error ) {
 247       $dbh->rollback if $oldAutoCommit;
 248       return "can't insert cust_tax_location for $line: $error";
 249     }
 250
 251     $imported++;
 252   }
 253
 254   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 255
 256   return "Empty file!" unless $imported;
 257
 258   ''; #no error
 259
 260 }
 261
 262 =back
 263
 264 =head1 BUGS
 265
 266 The author should be informed of any you find.
 267
 268 =head1 SEE ALSO
 269
 270 L<FS::Record>, schema.html from the base documentation.
 271
 272 =cut
 273
 274 1;
 275