FS/bin/freeside-cdr-sftp_and_import

   1 #!/usr/bin/perl
   2
   3 use strict;
   4 use Getopt::Std;
   5 use Net::SFTP::Foreign::Compat;
   6 use Net::FTP;
   7 use FS::UID qw(adminsuidsetup datasrc);
   8 use FS::cdr;
   9
  10 ###
  11 # parse command line
  12 ###
  13
  14 use vars qw( $opt_m $opt_p $opt_r $opt_e $opt_d $opt_v $opt_P $opt_a $opt_c );
  15 getopts('c:m:p:r:e:d:v:P:a');
  16
  17 $opt_e ||= 'csv';
  18 #$opt_e = ".$opt_e" unless $opt_e =~ /^\./;
  19 $opt_e =~ s/^\.//;
  20
  21 $opt_p ||= '';
  22
  23 die "invalid cdrtypenum" if $opt_c && $opt_c !~ /^\d+$/;
  24
  25 my %options = ();
  26
  27 my $user = shift or die &usage;
  28 adminsuidsetup $user;
  29
  30 # %%%FREESIDE_CACHE%%%
  31 my $cachedir = '%%%FREESIDE_CACHE%%%/cache.'. datasrc. '/cdrs';
  32 mkdir $cachedir unless -d $cachedir;
  33
  34 my $format = shift or die &usage;
  35
  36 use vars qw( $servername );
  37 $servername = shift or die &usage;
  38
  39 ###
  40 # get the file list
  41 ###
  42
  43 warn "Retrieving directory listing\n" if $opt_v;
  44
  45 $opt_m = 'sftp' if !defined($opt_m);
  46 $opt_m = lc($opt_m);
  47
  48 my $ls;
  49
  50 if($opt_m eq 'ftp') {
  51   $options{'Port'}    = $opt_P if $opt_P;
  52   $options{'Debug'}   = $opt_v if $opt_v;
  53   $options{'Passive'} = $opt_a if $opt_a;
  54
  55   my $ls_ftp = ftp();
  56
  57   $ls = [ grep { /^$opt_p.*\.$opt_e$/i } $ls_ftp->ls ];
  58 }
  59 elsif($opt_m eq 'sftp') {
  60   $options{'port'}    = $opt_P if $opt_P;
  61   $options{'debug'}   = $opt_v if $opt_v;
  62
  63   my $ls_sftp = sftp();
  64
  65   $ls_sftp->setcwd($opt_r) or die "can't chdir to $opt_r\n"
  66     if $opt_r;
  67
  68   $ls = $ls_sftp->ls('.', wanted => qr/^$opt_p.*\.$opt_e$/i,
  69                           names_only => 1 );
  70 }
  71 else {
  72   die "Method '$opt_m' not supported; must be ftp or sftp\n";
  73 }
  74
  75 ###
  76 # import each file
  77 ###
  78
  79 foreach my $filename ( @$ls ) {
  80
  81   warn "Downloading $filename\n" if $opt_v;
  82
  83   #get the file
  84   if($opt_m eq 'ftp') {
  85     my $ftp = ftp();
  86     $ftp->get($filename, "$cachedir/$filename")
  87       or die "Can't get $filename: ". $ftp->message . "\n";
  88   }
  89   else {
  90     my $sftp = sftp();
  91     $sftp->get($filename, "$cachedir/$filename")
  92       or die "Can't get $filename: ". $sftp->error . "\n";
  93   }
  94
  95   warn "Processing $filename\n" if $opt_v;
  96
  97   my $import_options = {
  98     'file'            => "$cachedir/$filename",
  99     'format'          => $format,
 100     'batch_namevalue' => $filename,
 101     'empty_ok'        => 1,
 102   };
 103   $import_options->{'cdrtypenum'} = $opt_c if $opt_c;
 104
 105   my $error = FS::cdr::batch_import($import_options);
 106   die $error if $error;
 107
 108   if ( $opt_d ) {
 109     if($opt_m eq 'ftp') {
 110       my $ftp = ftp();
 111       $ftp->rename($filename, "$opt_d/$filename")
 112         or die "Can't move $filename to $opt_d: ".$ftp->message . "\n";
 113     }
 114     else {
 115       my $sftp = sftp();
 116       $sftp->rename($filename, "$opt_d/$filename")
 117         or die "can't move $filename to $opt_d: ". $sftp->error . "\n";
 118     }
 119   }
 120
 121   unlink "$cachedir/$filename";
 122
 123 }
 124
 125 ###
 126 # subs
 127 ###
 128
 129 sub usage {
 130   "Usage: \n  cdr.import user format servername\n";
 131 }
 132
 133 use vars qw( $sftp $ftp );
 134
 135 sub ftp {
 136   return $ftp if $ftp && $ftp->pwd;
 137
 138   my ($hostname, $user) = reverse split('@', $servername);
 139   my ($user, $pass) = split(':', $user);
 140
 141   my $ftp = Net::FTP->new($hostname, %options)
 142     or die "FTP connection to '$hostname' failed.";
 143   $ftp->login($user, $pass) or die "FTP login failed: ".$ftp->message;
 144   $ftp->cwd($opt_r) or die "can't chdir to $opt_r\n" if $opt_r;
 145   return $ftp;
 146 }
 147
 148 sub sftp {
 149
 150   #reuse connections
 151   return $sftp if $sftp && $sftp->cwd;
 152
 153   my %sftp = ( host => $servername );
 154
 155   $sftp = Net::SFTP::Foreign->new(%sftp);
 156   $sftp->error and die "SFTP connection failed: ". $sftp->error;
 157
 158   $sftp;
 159 }
 160
 161 =head1 NAME
 162
 163 cdr.sftp_and_import - Download CDR files from a remote server via SFTP
 164
 165 =head1 SYNOPSIS
 166
 167   cdr.sftp_and_import [ -m method ] [ -p prefix ] [ -e extension ]
 168     [ -r remotefolder ] [ -d donefolder ] [ -v level ] [ -P port ]
 169     [ -a ] [ -c cdrtypenum ] user format [sftpuser@]servername
 170
 171 =head1 DESCRIPTION
 172
 173 Command line tool to download CDR files from a remote server via SFTP
 174 or FTP and then import them into the database.
 175
 176 -m: transfer method (sftp or ftp), defaults to sftp
 177
 178 -p: file prefix, if specified
 179
 180 -e: file extension, defaults to .csv
 181
 182 -r: if specified, changes into this remote folder before starting
 183
 184 -d: if specified, moves files to the specified folder when done
 185
 186 -P: if specified, sets the port to use
 187
 188 -a: use ftp passive mode
 189
 190 -v: set verbosity level; this script only has one level, but it will
 191     be passed as the 'debug' argument to the transport method
 192
 193 -c: cdrtypenum to set, defaults to none
 194
 195 user: freeside username
 196
 197 format: CDR format name
 198
 199 [sftpuser@]servername: remote server
 200 (or ftpuser:ftppass@servername)
 201
 202 =head1 BUGS
 203
 204 =head1 SEE ALSO
 205
 206 L<FS::cdr>
 207
 208 =cut
 209
 210 1;
 211