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
|
<?php
/**
* AttachmentBehavior
*
* A CakePHP Behavior that attaches a file to a model, and uploads automatically, then stores a value in the database.
*
* @author Miles Johnson - http://milesj.me
* @copyright Copyright 2006-2011, Miles Johnson, Inc.
* @license http://opensource.org/licenses/mit-license.php - Licensed under The MIT License
* @link http://milesj.me/code/cakephp/uploader
*/
App::uses('Set', 'Utility');
App::uses('String', 'Utility');
App::uses('ModelBehavior', 'Model');
App::import('Vendor', 'Uploader.S3');
App::import('Vendor', 'Uploader.Uploader');
class AttachmentBehavior extends ModelBehavior {
/**
* AS3 domain snippet.
*/
const AS3_DOMAIN = 's3.amazonaws.com';
/**
* Uploader instance.
*
* @access public
* @var Uploader
*/
public $uploader = null;
/**
* S3 instance.
*
* @access public
* @var S3
*/
public $s3 = null;
/**
* All user defined attachments; images => model.
*
* @access protected
* @var array
*/
protected $_attachments = array();
/**
* Mapping of database columns to form fields.
*
* @access protected
* @var array
*/
protected $_columns = array();
/**
* The default settings for attachments.
*
* @access protected
* @var array
*/
protected $_defaults = array(
'name' => '',
'baseDir' => '',
'uploadDir' => '',
'append' => '',
'prepend' => '',
'dbColumn' => 'uploadPath',
'importFrom' => '',
'defaultPath' => '', // Default file path to be used if the field is empty
'maxNameLength' => null,
'overwrite' => false, // Overwrite a file with the same name if it exists
'stopSave' => true, // Stop model save() on form upload error
'allowEmpty' => true, // Allow an empty file upload to continue
'saveAsFilename' => false, // If true, will only save the filename and not relative path
'transforms' => array(),
's3' => array(
'format' => 'http://{host}/{bucket}/{path}',
'accessKey' => '',
'secretKey' => '',
'ssl' => true,
'bucket' => '',
'path' => '',
'host' => self::AS3_DOMAIN
),
'metaColumns' => array(
'ext' => '',
'type' => '',
'size' => '',
'group' => '',
'width' => '',
'height' => '',
'filesize' => ''
)
);
/**
* Initialize uploader and save attachments.
*
* @access public
* @param Model $model
* @param array $config
* @return void
*/
public function setup(Model $model, $config = array()) {
$this->uploader = new Uploader();
if ($config) {
foreach ($config as $field => $attachment) {
if (isset($attachment['skipSave'])) {
$attachment['stopSave'] = $attachment['skipSave'];
}
$attachment = Set::merge($this->_defaults, $attachment);
$attachment['field'] = $field;
$columns = array($attachment['dbColumn'] => $field);
if ($attachment['transforms']) {
foreach ($attachment['transforms'] as $transform) {
$columns[$transform['dbColumn']] = $field;
}
}
$this->_attachments[$model->alias][$field] = $attachment;
$this->_columns[$model->alias] = $columns;
}
}
}
/**
* Deletes any files that have been attached to this model.
*
* @access public
* @param Model $model
* @param boolean $cascade
* @return mixed
*/
public function beforeDelete(Model $model, $cascade = true) {
if (empty($model->id)) {
return false;
}
$data = $model->read(null, $model->id);
$columns = $this->_columns[$model->alias];
if (!empty($data[$model->alias])) {
foreach ($data[$model->alias] as $column => $value) {
if (isset($columns[$column])) {
$attachment = $this->_attachments[$model->alias][$columns[$column]];
$this->uploader->setup($attachment);
$this->s3 = $this->s3($attachment['s3']);
$path = $attachment['saveAsFilename'] ? rtrim($attachment['uploadDir'], '/') . '/' . $value : $value;
$this->delete($path);
}
}
}
return true;
}
/**
* Before saving the data, try uploading the image, if successful save to database.
*
* @access public
* @param Model $model
* @return mixed
*/
public function beforeSave(Model $model, $options = Array()) {
if (empty($model->data[$model->alias])) {
return true;
}
foreach ($model->data[$model->alias] as $field => $file) {
if (empty($this->_attachments[$model->alias][$field])) {
continue;
}
$attachment = $this->_attachments[$model->alias][$field];
$attachment = $this->callback($model, 'beforeUpload', $attachment);
$data = array();
// Not a form upload, so lets treat it as an import
if (is_string($file) && !empty($file)) {
$attachment['importFrom'] = $file;
}
// Should we continue if a file threw errors during upload?
if (empty($file['tmp_name']) || (isset($file['error']) && $file['error'] == UPLOAD_ERR_NO_FILE) || (is_string($file) && empty($attachment['importFrom']))) {
if ($attachment['stopSave'] && !$attachment['allowEmpty']) {
return false;
} else if ($attachment['allowEmpty']) {
if (empty($attachment['defaultPath'])) {
unset($model->data[$model->alias][$attachment['dbColumn']]);
} else {
$model->data[$model->alias][$attachment['dbColumn']] = $attachment['defaultPath'];
}
continue;
}
}
// Save model method for formatting function
if (!empty($attachment['name']) && method_exists($model, $attachment['name'])) {
$attachment['name'] = array($model, $attachment['name']);
}
// Setup instances
$this->uploader->setup($attachment);
$this->s3 = $this->s3($attachment['s3']);
// Upload or import the file and attach to model data
$uploadResponse = $this->upload($file, $attachment, array(
'overwrite' => $attachment['overwrite'],
'name' => $attachment['name'],
'append' => $attachment['append'],
'prepend' => $attachment['prepend']
));
$uploaderOptions = array(
'uploadDir' => $this->uploader->uploadDir,
'baseDir' => $this->uploader->baseDir,
'tempDir' => $this->uploader->tempDir
);
if (empty($uploadResponse)) {
$model->invalidate($field, __d('uploader', 'There was an error uploading this file, please try again.'));
return false;
}
$basePath = $this->transfer($uploadResponse['path']);
$data[$attachment['dbColumn']] = ($attachment['saveAsFilename'] && $this->s3 === null) ? basename($basePath) : $basePath;
$toDelete = array();
$lastPath = $basePath;
// Apply image transformations
if ($attachment['transforms']) {
foreach ($attachment['transforms'] as $options) {
$options['field'] = $field;
$options = $this->callback($model, 'beforeTransform', $options);
$method = $options['method'];
if (!method_exists($this->uploader, $method)) {
trigger_error(sprintf('Uploader.Attachment::beforeSave(): "%s" is not a defined transformation method.', $method), E_USER_WARNING);
return false;
}
// Apply custom options for transform
$this->uploader->setup($options);
// Transform image
$transformResponse = $this->uploader->{$method}($options);
// Rollback uploaded files if one fails
if (empty($transformResponse)) {
foreach ($data as $path) {
$this->delete($path);
}
$model->invalidate($field, __d('uploader', 'An error occured during image %s transformation.', $method));
return false;
}
// Transform successful
$transformPath = $this->transfer($transformResponse);
$data[$options['dbColumn']] = ($attachment['saveAsFilename'] && $this->s3 === null) ? basename($transformPath) : $transformPath;
// Delete original if same column name and transform name are not the same file
if ($options['dbColumn'] == $attachment['dbColumn'] && $lastPath != $transformPath) {
$toDelete[] = $lastPath;
}
$lastPath = $transformPath;
// Reset to default settings
$this->uploader->setup($uploaderOptions);
}
}
// Delete old files if replacing them
if ($toDelete) {
foreach ($toDelete as $deleteFile) {
$this->delete($deleteFile);
}
}
// Apply meta columns
if ($attachment['metaColumns']) {
foreach ($attachment['metaColumns'] as $field => $column) {
if (isset($uploadResponse[$field]) && !empty($column)) {
$data[$column] = $uploadResponse[$field];
}
}
}
// Reset S3 and delete original files
if ($this->s3 !== null) {
foreach ($this->s3->uploads as $path) {
$this->delete($path);
}
$this->s3 = null;
}
// Merge upload data with model data
$model->data[$model->alias] = $data + $model->data[$model->alias];
}
return true;
}
/**
* Delete a file from Amazon S3 or locally.
*
* @access public
* @param string $path
* @return boolean
*/
public function delete($path) {
if ($this->s3 !== null && strpos($path, self::AS3_DOMAIN) !== false) {
return $this->s3->deleteObject($this->s3->bucket, $this->s3->path . basename($path));
}
return $this->uploader->delete($path);
}
/**
* Return an S3 instance.
*
* @access public
* @param array $settings
* @return S3
*/
public function s3(array $settings) {
if (empty($settings['accessKey']) || empty($settings['secretKey'])) {
return null;
}
$ssl = isset($settings['useSsl']) ? $settings['useSsl'] : $settings['ssl'];
$s3 = new S3($settings['accessKey'], $settings['secretKey'], (bool) $ssl);
$s3->host = $settings['host'];
$s3->bucket = $settings['bucket'];
$s3->path = trim($settings['path'], '/');
$s3->format = $settings['format'];
$s3->uploads = array();
return $s3;
}
/**
* Attempt to upload a file via remote import, file system import or standard upload.
*
* @access public
* @param string|array $file
* @param array $attachment
* @param array $options
* @return array
*/
public function upload($file, $attachment, $options) {
if ($attachment['importFrom']) {
if (preg_match('/(http|https)/', $attachment['importFrom'])) {
return $this->uploader->importRemote($attachment['importFrom'], $options);
} else {
return $this->uploader->import($attachment['importFrom'], $options);
}
}
return $this->uploader->upload($file, $options);
}
/**
* Transfer an object to the S3 storage bucket.
*
* @access public
* @param string $path
* @return string
*/
public function transfer($path) {
if ($this->s3 === null) {
return $path;
}
$host = empty($this->s3->host) ? self::AS3_DOMAIN : $this->s3->host;
$name = basename($path);
$bucket = $this->s3->bucket;
if (!empty($this->s3->path)) {
$name = $this->s3->path . '/' . $name;
}
if ($this->s3->putObjectFile($this->uploader->formatPath($path), $bucket, $name, S3::ACL_PUBLIC_READ)) {
$this->s3->uploads[] = $path;
return String::insert($this->s3->format, array(
'bucket' => $bucket,
'path' => $name,
'host' => $host
), array(
'before' => '{',
'after' => '}'
));
}
return $path;
}
/**
* Trigger a callback function to modify data.
*
* @access public
* @param Model $model
* @param string $method
* @param array $options
* @return array
*/
public function callback(Model $model, $method, array $options) {
if (method_exists($model, $method)) {
return $model->{$method}($options);
}
return $options;
}
} |
