FS/FS/cust_pkg/Import.pm

   1 package FS::cust_pkg::Import;
   2
   3 use strict;
   4 use vars qw( $DEBUG ); #$conf );
   5 use Storable qw(thaw);
   6 use Data::Dumper;
   7 use MIME::Base64;
   8 use FS::Misc::DateTime qw( parse_datetime );
   9 use FS::Record qw( qsearchs );
  10 use FS::cust_pkg;
  11 use FS::cust_main;
  12 use FS::svc_acct;
  13 use FS::svc_external;
  14 use FS::svc_phone;
  15 use FS::svc_domain;
  16
  17 $DEBUG = 0;
  18
  19 #install_callback FS::UID sub {
  20 #  $conf = new FS::Conf;
  21 #};
  22
  23 =head1 NAME
  24
  25 FS::cust_pkg::Import - Batch customer importing
  26
  27 =head1 SYNOPSIS
  28
  29   use FS::cust_pkg::Import;
  30
  31   #import
  32   FS::cust_pkg::Import::batch_import( {
  33     file      => $file,      #filename
  34     type      => $type,      #csv or xls
  35     format    => $format,    #extended, extended-plus_company, svc_external,
  36                              # or svc_external_svc_phone
  37     agentnum  => $agentnum,
  38     job       => $job,       #optional job queue job, for progressbar updates
  39     pkgbatch  => $pkgbatch, #optional batch unique identifier
  40   } );
  41   die $error if $error;
  42
  43   #ajax helper
  44   use FS::UI::Web::JSRPC;
  45   my $server =
  46     new FS::UI::Web::JSRPC 'FS::cust_pkg::Import::process_batch_import', $cgi;
  47   print $server->process;
  48
  49 =head1 DESCRIPTION
  50
  51 Batch package importing.
  52
  53 =head1 SUBROUTINES
  54
  55 =item process_batch_import
  56
  57 Load a batch import as a queued JSRPC job
  58
  59 =cut
  60
  61 sub process_batch_import {
  62   my $job = shift;
  63
  64   my $param = thaw(decode_base64(shift));
  65   warn Dumper($param) if $DEBUG;
  66
  67   my $files = $param->{'uploaded_files'}
  68     or die "No files provided.\n";
  69
  70   my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
  71
  72   my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
  73   my $file = $dir. $files{'file'};
  74
  75   my $type;
  76   if ( $file =~ /\.(\w+)$/i ) {
  77     $type = lc($1);
  78   } else {
  79     #or error out???
  80     warn "can't parse file type from filename $file; defaulting to CSV";
  81     $type = 'csv';
  82   }
  83
  84   my $error =
  85     FS::cust_pkg::Import::batch_import( {
  86       job      => $job,
  87       file     => $file,
  88       type     => $type,
  89       'params' => { pkgbatch => $param->{pkgbatch} },
  90       agentnum => $param->{'agentnum'},
  91       'format' => $param->{'format'},
  92     } );
  93
  94   unlink $file;
  95
  96   die "$error\n" if $error;
  97
  98 }
  99
 100 =item batch_import
 101
 102 =cut
 103
 104 my %formatfields = (
 105   'default'      => [],
 106   'svc_acct'     => [qw( username _password domsvc )],
 107   'svc_phone'    => [qw( countrycode phonenum sip_password pin )],
 108   'svc_external' => [qw( id title )],
 109   'location'     => [qw( address1 address2 city state zip country )],
 110 );
 111
 112 sub _formatfields {
 113   \%formatfields;
 114 }
 115
 116 my %import_options = (
 117   'table'         => 'cust_pkg',
 118
 119   'preinsert_callback'  => sub {
 120     my($record, $param) = @_;
 121     my @location_params = grep /^location\./, keys %$param;
 122     if (@location_params) {
 123       my $cust_location = FS::cust_location->new({
 124           'custnum' => $record->custnum,
 125       });
 126       foreach my $p (@location_params) {
 127         $p =~ /^location.(\w+)$/;
 128         $cust_location->set($1, $param->{$p});
 129       }
 130
 131 warn Dumper $cust_location; # XXX
 132       my $error = $cust_location->find_or_insert; # this avoids duplicates
 133       return "error creating location: $error" if $error;
 134       $record->set('locationnum', $cust_location->locationnum);
 135     }
 136     '';
 137   },
 138
 139   'postinsert_callback' => sub {
 140     my( $record, $param ) = @_;
 141
 142     my $formatfields = _formatfields;
 143     foreach my $svc_x ( grep /^svc/, keys %$formatfields ) {
 144
 145       my $ff = $formatfields->{$svc_x};
 146
 147       if ( grep $param->{"$svc_x.$_"}, @$ff ) {
 148         my $svc = "FS::$svc_x"->new( {
 149           'pkgnum'  => $record->pkgnum,
 150           'svcpart' => $record->part_pkg->svcpart($svc_x),
 151           map { $_ => $param->{"$svc_x.$_"} } @$ff
 152         } );
 153
 154         #this whole thing should be turned into a callback or config to turn on
 155         if ( $svc_x eq 'svc_acct' && $svc->username =~ /\@/ ) {
 156           my($username, $domain) = split(/\@/, $svc->username);
 157           my $svc_domain = qsearchs('svc_domain', { 'domain' => $domain } )
 158                          || new FS::svc_domain { 'svcpart' => 1,
 159                                                  'domain'  => $domain, };
 160           unless ( $svc_domain->svcnum ) {
 161             my $error = $svc_domain->insert;
 162             return "error auto-inserting domain: $error" if $error;
 163           }
 164           $svc->username($username);
 165           $svc->domsvc($svc_domain->svcnum);
 166         }
 167
 168         my $error = $svc->insert;
 169         return "error inserting service: $error" if $error;
 170       }
 171
 172     }
 173
 174     return ''; #no error
 175
 176   },
 177 );
 178
 179 sub _import_options {
 180   \%import_options;
 181 }
 182
 183 sub batch_import {
 184   my $opt = shift;
 185
 186   my $iopt = _import_options;
 187   $opt->{$_} = $iopt->{$_} foreach keys %$iopt;
 188
 189   my $agentnum  = delete $opt->{agentnum}; # i like closures (delete though?)
 190
 191   my $format = delete $opt->{'format'};
 192   my @fields = ();
 193
 194   if ( $format =~ /^(.*)-agent_custid(-agent_pkgid)?$/ ) {
 195     $format = $1;
 196     my $agent_pkgid = $2;
 197     @fields = (
 198       sub {
 199         my( $self, $value ) = @_; # $conf, $param
 200         my $cust_main = qsearchs('cust_main', {
 201           'agentnum'     => $agentnum,
 202           'agent_custid' => $value,
 203         });
 204         $self->custnum($cust_main->custnum) if $cust_main;
 205       },
 206     );
 207     push @fields, 'agent_pkgid' if $agent_pkgid;
 208   } else {
 209     @fields = ( 'custnum' );
 210   }
 211
 212   push @fields, ( 'pkgpart', 'discountnum' );
 213
 214   foreach my $field (
 215     qw( start_date setup bill last_bill susp adjourn cancel expire )
 216   ) {
 217     push @fields, sub {
 218       my( $self, $value ) = @_; # $conf, $param
 219       #->$field has undesirable effects
 220       $self->set($field, parse_datetime($value) ); #$field closure
 221     };
 222   }
 223
 224   my $formatfields = _formatfields();
 225
 226   die "unknown format $format" unless $formatfields->{$format};
 227
 228   foreach my $field ( @{ $formatfields->{$format} } ) {
 229
 230     push @fields, sub {
 231       my( $self, $value, $conf, $param ) = @_;
 232       $param->{"$format.$field"} = $value;
 233     };
 234
 235   }
 236
 237   $opt->{'fields'} = \@fields;
 238
 239   FS::Record::batch_import( $opt );
 240
 241 }
 242
 243 =for comment
 244
 245     my $billtime = time;
 246     my %cust_pkg = ( pkgpart => $pkgpart );
 247     my %svc_x = ();
 248     foreach my $field ( @fields ) {
 249
 250       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
 251
 252         #$cust_pkg{$1} = parse_datetime( shift @$columns );
 253         if ( $1 eq 'pkgpart' ) {
 254           $cust_pkg{$1} = shift @columns;
 255         } elsif ( $1 eq 'setup' ) {
 256           $billtime = parse_datetime(shift @columns);
 257         } else {
 258           $cust_pkg{$1} = parse_datetime( shift @columns );
 259         }
 260
 261       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
 262
 263         $svc_x{$1} = shift @columns;
 264
 265       } elsif ( $field =~ /^svc_external\.(id|title)$/ ) {
 266
 267         $svc_x{$1} = shift @columns;
 268
 269       } elsif ( $field =~ /^svc_phone\.(countrycode|phonenum|sip_password|pin)$/ ) {
 270         $svc_x{$1} = shift @columns;
 271
 272       } else {
 273
 274         #refnum interception
 275         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
 276
 277           my $referral = $columns[0];
 278           my %hash = ( 'referral' => $referral,
 279                        'agentnum' => $agentnum,
 280                        'disabled' => '',
 281                      );
 282
 283           my $part_referral = qsearchs('part_referral', \%hash )
 284                               || new FS::part_referral \%hash;
 285
 286           unless ( $part_referral->refnum ) {
 287             my $error = $part_referral->insert;
 288             if ( $error ) {
 289               $dbh->rollback if $oldAutoCommit;
 290               return "can't auto-insert advertising source: $referral: $error";
 291             }
 292           }
 293
 294           $columns[0] = $part_referral->refnum;
 295         }
 296
 297         my $value = shift @columns;
 298         $cust_main{$field} = $value if length($value);
 299       }
 300     }
 301
 302     $cust_main{'payby'} = 'CARD'
 303       if defined $cust_main{'payinfo'}
 304       && length  $cust_main{'payinfo'};
 305
 306     my $invoicing_list = $cust_main{'invoicing_list'}
 307                            ? [ delete $cust_main{'invoicing_list'} ]
 308                            : [];
 309
 310     my $cust_main = new FS::cust_main ( \%cust_main );
 311
 312     use Tie::RefHash;
 313     tie my %hash, 'Tie::RefHash'; #this part is important
 314
 315     if ( $cust_pkg{'pkgpart'} ) {
 316       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
 317
 318       my @svc_x = ();
 319       my $svcdb = '';
 320       if ( $svc_x{'username'} ) {
 321         $svcdb = 'svc_acct';
 322       } elsif ( $svc_x{'id'} || $svc_x{'title'} ) {
 323         $svcdb = 'svc_external';
 324       }
 325
 326       my $svc_phone = '';
 327       if ( $svc_x{'countrycode'} || $svc_x{'phonenum'} ) {
 328         $svc_phone = FS::svc_phone->new( {
 329           map { $_ => delete($svc_x{$_}) }
 330               qw( countrycode phonenum sip_password pin)
 331         } );
 332       }
 333
 334       if ( $svcdb || $svc_phone ) {
 335         my $part_pkg = $cust_pkg->part_pkg;
 336         unless ( $part_pkg ) {
 337           $dbh->rollback if $oldAutoCommit;
 338           return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
 339         }
 340         if ( $svcdb ) {
 341           $svc_x{svcpart} = $part_pkg->svcpart_unique_svcdb( $svcdb );
 342           my $class = "FS::$svcdb";
 343           push @svc_x, $class->new( \%svc_x );
 344         }
 345         if ( $svc_phone ) {
 346           $svc_phone->svcpart( $part_pkg->svcpart_unique_svcdb('svc_phone') );
 347           push @svc_x, $svc_phone;
 348         }
 349       }
 350
 351       $hash{$cust_pkg} = \@svc_x;
 352     }
 353
 354     my $error = $cust_main->insert( \%hash, $invoicing_list );
 355
 356     if ( $error ) {
 357       $dbh->rollback if $oldAutoCommit;
 358       return "can't insert customer". ( $line ? " for $line" : '' ). ": $error";
 359     }
 360
 361     if ( $format eq 'simple' ) {
 362
 363       #false laziness w/bill.cgi
 364       $error = $cust_main->bill( 'time' => $billtime );
 365       if ( $error ) {
 366         $dbh->rollback if $oldAutoCommit;
 367         return "can't bill customer for $line: $error";
 368       }
 369
 370       $error = $cust_main->apply_payments_and_credits;
 371       if ( $error ) {
 372         $dbh->rollback if $oldAutoCommit;
 373         return "can't bill customer for $line: $error";
 374       }
 375
 376       $error = $cust_main->collect();
 377       if ( $error ) {
 378         $dbh->rollback if $oldAutoCommit;
 379         return "can't collect customer for $line: $error";
 380       }
 381
 382     }
 383
 384     $row++;
 385
 386     if ( $job && time - $min_sec > $last ) { #progress bar
 387       $job->update_statustext( int(100 * $row / $count) );
 388       $last = time;
 389     }
 390
 391   }
 392
 393   $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
 394
 395   return "Empty file!" unless $row;
 396
 397   ''; #no error
 398
 399 }
 400
 401 =head1 BUGS
 402
 403 Not enough documentation.
 404
 405 =head1 SEE ALSO
 406
 407 L<FS::cust_main>, L<FS::cust_pkg>,
 408 L<FS::svc_acct>, L<FS::svc_external>, L<FS::svc_phone>
 409
 410 =cut
 411
 412 1;