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