FS/FS/tax_class.pm

   1 package FS::tax_class;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::UID qw(dbh);
   6 use FS::Record qw( qsearch qsearchs );
   7 use FS::Misc qw( csv_from_fixed );
   8
   9 @ISA = qw(FS::Record);
  10
  11 =head1 NAME
  12
  13 FS::tax_class - Object methods for tax_class records
  14
  15 =head1 SYNOPSIS
  16
  17   use FS::tax_class;
  18
  19   $record = new FS::tax_class \%hash;
  20   $record = new FS::tax_class { 'column' => 'value' };
  21
  22   $error = $record->insert;
  23
  24   $error = $new_record->replace($old_record);
  25
  26   $error = $record->delete;
  27
  28   $error = $record->check;
  29
  30 =head1 DESCRIPTION
  31
  32 An FS::tax_class object represents a tax class.  FS::tax_class
  33 inherits from FS::Record.  The following fields are currently supported:
  34
  35 =over 4
  36
  37 =item taxclassnum
  38
  39 Primary key
  40
  41 =item data_vendor
  42
  43 Vendor of the tax data
  44
  45 =item taxclass
  46
  47 Tax class
  48
  49 =item description
  50
  51 Human readable description of the tax class
  52
  53 =back
  54
  55 =head1 METHODS
  56
  57 =over 4
  58
  59 =item new HASHREF
  60
  61 Creates a new tax class.  To add the tax class to the database, see L<"insert">.
  62
  63 Note that this stores the hash reference, not a distinct copy of the hash it
  64 points to.  You can ask the object for a copy with the I<hash> method.
  65
  66 =cut
  67
  68 sub table { 'tax_class'; }
  69
  70 =item insert
  71
  72 Adds this record to the database.  If there is an error, returns the error,
  73 otherwise returns false.
  74
  75 =cut
  76
  77 =item delete
  78
  79 Delete this record from the database.
  80
  81 =cut
  82
  83 sub delete {
  84   my $self = shift;
  85
  86   return "Can't delete a tax class which has tax rates!"
  87     if qsearch( 'tax_rate', { 'taxclassnum' => $self->taxclassnum } );
  88
  89   return "Can't delete a tax class which has package tax rates!"
  90     if qsearch( 'part_pkg_taxrate', { 'taxclassnum' => $self->taxclassnum } );
  91
  92   return "Can't delete a tax class which has package tax rates!"
  93     if qsearch( 'part_pkg_taxrate', { 'taxclassnumtaxed' => $self->taxclassnum } );
  94
  95   return "Can't delete a tax class which has package tax overrides!"
  96     if qsearch( 'part_pkg_taxoverride', { 'taxclassnum' => $self->taxclassnum } );
  97
  98   $self->SUPER::delete(@_);
  99
 100 }
 101
 102 =item replace OLD_RECORD
 103
 104 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 105 returns the error, otherwise returns false.
 106
 107 =cut
 108
 109 =item check
 110
 111 Checks all fields to make sure this is a valid tax class.  If there is
 112 an error, returns the error, otherwise returns false.  Called by the insert
 113 and replace methods.
 114
 115 =cut
 116
 117 sub check {
 118   my $self = shift;
 119
 120   my $error =
 121     $self->ut_numbern('taxclassnum')
 122     || $self->ut_text('taxclass')
 123     || $self->ut_textn('data_vendor')
 124     || $self->ut_textn('description')
 125   ;
 126   return $error if $error;
 127
 128   $self->SUPER::check;
 129 }
 130
 131 =item batch_import
 132
 133 Loads part_pkg_taxrate records from an external CSV file.  If there is
 134 an error, returns the error, otherwise returns false.
 135
 136 =cut
 137
 138 sub batch_import {
 139   my ($param, $job) = @_;
 140
 141   my $fh = $param->{filehandle};
 142   my $format = $param->{'format'};
 143
 144   my @fields;
 145   my $hook;
 146   my $endhook;
 147   my $data = {};
 148   my $imported = 0;
 149   my $dbh = dbh;
 150
 151   my @column_lengths = ();
 152   my @column_callbacks = ();
 153   if ( $format eq 'cch-fixed' || $format eq 'cch-fixed-update' ) {
 154     $format =~ s/-fixed//;
 155     push @column_lengths, qw( 8 10 3 2 2 10 100 );
 156     push @column_lengths, 1 if $format eq 'cch-update';
 157   }
 158
 159   my $line;
 160   my ( $count, $last, $min_sec ) = (0, time, 5); #progressbar
 161   if ( $job || scalar(@column_lengths) ) {
 162     my $error = csv_from_fixed(\$fh, \$count, \@column_lengths);
 163     return $error if $error;
 164   }
 165
 166   if ( $format eq 'cch' || $format eq 'cch-update' ) {
 167     @fields = qw( table name pos length number value description );
 168     push @fields, 'actionflag' if $format eq 'cch-update';
 169
 170     $hook = sub {
 171       my $hash = shift;
 172 use Data::Dumper;
 173 warn Dumper($hash);
 174       if ($hash->{'table'} eq 'DETAIL') {
 175         push @{$data->{'taxcat'}}, [ $hash->{'value'}, $hash->{'description'} ]
 176           if ($hash->{'name'} eq 'TAXCAT' &&
 177              (!exists($hash->{actionflag}) || $hash->{actionflag} eq 'I') );
 178
 179         push @{$data->{'taxtype'}}, [ $hash->{'value'}, $hash->{'description'} ]
 180           if ($hash->{'name'} eq 'TAXTYPE' &&
 181              (!exists($hash->{actionflag}) || $hash->{actionflag} eq 'I') );
 182
 183         if (exists($hash->{actionflag}) && $hash->{actionflag} eq 'D') {
 184           my $name = $hash->{'name'};
 185           my $value = $hash->{'value'};
 186           return "Bad value for $name: $value"
 187             unless $value =~ /^\d+$/;
 188
 189           if ($name eq 'TAXCAT' || $name eq 'TAXTYPE') {
 190             my @tax_class = qsearch( 'tax_class',
 191                                      { 'data_vendor' => 'cch' },
 192                                      '',
 193                                      "AND taxclass LIKE '".
 194                                        ($name eq 'TAXTYPE' ? $value : '%').":".
 195                                        ($name eq 'TAXCAT' ? $value : '%')."'",
 196                                    );
 197             foreach (@tax_class) {
 198 warn "deleting ". $_->taxclass. ' '. $_->description. "\n";
 199               my $error = $_->delete;
 200               return $error if $error;
 201             }
 202           }
 203         }
 204
 205       }
 206
 207       delete($hash->{$_})
 208         for qw( data_vendor table name pos length number value description );
 209       delete($hash->{actionflag}) if exists($hash->{actionflag});
 210
 211       '';
 212
 213     };
 214
 215     $endhook = sub {
 216
 217       my $sql = "SELECT DISTINCT ".
 218          "substring(taxclass from 1 for position(':' in taxclass)-1),".
 219          "substring(description from 1 for position(':' in description)-1) ".
 220          "FROM tax_class WHERE data_vendor='cch'";
 221
 222       my $sth = $dbh->prepare($sql) or die $dbh->errstr;
 223       $sth->execute or die $sth->errstr;
 224       my @old_types = @{$sth->fetchall_arrayref};
 225
 226       $sql = "SELECT DISTINCT ".
 227          "substring(taxclass from position(':' in taxclass)+1),".
 228          "substring(description from position(':' in description)+1) ".
 229          "FROM tax_class WHERE data_vendor='cch'";
 230
 231       $sth = $dbh->prepare($sql) or die $dbh->errstr;
 232       $sth->execute or die $sth->errstr;
 233       my @old_cats = @{$sth->fetchall_arrayref};
 234
 235       my $catcount  = exists($data->{'taxcat'})  ? scalar(@{$data->{'taxcat'}})
 236                                                  : 0;
 237       my $typecount = exists($data->{'taxtype'}) ? scalar(@{$data->{'taxtype'}})
 238                                                  : 0;
 239
 240       my $count = scalar(@old_types) * $catcount
 241                 + $typecount * (scalar(@old_cats) + $catcount);
 242
 243       $imported = 1 if $format eq 'cch-update';  #empty file ok
 244
 245       foreach my $type (@old_types) {
 246         foreach my $cat (@{$data->{'taxcat'}}) {
 247
 248           if ( $job ) {  # progress bar
 249             if ( time - $min_sec > $last ) {
 250               my $error = $job->update_statustext(
 251                 int( 100 * $imported / $count ). ",Importing tax classes"
 252               );
 253               die $error if $error;
 254               $last = time;
 255             }
 256           }
 257
 258           my %hash = ( 'data_vendor' => 'cch',
 259                        'taxclass'    => $type->[0].':'.$cat->[0],
 260                        'description' => $type->[1].':'.$cat->[1],
 261                      );
 262           unless ( qsearchs('tax_class', \%hash) ) {
 263             my $tax_class = new FS::tax_class \%hash;
 264             my $error = $tax_class->insert;
 265
 266             return "can't insert tax_class for ".
 267                    " old TAXTYPE ". $type->[0].':'.$type->[1].
 268                    " and new TAXCAT ". $cat->[0].':'. $cat->[1].
 269                    " : $error"
 270               if $error;
 271           }
 272
 273           $imported++;
 274
 275         }
 276       }
 277
 278       foreach my $type (@{$data->{'taxtype'}}) {
 279         foreach my $cat (@old_cats, @{$data->{'taxcat'}}) {
 280
 281           if ( $job ) {  # progress bar
 282             if ( time - $min_sec > $last ) {
 283               my $error = $job->update_statustext(
 284                 int( 100 * $imported / $count ). ",Importing tax classes"
 285               );
 286               die $error if $error;
 287               $last = time;
 288             }
 289           }
 290
 291           my $tax_class =
 292             new FS::tax_class( { 'data_vendor' => 'cch',
 293                                  'taxclass'    => $type->[0].':'.$cat->[0],
 294                                  'description' => $type->[1].':'.$cat->[1],
 295                              } );
 296           my $error = $tax_class->insert;
 297           return "can't insert tax_class for new TAXTYPE $type and TAXCAT $cat: $error" if $error;
 298           $imported++;
 299         }
 300       }
 301
 302       '';
 303     };
 304
 305   } elsif ( $format eq 'extended' ) {
 306     die "unimplemented\n";
 307     @fields = qw( );
 308     $hook = sub {};
 309   } else {
 310     die "unknown format $format";
 311   }
 312
 313   eval "use Text::CSV_XS;";
 314   die $@ if $@;
 315
 316   my $csv = new Text::CSV_XS;
 317
 318   local $SIG{HUP} = 'IGNORE';
 319   local $SIG{INT} = 'IGNORE';
 320   local $SIG{QUIT} = 'IGNORE';
 321   local $SIG{TERM} = 'IGNORE';
 322   local $SIG{TSTP} = 'IGNORE';
 323   local $SIG{PIPE} = 'IGNORE';
 324
 325   my $oldAutoCommit = $FS::UID::AutoCommit;
 326   local $FS::UID::AutoCommit = 0;
 327
 328   while ( defined($line=<$fh>) ) {
 329
 330     if ( $job ) {  # progress bar
 331       if ( time - $min_sec > $last ) {
 332         my $error = $job->update_statustext(
 333           int( 100 * $imported / $count ). ",Importing tax classes"
 334         );
 335         die $error if $error;
 336         $last = time;
 337       }
 338     }
 339
 340     $csv->parse($line) or do {
 341       $dbh->rollback if $oldAutoCommit;
 342       return "can't parse: ". $csv->error_input();
 343     };
 344
 345     my @columns = $csv->fields();
 346
 347     my %tax_class = ( 'data_vendor' => $format );
 348     foreach my $field ( @fields ) {
 349       $tax_class{$field} = shift @columns;
 350     }
 351     if ( scalar( @columns ) ) {
 352       $dbh->rollback if $oldAutoCommit;
 353       return "Unexpected trailing columns in line (wrong format?) importing tax_class: $line";
 354     }
 355
 356     my $error = &{$hook}(\%tax_class);
 357     if ( $error ) {
 358       $dbh->rollback if $oldAutoCommit;
 359       return $error;
 360     }
 361
 362     next unless scalar(keys %tax_class);
 363
 364     my $tax_class = new FS::tax_class( \%tax_class );
 365     $error = $tax_class->insert;
 366     if ( $error ) {
 367       $dbh->rollback if $oldAutoCommit;
 368       return "can't insert tax_class for $line: $error";
 369     }
 370
 371     $imported++;
 372   }
 373
 374   my $error = &{$endhook}();
 375   if ( $error ) {
 376     $dbh->rollback if $oldAutoCommit;
 377     return "can't run end hook: $error";
 378   }
 379
 380   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 381
 382   return "Empty File!" unless ($imported || $format eq 'cch-update');
 383
 384   ''; #no error
 385
 386 }
 387
 388 =back
 389
 390 =head1 BUGS
 391
 392   batch_import does not handle mixed I and D records in the same file for
 393   format cch-update
 394
 395 =head1 SEE ALSO
 396
 397 L<FS::Record>, schema.html from the base documentation.
 398
 399 =cut
 400
 401 1;
 402
 403