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   'all_dates'    => [],
 107   'svc_acct'     => [qw( username _password domsvc )],
 108   'svc_phone'    => [qw( countrycode phonenum sip_password pin )],
 109   'svc_external' => [qw( id title )],
 110   'location'     => [qw( address1 address2 city state zip country )],
 111 );
 112
 113 sub _formatfields {
 114   \%formatfields;
 115 }
 116
 117 my %import_options = (
 118   'table'         => 'cust_pkg',
 119
 120   'preinsert_callback'  => sub {
 121     my($record, $param) = @_;
 122     my @location_params = grep /^location\./, keys %$param;
 123     if (@location_params) {
 124       my $cust_location = FS::cust_location->new({
 125           'custnum' => $record->custnum,
 126       });
 127       foreach my $p (@location_params) {
 128         $p =~ /^location.(\w+)$/;
 129         $cust_location->set($1, $param->{$p});
 130       }
 131
 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   if ( $format =~ /^(.*)-locationnum$/ ) {
 213     $format = $1;
 214     push @fields, 'locationnum';
 215   }
 216
 217   push @fields, ( 'pkgpart', 'discountnum' );
 218
 219   my @date_fields = ();
 220   if ( $format =~ /all_dates/ ) {
 221     @date_fields = qw(
 222       order_date
 223       start_date setup bill last_bill susp adjourn
 224       resume
 225       cancel expire
 226       contract_end dundate
 227     );
 228   } else {
 229     @date_fields = qw(
 230       start_date setup bill last_bill susp adjourn
 231       cancel expire
 232     );
 233   }
 234
 235   foreach my $field (@date_fields) {
 236     push @fields, sub {
 237       my( $self, $value ) = @_; # $conf, $param
 238       #->$field has undesirable effects
 239       $self->set($field, parse_datetime($value) ); #$field closure
 240     };
 241   }
 242
 243   my $formatfields = _formatfields();
 244
 245   die "unknown format $format" unless $formatfields->{$format};
 246
 247   foreach my $field ( @{ $formatfields->{$format} } ) {
 248
 249     push @fields, sub {
 250       my( $self, $value, $conf, $param ) = @_;
 251       $param->{"$format.$field"} = $value;
 252     };
 253
 254   }
 255
 256   $opt->{'fields'} = \@fields;
 257
 258   FS::Record::batch_import( $opt );
 259
 260 }
 261
 262 =for comment
 263
 264     my $billtime = time;
 265     my %cust_pkg = ( pkgpart => $pkgpart );
 266     my %svc_x = ();
 267     foreach my $field ( @fields ) {
 268
 269       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
 270
 271         #$cust_pkg{$1} = parse_datetime( shift @$columns );
 272         if ( $1 eq 'pkgpart' ) {
 273           $cust_pkg{$1} = shift @columns;
 274         } elsif ( $1 eq 'setup' ) {
 275           $billtime = parse_datetime(shift @columns);
 276         } else {
 277           $cust_pkg{$1} = parse_datetime( shift @columns );
 278         }
 279
 280       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
 281
 282         $svc_x{$1} = shift @columns;
 283
 284       } elsif ( $field =~ /^svc_external\.(id|title)$/ ) {
 285
 286         $svc_x{$1} = shift @columns;
 287
 288       } elsif ( $field =~ /^svc_phone\.(countrycode|phonenum|sip_password|pin)$/ ) {
 289         $svc_x{$1} = shift @columns;
 290
 291       } else {
 292
 293         #refnum interception
 294         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
 295
 296           my $referral = $columns[0];
 297           my %hash = ( 'referral' => $referral,
 298                        'agentnum' => $agentnum,
 299                        'disabled' => '',
 300                      );
 301
 302           my $part_referral = qsearchs('part_referral', \%hash )
 303                               || new FS::part_referral \%hash;
 304
 305           unless ( $part_referral->refnum ) {
 306             my $error = $part_referral->insert;
 307             if ( $error ) {
 308               $dbh->rollback if $oldAutoCommit;
 309               return "can't auto-insert advertising source: $referral: $error";
 310             }
 311           }
 312
 313           $columns[0] = $part_referral->refnum;
 314         }
 315
 316         my $value = shift @columns;
 317         $cust_main{$field} = $value if length($value);
 318       }
 319     }
 320
 321     $cust_main{'payby'} = 'CARD'
 322       if defined $cust_main{'payinfo'}
 323       && length  $cust_main{'payinfo'};
 324
 325     my $invoicing_list = $cust_main{'invoicing_list'}
 326                            ? [ delete $cust_main{'invoicing_list'} ]
 327                            : [];
 328
 329     my $cust_main = new FS::cust_main ( \%cust_main );
 330
 331     use Tie::RefHash;
 332     tie my %hash, 'Tie::RefHash'; #this part is important
 333
 334     if ( $cust_pkg{'pkgpart'} ) {
 335       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
 336
 337       my @svc_x = ();
 338       my $svcdb = '';
 339       if ( $svc_x{'username'} ) {
 340         $svcdb = 'svc_acct';
 341       } elsif ( $svc_x{'id'} || $svc_x{'title'} ) {
 342         $svcdb = 'svc_external';
 343       }
 344
 345       my $svc_phone = '';
 346       if ( $svc_x{'countrycode'} || $svc_x{'phonenum'} ) {
 347         $svc_phone = FS::svc_phone->new( {
 348           map { $_ => delete($svc_x{$_}) }
 349               qw( countrycode phonenum sip_password pin)
 350         } );
 351       }
 352
 353       if ( $svcdb || $svc_phone ) {
 354         my $part_pkg = $cust_pkg->part_pkg;
 355         unless ( $part_pkg ) {
 356           $dbh->rollback if $oldAutoCommit;
 357           return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
 358         }
 359         if ( $svcdb ) {
 360           $svc_x{svcpart} = $part_pkg->svcpart_unique_svcdb( $svcdb );
 361           my $class = "FS::$svcdb";
 362           push @svc_x, $class->new( \%svc_x );
 363         }
 364         if ( $svc_phone ) {
 365           $svc_phone->svcpart( $part_pkg->svcpart_unique_svcdb('svc_phone') );
 366           push @svc_x, $svc_phone;
 367         }
 368       }
 369
 370       $hash{$cust_pkg} = \@svc_x;
 371     }
 372
 373     my $error = $cust_main->insert( \%hash, $invoicing_list );
 374
 375     if ( $error ) {
 376       $dbh->rollback if $oldAutoCommit;
 377       return "can't insert customer". ( $line ? " for $line" : '' ). ": $error";
 378     }
 379
 380     if ( $format eq 'simple' ) {
 381
 382       #false laziness w/bill.cgi
 383       $error = $cust_main->bill( 'time' => $billtime );
 384       if ( $error ) {
 385         $dbh->rollback if $oldAutoCommit;
 386         return "can't bill customer for $line: $error";
 387       }
 388
 389       $error = $cust_main->apply_payments_and_credits;
 390       if ( $error ) {
 391         $dbh->rollback if $oldAutoCommit;
 392         return "can't bill customer for $line: $error";
 393       }
 394
 395       $error = $cust_main->collect();
 396       if ( $error ) {
 397         $dbh->rollback if $oldAutoCommit;
 398         return "can't collect customer for $line: $error";
 399       }
 400
 401     }
 402
 403     $row++;
 404
 405     if ( $job && time - $min_sec > $last ) { #progress bar
 406       $job->update_statustext( int(100 * $row / $count) );
 407       $last = time;
 408     }
 409
 410   }
 411
 412   $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
 413
 414   return "Empty file!" unless $row;
 415
 416   ''; #no error
 417
 418 }
 419
 420 =head1 BUGS
 421
 422 Not enough documentation.
 423
 424 =head1 SEE ALSO
 425
 426 L<FS::cust_main>, L<FS::cust_pkg>,
 427 L<FS::svc_acct>, L<FS::svc_external>, L<FS::svc_phone>
 428
 429 =cut
 430
 431 1;