symphonycms /
symphony-2
| Total Complexity | 130 |
| Total Lines | 817 |
| Duplicated Lines | 0 % |
| Changes | 15 | ||
| Bugs | 1 | Features | 0 |
Complex classes like FieldUpload often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use FieldUpload, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 10 | class FieldUpload extends Field implements ExportableField, ImportableField |
||
| 11 | { |
||
| 12 | protected static $imageMimeTypes = array( |
||
| 13 | 'image/gif', |
||
| 14 | 'image/jpg', |
||
| 15 | 'image/jpeg', |
||
| 16 | 'image/pjpeg', |
||
| 17 | 'image/png', |
||
| 18 | 'image/x-png' |
||
| 19 | ); |
||
| 20 | |||
| 21 | public function __construct() |
||
| 22 | { |
||
| 23 | parent::__construct(); |
||
| 24 | |||
| 25 | $this->_name = __('File Upload'); |
||
|
Bug
Best Practice
introduced
by
|
|||
| 26 | $this->_required = true; |
||
| 27 | |||
| 28 | $this->set('location', 'sidebar'); |
||
| 29 | $this->set('required', 'no'); |
||
| 30 | } |
||
| 31 | |||
| 32 | /*------------------------------------------------------------------------- |
||
| 33 | Definition: |
||
| 34 | -------------------------------------------------------------------------*/ |
||
| 35 | |||
| 36 | public function canFilter() |
||
| 37 | { |
||
| 38 | return true; |
||
| 39 | } |
||
| 40 | |||
| 41 | public function canPrePopulate() |
||
| 42 | { |
||
| 43 | return true; |
||
| 44 | } |
||
| 45 | |||
| 46 | public function isSortable() |
||
| 49 | } |
||
| 50 | |||
| 51 | public function fetchFilterableOperators() |
||
| 52 | { |
||
| 53 | return array( |
||
| 54 | array( |
||
| 55 | 'title' => 'is', |
||
| 56 | 'filter' => ' ', |
||
| 57 | 'help' => __('Find files that are an exact match for the given string.') |
||
| 58 | ), |
||
| 59 | array( |
||
| 60 | 'filter' => 'sql: NOT NULL', |
||
| 61 | 'title' => 'is not empty', |
||
| 62 | 'help' => __('Find entries where a file has been saved.') |
||
| 63 | ), |
||
| 64 | array( |
||
| 65 | 'filter' => 'sql: NULL', |
||
| 66 | 'title' => 'is empty', |
||
| 67 | 'help' => __('Find entries where no file has been saved.') |
||
| 68 | ), |
||
| 69 | array( |
||
| 70 | 'title' => 'contains', |
||
| 71 | 'filter' => 'regexp: ', |
||
| 72 | 'help' => __('Find files that match the given <a href="%s">MySQL regular expressions</a>.', array( |
||
| 73 | 'https://dev.mysql.com/doc/mysql/en/regexp.html' |
||
| 74 | )) |
||
| 75 | ), |
||
| 76 | array( |
||
| 77 | 'title' => 'does not contain', |
||
| 78 | 'filter' => 'not-regexp: ', |
||
| 79 | 'help' => __('Find files that do not match the given <a href="%s">MySQL regular expressions</a>.', array( |
||
| 80 | 'https://dev.mysql.com/doc/mysql/en/regexp.html' |
||
| 81 | )) |
||
| 82 | ), |
||
| 83 | array( |
||
| 84 | 'title' => 'file type is', |
||
| 85 | 'filter' => 'mimetype: ', |
||
| 86 | 'help' => __('Find files that match the given mimetype.') |
||
| 87 | ), |
||
| 88 | array( |
||
| 89 | 'title' => 'size is', |
||
| 90 | 'filter' => 'size: ', |
||
| 91 | 'help' => __('Find files that match the given size.') |
||
| 92 | ) |
||
| 93 | ); |
||
| 94 | } |
||
| 95 | |||
| 96 | /*------------------------------------------------------------------------- |
||
| 97 | Setup: |
||
| 98 | -------------------------------------------------------------------------*/ |
||
| 99 | |||
| 100 | public function createTable() |
||
| 104 | `id` int(11) unsigned NOT null auto_increment, |
||
| 105 | `entry_id` int(11) unsigned NOT null, |
||
| 106 | `file` varchar(255) default null, |
||
| 107 | `size` int(11) unsigned null, |
||
| 108 | `mimetype` varchar(100) default null, |
||
| 109 | `meta` varchar(255) default null, |
||
| 110 | PRIMARY KEY (`id`), |
||
| 111 | UNIQUE KEY `entry_id` (`entry_id`), |
||
| 112 | KEY `file` (`file`), |
||
| 113 | KEY `mimetype` (`mimetype`) |
||
| 114 | ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;" |
||
| 115 | ); |
||
| 116 | } |
||
| 117 | |||
| 118 | /*------------------------------------------------------------------------- |
||
| 119 | Utilities: |
||
| 120 | -------------------------------------------------------------------------*/ |
||
| 121 | |||
| 122 | public function entryDataCleanup($entry_id, $data = null) |
||
| 123 | { |
||
| 124 | $file_location = $this->getFilePath($data['file']); |
||
| 125 | |||
| 126 | if (is_file($file_location)) { |
||
| 127 | General::deleteFile($file_location); |
||
| 128 | } |
||
| 129 | |||
| 130 | parent::entryDataCleanup($entry_id); |
||
| 131 | |||
| 132 | return true; |
||
| 133 | } |
||
| 134 | |||
| 135 | public static function getMetaInfo($file, $type) |
||
| 136 | { |
||
| 137 | $meta = array(); |
||
| 138 | |||
| 139 | if (!file_exists($file) || !is_readable($file)) { |
||
| 140 | return $meta; |
||
| 141 | } |
||
| 142 | |||
| 143 | $meta['creation'] = DateTimeObj::get('c', filemtime($file)); |
||
| 144 | |||
| 145 | if (General::in_iarray($type, fieldUpload::$imageMimeTypes) && $array = @getimagesize($file)) { |
||
| 146 | $meta['width'] = $array[0]; |
||
| 147 | $meta['height'] = $array[1]; |
||
| 148 | } |
||
| 149 | |||
| 150 | return $meta; |
||
| 151 | } |
||
| 152 | |||
| 153 | public function getFilePath($filename) |
||
| 154 | { |
||
| 155 | /** |
||
| 156 | * Ensure the file exists in the `WORKSPACE` directory |
||
| 157 | * @link http://getsymphony.com/discuss/issues/view/610/ |
||
| 158 | */ |
||
| 159 | $file = WORKSPACE . preg_replace(array('%/+%', '%(^|/)\.\./%', '%\/workspace\/%'), '/', $this->get('destination') . '/' . $filename); |
||
| 160 | |||
| 161 | return $file; |
||
| 162 | } |
||
| 163 | |||
| 164 | /*------------------------------------------------------------------------- |
||
| 165 | Settings: |
||
| 166 | -------------------------------------------------------------------------*/ |
||
| 167 | |||
| 168 | public function displaySettingsPanel(XMLElement &$wrapper, $errors = null) |
||
| 169 | { |
||
| 170 | parent::displaySettingsPanel($wrapper, $errors); |
||
| 171 | |||
| 172 | // Destination Folder |
||
| 173 | $ignore = array( |
||
| 174 | '/workspace/events', |
||
| 175 | '/workspace/data-sources', |
||
| 176 | '/workspace/text-formatters', |
||
| 177 | '/workspace/pages', |
||
| 178 | '/workspace/utilities' |
||
| 179 | ); |
||
| 180 | $directories = General::listDirStructure(WORKSPACE, null, true, DOCROOT, $ignore); |
||
| 181 | |||
| 182 | $label = Widget::Label(__('Destination Directory')); |
||
| 183 | |||
| 184 | $options = array(); |
||
| 185 | $options[] = array('/workspace', false, '/workspace'); |
||
| 186 | |||
| 187 | if (!empty($directories) && is_array($directories)) { |
||
| 188 | foreach ($directories as $d) { |
||
| 189 | $d = '/' . trim($d, '/'); |
||
| 190 | |||
| 191 | if (!in_array($d, $ignore)) { |
||
| 192 | $options[] = array($d, ($this->get('destination') == $d), $d); |
||
| 193 | } |
||
| 194 | } |
||
| 195 | } |
||
| 196 | |||
| 197 | $label->appendChild(Widget::Select('fields['.$this->get('sortorder').'][destination]', $options)); |
||
| 198 | |||
| 199 | if (isset($errors['destination'])) { |
||
| 200 | $wrapper->appendChild(Widget::Error($label, $errors['destination'])); |
||
| 201 | } else { |
||
| 202 | $wrapper->appendChild($label); |
||
| 203 | } |
||
| 204 | |||
| 205 | // Validation rule |
||
| 206 | $this->buildValidationSelect($wrapper, $this->get('validator'), 'fields['.$this->get('sortorder').'][validator]', 'upload', $errors); |
||
| 207 | |||
| 208 | // Requirements and table display |
||
| 209 | $this->appendStatusFooter($wrapper); |
||
| 210 | } |
||
| 211 | |||
| 212 | public function checkFields(array &$errors, $checkForDuplicates = true) |
||
| 213 | { |
||
| 214 | if (is_dir(DOCROOT . $this->get('destination') . '/') === false) { |
||
| 215 | $errors['destination'] = __('The destination directory, %s, does not exist.', array( |
||
| 216 | '<code>' . $this->get('destination') . '</code>' |
||
| 217 | )); |
||
| 218 | } elseif (is_writable(DOCROOT . $this->get('destination') . '/') === false) { |
||
| 219 | $errors['destination'] = __('The destination directory is not writable.') |
||
| 220 | . ' ' |
||
| 221 | . __('Please check permissions on %s.', array( |
||
| 222 | '<code>' . $this->get('destination') . '</code>' |
||
| 223 | )); |
||
| 224 | } |
||
| 225 | |||
| 226 | parent::checkFields($errors, $checkForDuplicates); |
||
| 227 | } |
||
| 228 | |||
| 229 | public function commit() |
||
| 230 | { |
||
| 231 | if (!parent::commit()) { |
||
| 232 | return false; |
||
| 233 | } |
||
| 234 | |||
| 235 | $id = $this->get('id'); |
||
| 236 | |||
| 237 | if ($id === false) { |
||
| 238 | return false; |
||
| 239 | } |
||
| 240 | |||
| 241 | $fields = array(); |
||
| 242 | |||
| 243 | $fields['destination'] = $this->get('destination'); |
||
| 244 | $fields['validator'] = ($fields['validator'] == 'custom' ? null : $this->get('validator')); |
||
| 245 | |||
| 246 | return FieldManager::saveSettings($id, $fields); |
||
| 247 | } |
||
| 248 | |||
| 249 | /*------------------------------------------------------------------------- |
||
| 250 | Publish: |
||
| 251 | -------------------------------------------------------------------------*/ |
||
| 252 | |||
| 253 | public function displayPublishPanel(XMLElement &$wrapper, $data = null, $flagWithError = null, $fieldnamePrefix = null, $fieldnamePostfix = null, $entry_id = null) |
||
| 254 | { |
||
| 255 | if (is_dir(DOCROOT . $this->get('destination') . '/') === false) { |
||
| 256 | $flagWithError = __('The destination directory, %s, does not exist.', array( |
||
| 257 | '<code>' . $this->get('destination') . '</code>' |
||
| 258 | )); |
||
| 259 | } elseif ($flagWithError && is_writable(DOCROOT . $this->get('destination') . '/') === false) { |
||
| 260 | $flagWithError = __('Destination folder is not writable.') |
||
| 261 | . ' ' |
||
| 262 | . __('Please check permissions on %s.', array( |
||
| 263 | '<code>' . $this->get('destination') . '</code>' |
||
| 264 | )); |
||
| 265 | } |
||
| 266 | |||
| 267 | $label = Widget::Label($this->get('label')); |
||
| 268 | $label->setAttribute('class', 'file'); |
||
| 269 | |||
| 270 | if ($this->get('required') !== 'yes') { |
||
| 271 | $label->appendChild(new XMLElement('i', __('Optional'))); |
||
| 272 | } |
||
| 273 | |||
| 274 | $span = new XMLElement('span', null, array('class' => 'frame')); |
||
| 275 | |||
| 276 | if (isset($data['file'])) { |
||
| 277 | $filename = $this->get('destination') . '/' . basename($data['file']); |
||
| 278 | $file = $this->getFilePath($data['file']); |
||
| 279 | if (file_exists($file) === false || !is_readable($file)) { |
||
| 280 | $flagWithError = __('The file uploaded is no longer available. Please check that it exists, and is readable.'); |
||
| 281 | } |
||
| 282 | |||
| 283 | $span->appendChild(new XMLElement('span', Widget::Anchor(preg_replace("![^a-z0-9]+!i", "$0​", $filename), URL . $filename))); |
||
| 284 | } else { |
||
| 285 | $filename = null; |
||
| 286 | } |
||
| 287 | |||
| 288 | $span->appendChild(Widget::Input('fields'.$fieldnamePrefix.'['.$this->get('element_name').']'.$fieldnamePostfix, $filename, ($filename ? 'hidden' : 'file'))); |
||
| 289 | |||
| 290 | $label->appendChild($span); |
||
| 291 | |||
| 292 | if ($flagWithError != null) { |
||
| 293 | $wrapper->appendChild(Widget::Error($label, $flagWithError)); |
||
| 294 | } else { |
||
| 295 | $wrapper->appendChild($label); |
||
| 296 | } |
||
| 297 | } |
||
| 298 | |||
| 299 | public function validateFilename($file, &$message) |
||
| 300 | { |
||
| 301 | if ($this->get('validator') != null) { |
||
| 302 | $rule = $this->get('validator'); |
||
| 303 | |||
| 304 | if (General::validateString($file, $rule) === false) { |
||
| 305 | $message = __('File chosen in ‘%s’ does not match allowable file types for that field.', array( |
||
| 306 | $this->get('label') |
||
| 307 | )); |
||
| 308 | |||
| 309 | return self::__INVALID_FIELDS__; |
||
| 310 | } |
||
| 311 | } |
||
| 312 | // If the developer did not specified any validator, check for the |
||
| 313 | // blacklisted file types instead |
||
| 314 | else { |
||
| 315 | $blacklist = Symphony::Configuration()->get('upload_blacklist', 'admin'); |
||
| 316 | |||
| 317 | if (!empty($blacklist) && General::validateString($file, $blacklist)) { |
||
| 318 | $message = __('File chosen in ‘%s’ is blacklisted for that field.', array( |
||
| 319 | $this->get('label') |
||
| 320 | )); |
||
| 321 | |||
| 322 | return self::__INVALID_FIELDS__; |
||
| 323 | } |
||
| 324 | } |
||
| 325 | |||
| 326 | return self::__OK__; |
||
| 327 | } |
||
| 328 | |||
| 329 | public function checkPostFieldData($data, &$message, $entry_id = null) |
||
| 330 | { |
||
| 331 | /** |
||
| 332 | * For information about PHPs upload error constants see: |
||
| 333 | * @link http://php.net/manual/en/features.file-upload.errors.php |
||
| 334 | */ |
||
| 335 | $message = null; |
||
| 336 | |||
| 337 | if ( |
||
| 338 | empty($data) |
||
| 339 | || ( |
||
| 340 | is_array($data) |
||
| 341 | && isset($data['error']) |
||
| 342 | && $data['error'] == UPLOAD_ERR_NO_FILE |
||
| 343 | ) |
||
| 344 | ) { |
||
| 345 | if ($this->get('required') === 'yes') { |
||
| 346 | $message = __('‘%s’ is a required field.', array($this->get('label'))); |
||
| 347 | |||
| 348 | return self::__MISSING_FIELDS__; |
||
| 349 | } |
||
| 350 | |||
| 351 | return self::__OK__; |
||
| 352 | } |
||
| 353 | |||
| 354 | // Its not an array, so just retain the current data and return |
||
| 355 | if (is_array($data) === false) { |
||
| 356 | $file = $this->getFilePath(basename($data)); |
||
| 357 | if (file_exists($file) === false || !is_readable($file)) { |
||
| 358 | $message = __('The file uploaded is no longer available. Please check that it exists, and is readable.'); |
||
| 359 | |||
| 360 | return self::__INVALID_FIELDS__; |
||
| 361 | } |
||
| 362 | |||
| 363 | // Ensure that the file still matches the validator and hasn't |
||
| 364 | // changed since it was uploaded. |
||
| 365 | return $this->validateFilename($file, $message); |
||
| 366 | } |
||
| 367 | |||
| 368 | if (is_dir(DOCROOT . $this->get('destination') . '/') === false) { |
||
| 369 | $message = __('The destination directory, %s, does not exist.', array( |
||
| 370 | '<code>' . $this->get('destination') . '</code>' |
||
| 371 | )); |
||
| 372 | |||
| 373 | return self::__ERROR__; |
||
| 374 | } elseif (is_writable(DOCROOT . $this->get('destination') . '/') === false) { |
||
| 375 | $message = __('Destination folder is not writable.') |
||
| 376 | . ' ' |
||
| 377 | . __('Please check permissions on %s.', array( |
||
| 378 | '<code>' . $this->get('destination') . '</code>' |
||
| 379 | )); |
||
| 380 | |||
| 381 | return self::__ERROR__; |
||
| 382 | } |
||
| 383 | |||
| 384 | if ($data['error'] != UPLOAD_ERR_NO_FILE && $data['error'] != UPLOAD_ERR_OK) { |
||
| 385 | switch ($data['error']) { |
||
| 386 | case UPLOAD_ERR_INI_SIZE: |
||
| 387 | $message = __('File chosen in ‘%1$s’ exceeds the maximum allowed upload size of %2$s specified by your host.', array($this->get('label'), (is_numeric(ini_get('upload_max_filesize')) ? General::formatFilesize(ini_get('upload_max_filesize')) : ini_get('upload_max_filesize')))); |
||
| 388 | break; |
||
| 389 | case UPLOAD_ERR_FORM_SIZE: |
||
| 390 | $message = __('File chosen in ‘%1$s’ exceeds the maximum allowed upload size of %2$s, specified by Symphony.', array($this->get('label'), General::formatFilesize($_POST['MAX_FILE_SIZE']))); |
||
| 391 | break; |
||
| 392 | case UPLOAD_ERR_PARTIAL: |
||
| 393 | case UPLOAD_ERR_NO_TMP_DIR: |
||
| 394 | $message = __('File chosen in ‘%s’ was only partially uploaded due to an error.', array($this->get('label'))); |
||
| 395 | break; |
||
| 396 | case UPLOAD_ERR_CANT_WRITE: |
||
| 397 | $message = __('Uploading ‘%s’ failed. Could not write temporary file to disk.', array($this->get('label'))); |
||
| 398 | break; |
||
| 399 | case UPLOAD_ERR_EXTENSION: |
||
| 400 | $message = __('Uploading ‘%s’ failed. File upload stopped by extension.', array($this->get('label'))); |
||
| 401 | break; |
||
| 402 | } |
||
| 403 | |||
| 404 | return self::__ERROR_CUSTOM__; |
||
| 405 | } |
||
| 406 | |||
| 407 | // Sanitize the filename |
||
| 408 | $data['name'] = Lang::createFilename($data['name']); |
||
| 409 | |||
| 410 | // Validate the filename |
||
| 411 | return $this->validateFilename($data['name'], $message); |
||
| 412 | } |
||
| 413 | |||
| 414 | public function processRawFieldData($data, &$status, &$message = null, $simulate = false, $entry_id = null) |
||
| 415 | { |
||
| 416 | $status = self::__OK__; |
||
| 417 | |||
| 418 | // No file given, save empty data: |
||
| 419 | if ($data === null) { |
||
| 420 | return array( |
||
| 421 | 'file' => null, |
||
| 422 | 'mimetype' => null, |
||
| 423 | 'size' => null, |
||
| 424 | 'meta' => null |
||
| 425 | ); |
||
| 426 | } |
||
| 427 | |||
| 428 | // Its not an array, so just retain the current data and return: |
||
| 429 | if (is_array($data) === false) { |
||
| 430 | $file = $this->getFilePath(basename($data)); |
||
| 431 | |||
| 432 | $result = array( |
||
| 433 | 'file' => $data, |
||
| 434 | 'mimetype' => null, |
||
| 435 | 'size' => null, |
||
| 436 | 'meta' => null |
||
| 437 | ); |
||
| 438 | |||
| 439 | // Grab the existing entry data to preserve the MIME type and size information |
||
| 440 | if (isset($entry_id)) { |
||
| 441 | $row = $this->getCurrentValues($entry_id); |
||
| 442 | |||
| 443 | if (empty($row) === false) { |
||
| 444 | $result = $row; |
||
| 445 | } |
||
| 446 | } |
||
| 447 | |||
| 448 | // Found the file, add any missing meta information: |
||
| 449 | if (file_exists($file) && is_readable($file)) { |
||
| 450 | if (empty($result['mimetype'])) { |
||
| 451 | $result['mimetype'] = General::getMimeType($file); |
||
| 452 | } |
||
| 453 | |||
| 454 | if (empty($result['size'])) { |
||
| 455 | $result['size'] = filesize($file); |
||
| 456 | } |
||
| 457 | |||
| 458 | if (empty($result['meta'])) { |
||
| 459 | $result['meta'] = serialize(static::getMetaInfo($file, $result['mimetype'])); |
||
| 460 | } |
||
| 461 | |||
| 462 | // The file was not found, or is unreadable: |
||
| 463 | } else { |
||
| 464 | $message = __('The file uploaded is no longer available. Please check that it exists, and is readable.'); |
||
| 465 | $status = self::__INVALID_FIELDS__; |
||
| 466 | } |
||
| 467 | |||
| 468 | return $result; |
||
| 469 | } |
||
| 470 | |||
| 471 | if ($simulate && is_null($entry_id)) { |
||
| 472 | return $data; |
||
| 473 | } |
||
| 474 | |||
| 475 | // Check to see if the entry already has a file associated with it: |
||
| 476 | if (is_null($entry_id) === false) { |
||
| 477 | $row = $this->getCurrentValues($entry_id); |
||
| 478 | |||
| 479 | $existing_file = isset($row['file']) ? $this->getFilePath($row['file']) : null; |
||
| 480 | |||
| 481 | // File was removed: |
||
| 482 | if ( |
||
| 483 | $data['error'] == UPLOAD_ERR_NO_FILE |
||
| 484 | && !is_null($existing_file) |
||
| 485 | && is_file($existing_file) |
||
| 486 | ) { |
||
| 487 | General::deleteFile($existing_file); |
||
| 488 | } |
||
| 489 | } |
||
| 490 | |||
| 491 | // Do not continue on upload error: |
||
| 492 | if ($data['error'] == UPLOAD_ERR_NO_FILE || $data['error'] != UPLOAD_ERR_OK) { |
||
| 493 | return false; |
||
| 494 | } |
||
| 495 | |||
| 496 | // Where to upload the new file? |
||
| 497 | $abs_path = DOCROOT . '/' . trim($this->get('destination'), '/'); |
||
| 498 | $rel_path = str_replace('/workspace', '', $this->get('destination')); |
||
| 499 | |||
| 500 | // Sanitize the filename |
||
| 501 | $data['name'] = Lang::createFilename($data['name']); |
||
| 502 | |||
| 503 | // If a file already exists, then rename the file being uploaded by |
||
| 504 | // adding `_1` to the filename. If `_1` already exists, the logic |
||
| 505 | // will keep adding 1 until a filename is available (#672) |
||
| 506 | if (file_exists($abs_path . '/' . $data['name'])) { |
||
| 507 | $extension = General::getExtension($data['name']); |
||
| 508 | $new_file = substr($abs_path . '/' . $data['name'], 0, -1 - strlen($extension)); |
||
| 509 | $count = 1; |
||
| 510 | |||
| 511 | do { |
||
| 512 | $renamed_file = $new_file . '_' . $count . '.' . $extension; |
||
| 513 | $count++; |
||
| 514 | } while (file_exists($renamed_file)); |
||
| 515 | |||
| 516 | // Extract the name filename from `$renamed_file`. |
||
| 517 | $data['name'] = str_replace($abs_path . '/', '', $renamed_file); |
||
| 518 | } |
||
| 519 | |||
| 520 | $file = $this->getFilePath($data['name']); |
||
| 521 | |||
| 522 | // Attempt to upload the file: |
||
| 523 | $uploaded = General::uploadFile( |
||
| 524 | $abs_path, |
||
| 525 | $data['name'], |
||
| 526 | $data['tmp_name'], |
||
| 527 | Symphony::Configuration()->get('write_mode', 'file') |
||
| 528 | ); |
||
| 529 | |||
| 530 | if ($uploaded === false) { |
||
| 531 | $message = __( |
||
| 532 | __('There was an error while trying to upload the file %1$s to the target directory %2$s.'), |
||
| 533 | array( |
||
| 534 | '<code>' . $data['name'] . '</code>', |
||
| 535 | '<code>workspace/' . ltrim($rel_path, '/') . '</code>' |
||
| 536 | ) |
||
| 537 | ); |
||
| 538 | $status = self::__ERROR_CUSTOM__; |
||
| 539 | |||
| 540 | return false; |
||
| 541 | } |
||
| 542 | |||
| 543 | // File has been replaced: |
||
| 544 | if ( |
||
| 545 | isset($existing_file) |
||
| 546 | && $existing_file !== $file |
||
| 547 | && is_file($existing_file) |
||
| 548 | ) { |
||
| 549 | General::deleteFile($existing_file); |
||
| 550 | } |
||
| 551 | |||
| 552 | // Get the mimetype, don't trust the browser. RE: #1609 |
||
| 553 | $data['type'] = General::getMimeType($file); |
||
| 554 | |||
| 555 | return array( |
||
| 556 | 'file' => basename($file), |
||
| 557 | 'size' => $data['size'], |
||
| 558 | 'mimetype' => $data['type'], |
||
| 559 | 'meta' => serialize(static::getMetaInfo($file, $data['type'])) |
||
| 560 | ); |
||
| 561 | } |
||
| 562 | |||
| 563 | protected function getCurrentValues($entry_id) |
||
| 564 | { |
||
| 565 | return Symphony::Database()->fetchRow(0, sprintf( |
||
| 566 | "SELECT `file`, `mimetype`, `size`, `meta` |
||
| 567 | FROM `tbl_entries_data_%d` |
||
| 568 | WHERE `entry_id` = %d |
||
| 569 | LIMIT 1 |
||
| 570 | ", |
||
| 571 | $this->get('id'), |
||
| 572 | $entry_id |
||
| 573 | )); |
||
| 574 | } |
||
| 575 | |||
| 576 | /*------------------------------------------------------------------------- |
||
| 577 | Output: |
||
| 578 | -------------------------------------------------------------------------*/ |
||
| 579 | |||
| 580 | public function appendFormattedElement(XMLElement &$wrapper, $data, $encode = false, $mode = null, $entry_id = null) |
||
| 581 | { |
||
| 582 | // It is possible an array of null data will be passed in. Check for this. |
||
| 583 | if (!is_array($data) || !isset($data['file']) || is_null($data['file'])) { |
||
| 584 | return; |
||
| 585 | } |
||
| 586 | |||
| 587 | $file = $this->getFilePath($data['file']); |
||
| 588 | $filesize = (file_exists($file) && is_readable($file)) ? filesize($file) : null; |
||
| 589 | $item = new XMLElement($this->get('element_name')); |
||
| 590 | $item->setAttributeArray(array( |
||
| 591 | 'size' => !is_null($filesize) ? General::formatFilesize($filesize) : 'unknown', |
||
| 592 | 'bytes' => !is_null($filesize) ? $filesize : 'unknown', |
||
| 593 | 'path' => General::sanitize( |
||
| 594 | str_replace(WORKSPACE, null, dirname($file)) |
||
| 595 | ), |
||
| 596 | 'type' => $data['mimetype'] |
||
| 597 | )); |
||
| 598 | |||
| 599 | $item->appendChild(new XMLElement('filename', General::sanitize(basename($file)))); |
||
| 600 | |||
| 601 | $m = unserialize($data['meta']); |
||
| 602 | |||
| 603 | if (is_array($m) && !empty($m)) { |
||
| 604 | $item->appendChild(new XMLElement('meta', null, $m)); |
||
| 605 | } |
||
| 606 | |||
| 607 | $wrapper->appendChild($item); |
||
| 608 | } |
||
| 609 | |||
| 610 | public function prepareTableValue($data, XMLElement $link = null, $entry_id = null) |
||
| 626 | } |
||
| 627 | } |
||
| 628 | |||
| 629 | public function prepareTextValue($data, $entry_id = null) |
||
| 630 | { |
||
| 631 | if (isset($data['file'])) { |
||
| 632 | return $data['file']; |
||
| 633 | } |
||
| 634 | return null; |
||
| 635 | } |
||
| 636 | |||
| 637 | public function prepareAssociationsDrawerXMLElement(Entry $e, array $parent_association, $prepopulate = '') |
||
| 638 | { |
||
| 639 | $li = parent::prepareAssociationsDrawerXMLElement($e, $parent_association); |
||
| 640 | $a = $li->getChild(0); |
||
| 641 | $a->setAttribute('data-path', $this->get('destination')); |
||
| 642 | |||
| 643 | return $li; |
||
| 644 | } |
||
| 645 | |||
| 646 | /*------------------------------------------------------------------------- |
||
| 647 | Import: |
||
| 648 | -------------------------------------------------------------------------*/ |
||
| 649 | |||
| 650 | public function getImportModes() |
||
| 651 | { |
||
| 652 | return array( |
||
| 653 | 'getValue' => ImportableField::STRING_VALUE, |
||
| 654 | 'getPostdata' => ImportableField::ARRAY_VALUE |
||
| 655 | ); |
||
| 656 | } |
||
| 657 | |||
| 658 | public function prepareImportValue($data, $mode, $entry_id = null) |
||
| 670 | } |
||
| 671 | |||
| 672 | /*------------------------------------------------------------------------- |
||
| 673 | Export: |
||
| 674 | -------------------------------------------------------------------------*/ |
||
| 675 | |||
| 676 | /** |
||
| 677 | * Return a list of supported export modes for use with `prepareExportValue`. |
||
| 678 | * |
||
| 679 | * @return array |
||
| 680 | */ |
||
| 681 | public function getExportModes() |
||
| 682 | { |
||
| 683 | return array( |
||
| 684 | 'getFilename' => ExportableField::VALUE, |
||
| 685 | 'getObject' => ExportableField::OBJECT, |
||
| 686 | 'getPostdata' => ExportableField::POSTDATA |
||
| 687 | ); |
||
| 688 | } |
||
| 689 | |||
| 690 | /** |
||
| 691 | * Give the field some data and ask it to return a value using one of many |
||
| 692 | * possible modes. |
||
| 693 | * |
||
| 694 | * @param mixed $data |
||
| 695 | * @param integer $mode |
||
| 696 | * @param integer $entry_id |
||
| 697 | * @return array|string|null |
||
| 698 | */ |
||
| 699 | public function prepareExportValue($data, $mode, $entry_id = null) |
||
| 700 | { |
||
| 701 | $modes = (object)$this->getExportModes(); |
||
| 702 | |||
| 703 | $filepath = $this->getFilePath($data['file']); |
||
| 704 | |||
| 705 | // No file, or the file that the entry is meant to have no |
||
| 706 | // longer exists. |
||
| 707 | if (!isset($data['file']) || !is_file($filepath)) { |
||
| 708 | return null; |
||
| 709 | } |
||
| 710 | |||
| 711 | if ($mode === $modes->getFilename) { |
||
| 712 | return $data['file']; |
||
| 713 | } |
||
| 714 | |||
| 715 | if ($mode === $modes->getObject) { |
||
| 716 | $object = (object)$data; |
||
| 717 | |||
| 718 | if (isset($object->meta)) { |
||
| 719 | $object->meta = unserialize($object->meta); |
||
| 720 | } |
||
| 721 | |||
| 722 | return $object; |
||
| 723 | } |
||
| 724 | |||
| 725 | if ($mode === $modes->getPostdata) { |
||
| 726 | return $data['file']; |
||
| 727 | } |
||
| 728 | } |
||
| 729 | |||
| 730 | /*------------------------------------------------------------------------- |
||
| 731 | Filtering: |
||
| 732 | -------------------------------------------------------------------------*/ |
||
| 733 | |||
| 734 | public function buildDSRetrievalSQL($data, &$joins, &$where, $andOperation = false) |
||
| 787 | } |
||
| 788 | |||
| 789 | /*------------------------------------------------------------------------- |
||
| 790 | Sorting: |
||
| 791 | -------------------------------------------------------------------------*/ |
||
| 792 | |||
| 793 | public function buildSortingSQL(&$joins, &$where, &$sort, $order = 'ASC') |
||
| 794 | { |
||
| 795 | if ($this->isRandomOrder($order)) { |
||
| 796 | $sort = 'ORDER BY RAND()'; |
||
| 797 | } else { |
||
| 798 | $sort = sprintf( |
||
| 799 | 'ORDER BY ( |
||
| 800 | SELECT %s |
||
| 801 | FROM tbl_entries_data_%d AS `ed` |
||
| 802 | WHERE entry_id = e.id |
||
| 803 | ) %s, `e`.`id` %s', |
||
| 804 | '`ed`.file', |
||
| 805 | $this->get('id'), |
||
| 806 | $order, |
||
| 807 | $order |
||
| 808 | ); |
||
| 809 | } |
||
| 810 | } |
||
| 811 | |||
| 812 | public function buildSortingSelectSQL($sort, $order = 'ASC') |
||
| 813 | { |
||
| 814 | return null; |
||
| 815 | } |
||
| 816 | |||
| 817 | /*------------------------------------------------------------------------- |
||
| 818 | Events: |
||
| 819 | -------------------------------------------------------------------------*/ |
||
| 820 | |||
| 821 | public function getExampleFormMarkup() |
||
| 827 | } |
||
| 828 | } |
||
| 829 |
Loading history...
