[TASK] Turn todos into @todo to find them easier
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Resource / Driver / LocalDriver.php
1 <?php
2 namespace TYPO3\CMS\Core\Resource\Driver;
3
4 /**
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Resource\FolderInterface;
18 use TYPO3\CMS\Core\Resource\ResourceStorage;
19 use TYPO3\CMS\Core\Utility\GeneralUtility;
20 use TYPO3\CMS\Core\Utility\PathUtility;
21 use TYPO3\CMS\Core\Resource\Exception;
22
23 /**
24 * Driver for the local file system
25 *
26 */
27 class LocalDriver extends AbstractHierarchicalFilesystemDriver {
28
29 /**
30 * @var string
31 */
32 const UNSAFE_FILENAME_CHARACTER_EXPRESSION = '\\x00-\\x2C\\/\\x3A-\\x3F\\x5B-\\x60\\x7B-\\xBF';
33
34 /**
35 * The absolute base path. It always contains a trailing slash.
36 *
37 * @var string
38 */
39 protected $absoluteBasePath;
40
41 /**
42 * A list of all supported hash algorithms, written all lower case.
43 *
44 * @var array
45 */
46 protected $supportedHashAlgorithms = array('sha1', 'md5');
47
48 /**
49 * The base URL that points to this driver's storage. As long is this
50 * is not set, it is assumed that this folder is not publicly available
51 *
52 * @var string
53 */
54 protected $baseUri = NULL;
55
56 /**
57 * @var \TYPO3\CMS\Core\Charset\CharsetConverter
58 */
59 protected $charsetConversion;
60
61 /** @var array */
62 protected $mappingFolderNameToRole = array(
63 '_recycler_' => FolderInterface::ROLE_RECYCLER,
64 '_temp_' => FolderInterface::ROLE_TEMPORARY,
65 'user_upload' => FolderInterface::ROLE_USERUPLOAD,
66 );
67
68 /**
69 * @param array $configuration
70 */
71 public function __construct(array $configuration = array()) {
72 parent::__construct($configuration);
73 // The capabilities default of this driver. See CAPABILITY_* constants for possible values
74 $this->capabilities =
75 ResourceStorage::CAPABILITY_BROWSABLE
76 | ResourceStorage::CAPABILITY_PUBLIC
77 | ResourceStorage::CAPABILITY_WRITABLE;
78 }
79
80 /**
81 * Merges the capabilites merged by the user at the storage
82 * configuration into the actual capabilities of the driver
83 * and returns the result.
84 *
85 * @param int $capabilities
86 *
87 * @return int
88 */
89 public function mergeConfigurationCapabilities($capabilities) {
90 $this->capabilities &= $capabilities;
91 return $this->capabilities;
92 }
93
94
95 /**
96 * Processes the configuration for this driver.
97 *
98 * @return void
99 */
100 public function processConfiguration() {
101 $this->absoluteBasePath = $this->calculateBasePath($this->configuration);
102 $this->determineBaseUrl();
103 if ($this->baseUri === NULL) {
104 // remove public flag
105 $this->capabilities &= ~ResourceStorage::CAPABILITY_PUBLIC;
106 }
107 }
108
109 /**
110 * Initializes this object. This is called by the storage after the driver
111 * has been attached.
112 *
113 * @return void
114 */
115 public function initialize() {
116 }
117
118 /**
119 * Determines the base URL for this driver, from the configuration or
120 * the TypoScript frontend object
121 *
122 * @return void
123 */
124 protected function determineBaseUrl() {
125 // only calculate baseURI if the storage does not enforce jumpUrl Script
126 if ($this->hasCapability(ResourceStorage::CAPABILITY_PUBLIC)) {
127 if (GeneralUtility::isFirstPartOfStr($this->absoluteBasePath, PATH_site)) {
128 // use site-relative URLs
129 $temporaryBaseUri = rtrim(PathUtility::stripPathSitePrefix($this->absoluteBasePath), '/');
130 if ($temporaryBaseUri !== '') {
131 $uriParts = explode('/', $temporaryBaseUri);
132 $uriParts = array_map('rawurlencode', $uriParts);
133 $temporaryBaseUri = implode('/', $uriParts) . '/';
134 }
135 $this->baseUri = $temporaryBaseUri;
136 } elseif (isset($this->configuration['baseUri']) && GeneralUtility::isValidUrl($this->configuration['baseUri'])) {
137 $this->baseUri = rtrim($this->configuration['baseUri'], '/') . '/';
138 }
139 }
140 }
141
142 /**
143 * Calculates the absolute path to this drivers storage location.
144 *
145 * @throws Exception\InvalidConfigurationException
146 * @param array $configuration
147 * @return string
148 */
149 protected function calculateBasePath(array $configuration) {
150 if (!array_key_exists('basePath', $configuration) || empty($configuration['basePath'])) {
151 throw new Exception\InvalidConfigurationException(
152 'Configuration must contain base path.',
153 1346510477
154 );
155 }
156
157 if ($configuration['pathType'] === 'relative') {
158 $relativeBasePath = $configuration['basePath'];
159 $absoluteBasePath = PATH_site . $relativeBasePath;
160 } else {
161 $absoluteBasePath = $configuration['basePath'];
162 }
163 $absoluteBasePath = $this->canonicalizeAndCheckFilePath($absoluteBasePath);
164 $absoluteBasePath = rtrim($absoluteBasePath, '/') . '/';
165 if (!is_dir($absoluteBasePath)) {
166 throw new Exception\InvalidConfigurationException(
167 'Base path "' . $absoluteBasePath . '" does not exist or is no directory.',
168 1299233097
169 );
170 }
171 return $absoluteBasePath;
172 }
173
174 /**
175 * Returns the public URL to a file.
176 * For the local driver, this will always return a path relative to PATH_site.
177 *
178 * @param string $identifier
179 * @return string
180 * @throws \TYPO3\CMS\Core\Resource\Exception
181 */
182 public function getPublicUrl($identifier) {
183 $publicUrl = NULL;
184 if ($this->baseUri !== NULL) {
185 $uriParts = explode('/', ltrim($identifier, '/'));
186 $uriParts = array_map('rawurlencode', $uriParts);
187 $identifier = implode('/', $uriParts);
188 $publicUrl = $this->baseUri . $identifier;
189 }
190 return $publicUrl;
191 }
192
193 /**
194 * Returns the Identifier of the root level folder of the storage.
195 *
196 * @return string
197 */
198 public function getRootLevelFolder() {
199 return '/';
200 }
201
202 /**
203 * Returns identifier of the default folder new files should be put into.
204 *
205 * @return string
206 */
207 public function getDefaultFolder() {
208 $identifier = '/user_upload/';
209 $createFolder = !$this->folderExists($identifier);
210 if ($createFolder === TRUE) {
211 $identifier = $this->createFolder('user_upload');
212 }
213 return $identifier;
214 }
215
216 /**
217 * Creates a folder, within a parent folder.
218 * If no parent folder is given, a rootlevel folder will be created
219 *
220 * @param string $newFolderName
221 * @param string $parentFolderIdentifier
222 * @param bool $recursive
223 * @return string the Identifier of the new folder
224 */
225 public function createFolder($newFolderName, $parentFolderIdentifier = '', $recursive = FALSE) {
226 $parentFolderIdentifier = $this->canonicalizeAndCheckFolderIdentifier($parentFolderIdentifier);
227 $newFolderName = trim($newFolderName, '/');
228 if ($recursive == FALSE) {
229 $newFolderName = $this->sanitizeFileName($newFolderName);
230 $newIdentifier = $parentFolderIdentifier . $newFolderName . '/';
231 GeneralUtility::mkdir($this->getAbsoluteBasePath() . $newIdentifier);
232 } else {
233 $parts = GeneralUtility::trimExplode('/', $newFolderName);
234 $parts = array_map(array($this, 'sanitizeFileName'), $parts);
235 $newFolderName = implode('/', $parts);
236 $newIdentifier = $parentFolderIdentifier . $newFolderName . '/';
237 GeneralUtility::mkdir_deep($this->getAbsoluteBasePath() . $parentFolderIdentifier, $newFolderName);
238 }
239 return $newIdentifier;
240 }
241
242 /**
243 * Returns information about a file.
244 *
245 * @param string $fileIdentifier In the case of the LocalDriver, this is the (relative) path to the file.
246 * @param array $propertiesToExtract Array of properties which should be extracted, if empty all will be extracted
247 * @return array
248 * @throws \InvalidArgumentException
249 */
250 public function getFileInfoByIdentifier($fileIdentifier, array $propertiesToExtract = array()) {
251 $absoluteFilePath = $this->getAbsolutePath($fileIdentifier);
252 // don't use $this->fileExists() because we need the absolute path to the file anyways, so we can directly
253 // use PHP's filesystem method.
254 if (!file_exists($absoluteFilePath) || !is_file($absoluteFilePath)) {
255 throw new \InvalidArgumentException('File ' . $fileIdentifier . ' does not exist.', 1314516809);
256 }
257
258 $dirPath = PathUtility::dirname($fileIdentifier);
259 $dirPath = $this->canonicalizeAndCheckFolderIdentifier($dirPath);
260 return $this->extractFileInformation($absoluteFilePath, $dirPath, $propertiesToExtract);
261 }
262
263 /**
264 * Returns information about a folder.
265 *
266 * @param string $folderIdentifier In the case of the LocalDriver, this is the (relative) path to the file.
267 * @return array
268 * @throws Exception\FolderDoesNotExistException
269 */
270 public function getFolderInfoByIdentifier($folderIdentifier) {
271 $folderIdentifier = $this->canonicalizeAndCheckFolderIdentifier($folderIdentifier);
272
273 if (!$this->folderExists($folderIdentifier)) {
274 throw new Exception\FolderDoesNotExistException(
275 'File ' . $folderIdentifier . ' does not exist.',
276 1314516810
277 );
278 }
279 return array(
280 'identifier' => $folderIdentifier,
281 'name' => PathUtility::basename($folderIdentifier),
282 'storage' => $this->storageUid
283 );
284 }
285
286 /**
287 * Returns a string where any character not matching [.a-zA-Z0-9_-] is
288 * substituted by '_'
289 * Trailing dots are removed
290 *
291 * Previously in \TYPO3\CMS\Core\Utility\File\BasicFileUtility::cleanFileName()
292 *
293 * @param string $fileName Input string, typically the body of a fileName
294 * @param string $charset Charset of the a fileName (defaults to current charset; depending on context)
295 * @return string Output string with any characters not matching [.a-zA-Z0-9_-] is substituted by '_' and trailing dots removed
296 * @throws Exception\InvalidFileNameException
297 */
298 public function sanitizeFileName($fileName, $charset = '') {
299 // Handle UTF-8 characters
300 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['UTF8filesystem']) {
301 // Allow ".", "-", 0-9, a-z, A-Z and everything beyond U+C0 (latin capital letter a with grave)
302 $cleanFileName = preg_replace('/[' . self::UNSAFE_FILENAME_CHARACTER_EXPRESSION . ']/u', '_', trim($fileName));
303 } else {
304 // Define character set
305 if (!$charset) {
306 if (TYPO3_MODE === 'FE') {
307 $charset = $GLOBALS['TSFE']->renderCharset;
308 } else {
309 // default for Backend
310 $charset = 'utf-8';
311 }
312 }
313 // If a charset was found, convert fileName
314 if ($charset) {
315 $fileName = $this->getCharsetConversion()->specCharsToASCII($charset, $fileName);
316 }
317 // Replace unwanted characters by underscores
318 $cleanFileName = preg_replace('/[' . self::UNSAFE_FILENAME_CHARACTER_EXPRESSION . '\\xC0-\\xFF]/', '_', trim($fileName));
319 }
320 // Strip trailing dots and return
321 $cleanFileName = preg_replace('/\\.*$/', '', $cleanFileName);
322 if (!$cleanFileName) {
323 throw new Exception\InvalidFileNameException(
324 'File name ' . $cleanFileName . ' is invalid.',
325 1320288991
326 );
327 }
328 return $cleanFileName;
329 }
330
331 /**
332 * Generic wrapper for extracting a list of items from a path.
333 *
334 * @param string $folderIdentifier
335 * @param int $start The position to start the listing; if not set, start from the beginning
336 * @param int $numberOfItems The number of items to list; if set to zero, all items are returned
337 * @param array $filterMethods The filter methods used to filter the directory items
338 * @param bool $includeFiles
339 * @param bool $includeDirs
340 * @param bool $recursive
341 *
342 * @return array
343 * @throws \InvalidArgumentException
344 */
345 protected function getDirectoryItemList($folderIdentifier, $start = 0, $numberOfItems = 0, array $filterMethods, $includeFiles = TRUE, $includeDirs = TRUE, $recursive = FALSE) {
346 $folderIdentifier = $this->canonicalizeAndCheckFolderIdentifier($folderIdentifier);
347 $realPath = $this->getAbsolutePath($folderIdentifier);
348 if (!is_dir($realPath)) {
349 throw new \InvalidArgumentException(
350 'Cannot list items in directory ' . $folderIdentifier . ' - does not exist or is no directory',
351 1314349666
352 );
353 }
354
355 if ($start > 0) {
356 $start--;
357 }
358
359 // Fetch the files and folders and sort them by name; we have to do
360 // this here because the directory iterator does return them in
361 // an arbitrary order
362 $items = $this->retrieveFileAndFoldersInPath($realPath, $recursive, $includeFiles, $includeDirs);
363 uksort(
364 $items,
365 array('\\TYPO3\\CMS\\Core\\Utility\\ResourceUtility', 'recursiveFileListSortingHelper')
366 );
367
368 $iterator = new \ArrayIterator($items);
369 if ($iterator->count() === 0) {
370 return array();
371 }
372 $iterator->seek($start);
373
374 // $c is the counter for how many items we still have to fetch (-1 is unlimited)
375 $c = $numberOfItems > 0 ? $numberOfItems : - 1;
376 $items = array();
377 while ($iterator->valid() && ($numberOfItems === 0 || $c > 0)) {
378 // $iteratorItem is the file or folder name
379 $iteratorItem = $iterator->current();
380 // go on to the next iterator item now as we might skip this one early
381 $iterator->next();
382
383 if (
384 !$this->applyFilterMethodsToDirectoryItem(
385 $filterMethods,
386 $iteratorItem['name'],
387 $iteratorItem['identifier'],
388 $this->getParentFolderIdentifierOfIdentifier($iteratorItem['identifier'])
389 )
390 ) {
391 continue;
392 }
393
394
395 $items[$iteratorItem['identifier']] = $iteratorItem['identifier'];
396 // Decrement item counter to make sure we only return $numberOfItems
397 // we cannot do this earlier in the method (unlike moving the iterator forward) because we only add the
398 // item here
399 --$c;
400 }
401 return $items;
402 }
403
404 /**
405 * Applies a set of filter methods to a file name to find out if it should be used or not. This is e.g. used by
406 * directory listings.
407 *
408 * @param array $filterMethods The filter methods to use
409 * @param string $itemName
410 * @param string $itemIdentifier
411 * @param string $parentIdentifier
412 * @throws \RuntimeException
413 * @return bool
414 */
415 protected function applyFilterMethodsToDirectoryItem(array $filterMethods, $itemName, $itemIdentifier, $parentIdentifier) {
416 foreach ($filterMethods as $filter) {
417 if (is_array($filter)) {
418 $result = call_user_func($filter, $itemName, $itemIdentifier, $parentIdentifier, array(), $this);
419 // We have to use -1 as the „don't include“ return value, as call_user_func() will return FALSE
420 // If calling the method succeeded and thus we can't use that as a return value.
421 if ($result === -1) {
422 return FALSE;
423 } elseif ($result === FALSE) {
424 throw new \RuntimeException('Could not apply file/folder name filter ' . $filter[0] . '::' . $filter[1]);
425 }
426 }
427 }
428 return TRUE;
429 }
430
431 /**
432 * Returns a list of files inside the specified path
433 *
434 * @param string $folderIdentifier
435 * @param int $start
436 * @param int $numberOfItems
437 * @param bool $recursive
438 * @param array $filenameFilterCallbacks The method callbacks to use for filtering the items
439 *
440 * @return array of FileIdentifiers
441 */
442 public function getFilesInFolder($folderIdentifier, $start = 0, $numberOfItems = 0, $recursive = FALSE, array $filenameFilterCallbacks = array()) {
443 return $this->getDirectoryItemList($folderIdentifier, $start, $numberOfItems, $filenameFilterCallbacks, TRUE, FALSE, $recursive);
444 }
445
446 /**
447 * Returns a list of folders inside the specified path
448 *
449 * @param string $folderIdentifier
450 * @param int $start
451 * @param int $numberOfItems
452 * @param bool $recursive
453 * @param array $folderNameFilterCallbacks The method callbacks to use for filtering the items
454 *
455 * @return array of Folder Identifier
456 */
457 public function getFoldersInFolder($folderIdentifier, $start = 0, $numberOfItems = 0, $recursive = FALSE, array $folderNameFilterCallbacks = array()) {
458 return $this->getDirectoryItemList($folderIdentifier, $start, $numberOfItems, $folderNameFilterCallbacks, FALSE, TRUE, $recursive);
459 }
460
461 /**
462 * Returns a list with the names of all files and folders in a path, optionally recursive.
463 *
464 * @param string $path The absolute path
465 * @param bool $recursive If TRUE, recursively fetches files and folders
466 * @param bool $includeFiles
467 * @param bool $includeDirs
468 * @return array
469 */
470 protected function retrieveFileAndFoldersInPath($path, $recursive = FALSE, $includeFiles = TRUE, $includeDirs = TRUE) {
471 $pathLength = strlen($this->getAbsoluteBasePath());
472 $iteratorMode = \FilesystemIterator::UNIX_PATHS | \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::CURRENT_AS_FILEINFO;
473 if ($recursive) {
474 $iterator = new \RecursiveIteratorIterator(
475 new \RecursiveDirectoryIterator($path, $iteratorMode),
476 \RecursiveIteratorIterator::SELF_FIRST
477 );
478 } else {
479 $iterator = new \RecursiveDirectoryIterator($path, $iteratorMode);
480 }
481
482 $directoryEntries = array();
483 while ($iterator->valid()) {
484 /** @var $entry \SplFileInfo */
485 $entry = $iterator->current();
486 // skip non-files/non-folders, and empty entries
487 if ((!$entry->isFile() && !$entry->isDir()) || $entry->getFilename() == '' ||
488 ($entry->isFile() && !$includeFiles) || ($entry->isDir() && !$includeDirs)) {
489 $iterator->next();
490 continue;
491 }
492 $entryIdentifier = '/' . substr($entry->getPathname(), $pathLength);
493 $entryName = PathUtility::basename($entryIdentifier);
494 if ($entry->isDir()) {
495 $entryIdentifier .= '/';
496 }
497 $entryArray = array(
498 'identifier' => $entryIdentifier,
499 'name' => $entryName,
500 'type' => $entry->isDir() ? 'dir' : 'file'
501 );
502 $directoryEntries[$entryIdentifier] = $entryArray;
503 $iterator->next();
504 }
505 return $directoryEntries;
506 }
507
508 /**
509 * Extracts information about a file from the filesystem.
510 *
511 * @param string $filePath The absolute path to the file
512 * @param string $containerPath The relative path to the file's container
513 * @param array $propertiesToExtract array of properties which should be returned, if empty all will be extracted
514 * @return array
515 */
516 protected function extractFileInformation($filePath, $containerPath, array $propertiesToExtract = array()) {
517 if (count($propertiesToExtract) === 0) {
518 $propertiesToExtract = array(
519 'size', 'atime', 'atime', 'mtime', 'ctime', 'mimetype', 'name',
520 'identifier', 'identifier_hash', 'storage', 'folder_hash'
521 );
522 }
523 $fileInformation = array();
524 foreach ($propertiesToExtract as $property) {
525 $fileInformation[$property] = $this->getSpecificFileInformation($filePath, $containerPath, $property);
526 }
527 return $fileInformation;
528 }
529
530
531 /**
532 * Extracts a specific FileInformation from the FileSystems.
533 *
534 * @param string $fileIdentifier
535 * @param string $containerPath
536 * @param string $property
537 *
538 * @return bool|int|string
539 * @throws \InvalidArgumentException
540 */
541 public function getSpecificFileInformation($fileIdentifier, $containerPath, $property) {
542 $identifier = $this->canonicalizeAndCheckFileIdentifier($containerPath . PathUtility::basename($fileIdentifier));
543
544 switch ($property) {
545 case 'size':
546 return filesize($fileIdentifier);
547 case 'atime':
548 return fileatime($fileIdentifier);
549 case 'mtime':
550 return filemtime($fileIdentifier);
551 case 'ctime':
552 return filectime($fileIdentifier);
553 case 'name':
554 return PathUtility::basename($fileIdentifier);
555 case 'mimetype':
556 return $this->getMimeTypeOfFile($fileIdentifier);
557 case 'identifier':
558 return $identifier;
559 case 'storage':
560 return $this->storageUid;
561 case 'identifier_hash':
562 return $this->hashIdentifier($identifier);
563 case 'folder_hash':
564 return $this->hashIdentifier($this->getParentFolderIdentifierOfIdentifier($identifier));
565 default:
566 throw new \InvalidArgumentException(sprintf('The information "%s" is not available.', $property));
567 }
568 }
569
570 /**
571 * Returns the absolute path of the folder this driver operates on.
572 *
573 * @return string
574 */
575 protected function getAbsoluteBasePath() {
576 return $this->absoluteBasePath;
577 }
578
579 /**
580 * Returns the absolute path of a file or folder.
581 *
582 * @param string $fileIdentifier
583 * @return string
584 */
585 protected function getAbsolutePath($fileIdentifier) {
586 $relativeFilePath = ltrim($this->canonicalizeAndCheckFileIdentifier($fileIdentifier), '/');
587 $path = $this->absoluteBasePath . $relativeFilePath;
588 return $path;
589 }
590
591 /**
592 * Get MIME type of file.
593 *
594 * @param string $absoluteFilePath Absolute path to file
595 * @return string|boolean MIME type. eg, text/html, FALSE on error
596 */
597 protected function getMimeTypeOfFile($absoluteFilePath) {
598 if (function_exists('finfo_file')) {
599 $fileInfo = new \finfo();
600 return $fileInfo->file($absoluteFilePath, FILEINFO_MIME_TYPE);
601 } elseif (function_exists('mime_content_type')) {
602 return mime_content_type($absoluteFilePath);
603 }
604 return FALSE;
605 }
606
607 /**
608 * Creates a (cryptographic) hash for a file.
609 *
610 * @param string $fileIdentifier
611 * @param string $hashAlgorithm The hash algorithm to use
612 * @return string
613 * @throws \RuntimeException
614 * @throws \InvalidArgumentException
615 */
616 public function hash($fileIdentifier, $hashAlgorithm) {
617 if (!in_array($hashAlgorithm, $this->supportedHashAlgorithms)) {
618 throw new \InvalidArgumentException('Hash algorithm "' . $hashAlgorithm . '" is not supported.', 1304964032);
619 }
620 switch ($hashAlgorithm) {
621 case 'sha1':
622 $hash = sha1_file($this->getAbsolutePath($fileIdentifier));
623 break;
624 case 'md5':
625 $hash = md5_file($this->getAbsolutePath($fileIdentifier));
626 break;
627 default:
628 throw new \RuntimeException('Hash algorithm ' . $hashAlgorithm . ' is not implemented.', 1329644451);
629 }
630 return $hash;
631 }
632
633 /**
634 * Adds a file from the local server hard disk to a given path in TYPO3s virtual file system.
635 * This assumes that the local file exists, so no further check is done here!
636 * After a successful the original file must not exist anymore.
637 *
638 * @param string $localFilePath (within PATH_site)
639 * @param string $targetFolderIdentifier
640 * @param string $newFileName optional, if not given original name is used
641 * @param bool $removeOriginal if set the original file will be removed after successful operation
642 * @return string the identifier of the new file
643 * @throws \RuntimeException
644 * @throws \InvalidArgumentException
645 */
646 public function addFile($localFilePath, $targetFolderIdentifier, $newFileName = '', $removeOriginal = TRUE) {
647 $localFilePath = $this->canonicalizeAndCheckFilePath($localFilePath);
648 // as for the "virtual storage" for backwards-compatibility, this check always fails, as the file probably lies under PATH_site
649 // thus, it is not checked here
650 // @todo is check in storage
651 if (GeneralUtility::isFirstPartOfStr($localFilePath, $this->absoluteBasePath) && $this->storageUid > 0) {
652 throw new \InvalidArgumentException('Cannot add a file that is already part of this storage.', 1314778269);
653 }
654 $newFileName = $this->sanitizeFileName($newFileName !== '' ? $newFileName : PathUtility::basename($localFilePath));
655 $newFileIdentifier = $this->canonicalizeAndCheckFolderIdentifier($targetFolderIdentifier) . $newFileName;
656 $targetPath = $this->absoluteBasePath . $newFileIdentifier;
657
658 if ($removeOriginal) {
659 if (is_uploaded_file($localFilePath)) {
660 $result = move_uploaded_file($localFilePath, $targetPath);
661 } else {
662 $result = rename($localFilePath, $targetPath);
663 }
664 } else {
665 $result = copy($localFilePath, $targetPath);
666 }
667 if ($result === FALSE || !file_exists($targetPath)) {
668 throw new \RuntimeException('Adding file ' . $localFilePath . ' at ' . $newFileIdentifier . ' failed.');
669 }
670 clearstatcache();
671 // Change the permissions of the file
672 GeneralUtility::fixPermissions($targetPath);
673 return $newFileIdentifier;
674 }
675
676 /**
677 * Checks if a file exists.
678 *
679 * @param string $fileIdentifier
680 *
681 * @return bool
682 */
683 public function fileExists($fileIdentifier) {
684 $absoluteFilePath = $this->getAbsolutePath($fileIdentifier);
685 return is_file($absoluteFilePath);
686 }
687
688 /**
689 * Checks if a file inside a folder exists
690 *
691 * @param string $fileName
692 * @param string $folderIdentifier
693 * @return bool
694 */
695 public function fileExistsInFolder($fileName, $folderIdentifier) {
696 $identifier = $folderIdentifier . '/' . $fileName;
697 $identifier = $this->canonicalizeAndCheckFileIdentifier($identifier);
698 return $this->fileExists($identifier);
699 }
700
701 /**
702 * Checks if a folder exists.
703 *
704 * @param string $folderIdentifier
705 *
706 * @return bool
707 */
708 public function folderExists($folderIdentifier) {
709 $absoluteFilePath = $this->getAbsolutePath($folderIdentifier);
710 return is_dir($absoluteFilePath);
711 }
712
713 /**
714 * Checks if a folder inside a folder exists.
715 *
716 * @param string $folderName
717 * @param string $folderIdentifier
718 * @return bool
719 */
720 public function folderExistsInFolder($folderName, $folderIdentifier) {
721 $identifier = $folderIdentifier . '/' . $folderName;
722 $identifier = $this->canonicalizeAndCheckFolderIdentifier($identifier);
723 return $this->folderExists($identifier);
724 }
725
726 /**
727 * Returns the Identifier for a folder within a given folder.
728 *
729 * @param string $folderName The name of the target folder
730 * @param string $folderIdentifier
731 *
732 * @return string
733 */
734 public function getFolderInFolder($folderName, $folderIdentifier) {
735 $folderIdentifier = $this->canonicalizeAndCheckFolderIdentifier($folderIdentifier . '/' . $folderName);
736 return $folderIdentifier;
737 }
738
739 /**
740 * Replaces the contents (and file-specific metadata) of a file object with a local file.
741 *
742 * @param string $fileIdentifier
743 * @param string $localFilePath
744 * @return bool TRUE if the operation succeeded
745 * @throws \RuntimeException
746 */
747 public function replaceFile($fileIdentifier, $localFilePath) {
748 $filePath = $this->getAbsolutePath($fileIdentifier);
749 $result = rename($localFilePath, $filePath);
750 if ($result === FALSE) {
751 throw new \RuntimeException('Replacing file ' . $fileIdentifier . ' with ' . $localFilePath . ' failed.', 1315314711);
752 }
753 return $result;
754 }
755
756 /**
757 * Copies a file *within* the current storage.
758 * Note that this is only about an intra-storage copy action, where a file is just
759 * copied to another folder in the same storage.
760 *
761 * @param string $fileIdentifier
762 * @param string $targetFolderIdentifier
763 * @param string $fileName
764 * @return string the Identifier of the new file
765 */
766 public function copyFileWithinStorage($fileIdentifier, $targetFolderIdentifier, $fileName) {
767 $sourcePath = $this->getAbsolutePath($fileIdentifier);
768 $newIdentifier = $targetFolderIdentifier . '/' . $fileName;
769 $newIdentifier = $this->canonicalizeAndCheckFileIdentifier($newIdentifier);
770
771 copy($sourcePath, $this->absoluteBasePath . $newIdentifier);
772 GeneralUtility::fixPermissions($this->absoluteBasePath . $newIdentifier);
773 return $newIdentifier;
774 }
775
776 /**
777 * Moves a file *within* the current storage.
778 * Note that this is only about an inner-storage move action, where a file is just
779 * moved to another folder in the same storage.
780 *
781 * @param string $fileIdentifier
782 * @param string $targetFolderIdentifier
783 * @param string $newFileName
784 *
785 * @return string
786 * @throws \RuntimeException
787 */
788 public function moveFileWithinStorage($fileIdentifier, $targetFolderIdentifier, $newFileName) {
789 $sourcePath = $this->getAbsolutePath($fileIdentifier);
790 $targetIdentifier = $targetFolderIdentifier . '/' . $newFileName;
791 $targetIdentifier = $this->canonicalizeAndCheckFileIdentifier($targetIdentifier);
792 $result = rename($sourcePath, $this->getAbsolutePath($targetIdentifier));
793 if ($result === FALSE) {
794 throw new \RuntimeException('Moving file ' . $sourcePath . ' to ' . $targetIdentifier . ' failed.', 1315314712);
795 }
796 return $targetIdentifier;
797 }
798
799 /**
800 * Copies a file to a temporary path and returns that path.
801 *
802 * @param string $fileIdentifier
803 * @return string The temporary path
804 * @throws \RuntimeException
805 */
806 protected function copyFileToTemporaryPath($fileIdentifier) {
807 $sourcePath = $this->getAbsolutePath($fileIdentifier);
808 $temporaryPath = $this->getTemporaryPathForFile($fileIdentifier);
809 $result = copy($sourcePath, $temporaryPath);
810 touch($temporaryPath, filemtime($sourcePath));
811 if ($result === FALSE) {
812 throw new \RuntimeException('Copying file ' . $fileIdentifier . ' to temporary path failed.', 1320577649);
813 }
814 return $temporaryPath;
815 }
816
817 /**
818 * Creates a map of old and new file/folder identifiers after renaming or
819 * moving a folder. The old identifier is used as the key, the new one as the value.
820 *
821 * @param array $filesAndFolders
822 * @param string $sourceFolderIdentifier
823 * @param string $targetFolderIdentifier
824 *
825 * @return array
826 * @throws Exception\FileOperationErrorException
827 */
828 protected function createIdentifierMap(array $filesAndFolders, $sourceFolderIdentifier, $targetFolderIdentifier) {
829 $identifierMap = array();
830 $identifierMap[$sourceFolderIdentifier] = $targetFolderIdentifier;
831 foreach ($filesAndFolders as $oldItem) {
832 if ($oldItem['type'] == 'dir') {
833 $oldIdentifier = $oldItem['identifier'];
834 $newIdentifier = $this->canonicalizeAndCheckFolderIdentifier(
835 str_replace($sourceFolderIdentifier, $targetFolderIdentifier, $oldItem['identifier'])
836 );
837 } else {
838 $oldIdentifier = $oldItem['identifier'];
839 $newIdentifier = $this->canonicalizeAndCheckFileIdentifier(
840 str_replace($sourceFolderIdentifier, $targetFolderIdentifier, $oldItem['identifier'])
841 );
842 }
843 if (!file_exists($this->getAbsolutePath($newIdentifier))) {
844 throw new Exception\FileOperationErrorException(
845 sprintf('File "%1$s" was not found (should have been copied/moved from "%2$s").', $newIdentifier, $oldIdentifier),
846 1330119453
847 );
848 }
849 $identifierMap[$oldIdentifier] = $newIdentifier;
850 }
851 return $identifierMap;
852 }
853
854 /**
855 * Folder equivalent to moveFileWithinStorage().
856 *
857 * @param string $sourceFolderIdentifier
858 * @param string $targetFolderIdentifier
859 * @param string $newFolderName
860 *
861 * @return array A map of old to new file identifiers
862 * @throws \RuntimeException
863 */
864 public function moveFolderWithinStorage($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName) {
865 $sourcePath = $this->getAbsolutePath($sourceFolderIdentifier);
866 $relativeTargetPath = $this->canonicalizeAndCheckFolderIdentifier($targetFolderIdentifier . '/' . $newFolderName);
867 $targetPath = $this->getAbsolutePath($relativeTargetPath);
868 // get all files and folders we are going to move, to have a map for updating later.
869 $filesAndFolders = $this->retrieveFileAndFoldersInPath($sourcePath, TRUE);
870 $result = rename($sourcePath, $targetPath);
871 if ($result === FALSE) {
872 throw new \RuntimeException('Moving folder ' . $sourcePath . ' to ' . $targetPath . ' failed.', 1320711817);
873 }
874 // Create a mapping from old to new identifiers
875 $identifierMap = $this->createIdentifierMap($filesAndFolders, $sourceFolderIdentifier, $relativeTargetPath);
876 return $identifierMap;
877 }
878
879 /**
880 * Folder equivalent to copyFileWithinStorage().
881 *
882 * @param string $sourceFolderIdentifier
883 * @param string $targetFolderIdentifier
884 * @param string $newFolderName
885 *
886 * @return bool
887 * @throws Exception\FileOperationErrorException
888 */
889 public function copyFolderWithinStorage($sourceFolderIdentifier, $targetFolderIdentifier, $newFolderName) {
890 // This target folder path already includes the topmost level, i.e. the folder this method knows as $folderToCopy.
891 // We can thus rely on this folder being present and just create the subfolder we want to copy to.
892 $newFolderIdentifier = $this->canonicalizeAndCheckFolderIdentifier($targetFolderIdentifier . '/' . $newFolderName);
893 $sourceFolderPath = $this->getAbsolutePath($sourceFolderIdentifier);
894 $targetFolderPath = $this->getAbsolutePath($newFolderIdentifier);
895
896 mkdir($targetFolderPath);
897 /** @var $iterator \RecursiveDirectoryIterator */
898 $iterator = new \RecursiveIteratorIterator(
899 new \RecursiveDirectoryIterator($sourceFolderPath),
900 \RecursiveIteratorIterator::SELF_FIRST
901 );
902 // Rewind the iterator as this is important for some systems e.g. Windows
903 $iterator->rewind();
904 while ($iterator->valid()) {
905 /** @var $current \RecursiveDirectoryIterator */
906 $current = $iterator->current();
907 $fileName = $current->getFilename();
908 $itemSubPath = GeneralUtility::fixWindowsFilePath($iterator->getSubPathname());
909 if ($current->isDir() && !($fileName === '..' || $fileName === '.')) {
910 GeneralUtility::mkdir($targetFolderPath . '/' . $itemSubPath);
911 } elseif ($current->isFile()) {
912 $result = copy($sourceFolderPath . '/' . $itemSubPath, $targetFolderPath . '/' . $itemSubPath);
913 if ($result === FALSE) {
914 // rollback
915 GeneralUtility::rmdir($targetFolderIdentifier, TRUE);
916 throw new Exception\FileOperationErrorException(
917 'Copying file "' . $sourceFolderPath . $itemSubPath . '" to "' . $targetFolderPath . $itemSubPath . '" failed.',
918 1330119452
919 );
920
921 }
922 }
923 $iterator->next();
924 }
925 GeneralUtility::fixPermissions($targetFolderPath, TRUE);
926 return TRUE;
927 }
928
929 /**
930 * Renames a file in this storage.
931 *
932 * @param string $fileIdentifier
933 * @param string $newName The target path (including the file name!)
934 * @return string The identifier of the file after renaming
935 * @throws Exception\ExistingTargetFileNameException
936 * @throws \RuntimeException
937 */
938 public function renameFile($fileIdentifier, $newName) {
939 // Makes sure the Path given as parameter is valid
940 $newName = $this->sanitizeFileName($newName);
941 $newIdentifier = rtrim(GeneralUtility::fixWindowsFilePath(PathUtility::dirname($fileIdentifier)), '/') . '/' . $newName;
942 $newIdentifier = $this->canonicalizeAndCheckFileIdentifier($newIdentifier);
943 // The target should not exist already
944 if ($this->fileExists($newIdentifier)) {
945 throw new Exception\ExistingTargetFileNameException('The target file already exists.', 1320291063);
946 }
947 $sourcePath = $this->getAbsolutePath($fileIdentifier);
948 $targetPath = $this->getAbsolutePath($newIdentifier);
949 $result = rename($sourcePath, $targetPath);
950 if ($result === FALSE) {
951 throw new \RuntimeException('Renaming file ' . $sourcePath . ' to ' . $targetPath . ' failed.', 1320375115);
952 }
953 return $newIdentifier;
954 }
955
956
957 /**
958 * Renames a folder in this storage.
959 *
960 * @param string $folderIdentifier
961 * @param string $newName
962 * @return array A map of old to new file identifiers of all affected files and folders
963 * @throws \RuntimeException if renaming the folder failed
964 */
965 public function renameFolder($folderIdentifier, $newName) {
966 $folderIdentifier = $this->canonicalizeAndCheckFolderIdentifier($folderIdentifier);
967 $newName = $this->sanitizeFileName($newName);
968
969 $newIdentifier = PathUtility::dirname($folderIdentifier) . '/' . $newName;
970 $newIdentifier = $this->canonicalizeAndCheckFolderIdentifier($newIdentifier);
971
972 $sourcePath = $this->getAbsolutePath($folderIdentifier);
973 $targetPath = $this->getAbsolutePath($newIdentifier);
974 // get all files and folders we are going to move, to have a map for updating later.
975 $filesAndFolders = $this->retrieveFileAndFoldersInPath($sourcePath, TRUE);
976 $result = rename($sourcePath, $targetPath);
977 if ($result === FALSE) {
978 throw new \RuntimeException(sprintf('Renaming folder "%1$s" to "%2$s" failed."', $sourcePath, $targetPath), 1320375116);
979 }
980 try {
981 // Create a mapping from old to new identifiers
982 $identifierMap = $this->createIdentifierMap($filesAndFolders, $folderIdentifier, $newIdentifier);
983 } catch (\Exception $e) {
984 rename($targetPath, $sourcePath);
985 throw new \RuntimeException(
986 sprintf(
987 'Creating filename mapping after renaming "%1$s" to "%2$s" failed. Reverted rename operation.\\n\\nOriginal error: %3$s"',
988 $sourcePath, $targetPath, $e->getMessage()
989 ),
990 1334160746
991 );
992 }
993 return $identifierMap;
994 }
995
996 /**
997 * Removes a file from the filesystem. This does not check if the file is
998 * still used or if it is a bad idea to delete it for some other reason
999 * this has to be taken care of in the upper layers (e.g. the Storage)!
1000 *
1001 * @param string $fileIdentifier
1002 * @return bool TRUE if deleting the file succeeded
1003 * @throws \RuntimeException
1004 */
1005 public function deleteFile($fileIdentifier) {
1006 $filePath = $this->getAbsolutePath($fileIdentifier);
1007 $result = unlink($filePath);
1008 if ($result === FALSE) {
1009 throw new \RuntimeException('Deletion of file ' . $fileIdentifier . ' failed.', 1320855304);
1010 }
1011 return $result;
1012 }
1013
1014 /**
1015 * Removes a folder from this storage.
1016 *
1017 * @param string $folderIdentifier
1018 * @param bool $deleteRecursively
1019 * @return bool
1020 * @throws Exception\FileOperationErrorException
1021 */
1022 public function deleteFolder($folderIdentifier, $deleteRecursively = FALSE) {
1023 $folderPath = $this->getAbsolutePath($folderIdentifier);
1024 $result = GeneralUtility::rmdir($folderPath, $deleteRecursively);
1025 if ($result === FALSE) {
1026 throw new Exception\FileOperationErrorException(
1027 'Deleting folder "' . $folderIdentifier . '" failed.',
1028 1330119451
1029 );
1030 }
1031 return $result;
1032 }
1033
1034 /**
1035 * Checks if a folder contains files and (if supported) other folders.
1036 *
1037 * @param string $folderIdentifier
1038 * @return bool TRUE if there are no files and folders within $folder
1039 */
1040 public function isFolderEmpty($folderIdentifier) {
1041 $path = $this->getAbsolutePath($folderIdentifier);
1042 $dirHandle = opendir($path);
1043 while ($entry = readdir($dirHandle)) {
1044 if ($entry !== '.' && $entry !== '..') {
1045 closedir($dirHandle);
1046 return FALSE;
1047 }
1048 }
1049 closedir($dirHandle);
1050 return TRUE;
1051 }
1052
1053 /**
1054 * Returns (a local copy of) a file for processing it. This makes a copy
1055 * first when in writable mode, so if you change the file, you have to update it yourself afterwards.
1056 *
1057 * @param string $fileIdentifier
1058 * @param bool $writable Set this to FALSE if you only need the file for read operations.
1059 * This might speed up things, e.g. by using a cached local version.
1060 * Never modify the file if you have set this flag!
1061 * @return string The path to the file on the local disk
1062 */
1063 public function getFileForLocalProcessing($fileIdentifier, $writable = TRUE) {
1064 if ($writable === FALSE) {
1065 return $this->getAbsolutePath($fileIdentifier);
1066 } else {
1067 return $this->copyFileToTemporaryPath($fileIdentifier);
1068 }
1069 }
1070
1071
1072 /**
1073 * Returns the permissions of a file/folder as an array (keys r, w) of boolean flags
1074 *
1075 * @param string $identifier
1076 * @return array
1077 * @throws \RuntimeException
1078 */
1079 public function getPermissions($identifier) {
1080 $path = $this->getAbsolutePath($identifier);
1081 $permissionBits = fileperms($path);
1082 if ($permissionBits === FALSE) {
1083 throw new \RuntimeException('Error while fetching permissions for ' . $path, 1319455097);
1084 }
1085 return array(
1086 'r' => (bool)is_readable($path),
1087 'w' => (bool)is_writable($path)
1088 );
1089 }
1090
1091 /**
1092 * Checks if a given identifier is within a container, e.g. if
1093 * a file or folder is within another folder. It will also return
1094 * TRUE if both canonicalized identifiers are equal.
1095 *
1096 * @param string $folderIdentifier
1097 * @param string $identifier identifier to be checked against $folderIdentifier
1098 * @return bool TRUE if $content is within or matches $folderIdentifier
1099 */
1100 public function isWithin($folderIdentifier, $identifier) {
1101 $folderIdentifier = $this->canonicalizeAndCheckFileIdentifier($folderIdentifier);
1102 $entryIdentifier = $this->canonicalizeAndCheckFileIdentifier($identifier);
1103 if ($folderIdentifier === $entryIdentifier) {
1104 return TRUE;
1105 }
1106 // File identifier canonicalization will not modify a single slash so
1107 // we must not append another slash in that case.
1108 if ($folderIdentifier !== '/') {
1109 $folderIdentifier .= '/';
1110 }
1111 return GeneralUtility::isFirstPartOfStr($entryIdentifier, $folderIdentifier);
1112 }
1113
1114 /**
1115 * Creates a new (empty) file and returns the identifier.
1116 *
1117 * @param string $fileName
1118 * @param string $parentFolderIdentifier
1119 * @return string
1120 * @throws Exception\InvalidFileNameException
1121 * @throws \RuntimeException
1122 */
1123 public function createFile($fileName, $parentFolderIdentifier) {
1124 if (!$this->isValidFilename($fileName)) {
1125 throw new Exception\InvalidFileNameException(
1126 'Invalid characters in fileName "' . $fileName . '"',
1127 1320572272
1128 );
1129 }
1130 $parentFolderIdentifier = $this->canonicalizeAndCheckFolderIdentifier($parentFolderIdentifier);
1131 $fileIdentifier = $this->canonicalizeAndCheckFileIdentifier(
1132 $parentFolderIdentifier . $this->sanitizeFileName(ltrim($fileName, '/'))
1133 );
1134 $absoluteFilePath = $this->getAbsolutePath($fileIdentifier);
1135 $result = touch($absoluteFilePath);
1136 GeneralUtility::fixPermissions($absoluteFilePath);
1137 clearstatcache();
1138 if ($result !== TRUE) {
1139 throw new \RuntimeException('Creating file ' . $fileIdentifier . ' failed.', 1320569854);
1140 }
1141 return $fileIdentifier;
1142 }
1143
1144 /**
1145 * Returns the contents of a file. Beware that this requires to load the
1146 * complete file into memory and also may require fetching the file from an
1147 * external location. So this might be an expensive operation (both in terms of
1148 * processing resources and money) for large files.
1149 *
1150 * @param string $fileIdentifier
1151 * @return string The file contents
1152 */
1153 public function getFileContents($fileIdentifier) {
1154 $filePath = $this->getAbsolutePath($fileIdentifier);
1155 return file_get_contents($filePath);
1156 }
1157
1158 /**
1159 * Sets the contents of a file to the specified value.
1160 *
1161 * @param string $fileIdentifier
1162 * @param string $contents
1163 * @return int The number of bytes written to the file
1164 * @throws \RuntimeException if the operation failed
1165 */
1166 public function setFileContents($fileIdentifier, $contents) {
1167 $filePath = $this->getAbsolutePath($fileIdentifier);
1168 $result = file_put_contents($filePath, $contents);
1169
1170 // Make sure later calls to filesize() etc. return correct values.
1171 clearstatcache(TRUE, $filePath);
1172
1173 if ($result === FALSE) {
1174 throw new \RuntimeException('Setting contents of file "' . $fileIdentifier . '" failed.', 1325419305);
1175 }
1176 return $result;
1177 }
1178
1179 /**
1180 * Gets the charset conversion object.
1181 *
1182 * @return \TYPO3\CMS\Core\Charset\CharsetConverter
1183 */
1184 protected function getCharsetConversion() {
1185 if (!isset($this->charsetConversion)) {
1186 if (TYPO3_MODE === 'FE') {
1187 $this->charsetConversion = $GLOBALS['TSFE']->csConvObj;
1188 } elseif (is_object($GLOBALS['LANG'])) {
1189 // BE assumed:
1190 $this->charsetConversion = $GLOBALS['LANG']->csConvObj;
1191 } else {
1192 // The object may not exist yet, so we need to create it now. Happens in the Install Tool for example.
1193 $this->charsetConversion = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Charset\CharsetConverter::class);
1194 }
1195 }
1196 return $this->charsetConversion;
1197 }
1198
1199 /**
1200 * Returns the role of an item (currently only folders; can later be extended for files as well)
1201 *
1202 * @param string $folderIdentifier
1203 * @return string
1204 */
1205 public function getRole($folderIdentifier) {
1206 $name = PathUtility::basename($folderIdentifier);
1207 $role = $this->mappingFolderNameToRole[$name];
1208 if (empty($role)) {
1209 $role = FolderInterface::ROLE_DEFAULT;
1210 }
1211 return $role;
1212 }
1213
1214 /**
1215 * Directly output the contents of the file to the output
1216 * buffer. Should not take care of header files or flushing
1217 * buffer before. Will be taken care of by the Storage.
1218 *
1219 * @param string $identifier
1220 *
1221 * @return void
1222 */
1223 public function dumpFileContents($identifier) {
1224 readfile($this->getAbsolutePath($this->canonicalizeAndCheckFileIdentifier($identifier)), 0);
1225 }
1226
1227
1228 }