add internal did database & ability to query for availability, plus upload tool
authorivan <ivan>
Mon, 15 Sep 2008 07:18:57 +0000 (07:18 +0000)
committerivan <ivan>
Mon, 15 Sep 2008 07:18:57 +0000 (07:18 +0000)
FS/FS/Record.pm
FS/FS/Schema.pm
FS/FS/part_export/internal_diddb.pm [new file with mode: 0644]
FS/FS/phone_avail.pm
httemplate/elements/menu.html
httemplate/misc/phone_avail-import.html [new file with mode: 0644]
httemplate/misc/process/phone_avail-import.html [new file with mode: 0644]

index 7dea7cb..022f7cd 100644 (file)
@@ -11,6 +11,8 @@ use Carp qw(carp cluck croak confess);
 use Scalar::Util qw( blessed );
 use File::CounterFile;
 use Locale::Country;
+use Text::CSV_XS;
+use File::Slurp qw( slurp );
 use DBI qw(:sql_types);
 use DBIx::DBSchema 0.33;
 use FS::UID qw(dbh getotaker datasrc driver_name);
@@ -1294,6 +1296,194 @@ sub check {
   '';
 }
 
+=item batch_import PARAM_HASHREF
+
+Class method for batch imports.  Available params:
+
+=over 4
+
+=item job
+
+FS::queue object, will be updated with progress
+
+=back
+
+=cut
+
+use Storable qw(thaw);
+use Data::Dumper;
+use MIME::Base64;
+sub process_batch_import {
+  my($job, $opt) = ( shift, shift );
+
+  my $table = $opt->{table};
+  my @pass_params = @{ $opt->{params} };
+  my %formats = %{ $opt->{formats} };
+
+  my $param = thaw(decode_base64(shift));
+  warn Dumper($param) if $DEBUG;
+  
+  my $files = $param->{'uploaded_files'}
+    or die "No files provided.\n";
+
+  my (%files) = map { /^(\w+):([\.\w]+)$/ ? ($1,$2):() } split /,/, $files;
+
+  my $dir = '%%%FREESIDE_CACHE%%%/cache.'. $FS::UID::datasrc. '/';
+  my $file = $dir. $files{'file'};
+
+  my $type;
+  if ( $file =~ /\.(\w+)$/i ) {
+    $type = lc($1);
+  } else {
+    #or error out???
+    warn "can't parse file type from filename $file; defaulting to CSV";
+    $type = 'csv';
+  }
+
+  my $error =
+    FS::Record::batch_import( {
+      table     => $table,
+      formats   => \%formats,
+      job       => $job,
+      file      => $file,
+      type      => $type,
+      format    => $param->{format},
+      params    => { map { $_ => $param->{$_} } @pass_params },
+    } );
+
+  unlink $file;
+
+  die "$error\n" if $error;
+}
+
+sub batch_import {
+  my $param = shift;
+
+  my $table     = $param->{table};
+  my $formats   = $param->{formats};
+  my $params    = $param->{params};
+
+  my $job       = $param->{job};
+
+  my $filename  = $param->{file};
+  my $type      = $param->{type} || 'csv';
+
+  my $format = $param->{'format'};
+
+  die "unknown format $format" unless exists $formats->{ $format };
+  my @fields    = @{ $formats->{ $format } };
+
+  my $count;
+  my $parser;
+  my @buffer = ();
+  if ( $type eq 'csv' ) {
+
+    $parser = new Text::CSV_XS;
+
+    @buffer = split(/\r?\n/, slurp($filename) );
+    $count = scalar(@buffer);
+
+  } elsif ( $type eq 'xls' ) {
+
+    eval "use Spreadsheet::ParseExcel;";
+    die $@ if $@;
+
+    my $excel = new Spreadsheet::ParseExcel::Workbook->Parse($filename);
+    $parser = $excel->{Worksheet}[0]; #first sheet
+
+    $count = $parser->{MaxRow} || $parser->{MinRow};
+    $count++;
+
+  } else {
+    die "Unknown file type $type\n";
+  }
+
+  #my $columns;
+
+  local $SIG{HUP} = 'IGNORE';
+  local $SIG{INT} = 'IGNORE';
+  local $SIG{QUIT} = 'IGNORE';
+  local $SIG{TERM} = 'IGNORE';
+  local $SIG{TSTP} = 'IGNORE';
+  local $SIG{PIPE} = 'IGNORE';
+
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+  
+  my $line;
+  my $row = 0;
+  my( $last, $min_sec ) = ( time, 5 ); #progressbar foo
+  while (1) {
+
+    my @columns = ();
+    if ( $type eq 'csv' ) {
+
+      last unless scalar(@buffer);
+      $line = shift(@buffer);
+
+      $parser->parse($line) or do {
+        $dbh->rollback if $oldAutoCommit;
+        return "can't parse: ". $parser->error_input();
+      };
+      @columns = $parser->fields();
+
+    } elsif ( $type eq 'xls' ) {
+
+      last if $row > ($parser->{MaxRow} || $parser->{MinRow});
+
+      my @row = @{ $parser->{Cells}[$row] };
+      @columns = map $_->{Val}, @row;
+
+      #my $z = 'A';
+      #warn $z++. ": $_\n" for @columns;
+
+    } else {
+      die "Unknown file type $type\n";
+    }
+
+    my %hash = %$params;
+
+    foreach my $field ( @fields ) {
+
+      my $value = shift @columns;
+     
+      if ( ref($field) eq 'CODE' ) {
+        &{$field}(\%hash, $value);
+      } else {
+        $hash{$field} = $value if length($value);
+      }
+
+    }
+
+    my $class = "FS::$table";
+
+    my $record = $class->new( \%hash );
+
+    my $error = $record->insert;
+
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return "can't insert record". ( $line ? " for $line" : '' ). ": $error";
+    }
+
+    $row++;
+
+    if ( $job && time - $min_sec > $last ) { #progress bar
+      $job->update_statustext( int(100 * $row / $count) );
+      $last = time;
+    }
+
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
+
+  return "Empty file!" unless $row;
+
+  ''; #no error
+
+}
+
 sub _h_statement {
   my( $self, $action, $time ) = @_;
 
index c0fd466..22bd19e 100644 (file)
@@ -2112,10 +2112,19 @@ sub tables_hashref {
         'state',       'char', 'NULL',  2, '', '', 
         'npa',         'char',     '',  3, '', '', 
         'nxx',         'char', 'NULL',  3, '', '', 
+        'station',     'char', 'NULL',  4, '', '',
+        'svcnum',      'int',     'NULL',      '', '', '',
+        'availbatch', 'varchar', 'NULL', $char_d, '', '',
       ],
       'primary_key' => 'availnum',
       'unique' => [],
-      'index'  => [ [ 'exportnum', 'countrycode', 'state' ] ],
+      'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
+                    [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
+                    [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
+                    [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
+                    [ 'svcnum' ],
+                    [ 'availbatch' ],
+                  ],
     },
 
     'reason_type' => {
diff --git a/FS/FS/part_export/internal_diddb.pm b/FS/FS/part_export/internal_diddb.pm
new file mode 100644 (file)
index 0000000..5e14873
--- /dev/null
@@ -0,0 +1,126 @@
+package FS::part_export::internal_diddb;
+
+use vars qw(@ISA %info);
+#use Tie::IxHash;
+use FS::Record qw(qsearch qsearchs);
+use FS::part_export;
+use FS::phone_avail;
+
+@ISA = qw(FS::part_export);
+
+%info = (
+  'svc'   => 'svc_phone',
+  'desc'  => 'Provision phone numbers from the internal DID database',
+  'notes' => 'After adding the export, DIDs may be imported under Tools -> Importing -> Import phone numbers (DIDs)',
+);
+
+sub rebless { shift; }
+
+sub get_dids {
+  my $self = shift;
+  my %opt = ref($_[0]) ? %{$_[0]} : @_;
+
+  my %hash = ( 'countrycode' => 1, #XXX make an option or something
+               'exportnum'   => $self->exportnum,
+               'svcnum'      => '',
+             );
+
+  if ( $opt{'areacode'} && $opt{'exchange'} ) { #return numbers
+
+    $hash{npa} = $opt{areacode};
+    $hash{nxx} = $opt{exchange};
+
+    return [ map { $_->npa. '-'. $_->nxx. '-'. $_->station }
+                 qsearch({ 'table'    => 'phone_avail',
+                           'hashref'  => \%hash,
+                           'order_by' => 'ORDER BY station',
+                        })
+           ];
+
+  } elsif ( $opt{'areacode'} ) { #return city (npa-nxx-XXXX)
+
+    $hash{npa} = $opt{areacode};
+
+    return [ map { '('. $_->npa. '-'. $_->nxx. '-XXXX)' }
+                 qsearch({ 'select'   => 'DISTINCT npa, nxx',
+                           'table'    => 'phone_avail',
+                           'hashref'  => \%hash,
+                           'order_by' => 'ORDER BY nxx',
+                        })
+           ];
+
+  } elsif ( $opt{'state'} ) { #return aracodes
+
+    $hash{state} = $opt{state};
+
+    return [ map { $_->npa }
+                 qsearch({ 'select'   => 'DISTINCT npa',
+                           'table'    => 'phone_avail',
+                           'hashref'  => \%hash,
+                           'order_by' => 'ORDER BY npa',
+                        })
+           ];
+
+  } else { 
+    die "FS::part_export::internal_diddb::get_dids called without options\n";
+  }
+
+}
+
+sub _export_insert   { #link phone_avail to svcnum
+  my( $self, $svc_phone ) = (shift, shift);
+
+  $svc_phone =~ /^(\d{3})(\d{3})(\d+)$/
+    or return "unparsable phone number: ". $svc_phone->phonenum;
+  my( $npa, $nxx, $station ) = ($1, $2, $3);
+
+  my $phone_avail = qsearchs('phone_avail', {
+    'countrycode' => 1, #XXX make an option or something
+    'exportnum'   => $self->exportnum,
+    'svcnum'      => '',
+    'npa'         => $npa,
+    'nxx'         => $nxx,
+    'station'     => $station,
+  });
+
+  return "number not available: ". $svc_phone->phonenum
+    unless $phone_avail;
+
+  $phone_avail->svcnum($svc_phone->svcnum);
+
+  $phone_avail->replace;
+
+}
+
+sub _export_delete   { #unlink phone_avail from svcnum
+  my( $self, $svc_phone ) = (shift, shift);
+
+  $svc_phone =~ /^(\d{3})(\d{3})(\d+)$/
+    or return "unparsable phone number: ". $svc_phone->phonenum;
+  my( $npa, $nxx, $station ) = ($1, $2, $3);
+
+  my $phone_avail = qsearchs('phone_avail', {
+    'countrycode' => 1, #XXX make an option or something
+    'exportnum'   => $self->exportnum,
+    'svcnum'      => $svc_phone->svcnum,
+    #these too?
+    'npa'         => $npa,
+    'nxx'         => $nxx,
+    'station'     => $station,
+  });
+
+  return "can't find number to return to availability: ". $svc_phone->phonenum
+    unless $phone_avail;
+
+  $phone_avail->svcnum('');
+
+  $phone_avail->replace;
+
+}
+
+sub _export_replace  { ''; }
+sub _export_suspend  { ''; }
+sub _export_unsuspend  { ''; }
+
+1;
+
index 68aeca1..136fc24 100644 (file)
@@ -57,6 +57,18 @@ npa
 
 nxx
 
+=item station
+
+station
+
+=item svcnum
+
+svcnum
+
+=item availbatch
+
+availbatch
+
 =back
 
 =head1 METHODS
@@ -123,12 +135,34 @@ sub check {
     || $self->ut_alphan('state')
     || $self->ut_number('npa')
     || $self->ut_numbern('nxx')
+    || $self->ut_numbern('station')
+    || $self->ut_foreign_keyn('svcnum', 'cust_svc', 'svcnum' )
+    || $self->ut_textn('availbatch')
   ;
   return $error if $error;
 
   $self->SUPER::check;
 }
 
+sub process_batch_import {
+  my $job = shift;
+
+  my $numsub = sub {
+    my( $hash, $value ) = @_;
+    $value =~ s/\D//g;
+    $value =~ /^(\d{3})(\d{3})(\d+)$/ or die "unparsable number $value\n";
+    ( $hash->{npa}, $hash->{nxx}, $hash->{station} ) = ( $1, $2, $3 );
+  };
+
+  my $opt = { 'table'   => 'phone_avail',
+              'params'  => [ 'availbatch', 'exportnum', 'countrycode' ],
+              'formats' => { 'default' => [ 'state', $numsub ] },
+            };
+
+  FS::Record::process_batch_import( $job, $opt, @_ );
+
+}
+
 =back
 
 =head1 BUGS
index 60ea8b2..66e8ab6 100644 (file)
@@ -221,6 +221,7 @@ tie my %tools_importing, 'Tie::IxHash',
   'Import customer comments from CSV file' => [ $fsurl.'misc/cust_main_note-import.html', '' ],
   'Import one-time charges from CSV file' => [ $fsurl.'misc/cust_main-import_charges.cgi', '' ],
   'Import payments from CSV file' => [ $fsurl.'misc/cust_pay-import.cgi', '' ],
+  'Import phone numbers (DIDs)' => [ $fsurl.'misc/phone_avail-import.html', '' ],
   'Import Call Detail Records (CDRs) from CSV file' => [ $fsurl.'misc/cdr-import.html', '' ],
   'Import tax rates from CSV files' => [ $fsurl.'misc/tax-import.cgi', '' ],
 ;
diff --git a/httemplate/misc/phone_avail-import.html b/httemplate/misc/phone_avail-import.html
new file mode 100644 (file)
index 0000000..98dcc8a
--- /dev/null
@@ -0,0 +1,77 @@
+<% include('/elements/header.html', 'Phone number (DID) import') %>
+
+Import a file containing phone numbers (DIDs).
+<BR><BR>
+
+<% include( '/elements/form-file_upload.html',
+              'name'      => 'PhonenumImportForm',
+              'action'    => 'process/phone_avail-import.html',
+              'num_files' => 1,
+              'fields'    => [ 'format', 'availbatch', 'exportnum', 'countrycode' ],
+              'message'   => 'DID import successful',
+              'url'       => $p."search/phone_avail.html?availbatch=$availbatch",
+          )
+%>
+
+<% &ntable("#cccccc", 2) %>
+
+  <INPUT TYPE="hidden" NAME="format" VALUE="default">
+
+  <INPUT TYPE="hidden" NAME="availbatch" VALUE="<% $availbatch %>">
+
+  <INPUT TYPE="hidden" NAME="countrycode" VALUE="1">
+
+  <% include( '/elements/tr-select-table.html',
+                'table'       => 'part_export',
+                'name_col'    => 'machine',
+                'label'       => 'Export',
+                'empty_label' => 'Select export',
+                'hashref'     => { 'exporttype' => 'internal_diddb', },
+                #'label_callback' => 
+            )
+  %>
+
+  <% include( '/elements/file-upload.html',
+                'field' => 'file',
+                'label' => 'Filename',
+            )
+  %>
+
+  <TR>
+    <TD COLSPAN=2 ALIGN="center" STYLE="padding-top:6px">
+      <INPUT TYPE    = "submit"
+             ID      = "submit"
+             VALUE   = "Import file"
+             onClick = "document.PhonenumImportForm.submit.disabled=true;"
+      >
+    </TD>
+  </TR>
+
+</TABLE>
+
+</FORM>
+
+<BR>
+
+Uploaded files can be CSV (comma-separated value) files or Excel spreadsheets.  The file should have a .CSV or .XLS extension.
+<BR><BR>
+
+<b>Default</b> format has the following field order: <i>state, number<i></i>
+<BR><BR>
+
+Field information:
+<ul>
+  <li><i>state</i>: Two-letter state code, i.e. "CA"
+  <li><i>number</i>: Phone number
+</ul>
+
+<% include('/elements/footer.html') %>
+
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Import');
+
+my $availbatch = time2str('webimport-%Y/%m/%d-%T'. "-$$-". rand() * 2**32, time);
+
+</%init>
diff --git a/httemplate/misc/process/phone_avail-import.html b/httemplate/misc/process/phone_avail-import.html
new file mode 100644 (file)
index 0000000..f1a2f24
--- /dev/null
@@ -0,0 +1,9 @@
+<% $server->process %>
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Import');
+
+my $server = new FS::UI::Web::JSRPC 'FS::phone_avail::process_batch_import', $cgi;
+
+</%init>