Include a file-safe room name and ISO date in chat exports (#9440)

* conversation export named after room * sanitization added for exported file name * sanitization added for exported file name * sanitization added for exported file name * sanitization added for exported file name=>lint error fixed * sanitization added for exported file name=>lint error fixed * sanitization added for exported file name=>redundancy removed * sanitization added for exported file name=>redundancy removed * reverted to previous commit * sanitization added for exported file name=>redundancy removed * exported chat date iso formatted * conversation export named after room * conversation export named after room Co-authored-by: Michael Telatynski <7t3chguy@gmail.com> * code refacto filename date format * Add docs to fn * Bring in a util library for sanitizing * Extract file naming function and make consistent for all 3 types Also use the library we dragged in * Write tests & associated fixes * Apply linters locally * Include new date util in index Co-authored-by: Sinharitik589 <sinharitik18112835@gmail.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: yaya-usman <yayaazeez222@gmail.com> Co-authored-by: Sinharitik589 <67551927+Sinharitik589@users.noreply.github.com>
matrix-org · Oct 18, 2022 · 10a429c · 10a429c
1 parent ca8b1b0
commit 10a429c
Show file tree

Hide file tree

Showing 16 changed files with 233 additions and 90 deletions.
diff --git a/package.json b/package.json
@@ -111,6 +111,7 @@
     "react-focus-lock": "^2.5.1",
     "react-transition-group": "^4.4.1",
     "rfc4648": "^1.4.0",
+    "sanitize-filename": "^1.6.3",
     "sanitize-html": "^2.3.2",
     "tar-js": "^0.3.0",
     "ua-parser-js": "^1.0.2",

diff --git a/src/DateUtils.ts b/src/DateUtils.ts
@@ -1,6 +1,7 @@
 /*
 Copyright 2015, 2016 OpenMarket Ltd
 Copyright 2017 Vector Creations Ltd
+Copyright 2022 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.
@@ -177,6 +178,16 @@ export function formatFullDateNoDay(date: Date) {
     });
 }
 
+/**
+ * Returns an ISO date string without textual description of the date (ie: no "Wednesday" or
+ * similar)
+ * @param date The date to format.
+ * @returns The date string in ISO format.
+ */
+export function formatFullDateNoDayISO(date: Date): string {
+    return date.toISOString();
+}
+
 export function formatFullDateNoDayNoTime(date: Date) {
     return (
         date.getFullYear() +

diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
@@ -756,6 +756,7 @@
     "Zoom in": "Zoom in",
     "Zoom out": "Zoom out",
     "Are you sure you want to exit during this export?": "Are you sure you want to exit during this export?",
+    "Unnamed Room": "Unnamed Room",
     "Generating a ZIP": "Generating a ZIP",
     "Fetched %(count)s events out of %(total)s|other": "Fetched %(count)s events out of %(total)s",
     "Fetched %(count)s events out of %(total)s|one": "Fetched %(count)s event out of %(total)s",
@@ -2768,7 +2769,6 @@
     "Or send invite link": "Or send invite link",
     "Unnamed Space": "Unnamed Space",
     "Invite to %(roomName)s": "Invite to %(roomName)s",
-    "Unnamed Room": "Unnamed Room",
     "Invite someone using their name, email address, username (like <userId/>) or <a>share this space</a>.": "Invite someone using their name, email address, username (like <userId/>) or <a>share this space</a>.",
     "Invite someone using their name, username (like <userId/>) or <a>share this space</a>.": "Invite someone using their name, username (like <userId/>) or <a>share this space</a>.",
     "Invite someone using their name, email address, username (like <userId/>) or <a>share this room</a>.": "Invite someone using their name, email address, username (like <userId/>) or <a>share this room</a>.",

diff --git a/src/utils/exportUtils/Exporter.ts b/src/utils/exportUtils/Exporter.ts
@@ -1,5 +1,5 @@
 /*
-Copyright 2021 The Matrix.org Foundation C.I.C.
+Copyright 2021 - 2022 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.
@@ -20,12 +20,13 @@ import { MatrixClient } from "matrix-js-sdk/src/client";
 import { Direction } from "matrix-js-sdk/src/models/event-timeline";
 import { saveAs } from "file-saver";
 import { logger } from "matrix-js-sdk/src/logger";
+import sanitizeFilename from "sanitize-filename";
 
 import { MatrixClientPeg } from "../../MatrixClientPeg";
 import { ExportType, IExportOptions } from "./exportUtils";
 import { decryptFile } from "../DecryptFile";
 import { mediaFromContent } from "../../customisations/Media";
-import { formatFullDateNoDay } from "../../DateUtils";
+import { formatFullDateNoDay, formatFullDateNoDayISO } from "../../DateUtils";
 import { isVoiceMessage } from "../EventUtils";
 import { IMediaEventContent } from "../../customisations/models/IMediaEventContent";
 import { _t } from "../../languageHandler";
@@ -57,6 +58,10 @@ export default abstract class Exporter {
         window.addEventListener("beforeunload", this.onBeforeUnload);
     }
 
+    public get destinationFileName(): string {
+        return this.makeFileNameNoExtension(SdkConfig.get().brand) + ".zip";
+    }
+
     protected onBeforeUnload(e: BeforeUnloadEvent): string {
         e.preventDefault();
         return e.returnValue = _t("Are you sure you want to exit during this export?");
@@ -75,10 +80,19 @@ export default abstract class Exporter {
         this.files.push(file);
     }
 
+    protected makeFileNameNoExtension(brand = "matrix"): string {
+        // First try to use the real name of the room, then a translated copy of a generic name,
+        // then finally hardcoded default to guarantee we'll have a name.
+        const safeRoomName = sanitizeFilename(this.room.name ?? _t("Unnamed Room")).trim() || "Unnamed Room";
+        const safeDate = formatFullDateNoDayISO(new Date())
+            .replace(/:/g, '-'); // ISO format automatically removes a lot of stuff for us
+        const safeBrand = sanitizeFilename(brand);
+        return `${safeBrand} - ${safeRoomName} - Chat Export - ${safeDate}`;
+    }
+
     protected async downloadZIP(): Promise<string | void> {
-        const brand = SdkConfig.get().brand;
-        const filenameWithoutExt = `${brand} - Chat Export - ${formatFullDateNoDay(new Date())}`;
-        const filename = `${filenameWithoutExt}.zip`;
+        const filename = this.destinationFileName;
+        const filenameWithoutExt = filename.substring(0, filename.length - 4); // take off the .zip
         const { default: JSZip } = await import('jszip');
 
         const zip = new JSZip();

diff --git a/src/utils/exportUtils/JSONExport.ts b/src/utils/exportUtils/JSONExport.ts
@@ -1,5 +1,5 @@
 /*
-Copyright 2021 The Matrix.org Foundation C.I.C.
+Copyright 2021 - 2022 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.
@@ -20,7 +20,7 @@ import { EventType } from "matrix-js-sdk/src/@types/event";
 import { logger } from "matrix-js-sdk/src/logger";
 
 import Exporter from "./Exporter";
-import { formatFullDateNoDay, formatFullDateNoDayNoTime } from "../../DateUtils";
+import { formatFullDateNoDayNoTime } from "../../DateUtils";
 import { ExportType, IExportOptions } from "./exportUtils";
 import { _t } from "../../languageHandler";
 import { haveRendererForEvent } from "../../events/EventTileFactory";
@@ -38,6 +38,10 @@ export default class JSONExporter extends Exporter {
         super(room, exportType, exportOptions, setProgressText);
     }
 
+    public get destinationFileName(): string {
+        return this.makeFileNameNoExtension() + ".json";
+    }
+
     protected createJSONString(): string {
         const exportDate = formatFullDateNoDayNoTime(new Date());
         const creator = this.room.currentState.getStateEvents(EventType.RoomCreate, "")?.getSender();
@@ -108,7 +112,7 @@ export default class JSONExporter extends Exporter {
             this.addFile("export.json", new Blob([text]));
             await this.downloadZIP();
         } else {
-            const fileName = `matrix-export-${formatFullDateNoDay(new Date())}.json`;
+            const fileName = this.destinationFileName;
             this.downloadPlainText(fileName, text);
         }
 

diff --git a/src/utils/exportUtils/PlainTextExport.ts b/src/utils/exportUtils/PlainTextExport.ts
@@ -1,5 +1,5 @@
 /*
-Copyright 2021 The Matrix.org Foundation C.I.C.
+Copyright 2021 - 2022 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.
@@ -20,7 +20,6 @@ import { logger } from "matrix-js-sdk/src/logger";
 import React from "react";
 
 import Exporter from "./Exporter";
-import { formatFullDateNoDay } from "../../DateUtils";
 import { _t } from "../../languageHandler";
 import { ExportType, IExportOptions } from "./exportUtils";
 import { textForEvent } from "../../TextForEvent";
@@ -43,6 +42,10 @@ export default class PlainTextExporter extends Exporter {
             : _t("Media omitted - file size limit exceeded");
     }
 
+    public get destinationFileName(): string {
+        return this.makeFileNameNoExtension() + ".txt";
+    }
+
     public textForReplyEvent = (content: IContent) => {
         const REPLY_REGEX = /> <(.*?)>(.*?)\n\n(.*)/s;
         const REPLY_SOURCE_MAX_LENGTH = 32;
@@ -137,7 +140,7 @@ export default class PlainTextExporter extends Exporter {
             this.addFile("export.txt", new Blob([text]));
             await this.downloadZIP();
         } else {
-            const fileName = `matrix-export-${formatFullDateNoDay(new Date())}.txt`;
+            const fileName = this.destinationFileName;
             this.downloadPlainText(fileName, text);
         }
 

diff --git a/test/test-utils/date.ts b/test/test-utils/date.ts
@@ -0,0 +1,17 @@
+/*
+Copyright 2022 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.
+*/
+
+export const REPEATABLE_DATE = new Date(2022, 10, 17, 16, 58, 32, 517);
diff --git a/test/test-utils/index.ts b/test/test-utils/index.ts
@@ -24,3 +24,4 @@ export * from './test-utils';
 export * from './call';
 export * from './wrappers';
 export * from './utilities';
+export * from './date';
diff --git a/test/utils/DateUtils-test.ts b/test/utils/DateUtils-test.ts
@@ -14,7 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { formatSeconds, formatRelativeTime, formatDuration } from "../../src/DateUtils";
+import { formatSeconds, formatRelativeTime, formatDuration, formatFullDateNoDayISO } from "../../src/DateUtils";
+import { REPEATABLE_DATE } from "../test-utils";
 
 describe("formatSeconds", () => {
     it("correctly formats time with hours", () => {
@@ -92,3 +93,9 @@ describe('formatDuration()', () => {
         expect(formatDuration(input)).toEqual(expectedResult);
     });
 });
+
+describe("formatFullDateNoDayISO", () => {
+    it("should return ISO format", () => {
+        expect(formatFullDateNoDayISO(REPEATABLE_DATE)).toEqual("2022-11-17T16:58:32.517Z");
+    });
+});
diff --git a/test/utils/exportUtils/HTMLExport-test.ts b/test/utils/exportUtils/HTMLExport-test.ts
@@ -0,0 +1,52 @@
+/*
+Copyright 2022 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.
+*/
+
+import { mocked } from "jest-mock";
+
+import { createTestClient, mkStubRoom, REPEATABLE_DATE } from "../../test-utils";
+import { ExportType, IExportOptions } from "../../../src/utils/exportUtils/exportUtils";
+import SdkConfig from "../../../src/SdkConfig";
+import HTMLExporter from "../../../src/utils/exportUtils/HtmlExport";
+
+describe("HTMLExport", () => {
+    beforeEach(() => {
+        jest.useFakeTimers('modern');
+        jest.setSystemTime(REPEATABLE_DATE);
+    });
+
+    afterEach(() => {
+        mocked(SdkConfig.get).mockRestore();
+    });
+
+    it("should have an SDK-branded destination file name", () => {
+        const roomName = "My / Test / Room: Welcome";
+        const client = createTestClient();
+        const stubOptions: IExportOptions = {
+            attachmentsIncluded: false,
+            maxSize: 50000000,
+        };
+        const stubRoom = mkStubRoom("!myroom:example.org", roomName, client);
+        const exporter = new HTMLExporter(stubRoom, ExportType.Timeline, stubOptions, () => {});
+
+        expect(exporter.destinationFileName).toMatchSnapshot();
+
+        jest.spyOn(SdkConfig, "get").mockImplementation(() => {
+            return { brand: "BrandedChat/WithSlashes/ForFun" };
+        });
+
+        expect(exporter.destinationFileName).toMatchSnapshot();
+    });
+});
diff --git a/test/utils/exportUtils/JSONExport-test.ts b/test/utils/exportUtils/JSONExport-test.ts
@@ -0,0 +1,39 @@
+/*
+Copyright 2022 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.
+*/
+
+import JSONExporter from "../../../src/utils/exportUtils/JSONExport";
+import { createTestClient, mkStubRoom, REPEATABLE_DATE } from "../../test-utils";
+import { ExportType, IExportOptions } from "../../../src/utils/exportUtils/exportUtils";
+
+describe("JSONExport", () => {
+    beforeEach(() => {
+        jest.useFakeTimers('modern');
+        jest.setSystemTime(REPEATABLE_DATE);
+    });
+
+    it("should have a Matrix-branded destination file name", () => {
+        const roomName = "My / Test / Room: Welcome";
+        const client = createTestClient();
+        const stubOptions: IExportOptions = {
+            attachmentsIncluded: false,
+            maxSize: 50000000,
+        };
+        const stubRoom = mkStubRoom("!myroom:example.org", roomName, client);
+        const exporter = new JSONExporter(stubRoom, ExportType.Timeline, stubOptions, () => {});
+
+        expect(exporter.destinationFileName).toMatchSnapshot();
+    });
+});
diff --git a/test/utils/exportUtils/PlainTextExport-test.ts b/test/utils/exportUtils/PlainTextExport-test.ts
@@ -0,0 +1,39 @@
+/*
+Copyright 2022 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.
+*/
+
+import { createTestClient, mkStubRoom, REPEATABLE_DATE } from "../../test-utils";
+import { ExportType, IExportOptions } from "../../../src/utils/exportUtils/exportUtils";
+import PlainTextExporter from "../../../src/utils/exportUtils/PlainTextExport";
+
+describe("PlainTextExport", () => {
+    beforeEach(() => {
+        jest.useFakeTimers('modern');
+        jest.setSystemTime(REPEATABLE_DATE);
+    });
+
+    it("should have a Matrix-branded destination file name", () => {
+        const roomName = "My / Test / Room: Welcome";
+        const client = createTestClient();
+        const stubOptions: IExportOptions = {
+            attachmentsIncluded: false,
+            maxSize: 50000000,
+        };
+        const stubRoom = mkStubRoom("!myroom:example.org", roomName, client);
+        const exporter = new PlainTextExporter(stubRoom, ExportType.Timeline, stubOptions, () => {});
+
+        expect(exporter.destinationFileName).toMatchSnapshot();
+    });
+});
diff --git a/test/utils/exportUtils/__snapshots__/HTMLExport-test.ts.snap b/test/utils/exportUtils/__snapshots__/HTMLExport-test.ts.snap
@@ -0,0 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`HTMLExport should have an SDK-branded destination file name 1`] = `"Element - My  Test  Room Welcome - Chat Export - 2022-11-17T16-58-32.517Z.zip"`;
+
+exports[`HTMLExport should have an SDK-branded destination file name 2`] = `"BrandedChatWithSlashesForFun - My  Test  Room Welcome - Chat Export - 2022-11-17T16-58-32.517Z.zip"`;
diff --git a/test/utils/exportUtils/__snapshots__/JSONExport-test.ts.snap b/test/utils/exportUtils/__snapshots__/JSONExport-test.ts.snap
@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`JSONExport should have a Matrix-branded destination file name 1`] = `"matrix - My  Test  Room Welcome - Chat Export - 2022-11-17T16-58-32.517Z.json"`;
diff --git a/test/utils/exportUtils/__snapshots__/PlainTextExport-test.ts.snap b/test/utils/exportUtils/__snapshots__/PlainTextExport-test.ts.snap
@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`PlainTextExport should have a Matrix-branded destination file name 1`] = `"matrix - My  Test  Room Welcome - Chat Export - 2022-11-17T16-58-32.517Z.txt"`;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		// Jest Snapshot v1, https://goo.gl/fbAQLP

		exports[`JSONExport should have a Matrix-branded destination file name 1`] = `"matrix - My Test Room Welcome - Chat Export - 2022-11-17T16-58-32.517Z.json"`;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		// Jest Snapshot v1, https://goo.gl/fbAQLP

		exports[`PlainTextExport should have a Matrix-branded destination file name 1`] = `"matrix - My Test Room Welcome - Chat Export - 2022-11-17T16-58-32.517Z.txt"`;