default to a session cookie instead of setting an explicit timeout, weird timezone...
[freeside.git] / FS / bin / freeside-cdr-sftp_and_import
index d90695f..f2bf294 100755 (executable)
@@ -2,6 +2,7 @@
 
 use strict;
 use Getopt::Std;
+use Date::Format;
 use Net::SFTP::Foreign::Compat;
 use Net::FTP;
 use FS::UID qw(adminsuidsetup datasrc);
@@ -11,8 +12,8 @@ use FS::cdr;
 # parse command line
 ###
 
-use vars qw( $opt_m $opt_p $opt_r $opt_e $opt_d $opt_v );
-getopts('m:p:r:e:d:v');
+use vars qw( $opt_m $opt_p $opt_r $opt_e $opt_d $opt_v $opt_P $opt_a $opt_c $opt_i $opt_g $opt_s $opt_b );
+getopts('c:i:m:p:r:e:d:v:P:agsb');
 
 $opt_e ||= 'csv';
 #$opt_e = ".$opt_e" unless $opt_e =~ /^\./;
@@ -20,11 +21,16 @@ $opt_e =~ s/^\.//;
 
 $opt_p ||= '';
 
+die "invalid cdrtypenum" if defined $opt_c && $opt_c !~ /^\d+$/;
+die "invalid carrierid"  if defined $opt_i && $opt_i !~ /^\d+$/;
+
+my %options = ();
+
 my $user = shift or die &usage;
 adminsuidsetup $user;
 
 # %%%FREESIDE_CACHE%%%
-my $cachedir = '/usr/local/etc/freeside/cache.'. datasrc. '/cdrs';
+my $cachedir = '%%%FREESIDE_CACHE%%%/cache.'. datasrc. '/cdrs';
 mkdir $cachedir unless -d $cachedir;
 
 my $format = shift or die &usage;
