forked from thephpleague/flysystem
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSftp.php
More file actions
379 lines (315 loc) · 8.28 KB
/
Sftp.php
File metadata and controls
379 lines (315 loc) · 8.28 KB
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
<?php
namespace League\Flysystem\Adapter;
use Crypt_RSA;
use InvalidArgumentException;
use League\Flysystem\AdapterInterface;
use League\Flysystem\Adapter\Polyfill\StreamedCopyTrait;
use League\Flysystem\Adapter\Polyfill\StreamedTrait;
use League\Flysystem\Config;
use League\Flysystem\Util;
use LogicException;
use Net_SFTP;
use RuntimeException;
class Sftp extends AbstractFtpAdapter
{
use StreamedTrait;
use StreamedCopyTrait;
/**
* @var int
*/
protected $port = 22;
/**
* @var string
*/
protected $privatekey;
/**
* @var array
*/
protected $configurable = array('host', 'port', 'username', 'password', 'timeout', 'root', 'privateKey', 'permPrivate', 'permPublic');
/**
* @var array
*/
protected $statMap = array('mtime' => 'timestamp', 'size' => 'size');
/**
* Prefix a path
*
* @param string $path
* @return string
*/
protected function prefix($path)
{
return $this->root.ltrim($path, $this->separator);
}
/**
* Set the private key (string or path to local file)
*
* @param string $key
* @return $this
*/
public function setPrivateKey($key)
{
$this->privatekey = $key;
return $this;
}
/**
* Inject the Net_SFTP instance
*
* @param Net_SFTP $connection
* @return $this
*/
public function setNetSftpConnection(Net_SFTP $connection)
{
$this->connection = $connection;
return $this;
}
/**
* Connect
*
* @return void
*/
public function connect()
{
$this->connection = $this->connection ?: new Net_SFTP($this->host, $this->port, $this->timeout);
$this->login();
$this->setConnectionRoot();
}
/**
* Login
*
* @throws LogicException
* @return void
*/
protected function login()
{
if (! $this->connection->login($this->username, $this->getPassword())) {
throw new LogicException('Could not login with username: '.$this->username.', host: '.$this->host);
}
}
/**
* Set the connection root
*
* @return void
*/
protected function setConnectionRoot()
{
$root = $this->getRoot();
if (! $root) {
return;
}
if ( ! $this->connection->chdir($root)) {
throw new RuntimeException('Root is invalid or does not exist: ' . $root);
}
}
/**
* Get the password, either the private key or a plain text password
*
* @return Crypt_RSA|string
*/
public function getPassword()
{
if ($this->privatekey) {
return $this->getPrivateKey();
}
return $this->password;
}
/**
* Get the private get with the password or private key contents.
*
* @return Crypt_RSA
*/
public function getPrivateKey()
{
if (is_file($this->privatekey)) {
$this->privatekey = file_get_contents($this->privatekey);
}
$key = new Crypt_RSA();
if ($this->password) {
$key->setPassword($this->password);
}
$key->loadKey($this->privatekey);
return $key;
}
/**
* List the contents of a directory.
*
* @param string $directory
* @param bool $recursive
* @return array
*/
protected function listDirectoryContents($directory, $recursive = true)
{
$result = array();
$connection = $this->getConnection();
$location = $this->prefix($directory);
$listing = $connection->rawlist($location);
if ($listing === false) {
return array();
}
foreach ($listing as $filename => $object) {
if (in_array($filename, array('.', '..'))) {
continue;
}
$path = empty($directory) ? $filename : ($directory . DIRECTORY_SEPARATOR . $filename);
$result[] = $this->normalizeListingObject($path, $object);
if ($recursive && $object['type'] === NET_SFTP_TYPE_DIRECTORY) {
$result = array_merge($result, $this->listDirectoryContents($path));
}
}
return $result;
}
/**
* Normalize a listing response
*
* @param string $path
* @param array $object
* @return array
*/
protected function normalizeListingObject($path, array $object)
{
$permissions = $this->normalizePermissions($object['permissions']);
return array(
'path' => $path,
'size' => $object['size'],
'timestamp' => $object['mtime'],
'type' => ($object['type'] === 1 ? 'file' : 'dir'),
'visibility' => $permissions & 0044 ? AdapterInterface::VISIBILITY_PUBLIC : AdapterInterface::VISIBILITY_PRIVATE,
);
}
/**
* Disconnect
*
* @return void
*/
public function disconnect()
{
$this->connection = null;
}
/**
* {@inheritdoc}
*/
public function write($path, $contents, Config $config)
{
$connection = $this->getConnection();
$this->ensureDirectory(Util::dirname($path));
$config = Util::ensureConfig($config);
if (! $connection->put($path, $contents, NET_SFTP_STRING)) {
return false;
}
if ($config && $visibility = $config->get('visibility')) {
$this->setVisibility($path, $visibility);
}
return compact('contents', 'visibility', 'path');
}
/**
* {@inheritdoc}
*/
public function read($path)
{
$connection = $this->getConnection();
if (($contents = $connection->get($path)) === false) {
return false;
}
return compact('contents');
}
/**
* {@inheritdoc}
*/
public function update($path, $contents, Config $config)
{
return $this->write($path, $contents, $config);
}
/**
* {@inheritdoc}
*/
public function delete($path)
{
$connection = $this->getConnection();
return $connection->delete($path);
}
/**
* {@inheritdoc}
*/
public function rename($path, $newpath)
{
$connection = $this->getConnection();
return $connection->rename($path, $newpath);
}
/**
* {@inheritdoc}
*/
public function deleteDir($dirname)
{
$connection = $this->getConnection();
return $connection->delete($dirname, true);
}
/**
* {@inheritdoc}
*/
public function has($path)
{
return $this->getMetadata($path);
}
/**
* {@inheritdoc}
*/
public function getMetadata($path)
{
$connection = $this->getConnection();
$info = $connection->stat($path);
if ($info === false) {
return false;
}
$result = Util::map($info, $this->statMap);
$result['type'] = $info['type'] === NET_SFTP_TYPE_DIRECTORY ? 'dir' : 'file';
$result['visibility'] = $info['permissions'] & $this->permPublic ? 'public' : 'private';
return $result;
}
/**
* {@inheritdoc}
*/
public function getTimestamp($path)
{
return $this->getMetadata($path);
}
/**
* {@inheritdoc}
*/
public function getMimetype($path)
{
if (! $data = $this->read($path)) {
return false;
}
$data['mimetype'] = Util::guessMimeType($path, $data['contents']);
return $data;
}
/**
* {@inheritdoc}
*/
public function createDir($dirname, Config $config)
{
$connection = $this->getConnection();
if (! $connection->mkdir($dirname, 0744, true)) {
return false;
}
return array('path' => $dirname);
}
/**
* {@inheritdoc}
*/
public function getVisibility($path)
{
return $this->getMetadata($path);
}
/**
* {@inheritdoc}
*/
public function setVisibility($path, $visibility)
{
$visibility = ucfirst($visibility);
if (! isset($this->{'perm'.$visibility})) {
throw new InvalidArgumentException('Unknown visibility: '.$visibility);
}
$connection = $this->getConnection();
return $connection->chmod($this->{'perm'.$visibility}, $path);
}
}