-
Notifications
You must be signed in to change notification settings - Fork 6
/
Ssh2.php
874 lines (784 loc) · 28.9 KB
/
Ssh2.php
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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
<?php
/**
* VFS implementation for an SSH2 server.
* This module requires the SSH2 (version 0.10+) PECL package.
*
* Required values for $params:<pre>
* username - (string) The username with which to connect to the ssh2 server.
* password - (string) The password with which to connect to the ssh2 server.
* hostspec - (string) The ssh2 server to connect to.</pre>
*
* Optional values for $params:<pre>
* port - (integer) The port used to connect to the ssh2 server if other than
* 22.</pre>
*
* Copyright 2006-2017 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @editor Cliff Green <green@umdnj.edu>
* @package Vfs
*/
class Horde_Vfs_Ssh2 extends Horde_Vfs_Base
{
/**
* List of additional credentials required for this VFS backend.
*
* @var array
*/
protected $_credentials = array('username', 'password');
/**
* List of permissions and if they can be changed in this VFS backend.
*
* @var array
*/
protected $_permissions = array(
'owner' => array(
'read' => true,
'write' => true,
'execute' => true
),
'group' => array(
'read' => true,
'write' => true,
'execute' => true
),
'all' => array(
'read' => true,
'write' => true,
'execute' => true
)
);
/**
* Variable holding the connection to the ssh2 server.
*
* @var resource
*/
protected $_stream = false;
/**
* The SFTP resource stream.
*
* @var resource
*/
protected $_sftp;
/**
* The current working directory.
*
* @var string
*/
protected $_cwd;
/**
* Local cache array for user IDs.
*
* @var array
*/
protected $_uids = array();
/**
* Local cache array for group IDs.
*
* @var array
*/
protected $_gids = array();
/**
* Returns the size of a file.
*
* @param string $path The path of the file.
* @param string $name The filename.
*
* @return integer The size of the file in bytes.
* @throws Horde_Vfs_Exception
*/
public function size($path, $name)
{
$this->_connect();
$statinfo = @ssh2_sftp_stat($this->_sftp, $this->_getPath($path, $name));
if (($size = $statinfo['size']) === false) {
throw new Horde_Vfs_Exception(sprintf('Unable to check file size of "%s".', $this->_getPath($path, $name)));
}
return $size;
}
/**
* Retrieves a file from the VFS.
*
* @param string $path The pathname to the file.
* @param string $name The filename to retrieve.
*
* @return string The file data.
* @throws Horde_Vfs_Exception
*/
public function read($path, $name)
{
$file = $this->readFile($path, $name);
clearstatcache();
return (filesize($file) === 0)
? ''
: file_get_contents($file);
}
/**
* Retrieves a file from the VFS as an on-disk local file.
*
* This function provides a file on local disk with the data of a VFS file
* in it. This file <em>cannot</em> be modified! The behavior if you do
* modify it is undefined. It will be removed at the end of the request.
*
* @param string $path The pathname to the file.
* @param string $name The filename to retrieve.
*
* @return string A local filename.
* @throws Horde_Vfs_Exception
*/
public function readFile($path, $name)
{
$this->_connect();
// Create a temporary file and register it for deletion at the
// end of this request.
if (!($localFile = Horde_Util::getTempFile('vfs'))) {
throw new Horde_Vfs_Exception('Unable to create temporary file.');
}
if (!$this->_recv($this->_getPath($path, $name), $localFile)) {
throw new Horde_Vfs_Exception(sprintf('Unable to open VFS file "%s".', $this->_getPath($path, $name)));
}
return $localFile;
}
/**
* Open a stream to a file in the VFS.
*
* @param string $path The pathname to the file.
* @param string $name The filename to retrieve.
*
* @return resource The stream.
* @throws Horde_Vfs_Exception
*/
public function readStream($path, $name)
{
$stream = @fopen($this->_wrap($this->_getPath($path, $name)), 'r');
if (!is_resource($stream)) {
throw new Horde_Vfs_Exception('Unable to open VFS file.');
}
return $stream;
}
/**
* Stores a file in the VFS.
*
* @param string $path The path to store the file in.
* @param string $name The filename to use.
* @param string $tmpFile The temporary file containing the data to
* be stored.
* @param boolean $autocreate Automatically create directories?
*
* @throws Horde_Vfs_Exception
*/
public function write($path, $name, $tmpFile, $autocreate = false)
{
$this->_connect();
$this->_checkQuotaWrite('file', $tmpFile, $path, $name);
if (!$this->_send($tmpFile, $this->_getPath($path, $name))) {
if ($autocreate) {
$this->autocreatePath($path);
if ($this->_send($tmpFile, $this->_getPath($path, $name))) {
return;
}
}
throw new Horde_Vfs_Exception(sprintf('Unable to write VFS file "%s".', $this->_getPath($path, $name)));
}
}
/**
* Stores a file in the VFS from raw data.
*
* @param string $path The path to store the file in.
* @param string $name The filename to use.
* @param string|resource $data The data as a string or stream resource.
* Resources allowed @since 2.4.0
* @param boolean $autocreate Automatically create directories?
*
* @throws Horde_Vfs_Exception
*/
public function writeData($path, $name, $data, $autocreate = false)
{
$tmpFile = Horde_Util::getTempFile('vfs');
$data = $this->_ensureSeekable($data);
file_put_contents($tmpFile, $data);
clearstatcache();
$this->write($path, $name, $tmpFile, $autocreate);
}
/**
* Deletes a file from the VFS.
*
* @param string $path The path to delete the file from.
* @param string $name The filename to delete.
*
* @throws Horde_Vfs_Exception
*/
public function deleteFile($path, $name)
{
$this->_checkQuotaDelete($path, $name);
$this->_connect();
if (!@ssh2_sftp_unlink($this->_sftp, $this->_getPath($path, $name))) {
throw new Horde_Vfs_Exception(sprintf('Unable to delete VFS file "%s".', $this->_getPath($path, $name)));
}
}
/**
* Checks if a given item is a folder.
*
* @param string $path The parent folder.
* @param string $name The item name.
*
* @return boolean True if it is a folder, false otherwise.
*/
public function isFolder($path, $name)
{
try {
$this->_connect();
} catch (Horde_Vfs_Exception $e) {
return false;
}
/* See if we can stat the remote filename. ANDed with 040000 is true
* if it is a directory. */
$statinfo = @ssh2_sftp_stat($this->_sftp, $this->_getPath($path, $name));
return $statinfo['mode'] & 040000;
}
/**
* Deletes a folder from the VFS.
*
* @param string $path The parent folder.
* @param string $name The name of the folder to delete.
* @param boolean $recursive Force a recursive delete?
*
* @throws Horde_Vfs_Exception
*/
public function deleteFolder($path, $name, $recursive = false)
{
$this->_connect();
$isDir = false;
foreach ($this->listFolder($path) as $file) {
if ($file['name'] == $name && $file['type'] == '**dir') {
$isDir = true;
break;
}
}
if ($isDir) {
$file_list = $this->listFolder($path . '/' . $name);
if (count($file_list) && !$recursive) {
throw new Horde_Vfs_Exception(sprintf('Unable to delete "%s", the directory is not empty.', $this->_getPath($path, $name)));
}
foreach ($file_list as $file) {
if ($file['type'] == '**dir') {
$this->deleteFolder($path . '/' . $name, $file['name'], $recursive);
} else {
$this->deleteFile($path . '/' . $name, $file['name']);
}
}
if (!@ssh2_sftp_rmdir($this->_sftp, $this->_getPath($path, $name))) {
throw new Horde_Vfs_Exception(sprintf('Cannot remove directory "%s".', $this->_getPath($path, $name)));
}
} else {
if (!@ssh2_sftp_unlink($this->_sftp, $this->_getPath($path, $name))) {
throw new Horde_Vfs_Exception(sprintf('Cannot delete file "%s".', $this->_getPath($path, $name)));
}
}
}
/**
* Renames a file in the VFS.
*
* @param string $oldpath The old path to the file.
* @param string $oldname The old filename.
* @param string $newpath The new path of the file.
* @param string $newname The new filename.
*
* @throws Horde_Vfs_Exception
*/
public function rename($oldpath, $oldname, $newpath, $newname)
{
$this->_connect();
$this->autocreatePath($newpath);
if (!@ssh2_sftp_rename($this->_sftp, $this->_getPath($oldpath, $oldname), $this->_getPath($newpath, $newname))) {
throw new Horde_Vfs_Exception(sprintf('Unable to rename VFS file "%s".', $this->_getPath($oldpath, $oldname)));
}
}
/**
* Creates a folder on the VFS.
*
* @param string $path The parent folder.
* @param string $name The name of the new folder.
*
* @throws Horde_Vfs_Exception
*/
public function createFolder($path, $name)
{
$this->_connect();
if (!@ssh2_sftp_mkdir($this->_sftp, $this->_getPath($path, $name))) {
throw new Horde_Vfs_Exception(sprintf('Unable to create VFS directory "%s".', $this->_getPath($path, $name)));
}
}
/**
* Changes permissions for an item on the VFS.
*
* @param string $path The parent folder of the item.
* @param string $name The name of the item.
* @param string $permission The permission to set in octal notation.
*
* @throws Horde_Vfs_Exception
*/
public function changePermissions($path, $name, $permission)
{
$this->_connect();
$full = $this->_getPath($path, $name);
if (!@ssh2_sftp_chmod($this->_sftp, $full, octdec($permission))) {
throw new Horde_Vfs_Exception(sprintf('Unable to change permission for VFS file "%s".', $full));
}
}
/**
* Returns an unsorted file list of the specified directory.
*
* @param string $path The path of the directory.
* @param string|array $filter Regular expression(s) to filter
* file/directory name on.
* @param boolean $dotfiles Show dotfiles?
* @param boolean $dironly Show only directories?
*
* @return array File list.
* @throws Horde_Vfs_Exception
*/
protected function _listFolder($path = '', $filter = null,
$dotfiles = true, $dironly = false)
{
$this->_connect();
$files = array();
/* If 'maplocalids' is set, check for the POSIX extension. */
$mapids = (!empty($this->_params['maplocalids']) && extension_loaded('posix'));
// THIS IS A PROBLEM.... there is no builtin systype() fn for SSH2.
// Go with unix-style listings for now...
$type = 'unix';
$olddir = $this->getCurrentDirectory();
$path = $this->_getPath('', $path);
if (strlen($path)) {
$this->_setPath($path);
}
if ($type == 'unix') {
$ls_args = 'l';
// Get numeric ids if we're going to use posix_* functions to
// map them.
if ($mapids) {
$ls_args .= 'n';
}
// If we don't want dotfiles, We can save work here by not doing
// an ls -a and then not doing the check later (by setting
// $dotfiles to true, the if is short-circuited).
if ($dotfiles) {
$ls_args .= 'a';
$dotfiles = true;
}
$stream = @ssh2_exec(
$this->_stream,
'ls -' . $ls_args . ' ' . escapeshellarg($path),
null,
array('LC_TIME' => 'C'));
} else {
$stream = @ssh2_exec($this->_stream, '');
}
stream_set_blocking($stream, true);
$errstream = ssh2_fetch_stream($stream, SSH2_STREAM_STDERR);
if ($error = stream_get_contents($errstream)) {
fclose($errstream);
fclose($stream);
throw new Horde_Vfs_Exception($error);
}
unset($list);
while (!feof($stream)) {
$line = fgets($stream);
if ($line === false) {
break;
}
$list[] = trim($line);
}
fclose($errstream);
fclose($stream);
if (!is_array($list)) {
if (isset($olddir)) {
$this->_setPath($olddir);
}
return array();
}
$currtime = time();
foreach ($list as $line) {
$file = array();
$item = preg_split('/\s+/', $line);
if (($type == 'unix') ||
(($type == 'win') &&
!preg_match('|\d\d-\d\d-\d\d|', $item[0]))) {
if ((count($item) < 8) || (substr($line, 0, 5) == 'total')) {
continue;
}
$file['perms'] = $item[0];
if ($mapids) {
if (!isset($this->_uids[$item[2]])) {
$entry = posix_getpwuid($item[2]);
$this->_uids[$item[2]] = (empty($entry)) ? $item[2] : $entry['name'];
}
$file['owner'] = $this->_uids[$item[2]];
if (!isset($this->_uids[$item[3]])) {
$entry = posix_getgrgid($item[3]);
$this->_uids[$item[3]] = (empty($entry)) ? $item[3] : $entry['name'];
}
$file['group'] = $this->_uids[$item[3]];
} else {
$file['owner'] = $item[2];
$file['group'] = $item[3];
}
// /dev file systems may have an additional column.
$addcol = 0;
if (substr($item[4], -1) == ',') {
$addcol = 1;
}
$file['name'] = substr($line, strpos($line, sprintf("%s %2s %5s", $item[5 + $addcol], $item[6 + $addcol], $item[7 + $addcol])) + 13);
// Filter out '.' and '..' entries.
if (preg_match('/^\.\.?\/?$/', $file['name'])) {
continue;
}
// Filter out dotfiles if they aren't wanted.
if (!$dotfiles && (substr($file['name'], 0, 1) == '.')) {
continue;
}
$p1 = substr($file['perms'], 0, 1);
if ($p1 === 'l') {
$file['link'] = substr($file['name'], strpos($file['name'], '->') + 3);
$file['name'] = substr($file['name'], 0, strpos($file['name'], '->') - 1);
$file['type'] = '**sym';
if ($this->isFolder('', $file['link'])) {
$file['linktype'] = '**dir';
} else {
$parts = explode('/', $file['link']);
$name = explode('.', array_pop($parts));
if ((count($name) == 1) ||
(($name[0] === '') && (count($name) == 2))) {
$file['linktype'] = '**none';
} else {
$file['linktype'] = Horde_String::lower(array_pop($name));
}
}
} elseif ($p1 === 'd') {
$file['type'] = '**dir';
} else {
$name = explode('.', $file['name']);
if ((count($name) == 1) ||
((substr($file['name'], 0, 1) === '.') &&
(count($name) == 2))) {
$file['type'] = '**none';
} else {
$file['type'] = Horde_String::lower($name[count($name) - 1]);
}
}
if ($file['type'] == '**dir') {
$file['size'] = -1;
} else {
$file['size'] = $item[4 + $addcol];
}
if (strpos($item[7 + $addcol], ':') !== false) {
$file['date'] = strtotime($item[7 + $addcol] . ':00' . $item[5 + $addcol] . ' ' . $item[6 + $addcol] . ' ' . date('Y', $currtime));
// If the ssh2 server reports a file modification date more
// less than one day in the future, don't try to subtract
// a year from the date. There is no way to know, for
// example, if the VFS server and the ssh2 server reside
// in different timezones. We should simply report to the
// user what the SSH2 server is returning.
if ($file['date'] > ($currtime + 86400)) {
$file['date'] = strtotime($item[7 + $addcol] . ':00' . $item[5 + $addcol] . ' ' . $item[6 + $addcol] . ' ' . (date('Y', $currtime) - 1));
}
} else {
$file['date'] = strtotime('00:00:00' . $item[5 + $addcol] . ' ' . $item[6 + $addcol] . ' ' . $item[7 + $addcol]);
}
} elseif ($type == 'netware') {
$file = array();
$file['perms'] = $item[1];
$file['owner'] = $item[2];
if ($item[0] == 'd') {
$file['type'] = '**dir';
} else {
$file['type'] = '**none';
}
$file['size'] = $item[3];
$file['name'] = $item[7];
for ($index = 8, $c = count($item); $index < $c; $index++) {
$file['name'] .= ' ' . $item[$index];
}
} else {
/* Handle Windows SSH2 servers returning DOS-style file
* listings. */
$file['perms'] = '';
$file['owner'] = '';
$file['group'] = '';
$file['name'] = $item[3];
for ($index = 4, $c = count($item); $index < $c; $index++) {
$file['name'] .= ' ' . $item[$index];
}
$file['date'] = strtotime($item[0] . ' ' . $item[1]);
if ($item[2] == '<DIR>') {
$file['type'] = '**dir';
$file['size'] = -1;
} else {
$file['size'] = $item[2];
$name = explode('.', $file['name']);
if ((count($name) == 1) ||
((substr($file['name'], 0, 1) === '.') &&
(count($name) == 2))) {
$file['type'] = '**none';
} else {
$file['type'] = Horde_String::lower($name[count($name) - 1]);
}
}
}
// Filtering.
if ($this->_filterMatch($filter, $file['name'])) {
unset($file);
continue;
}
if ($dironly && $file['type'] !== '**dir') {
unset($file);
continue;
}
$files[$file['name']] = $file;
unset($file);
}
if (isset($olddir)) {
$this->_setPath($olddir);
}
return $files;
}
/**
* Returns if a given file or folder exists in a folder.
*
* @param string $path The path to the folder.
* @param string $name The file or folder name.
*
* @return boolean True if it exists, false otherwise.
*/
public function exists($path, $name)
{
$this->_connect();
return @ssh2_sftp_stat($this->_sftp, $this->_getPath($path, $name)) !== false;
}
/**
* Copies a file through the backend.
*
* @param string $path The path of the original file.
* @param string $name The name of the original file.
* @param string $dest The name of the destination directory.
* @param boolean $autocreate Auto-create the directory if it doesn't
* exist?
*
* @throws Horde_Vfs_Exception
*/
public function copy($path, $name, $dest, $autocreate = false)
{
$this->_checkDestination($path, $dest);
$this->_connect();
if ($autocreate) {
$this->autocreatePath($dest);
}
foreach ($this->listFolder($dest, null, true) as $file) {
if ($file['name'] == $name) {
throw new Horde_Vfs_Exception(sprintf('%s already exists.', $this->_getPath($dest, $name)));
}
}
if ($this->isFolder($path, $name)) {
$this->_copyRecursive($path, $name, $dest);
} else {
$tmpFile = Horde_Util::getTempFile('vfs');
if (!$this->_recv($this->_getPath($path, $name), $tmpFile)) {
throw new Horde_Vfs_Exception(sprintf('Failed to copy from "%s".', $this->_getPath($path, $name)));
}
clearstatcache();
$this->_checkQuotaWrite('file', $tmpFile, $dest, $name);
if (!$this->_send($tmpFile, $this->_getPath($dest, $name))) {
throw new Horde_Vfs_Exception(sprintf('Failed to copy to "%s".', $this->_getPath($dest, $name)));
}
}
}
/**
* Moves a file through the backend.
*
* @param string $path The path of the original file.
* @param string $name The name of the original file.
* @param string $dest The destination file name.
* @param boolean $autocreate Auto-create the directory if it doesn't
* exist?
*
* @throws Horde_Vfs_Exception
*/
public function move($path, $name, $dest, $autocreate = false)
{
$orig = $this->_getPath($path, $name);
if (preg_match('|^' . preg_quote($orig) . '/?$|', $dest)) {
throw new Horde_Vfs_Exception('Cannot move file(s) - destination is within source.');
}
$this->_connect();
if ($autocreate) {
$this->autocreatePath($dest);
}
foreach ($this->listFolder($dest, null, true) as $file) {
if ($file['name'] == $name) {
throw new Horde_Vfs_Exception(sprintf('%s already exists.', $this->_getPath($dest, $name)));
}
}
if (!@ssh2_sftp_rename($this->_sftp, $orig, $this->_getPath($dest, $name))) {
throw new Horde_Vfs_Exception(sprintf('Failed to move to "%s".', $this->_getPath($dest, $name)));
}
}
/**
* Returns the current working directory on the SSH2 server.
*
* @return string The current working directory.
* @throws Horde_Vfs_Exception
*/
public function getCurrentDirectory()
{
$this->_connect();
if (!strlen($this->_cwd)) {
$stream = @ssh2_exec($this->_stream, 'pwd');
stream_set_blocking($stream, true);
$this->_cwd = trim(fgets($stream));
}
return $this->_cwd;
}
/**
* Changes the current directory on the server.
*
* @param string $path The path to change to.
*
* @throws Horde_Vfs_Exception
*/
protected function _setPath($path)
{
if (!($stream = @ssh2_exec($this->_stream, 'cd ' . escapeshellarg($path) . '; pwd'))) {
throw new Horde_Vfs_Exception(sprintf('Unable to change to %s.', $path));
}
stream_set_blocking($stream, true);
$this->_cwd = trim(fgets($stream));
fclose($stream);
}
/**
* Returns the full path of an item.
*
* @param string $path The directory of the item.
* @param string $name The name of the item.
*
* @return mixed Full path to the file when $path is not empty and just
* $name when not set.
*/
protected function _getPath($path, $name)
{
if (isset($this->_params['vfsroot']) &&
strlen($this->_params['vfsroot'])) {
if (strlen($path)) {
$path = $this->_params['vfsroot'] . '/' . $path;
} else {
$path = $this->_params['vfsroot'];
}
}
return parent::_getPath($path, $name);
}
/**
* Returns the parent directory of the specified path.
*
* @param string $path The path to get the parent of.
*
* @return string The parent directory.
* @throws Horde_Vfs_Exception
*/
protected function _parentDir($path)
{
$this->_connect();
$this->_setPath('cd ' . $path . '/..');
return $this->getCurrentDirectory();
}
/**
* Attempts to open a connection to the SSH2 server.
*
* @throws Horde_Vfs_Exception
*/
protected function _connect()
{
if ($this->_stream !== false) {
return;
}
if (!extension_loaded('ssh2')) {
throw new Horde_Vfs_Exception('The SSH2 PECL extension is not available.');
}
if (!is_array($this->_params)) {
throw new Horde_Vfs_Exception('No configuration information specified for SSH2 VFS.');
}
$required = array('hostspec', 'username', 'password');
foreach ($required as $val) {
if (!isset($this->_params[$val])) {
throw new Horde_Vfs_Exception(sprintf('Required "%s" not specified in VFS configuration.', $val));
}
}
/* Connect to the ssh2 server using the supplied parameters. */
if (empty($this->_params['port'])) {
$this->_stream = @ssh2_connect($this->_params['hostspec']);
} else {
$this->_stream = @ssh2_connect($this->_params['hostspec'], $this->_params['port']);
}
if (!$this->_stream) {
$this->_stream = false;
throw new Horde_Vfs_Exception('Connection to SSH2 server failed.');
}
if (!@ssh2_auth_password($this->_stream, $this->_params['username'], $this->_params['password'])) {
$this->_stream = false;
throw new Horde_Vfs_Exception('Authentication to SSH2 server failed.');
}
/* Create sftp resource. */
$this->_sftp = @ssh2_sftp($this->_stream);
if (!empty($this->_params['vfsroot']) &&
!@ssh2_sftp_stat($this->_sftp, $this->_params['vfsroot']) &&
!@ssh2_sftp_mkdir($this->_sftp, $this->_params['vfsroot'])) {
throw new Horde_Vfs_Exception(sprintf('Unable to create VFS root directory "%s".', $this->_params['vfsroot']));
}
}
/**
* Sends local file to remote host.
*
* This function exists because the ssh2_scp_send function doesn't seem to
* work on some hosts.
*
* @param string $local Full path to the local file.
* @param string $remote Full path to the remote location.
*
* @return boolean Success.
*/
protected function _send($local, $remote)
{
return @copy($local, $this->_wrap($remote));
}
/**
* Receives file from remote host.
*
* This function exists because the ssh2_scp_recv function doesn't seem to
* work on some hosts.
*
* @param string $local Full path to the local file.
* @param string $remote Full path to the remote location.
*
* @return boolean Success.
*/
protected function _recv($remote, $local)
{
return @copy($this->_wrap($remote), $local);
}
/**
* Generate a stream wrapper file spec for a remote file path
*
* @param string $remote Full path to the remote location
*
* @return string A full stream wrapper path to the remote location
*/
protected function _wrap($remote)
{
$wrapper = 'ssh2.sftp://' . intval($this->_sftp);
if ($remote[0] != '/') {
$remote = $this->getCurrentDirectory() . '/' . $remote;
}
return $wrapper . $remote;
}
}