@@ -44,11 +50,18 @@ $opt_m = lc($opt_m);
 my $ls;
 
 if($opt_m eq 'ftp') {
+  $options{'Port'}    = $opt_P if $opt_P;
+  $options{'Debug'}   = $opt_v if $opt_v;
+  $options{'Passive'} = $opt_a if $opt_a;
+
   my $ls_ftp = ftp();
 
   $ls = [ grep { /^$opt_p.*\.$opt_e$/i } $ls_ftp->ls ];
 }
 elsif($opt_m eq 'sftp') {
+  $options{'port'}    = $opt_P if $opt_P;
+  $options{'debug'}   = $opt_v if $opt_v;
+
   my $ls_sftp = sftp();
 
   $ls_sftp->setcwd($opt_r) or die "can't chdir to $opt_r\n"
@@ -82,29 +95,66 @@ foreach my $filename ( @$ls ) {
   }
 
   warn "Processing $filename\n" if $opt_v;
+  my $ungziped = $filename;
+  $ungziped =~ s/\.gz$//;
+  if ( $opt_g ) {
+      if(system('gunzip', "$cachedir/$filename") != 0) {
+        warn "gunzip of '$cachedir/$filename' failed" if $opt_v;
+        unlink "$cachedir/$filename";
+        next;
+      }
+  }
 
-  my $error = FS::cdr::batch_import( {
-    'file'            => "$cachedir/$filename",
+  my $file_timestamp = $filename.'-'.time2str('%Y-%m-%d', time);
+
+  my $import_options = {
+    'file'            => "$cachedir/$ungziped",
     'format'          => $format,
-    'batch_namevalue' => $filename,
+    'batch_namevalue' => $file_timestamp,
     'empty_ok'        => 1,
-  } );
-  die $error if $error;
-
-  if ( $opt_d ) {
-    if($opt_m eq 'ftp') {
-      my $ftp = ftp();
-      $ftp->rename($filename, "$opt_d/$filename")
-        or die "Can't move $filename to $opt_d: ".$ftp->message . "\n";
+  };
+  $import_options->{'cdrtypenum'} = $opt_c if defined $opt_c;
+  $import_options->{'carrierid'}  = $opt_i if defined $opt_i;
+  
+  my $error = FS::cdr::batch_import($import_options);
+
+  if ( $error ) {
+
+    if ( $opt_s ) {
+      warn "$ungziped: $error\n";
+    } else {
+      unlink "$cachedir/$filename";
+      unlink "$cachedir/$ungziped" if $opt_g;
+      die $error;
     }
-    else {
-      my $sftp = sftp();
-      $sftp->rename($filename, "$opt_d/$filename")
-        or die "can't move $filename to $opt_d: ". $sftp->error . "\n";
+
+  } else {
+
+    if ( $opt_d ) {
+      if ( $opt_m eq 'ftp') {
+        my $ftp = ftp();
+        $ftp->rename($filename, "$opt_d/$file_timestamp")
+          or do {
+            unlink "$cachedir/$filename";
+            unlink "$cachedir/$ungziped" if $opt_g;
+            die "Can't move $filename to $opt_d: ".$ftp->message . "\n";
+          };
+      } else {
+        my $sftp = sftp();
+        $sftp->rename($filename, "$opt_d/$file_timestamp")
+          or do {
+            unlink "$cachedir/$filename";
+            unlink "$cachedir/$ungziped" if $opt_g;
+            die "can't move $filename to $opt_d: ". $sftp->error . "\n";
+          };
+      }
     }
+
   }
 
   unlink "$cachedir/$filename";
+  unlink "$cachedir/$ungziped" if $opt_g;
 
 }
 
@@ -113,7 +163,11 @@ foreach my $filename ( @$ls ) {
 ###
 
 sub usage {
-  "Usage: \n  cdr.import user format servername\n";
+  "Usage:
+  freeside-cdr-sftp_and_import [ -m method ] [ -p prefix ] [ -e extension ]
+    [ -r remotefolder ] [ -d donefolder ] [ -v level ] [ -P port ]
+    [ -a ] [ -g ] [ -s ] [ -c cdrtypenum ] user format [sftpuser@]servername
+  ";
 }
 
 use vars qw( $sftp $ftp );
@@ -121,12 +175,14 @@ use vars qw( $sftp $ftp );
 sub ftp {
   return $ftp if $ftp && $ftp->pwd;
   
-  my ($hostname, $user) = reverse split('@', $servername);
-  my ($user, $pass) = split(':', $user);
+  my ($hostname, $userpass) = reverse split('@', $servername);
+  my ($ftp_user, $ftp_pass) = split(':', $userpass);
 
-  my $ftp = Net::FTP->new($hostname) or die "FTP connection to '$hostname' failed.";
-  $ftp->login($user, $pass) or die "FTP login failed: ".$ftp->message;
+  my $ftp = Net::FTP->new($hostname, %options) 
+    or die "FTP connection to '$hostname' failed.";
+  $ftp->login($ftp_user, $ftp_pass) or die "FTP login failed: ".$ftp->message;
   $ftp->cwd($opt_r) or die "can't chdir to $opt_r\n" if $opt_r;
+  $ftp->binary or die "can't set BINARY mode: ". $ftp->message if $opt_b;
   return $ftp;
 }
 
@@ -145,16 +201,19 @@ sub sftp {
 
 =head1 NAME
 
-cdr.sftp_and_import - Download CDR files from a remote server via SFTP
+freeside-cdr-sftp_and_import - Download CDR files from a remote server via SFTP
 
 =head1 SYNOPSIS
 
-  cdr.sftp_and_import [ -m method ][ -p prefix ] [ -e extension ] [ -r remotefolder ] [ -d donefolder ] [ -v ] user format [sftpuser@]servername
+  freeside-cdr-sftp_and_import [ -m method ] [ -p prefix ] [ -e extension ] 
+    [ -r remotefolder ] [ -d donefolder ] [ -v level ] [ -P port ]
+    [ -a ] [ -g ] [ -s ] [ -c cdrtypenum ] [ -i carrierid]
+    user format [sftpuser@]servername
 
 =head1 DESCRIPTION
 
-Command line tool to download CDR files from a remote server via SFTP or FTP and then
-import them into the database.
+Command line tool to download CDR files from a remote server via SFTP 
+or FTP and then import them into the database.
 
 -m: transfer method (sftp or ftp), defaults to sftp
 
@@ -166,7 +225,22 @@ import them into the database.
 
 -d: if specified, moves files to the specified folder when done
 
--v: verbose
+-P: if specified, sets the port to use
+
+-a: use ftp passive mode
+
+-b: use ftp binary mode
+
+-v: set verbosity level; this script only has one level, but it will 
+    be passed as the 'debug' argument to the transport method
+
+-c: cdrtypenum to set, defaults to none
+
+-i: carrierid to set, defaults to none
+
+-g: File is gzipped
+
+-s: Warn and skip files which could not be imported rather than abort
 
 user: freeside username