ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Public Member Functions | Private Member Functions | Private Attributes
ILIAS\File\Sanitation\FilePathSanitizer Class Reference

Class FilePathSanitizer. More...

+ Collaboration diagram for ILIAS\File\Sanitation\FilePathSanitizer:

Public Member Functions

 __construct (ilObjFile $file_object)
 FilePathSanitizer constructor. More...
 
 needsSanitation ()
 
 sanitizeIfNeeded ()
 

Private Member Functions

 log ( $message)
 
 santitizeFilename ($first_file)
 
 saveNewNameForFileObject ($valid_filename)
 

Private Attributes

 $file_object
 
 $relative_path
 
 $fs
 
 $absolute_path
 
 $version = 1
 

Detailed Description

Class FilePathSanitizer.

Author
Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 17 of file FilePathSanitizer.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\File\Sanitation\FilePathSanitizer::__construct ( ilObjFile  $file_object)

FilePathSanitizer constructor.

Parameters
ilObjFile$file_object

Definition at line 47 of file FilePathSanitizer.php.

References ILIAS\File\Sanitation\FilePathSanitizer\$file_object, ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath(), ILIAS\Filesystem\Util\LegacyPathHelper\deriveFilesystemFrom(), and ilObjFile\getVersion().

48  {
49  $this->version = (int) $file_object->getVersion();
50  $this->file_object = $file_object;
51  $this->absolute_path = $this->file_object->getDirectory($this->version) . "/" . $this->file_object->getFileName();
52  $this->relative_path = LegacyPathHelper::createRelativePath($this->absolute_path);
53  $this->fs = LegacyPathHelper::deriveFilesystemFrom($this->absolute_path);
54  }
ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath
static createRelativePath(string $absolute_path)
Creates a relative path from an absolute path which starts with a valid storage location.
Definition: LegacyPathHelper.php:81
ILIAS\Filesystem\Util\LegacyPathHelper\deriveFilesystemFrom
static deriveFilesystemFrom(string $absolute_path)
Tries to fetch the filesystem responsible for the absolute path.
Definition: LegacyPathHelper.php:37
+ Here is the call graph for this function:

Member Function Documentation

◆ log()

ILIAS\File\Sanitation\FilePathSanitizer::log (   $message)
private
Parameters
string$message

Definition at line 83 of file FilePathSanitizer.php.

References $DIC, and $message.

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\sanitizeIfNeeded().

84  {
85  global $DIC;
86  $DIC->logger()->root()->debug("FilePathSanitizer: " . $message);
87  }
$DIC
global $DIC
Definition: saml.php:7
$message
catch(Exception $e) $message
Definition: saml2-logout.php:34
+ Here is the caller graph for this function:

◆ needsSanitation()

ILIAS\File\Sanitation\FilePathSanitizer::needsSanitation ( )
Returns
bool

Definition at line 60 of file FilePathSanitizer.php.

References ilFileUtils\getValidFilename().

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\sanitizeIfNeeded().

61  {
62  try {
63  $fs_relative_path_existing = $this->fs->has($this->relative_path);
64  $fs_valid_relative_path_existing = $this->fs->has(ilFileUtils::getValidFilename($this->relative_path));
65  $native_absolute_path_exists = file_exists($this->absolute_path);
66  $native_valid_absolute_path_existing = file_exists(ilFileUtils::getValidFilename($this->absolute_path));
67 
68  return (
69  !$fs_relative_path_existing
70  || !$fs_valid_relative_path_existing
71  || !$native_absolute_path_exists
72  || !$native_valid_absolute_path_existing
73  );
74  } catch (Exception $e) {
75  return false;
76  }
77  }
ilFileUtils\getValidFilename
static getValidFilename($a_filename)
Get valid filename.
Definition: class.ilFileUtils.php:837
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sanitizeIfNeeded()

ILIAS\File\Sanitation\FilePathSanitizer::sanitizeIfNeeded ( )
Returns
bool

Definition at line 93 of file FilePathSanitizer.php.

References ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath(), ILIAS\File\Sanitation\FilePathSanitizer\log(), ILIAS\File\Sanitation\FilePathSanitizer\needsSanitation(), ILIAS\File\Sanitation\FilePathSanitizer\santitizeFilename(), and ILIAS\File\Sanitation\FilePathSanitizer\saveNewNameForFileObject().

