move cdr-sftp_and_import script to FS/bin, add -p option, RT#4081
[freeside.git] / FS / bin / freeside-cdr-sftp_and_import
1 #!/usr/bin/perl
2
3 use strict;
4 use Getopt::Std;
5 use Net::SFTP::Foreign;
6 use FS::UID qw(adminsuidsetup datasrc);
7 use FS::cdr;
8
9 ###
10 # parse command line
11 ###
12
13 use vars qw( $opt_p $opt_e $opt_d $opt_v );
14 getopts('p:e:d:v');
15
16 $opt_e ||= 'csv';
17 #$opt_e = ".$opt_e" unless $opt_e =~ /^\./;
18 $opt_e =~ s/^\.//;
19
20 $opt_p ||= '';
21
22 my $user = shift or die &usage;
23 adminsuidsetup $user;
24
25 # %%%FREESIDE_CACHE%%%
26 my $cachedir = '/usr/local/etc/freeside/cache.'. datasrc. '/cdrs';
27 mkdir $cachedir unless -d $cachedir;
28
29 my $format = shift or die &usage;
30
31 use vars qw( $servername );
32 $servername = shift or die &usage;
33
34 ###
35 # get the file list
36 ###
37
38 warn "Retreiving directory listing\n" if $opt_v;
39
40 my $ls_sftp = sftp();
41
42 my $ls = $ls_sftp->ls('.', wanted => qr/^$opt_p.*\.$opt_e$/i );
43
44 ###
45 # import each file
46 ###
47
48 foreach my $file ( @$ls ) {
49
50   my $filename = $file->{filename};
51   warn "Downloading $filename\n" if $opt_v;
52
53   #get the file
54   my $get_sftp = sftp();
55   $get_sftp->get($filename, "$cachedir/$filename")
56     or die "Can't get $filename: ". $get_sftp->error;
57
58   warn "Processing $filename\n" if $opt_v;
59
60   my $error = FS::cdr::batch_import( {
61     'file'     => "$cachedir/$filename",
62     'format'   => $format,
63     'params'   => { 'cdrbatch' => $filename, },
64     'empty_ok' => 1,
65   } );
66   die $error if $error;
67
68   if ( $opt_d ) {
69     my $mv_sftp = sftp();
70     $mv_sftp->rename($filename, "$opt_d/$filename")
71       or die "can't move $filename to $opt_d: ". $mv_sftp->error;
72   }
73
74   unlink "$cachedir/$filename";
75
76 }
77
78 ###
79 # subs
80 ###
81
82 sub usage {
83   "Usage: \n  cdr.import user format servername\n";
84 }
85
86 use vars qw( $sftp );
87
88 sub sftp {
89
90   #reuse connections
91   return $sftp if $sftp && $sftp->cwd;
92
93   my %sftp = ( host => $servername );
94
95   #XXX remove these
96   $sftp{port} = 10022;
97   #$sftp{more} = '-v';
98
99   $sftp = Net::SFTP::Foreign->new(%sftp);
100   $sftp->error and die "SFTP connection failed: ". $sftp->error;
101
102   $sftp;
103 }
104
105 =head1 NAME
106
107 cdr.sftp_and_import - Download CDR files from a remote server via SFTP
108
109 =head1 SYNOPSIS
110
111   cdr.sftp_and_import [ -p prefix ] [ -e extension ] [ -d donefolder ] [ -v ] user format [sftpuser@]servername
112
113 =head1 DESCRIPTION
114
115 Command line tool to download CDR files from a remote server via SFTP and then
116 import them into the database.
117
118 -p: file prefix, if specified
119
120 -e: file extension, defaults to .csv
121
122 -d: if specified, moves files to the specified folder when done
123
124 -v: verbose
125
126 user: freeside username
127
128 format: CDR format name
129
130 [sftpuser@]servername: remote server
131
132 =head1 BUGS
133
134 Only supports SFTP right now.
135
136 =head1 SEE ALSO
137
138 L<FS::cdr>
139
140 =cut
141
142 1;
143