[BUGFIX] Wrong note in ResourceFactory
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Resource / Driver / AbstractHierarchicalFilesystemDriver.php
1 <?php
2 namespace TYPO3\CMS\Core\Resource\Driver;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2013 Steffen Ritter <steffen.ritter@typo3.org>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the text file GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29
30 /**
31 * Class AbstractHierarchicalFilesystemDriver
32 *
33 * @package TYPO3\CMS\Core\Resource\Driver
34 */
35 abstract class AbstractHierarchicalFilesystemDriver extends AbstractDriver {
36
37 /**
38 * Wrapper for \TYPO3\CMS\Core\Utility\GeneralUtility::validPathStr()
39 *
40 * @param string $theFile Filepath to evaluate
41 * @return boolean TRUE if no '/', '..' or '\' is in the $theFile
42 * @see \TYPO3\CMS\Core\Utility\GeneralUtility::validPathStr()
43 */
44 protected function isPathValid($theFile) {
45 return \TYPO3\CMS\Core\Utility\GeneralUtility::validPathStr($theFile);
46 }
47
48 /**
49 * Makes sure the Path given as parameter is valid
50 *
51 * @param string $filePath The file path (including the file name!)
52 * @return string
53 * @throws \TYPO3\CMS\Core\Resource\Exception\InvalidPathException
54 */
55 protected function canonicalizeAndCheckFilePath($filePath) {
56 $filePath = \TYPO3\CMS\Core\Utility\PathUtility::getCanonicalPath($filePath);
57
58 // filePath must be valid
59 if (!$this->isPathValid($filePath)) {
60 throw new \TYPO3\CMS\Core\Resource\Exception\InvalidPathException('File ' . $filePath . ' is not valid (".." and "//" is not allowed in path).', 1320286857);
61 }
62 return $filePath;
63 }
64
65 /**
66 * Makes sure the Path given as parameter is valid
67 *
68 * @param string $fileIdentifier The file path (including the file name!)
69 * @return string
70 */
71 protected function canonicalizeAndCheckFileIdentifier($fileIdentifier) {
72 if ($fileIdentifier !== '') {
73 $fileIdentifier = $this->canonicalizeAndCheckFilePath($fileIdentifier);
74 $fileIdentifier = '/' . ltrim($fileIdentifier, '/');
75 if (!$this->isCaseSensitiveFileSystem()) {
76 $fileIdentifier = strtolower($fileIdentifier);
77 }
78 }
79 return $fileIdentifier;
80 }
81
82 /**
83 * Makes sure the Path given as parameter is valid
84 *
85 * @param string $folderPath The file path (including the file name!)
86 * @return string
87 */
88 protected function canonicalizeAndCheckFolderIdentifier($folderPath) {
89 if ($folderPath === '/') {
90 $canonicalizedIdentifier = $folderPath;
91 } else {
92 $canonicalizedIdentifier = $this->canonicalizeAndCheckFileIdentifier($folderPath) . '/';
93 }
94 return $canonicalizedIdentifier;
95 }
96
97 /**
98 * Returns the identifier of the folder the file resides in
99 *
100 * @param string $fileIdentifier
101 * @return mixed
102 */
103 public function getParentFolderIdentifierOfIdentifier($fileIdentifier) {
104 $fileIdentifier = $this->canonicalizeAndCheckFileIdentifier($fileIdentifier);
105 return \TYPO3\CMS\Core\Utility\PathUtility::dirname($fileIdentifier) . '/';
106 }
107
108
109 }