summaryrefslogtreecommitdiff
path: root/buildscripts/phing/classes/phing/tasks/ext/Service/Amazon/S3/S3PutTask.php
blob: dbb18b56bd22b2287af239ee017a4cb0522eb14b (plain)
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
<?php
/*
 *  $Id: 84b1d6039427591cbf43dbe1a82691063ae4238a $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>. 
 */

require_once dirname(dirname(__FILE__)) . '/S3.php';

/**
 * Stores an object on S3
 * 
 * @version $Id: 84b1d6039427591cbf43dbe1a82691063ae4238a $
 * @package phing.tasks.ext
 * @author Andrei Serdeliuc <andrei@serdeliuc.ro>
 * @extends Service_Amazon_S3
 */
class S3PutTask extends Service_Amazon_S3
{
    /**
     * File we're trying to upload
     *
     * (default value: null)
     * 
     * @var string
     * @access protected
     */
    protected $_source = null;

    /**
	 * Content we're trying to upload
	 *
	 * The user can specify either a file to upload or just a bit of content
	 *
	 * (default value: null)
	 * 
	 * @var mixed
	 * @access protected
	 */
	protected $_content = null;
	
	/**
     * Collection of filesets
     * Used for uploading multiple files
     * 
     * (default value: array())
     * 
     * @var array
     * @access protected
     */
    protected $_filesets = array();
	
	/**
	 * Whether to try to create buckets or not
	 * 
	 * (default value: false)
	 * 
	 * @var bool
	 * @access protected
	 */
	protected $_createBuckets = false;
    
    public function setSource($source)
    {
        if(!is_readable($source)) {
            throw new BuildException('Source is not readable: ' . $source);
        }

        $this->_source = $source;
    }
    
    public function getSource()
    {
        if($this->_source === null) {
            throw new BuildException('Source is not set');
        }
        
        return $this->_source;
    }

	public function setContent($content)
	{
		if(empty($content) || !is_string($content)) {
			throw new BuildException('Content must be a non-empty string');
		}
		
		$this->_content = $content;
	}
	
	public function getContent()
	{
		if($this->_content === null) {
			throw new BuildException('Content is not set');
		}
		
		return $this->_content;
	}

	public function setObject($object)
	{
		if(empty($object) || !is_string($object)) {
			throw new BuildException('Object must be a non-empty string');
		}
		
		$this->_object = $object;
	}
	
	public function getObject()
	{
		if($this->_object === null) {
			throw new BuildException('Object is not set');
		}
		
		return $this->_object;
	}

	public function setCreateBuckets($createBuckets)
    {
        $this->_createBuckets = (bool) $createBuckets;
    }

	public function getCreateBuckets()
    {
        return (bool) $this->_createBuckets;
    }

	/**
     * creator for _filesets
     * 
     * @access public
     * @return FileSet
     */
    public function createFileset()
    {
        $num = array_push($this->_filesets, new FileSet());
        return $this->_filesets[$num-1];
    }

	/**
     * getter for _filesets
     * 
     * @access public
     * @return array
     */
    public function getFilesets()
    {
        return $this->_filesets;
    }

    /**
	 * Determines what we're going to store in the object
	 * 
	 * If _content has been set, this will get stored,
	 * otherwise, we read from _source
	 *
	 * @access public
	 * @return string
	 */
	public function getObjectData()
	{
		try {
			$content = $this->getContent();
		} catch(BuildException $e) {
			$source = $this->getSource();
			
			if(!is_file($source)) {
                throw new BuildException('Currently only files can be used as source');
			}
			
			$content = file_get_contents($source);
		}
		
		return $content;
	}
    
    /**
     * Store the object on S3
     * 
     * @access public
     * @return void
     */
    public function execute()
    {
		if(!$this->isBucketAvailable()) {
			if(!$this->getCreateBuckets()) {
				throw new BuildException('Bucket doesn\'t exist and createBuckets not specified');
			} else{
				if(!$this->createBucket()) {
					throw new BuildException('Bucket cannot be created');
				}
			}
		}
		
		// Filesets take precedence
		if(!empty($this->_filesets)) {
			$objects = array();
			
			foreach($this->_filesets as $fs) {
	            if(!($fs instanceof FileSet)) {
	                continue;
	            }

				$ds = $fs->getDirectoryScanner($this->getProject());
				$objects = array_merge($objects, $ds->getIncludedFiles());
			}
			
			$fromDir = $fs->getDir($this->getProject())->getAbsolutePath();
			
			foreach($objects as $object) {
				$this->saveObject($object, file_get_contents($fromDir . DIRECTORY_SEPARATOR . $object));
			}
			
			return true;
		}
		
		$this->saveObject($this->getObject(), $this->getObjectData());
    }

	protected function saveObject($object, $data)
	{
		$object = $this->getObjectInstance($object);
		$object->data = $data;
		$object->save();
		
		if(!$this->isObjectAvailable($object->key)) {
			throw new BuildException('Upload failed');
		}
	}
}