diff --git a/changelog.d/6449.bugfix b/changelog.d/6449.bugfix new file mode 100644 index 0000000000..203b01a0eb --- /dev/null +++ b/changelog.d/6449.bugfix @@ -0,0 +1 @@ +Extended file name support to include characters from multiple languages, including Cyrillic and Han scripts. ([#6449](https://github.com/element-hq/element-android/issues/6449)) diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/DefaultFileService.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/DefaultFileService.kt index 217ef43821..cc11f0e1b9 100644 --- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/DefaultFileService.kt +++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/DefaultFileService.kt @@ -41,6 +41,7 @@ import org.matrix.android.sdk.internal.network.httpclient.addAuthenticationHeade import org.matrix.android.sdk.internal.network.token.AccessTokenProvider import org.matrix.android.sdk.internal.session.download.DownloadProgressInterceptor.Companion.DOWNLOAD_PROGRESS_INTERCEPTOR_HEADER import org.matrix.android.sdk.internal.util.file.AtomicFileCreator +import org.matrix.android.sdk.internal.util.file.safeFileName import org.matrix.android.sdk.internal.util.time.Clock import org.matrix.android.sdk.internal.util.writeToFile import timber.log.Timber @@ -247,28 +248,6 @@ internal class DefaultFileService @Inject constructor( } } - private fun safeFileName(fileName: String?, mimeType: String?): String { - return buildString { - // filename has to be safe for the Android System - val result = fileName - ?.replace("[^a-z A-Z0-9\\\\.\\-]".toRegex(), "_") - ?.takeIf { it.isNotEmpty() } - ?: DEFAULT_FILENAME - append(result) - // Check that the extension is correct regarding the mimeType - val extensionFromMime = mimeType?.let { MimeTypeMap.getSingleton().getExtensionFromMimeType(mimeType) } - if (extensionFromMime != null) { - // Compare - val fileExtension = result.substringAfterLast(delimiter = ".", missingDelimiterValue = "") - if (fileExtension.isEmpty() || fileExtension != extensionFromMime) { - // Missing extension, or diff in extension, add the one provided by the mimetype - append(".") - append(extensionFromMime) - } - } - } - } - override fun isFileInCache( mxcUrl: String?, fileName: String, @@ -368,6 +347,6 @@ internal class DefaultFileService @Inject constructor( private const val ENCRYPTED_FILENAME = "encrypted.bin" // The extension would be added from the mimetype - private const val DEFAULT_FILENAME = "file" + const val DEFAULT_FILENAME = "file" } } diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/util/file/FileUtil.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/util/file/FileUtil.kt new file mode 100644 index 0000000000..49bdbdd0a9 --- /dev/null +++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/util/file/FileUtil.kt @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2024 New Vector Ltd + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.matrix.android.sdk.internal.util.file + +import android.webkit.MimeTypeMap +import org.matrix.android.sdk.internal.session.DefaultFileService.Companion.DEFAULT_FILENAME +import timber.log.Timber + +/** + * Remove any characters from the file name that are not supported by the Android OS, + * and update the file extension to match the mimeType. + */ +fun safeFileName(fileName: String?, mimeType: String?): String { + return buildString { + // filename has to be safe for the Android System + Timber.i("ISSUE: FileService: original fileName $fileName") + val result = fileName + ?.replace("[^\\p{sc=Cyrillic}\\p{sc=Han}a-z A-Z0-9\\\\.\\-]".toRegex(), "_") + ?.takeIf { it.isNotEmpty() } + ?: DEFAULT_FILENAME + Timber.i("ISSUE: FileService: safeFileName $result") + append(result) + // Check that the extension is correct regarding the mimeType + val extensionFromMime = mimeType?.let { MimeTypeMap.getSingleton().getExtensionFromMimeType(mimeType) } + if (extensionFromMime != null) { + // Compare + val fileExtension = result.substringAfterLast(delimiter = ".", missingDelimiterValue = "") + if (fileExtension.isEmpty() || fileExtension != extensionFromMime) { + // Missing extension, or diff in extension, add the one provided by the mimetype + append(".") + append(extensionFromMime) + } + } + } +} diff --git a/matrix-sdk-android/src/test/java/org/matrix/android/sdk/internal/util/FileUtilTest.kt b/matrix-sdk-android/src/test/java/org/matrix/android/sdk/internal/util/FileUtilTest.kt new file mode 100644 index 0000000000..fa88833b75 --- /dev/null +++ b/matrix-sdk-android/src/test/java/org/matrix/android/sdk/internal/util/FileUtilTest.kt @@ -0,0 +1,113 @@ +/* + * Copyright 2020 The Matrix.org Foundation C.I.C. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.matrix.android.sdk.internal.util + +import org.junit.Assert.assertEquals +import org.junit.Test +import org.matrix.android.sdk.internal.session.DefaultFileService.Companion.DEFAULT_FILENAME +import org.matrix.android.sdk.internal.util.file.safeFileName + +class FileUtilTest { + + @Test + fun `should return original filename when valid characters are used`() { + val fileName = "validFileName.txt" + val mimeType = "text/plain" + val result = safeFileName(fileName, mimeType) + assertEquals("validFileName.txt", result) + } + + @Test + fun `should replace invalid characters with underscores`() { + val fileName = "invalid/filename:with*chars?.txt" + val mimeType = "text/plain" + val result = safeFileName(fileName, mimeType) + assertEquals("invalid_filename_with_chars_.txt", result) + } + + @Test + fun `should allow Cyrillic characters in the filename`() { + val fileName = "тестовыйФайл.txt" + val mimeType = "text/plain" + val result = safeFileName(fileName, mimeType) + assertEquals("тестовыйФайл.txt", result) + } + + @Test + fun `should allow Han characters in the filename`() { + val fileName = "测试文件.txt" + val mimeType = "text/plain" + val result = safeFileName(fileName, mimeType) + assertEquals("测试文件.txt", result) + } + + @Test + fun `should return default filename when input is null`() { + val fileName = null + val mimeType = "text/plain" + val result = safeFileName(fileName, mimeType) + assertEquals(DEFAULT_FILENAME, result) + } + + @Test + fun `should add the correct extension when missing`() { + val fileName = "myDocument" + val mimeType = "application/pdf" + val result = safeFileName(fileName, mimeType) + assertEquals("myDocument.pdf", result) + } + + @Test + fun `should replace invalid characters and add the correct extension`() { + val fileName = "my*docu/ment" + val mimeType = "application/pdf" + val result = safeFileName(fileName, mimeType) + assertEquals("my_docu_ment.pdf", result) + } + + @Test + fun `should not modify the extension if it matches the mimeType`() { + val fileName = "report.pdf" + val mimeType = "application/pdf" + val result = safeFileName(fileName, mimeType) + assertEquals("report.pdf", result) + } + + @Test + fun `should replace spaces with underscores`() { + val fileName = "my report.doc" + val mimeType = "application/msword" + val result = safeFileName(fileName, mimeType) + assertEquals("my_report.doc", result) + } + + @Test + fun `should append extension if file name has none and mimeType is valid`() { + val fileName = "newfile" + val mimeType = "image/jpeg" + val result = safeFileName(fileName, mimeType) + assertEquals("newfile.jpg", result) + } + + @Test + fun `should keep hyphenated names intact`() { + val fileName = "my-file-name" + val mimeType = "application/octet-stream" + val result = safeFileName(fileName, mimeType) + assertEquals("my-file-name", result) + } +}