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