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