|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Copyright (c) 2011-present Mediasift Ltd |
|
5
|
|
|
* All rights reserved. |
|
6
|
|
|
* |
|
7
|
|
|
* Redistribution and use in source and binary forms, with or without |
|
8
|
|
|
* modification, are permitted provided that the following conditions |
|
9
|
|
|
* are met: |
|
10
|
|
|
* |
|
11
|
|
|
* * Redistributions of source code must retain the above copyright |
|
12
|
|
|
* notice, this list of conditions and the following disclaimer. |
|
13
|
|
|
* |
|
14
|
|
|
* * Redistributions in binary form must reproduce the above copyright |
|
15
|
|
|
* notice, this list of conditions and the following disclaimer in |
|
16
|
|
|
* the documentation and/or other materials provided with the |
|
17
|
|
|
* distribution. |
|
18
|
|
|
* |
|
19
|
|
|
* * Neither the names of the copyright holders nor the names of his |
|
20
|
|
|
* contributors may be used to endorse or promote products derived |
|
21
|
|
|
* from this software without specific prior written permission. |
|
22
|
|
|
* |
|
23
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
24
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
25
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
|
26
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
|
27
|
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
28
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
|
29
|
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
|
30
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|
31
|
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
32
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
33
|
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
34
|
|
|
* POSSIBILITY OF SUCH DAMAGE. |
|
35
|
|
|
* |
|
36
|
|
|
* @category Libraries |
|
37
|
|
|
* @package Storyplayer/Modules/Filesystem |
|
38
|
|
|
* @author Stuart Herbert <[email protected]> |
|
39
|
|
|
* @copyright 2011-present Mediasift Ltd www.datasift.com |
|
40
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
|
41
|
|
|
* @link http://datasift.github.io/storyplayer |
|
42
|
|
|
*/ |
|
43
|
|
|
|
|
44
|
|
|
namespace Storyplayer\SPv2\Modules\Filesystem; |
|
45
|
|
|
|
|
46
|
|
|
use DataSift\Storyplayer\OsLib; |
|
47
|
|
|
use DataSift\Stone\ObjectLib\BaseObject; |
|
48
|
|
|
|
|
49
|
|
|
use Storyplayer\SPv2\Modules\Exceptions; |
|
50
|
|
|
use Storyplayer\SPv2\Modules\Host\HostAwareModule; |
|
51
|
|
|
use Storyplayer\SPv2\Modules\Log; |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* do things with (possibly remote) filesystems |
|
55
|
|
|
* |
|
56
|
|
|
* @category Libraries |
|
57
|
|
|
* @package Storyplayer/Modules/Filesystem |
|
58
|
|
|
* @author Stuart Herbert <[email protected]> |
|
59
|
|
|
* @copyright 2011-present Mediasift Ltd www.datasift.com |
|
60
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
|
61
|
|
|
* @link http://datasift.github.io/storyplayer |
|
62
|
|
|
*/ |
|
63
|
|
|
class UsingFilesystem extends HostAwareModule |
|
64
|
|
|
{ |
|
65
|
|
|
public function uploadFile($sourceFilename, $destFilename) |
|
|
|
|
|
|
66
|
|
|
{ |
|
67
|
|
|
// what are we doing? |
|
68
|
|
|
$log = Log::usingLog()->startAction("upload file '{$sourceFilename}' to '{$this->args[0]}':'{$destFilename}'"); |
|
69
|
|
|
|
|
70
|
|
|
// does the source file exist? |
|
71
|
|
|
if (!is_file($sourceFilename)) { |
|
72
|
|
|
$log->endAction("file '{$sourceFilename}' not found :("); |
|
73
|
|
|
throw Exceptions::newActionFailedException(__METHOD__); |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
// make sure we have valid host details |
|
77
|
|
|
$hostDetails = $this->getHostDetails(); |
|
78
|
|
|
|
|
79
|
|
|
// get an object to talk to this host |
|
80
|
|
|
$host = OsLib::getHostAdapter($this->st, $hostDetails->osName); |
|
81
|
|
|
|
|
82
|
|
|
// upload the file |
|
83
|
|
|
$result = $host->uploadFile($hostDetails, $sourceFilename, $destFilename); |
|
84
|
|
|
|
|
85
|
|
|
// did the command used to upload succeed? |
|
86
|
|
|
if ($result->didCommandFail()) { |
|
87
|
|
|
$msg = "upload failed with return code '{$result->returnCode}' and output '{$result->output}'"; |
|
88
|
|
|
$log->endAction($msg); |
|
89
|
|
|
throw Exceptions::newActionFailedException(__METHOD__, $msg); |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
// all done |
|
93
|
|
|
$log->endAction(); |
|
94
|
|
|
return $result; |
|
95
|
|
|
} |
|
96
|
|
|
} |
|
97
|
|
|
|
datasift /
storyplayer
Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a
@returnannotation as described here.