1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
<?php
namespace Drupal\file\EventSubscriber;
use Drupal\Component\Transliteration\TransliterationInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\File\Event\FileUploadSanitizeNameEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
/**
* Sanitizes uploaded filenames.
*
* @package Drupal\file\EventSubscriber
*/
class FileEventSubscriber implements EventSubscriberInterface {
/**
* Constructs a new file event listener.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
* The config factory.
* @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration
* The transliteration service.
* @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
* The language manager.
*/
public function __construct(
protected ConfigFactoryInterface $configFactory,
protected TransliterationInterface $transliteration,
protected LanguageManagerInterface $languageManager,
) {}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents(): array {
return [
FileUploadSanitizeNameEvent::class => 'sanitizeFilename',
];
}
/**
* Sanitizes the filename of a file being uploaded.
*
* @param \Drupal\Core\File\Event\FileUploadSanitizeNameEvent $event
* File upload sanitize name event.
*
* @see file_form_system_file_system_settings_alter()
*/
public function sanitizeFilename(FileUploadSanitizeNameEvent $event) {
$fileSettings = $this->configFactory->get('file.settings');
$transliterate = $fileSettings->get('filename_sanitization.transliterate');
$filename = $event->getFilename();
$extension = pathinfo($filename, PATHINFO_EXTENSION);
if ($extension !== '') {
$extension = '.' . $extension;
$filename = pathinfo($filename, PATHINFO_FILENAME);
}
// Sanitize the filename according to configuration.
$alphanumeric = $fileSettings->get('filename_sanitization.replace_non_alphanumeric');
$replacement = $fileSettings->get('filename_sanitization.replacement_character');
if ($transliterate) {
$transliterated_filename = $this->transliteration->transliterate(
$filename,
$this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)->getId(),
$replacement
);
if (mb_strlen($transliterated_filename) > 0) {
$filename = $transliterated_filename;
}
else {
// If transliteration has resulted in a zero length string enable the
// 'replace_non_alphanumeric' option and ignore the result of
// transliteration.
$alphanumeric = TRUE;
}
}
if ($fileSettings->get('filename_sanitization.replace_whitespace')) {
$filename = preg_replace('/\s/u', $replacement, trim($filename));
}
// Only honor replace_non_alphanumeric if transliterate is enabled.
if ($transliterate && $alphanumeric) {
$filename = preg_replace('/[^0-9A-Za-z_.-]/u', $replacement, $filename);
}
if ($fileSettings->get('filename_sanitization.deduplicate_separators')) {
$filename = preg_replace('/(_)_+|(\.)\.+|(-)-+/u', $replacement, $filename);
// Replace multiple separators with single one.
$filename = preg_replace('/(_|\.|\-)[(_|\.|\-)]+/u', $replacement, $filename);
$filename = preg_replace('/' . preg_quote($replacement, NULL) . '[' . preg_quote($replacement, NULL) . ']*/u', $replacement, $filename);
// Remove replacement character from the end of the filename.
$filename = rtrim($filename, $replacement);
// If there is an extension remove dots from the end of the filename to
// prevent duplicate dots.
if (!empty($extension)) {
$filename = rtrim($filename, '.');
}
}
if ($fileSettings->get('filename_sanitization.lowercase')) {
// Force lowercase to prevent issues on case-insensitive file systems.
$filename = mb_strtolower($filename);
}
$event->setFilename($filename . $extension);
}
}
|