94  {
95  $versions = count($this->file_object->getVersions());
96  if ($versions === 1) {
97  $version_one = $this->file_object->getDirectory(1) . "/" . $this->file_object->getFileName();
98  $relative_version_one = LegacyPathHelper::createRelativePath($version_one);
99  $version_two = $this->file_object->getDirectory(2) . "/" . $this->file_object->getFileName();
100  $relative_version_two = LegacyPathHelper::createRelativePath($version_two);
101  if (!$this->fs->has($relative_version_one) && $this->fs->has($relative_version_two)) {
102  // $this->fs->copy($relative_version_two, $relative_version_one);
103  // $this->fs->delete($relative_version_two);
104  }
105  }
106 
107  if ($this->needsSanitation()) {
108  // First Try: using FileSystemService
109  $dirname = dirname($this->relative_path);
110  if (!$this->fs->has($dirname)) {
111  $this->log("FAILED: Sanitizing File Path: {$this->file_object->getFile()}. Message: Directory not found");
112 
113  return false;
114  }
115  try {
116  $first_file = reset($this->fs->listContents($dirname));
117  } catch (DirectoryNotFoundException $e) {
118  $this->log("FAILED AGAIN and AGAIN: Sanitizing File Path: {$this->file_object->getFile()}. Message: {$e->getMessage()}");
119 
120  return false;
121  }
122  if ($first_file instanceof \ILIAS\Filesystem\DTO\Metadata) {
123  try {
124  $valid_filename = $this->santitizeFilename($first_file->getPath());
125  // rename file in filesystem
126  if (!$this->fs->has($valid_filename)) {
127  $this->fs->rename($first_file->getPath(), $valid_filename);
128  // rename file object
129 
130  $this->log("Sanitized File Path: {$valid_filename}");
131  }
132  $this->saveNewNameForFileObject($valid_filename);
133 
134  return true;
135  } catch (Exception $e) {
136  $this->log("FAILED: Sanitizing File Path: {$this->file_object->getFile()}. Message: {$e->getMessage()}. Will try using native PHP");
137 
138  try {
139  // Second try: use native php
140  $scandir = scandir(dirname($this->absolute_path));
141  if (isset($scandir[2])) {
142  $first_file = $scandir[2];
143  if (is_file($first_file)) {
144  $valid_filename = $this->santitizeFilename($first_file);
145  if (rename($first_file, $valid_filename)) {
146  $this->saveNewNameForFileObject($valid_filename);
147  $this->log("Sanitized File Path: {$valid_filename}");
148  }
149  } else {
150  throw new Exception("is not a file: " . $first_file);
151  }
152  } else {
153  throw new Exception("no File found in " . dirname($this->absolute_path));
154  }
155  } catch (Exception $e) {
156  $this->log("FAILED AGAIN: Sanitizing File Path: {$this->file_object->getFile()}. Message: {$e->getMessage()}");
157 
158  try {
159  foreach (new DirectoryIterator(dirname($this->absolute_path)) as $item) {
160  if ($item->isDot()) {
161  continue;
162  }
163  if ($item->isFile()) {
164  $valid_filename = $this->santitizeFilename($item->getPathname());
165  if (rename($item->getPathname(), $valid_filename)) {
166  $this->saveNewNameForFileObject($valid_filename);
167  $this->log("Sanitized File Path: {$valid_filename}");
168  }
169  break;
170  }
171  }
172  } catch (Exception $e) {
173  $this->log("FAILED AGAIN and AGAIN: Sanitizing File Path: {$this->file_object->getFile()}. Message: {$e->getMessage()}");
174  }
175  }
176 
177  return false;
178  }
179  }
180 
181  return false;
182  }
183 
184  return true;
185  }
ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath
static createRelativePath(string $absolute_path)
Creates a relative path from an absolute path which starts with a valid storage location.
Definition: LegacyPathHelper.php:81
ILIAS
Class BaseForm.
Filesystem
Class FlySystemFileAccessTest.
+ Here is the call graph for this function:

◆ santitizeFilename()

ILIAS\File\Sanitation\FilePathSanitizer::santitizeFilename (   $first_file)
private
Parameters
$first_file
Returns
string|string[]|null
Exceptions

Definition at line 194 of file FilePathSanitizer.php.

References ilFileUtils\getValidFilename().

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\sanitizeIfNeeded().

195  {
196  $valid_filename = $first_file;
197 
198  while (preg_match('#\p{C}+|^\./#u', $valid_filename)) {
199  $valid_filename = preg_replace('#\p{C}+|^\./#u', '', $valid_filename);
200  }
201 
202  $valid_filename = preg_replace('/[\x00-\x1F\x7F-\xFF]/', '', $valid_filename); // removes all non printable characters (ASCII 7 Bit)
203 
204  // $valid_filename = \League\Flysystem\Util::normalizeRelativePath($valid_filename);
205  // $valid_filename = preg_replace('/[\x00-\x1F\x7F-\xA0\xAD]/u', '', $valid_filename);
206  // $valid_filename = iconv(mb_detect_encoding($valid_filename, mb_detect_order(), true), "UTF-8", $valid_filename);
207  // $valid_filename = utf8_encode($valid_filename);
208 
209  $valid_filename = ilFileUtils::getValidFilename($valid_filename);
210 
211  return $valid_filename;
212  }
ilFileUtils\getValidFilename
static getValidFilename($a_filename)
Get valid filename.
Definition: class.ilFileUtils.php:837
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ saveNewNameForFileObject()

ILIAS\File\Sanitation\FilePathSanitizer::saveNewNameForFileObject (   $valid_filename)
private
Parameters
$valid_filename

Definition at line 218 of file FilePathSanitizer.php.

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\sanitizeIfNeeded().

219  {
220  $sanitized_filename = basename($valid_filename);
221  $this->file_object->setFileName($sanitized_filename);
222  $this->file_object->update();
223  }
+ Here is the caller graph for this function:

Field Documentation

◆ $absolute_path

ILIAS\File\Sanitation\FilePathSanitizer::$absolute_path
private

Definition at line 35 of file FilePathSanitizer.php.

◆ $file_object

ILIAS\File\Sanitation\FilePathSanitizer::$file_object
private

Definition at line 23 of file FilePathSanitizer.php.

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\__construct().

◆ $fs

ILIAS\File\Sanitation\FilePathSanitizer::$fs
private

Definition at line 31 of file FilePathSanitizer.php.

◆ $relative_path

ILIAS\File\Sanitation\FilePathSanitizer::$relative_path
private

Definition at line 27 of file FilePathSanitizer.php.

◆ $version

ILIAS\File\Sanitation\FilePathSanitizer::$version = 1
private

Definition at line 39 of file FilePathSanitizer.php.

The documentation for this class was generated from the following file: