1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
package FS::ftp_target;
use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
use vars qw($me $DEBUG);
$DEBUG = 0;
=head1 NAME
FS::ftp_target - Object methods for ftp_target records
=head1 SYNOPSIS
use FS::ftp_target;
$record = new FS::ftp_target \%hash;
$record = new FS::ftp_target { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::ftp_target object represents an account on a remote FTP or SFTP
server for transferring files. FS::ftp_target inherits from FS::Record.
=over 4
=item targetnum - primary key
=item agentnum - L<FS::agent> foreign key; can be null
=item hostname - the DNS name of the FTP site
=item username - username
=item password - password
=item path - the working directory to change to upon connecting
=item secure - a flag ('Y' or null) for whether to use SFTP
=back
=head1 METHODS
=over 4
=cut
sub table { 'ftp_target'; }
=item new HASHREF
Creates a new FTP target. To add it to the database, see L<"insert">.
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Delete this record from the database.
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=item check
Checks all fields to make sure this is a valid example. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
sub check {
my $self = shift;
if ( !$self->get('port') ) {
if ( $self->secure ) {
$self->set('port', 22);
} else {
$self->set('port', 21);
}
}
my $error =
$self->ut_numbern('targetnum')
|| $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
|| $self->ut_text('hostname')
|| $self->ut_text('username')
|| $self->ut_text('password')
|| $self->ut_number('port')
|| $self->ut_text('path')
|| $self->ut_flag('secure')
|| $self->ut_enum('handling', [ $self->handling_types ])
;
return $error if $error;
$self->SUPER::check;
}
=item connect
Creates a Net::FTP or Net::SFTP::Foreign object (according to the setting
of the 'secure' flag), connects to 'hostname', attempts to log in with
'username' and 'password', and changes the working directory to 'path'.
On success, returns the object. On failure, dies with an error message.
=cut
sub connect {
my $self = shift;
if ( $self->secure ) {
eval "use Net::SFTP::Foreign;";
die $@ if $@;
my %args = (
port => $self->port,
user => $self->username,
password => $self->password,
more => ($DEBUG ? '-v' : ''),
timeout => 30,
autodie => 1, #we're doing this anyway
);
my $sftp = Net::SFTP::Foreign->new($self->hostname, %args);
$sftp->setcwd($self->path);
return $sftp;
}
else {
eval "use Net::FTP;";
die $@ if $@;
my %args = (
Debug => $DEBUG,
Port => $self->port,
Passive => 1,# optional?
);
my $ftp = Net::FTP->new($self->hostname, %args)
or die "connect to ".$self->hostname." failed: $@";
$ftp->login($self->username, $self->password)
or die "login to ".$self->username.'@'.$self->hostname." failed: $@";
$ftp->binary; #optional?
$ftp->cwd($self->path)
or ($self->path eq '/')
or die "cwd to ".$self->hostname.'/'.$self->path." failed: $@";
return $ftp;
}
}
=item label
Returns a descriptive label for this target.
=cut
sub label {
my $self = shift;
$self->targetnum . ': ' . $self->username . '@' . $self->hostname;
}
=item handling_types
Returns a list of values for the "handling" field, corresponding to the
known ways to preprocess a file before uploading. Currently those are
implemented somewhat crudely in L<FS::Cron::upload>.
=cut
sub handling_types {
'',
#'billco', #not implemented this way yet
'bridgestone',
}
=back
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
