Merge pull request #29 from City-of-Helsinki/UHF-10626

UHF-10626: Transliterate and normalize filenames on upload
City-of-Helsinki · Oct 3, 2024 · 955f8b7 · 955f8b7
2 parents 8f3de38 + 8513d49
commit 955f8b7
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 71 deletions.
diff --git a/helfi_azure_fs.info.yml b/helfi_azure_fs.info.yml
@@ -2,3 +2,5 @@ name: HELfi azure file system
 type: module
 package: Custom
 core_version_requirement: ^10 || ^11
+dependencies:
+  - drupal:file
diff --git a/helfi_azure_fs.install b/helfi_azure_fs.install
@@ -7,11 +7,43 @@
 
 declare(strict_types=1);
 
+/**
+ * Implements hook_install().
+ */
+function helfi_azure_fs_install($is_syncing) : void {
+  if ($is_syncing) {
+    return;
+  }
+
+  if (!Drupal::moduleHandler()->moduleExists('file')) {
+    \Drupal::service('module_installer')->install([
+      'file',
+    ]);
+  }
+  \Drupal::configFactory()->getEditable('file.settings')
+    ->set('filename_sanitization', [
+      'transliterate' => TRUE,
+      'replace_whitespace' => TRUE,
+      'replace_non_alphanumeric' => TRUE,
+      'deduplicate_separators' => TRUE,
+      'lowercase' => TRUE,
+      'replacement_character' => '_',
+    ])
+    ->save();
+}
+
 /**
  * Uninstall flysystem_azure module.
  */
-function helfi_azure_fs_update_90201() {
+function helfi_azure_fs_update_90201() : void {
   \Drupal::service('module_installer')->uninstall([
     'flysystem_azure',
   ]);
 }
+
+/**
+ * Make sure file sanitize settings are enabled.
+ */
+function helfi_azure_fs_update_90202() : void {
+  helfi_azure_fs_install(FALSE);
+}
diff --git a/helfi_azure_fs.module b/helfi_azure_fs.module
@@ -8,7 +8,6 @@
 declare(strict_types=1);
 
 use Drupal\Core\Entity\EntityTypeInterface;
-use Drupal\file\FileInterface;
 
 /**
  * Implements hook_entity_field_storage_info_alter().
@@ -32,22 +31,3 @@ function helfi_azure_fs_entity_field_storage_info_alter(
     $field->setSetting('uri_scheme', $scheme);
   }
 }
-
-/**
- * Implements hook_file_presave().
- */
-function helfi_azure_fs_file_presave(FileInterface $file) : void {
-  $new_filename = preg_replace('/[ +]/', '_', $file->getFilename());
-
-  if ($new_filename !== $file->getFilename()) {
-    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
-    $file_system = \Drupal::service('file_system');
-    $uri = $file->getFileUri();
-    $directory = $file_system->dirname($uri);
-    $uri = $directory . '/' . $new_filename;
-    if ($new_uri = $file_system->move($file->getFileUri(), $uri)) {
-      $file->set('uri', $new_uri);
-      $file->set('filename', $file_system->basename($new_uri));
-    }
-  }
-}
diff --git a/tests/src/Functional/FileNameTransliterateTest.php b/tests/src/Functional/FileNameTransliterateTest.php
diff --git a/tests/src/Kernel/StorageInfoAlterTest.php b/tests/src/Kernel/StorageInfoAlterTest.php
@@ -5,9 +5,9 @@
 namespace Drupal\Tests\helfi_azure_fs\Kernel;
 
 use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\Tests\field\Kernel\FieldKernelTestBase;
 use Drupal\field\Entity\FieldConfig;
 use Drupal\field\Entity\FieldStorageConfig;
-use Drupal\Tests\field\Kernel\FieldKernelTestBase;
 
 /**
  * Tests that file field's uri_scheme can be altered.

diff --git a/tests/src/Unit/AzureBlobStorageAdapterTest.php b/tests/src/Unit/AzureBlobStorageAdapterTest.php
@@ -4,8 +4,8 @@
 
 namespace Drupal\Tests\helfi_azure_fs\Unit;
 
-use Drupal\helfi_azure_fs\Flysystem\Adapter\AzureBlobStorageAdapter;
 use Drupal\Tests\UnitTestCase;
+use Drupal\helfi_azure_fs\Flysystem\Adapter\AzureBlobStorageAdapter;
 use GuzzleHttp\Psr7\Response;
 use MicrosoftAzure\Storage\Blob\BlobRestProxy;
 use MicrosoftAzure\Storage\Blob\Models\GetBlobPropertiesResult;

diff --git a/tests/src/Unit/AzureFileSystemTest.php b/tests/src/Unit/AzureFileSystemTest.php
@@ -9,11 +9,11 @@
 use Drupal\Core\Site\Settings;
 use Drupal\Core\StreamWrapper\StreamWrapperManager;
 use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface;
-use Drupal\helfi_azure_fs\AzureFileSystem;
 use Drupal\Tests\UnitTestCase;
-use org\bovigo\vfs\vfsStream;
+use Drupal\helfi_azure_fs\AzureFileSystem;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
+use org\bovigo\vfs\vfsStream;
 
 /**
  * Tests AzureFileSystem.

diff --git a/tests/src/Unit/AzureTest.php b/tests/src/Unit/AzureTest.php
@@ -8,15 +8,15 @@
 use Drupal\Core\File\FileUrlGeneratorInterface;
 use Drupal\Core\Logger\LoggerChannelFactory;
 use Drupal\Core\Session\AccountInterface;
-use Drupal\helfi_azure_fs\Flysystem\Azure;
 use Drupal\Tests\UnitTestCase;
+use Drupal\helfi_azure_fs\Flysystem\Azure;
 use MicrosoftAzure\Storage\Common\Internal\Authentication\SharedAccessSignatureAuthScheme;
 use MicrosoftAzure\Storage\Common\Internal\Authentication\SharedKeyAuthScheme;
-use org\bovigo\vfs\vfsStream;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
+use org\bovigo\vfs\vfsStream;
 
 /**
  * Tests Azure.