PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Apply PR Suggestions

Browse source
This commit is contained in:
Jaiwanth 2021-08-13 08:30:50 +05:30
parent d32f945e24
commit edfc8af6cf
8 changed files with 143 additions and 144 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
src/components/views/dialogs/ExportDialog.tsx
View file

@ -24,8 +24,8 @@ import Field from "../elements/Field";
import StyledRadioGroup from "../elements/StyledRadioGroup"; import StyledRadioGroup from "../elements/StyledRadioGroup";
import StyledCheckbox from "../elements/StyledCheckbox"; import StyledCheckbox from "../elements/StyledCheckbox";
import { import {
ExportFormats, ExportFormat,
ExportTypes, ExportType,
textForFormat, textForFormat,
textForType, textForType,
} from "../../../utils/exportUtils/exportUtils"; } from "../../../utils/exportUtils/exportUtils";
@ -42,8 +42,8 @@ interface IProps extends IDialogProps {
} }
const ExportDialog: React.FC<IProps> = ({ room, onFinished }) => { const ExportDialog: React.FC<IProps> = ({ room, onFinished }) => {
const [exportFormat, setExportFormat] = useState(ExportFormats.HTML); const [exportFormat, setExportFormat] = useState(ExportFormat.Html);
const [exportType, setExportType] = useState(ExportTypes.TIMELINE); const [exportType, setExportType] = useState(ExportType.Timeline);
const [includeAttachments, setAttachments] = useState(false); const [includeAttachments, setAttachments] = useState(false);
const [isExporting, setExporting] = useState(false); const [isExporting, setExporting] = useState(false);
const [numberOfMessages, setNumberOfMessages] = useState<number>(100); const [numberOfMessages, setNumberOfMessages] = useState<number>(100);
@ -70,31 +70,31 @@ const ExportDialog: React.FC<IProps> = ({ room, onFinished }) => {
maxSize: sizeLimit * 1024 * 1024, maxSize: sizeLimit * 1024 * 1024,
}; };
switch (exportFormat) { switch (exportFormat) {
case ExportFormats.HTML: case ExportFormat.Html:
setExporter( setExporter(
new HTMLExporter( new HTMLExporter(
room, room,
ExportTypes[exportType], ExportType[exportType],
exportOptions, exportOptions,
exportProgressRef, exportProgressRef,
), ),
); );
break; break;
case ExportFormats.JSON: case ExportFormat.Json:
setExporter( setExporter(
new JSONExporter( new JSONExporter(
room, room,
ExportTypes[exportType], ExportType[exportType],
exportOptions, exportOptions,
exportProgressRef, exportProgressRef,
), ),
); );
break; break;
case ExportFormats.PLAIN_TEXT: case ExportFormat.PlainText:
setExporter( setExporter(
new PlainTextExporter( new PlainTextExporter(
room, room,
ExportTypes[exportType], ExportType[exportType],
exportOptions, exportOptions,
exportProgressRef, exportProgressRef,
), ),
@ -114,7 +114,7 @@ const ExportDialog: React.FC<IProps> = ({ room, onFinished }) => {
sizeLimitRef.current.validate({ focused: true }); sizeLimitRef.current.validate({ focused: true });
return; return;
} }
if (exportType === ExportTypes.LAST_N_MESSAGES) { if (exportType === ExportType.LastNMessages) {
const isValidNumberOfMessages = const isValidNumberOfMessages =
await messageCountRef.current.validate({ focused: false }); await messageCountRef.current.validate({ focused: false });
if (!isValidNumberOfMessages) { if (!isValidNumberOfMessages) {
@ -202,12 +202,12 @@ const ExportDialog: React.FC<IProps> = ({ room, onFinished }) => {
}); });
}; };
const exportFormatOptions = Object.keys(ExportFormats).map((format) => ({ const exportFormatOptions = Object.keys(ExportFormat).map((format) => ({
value: format, value: format,
label: textForFormat(format), label: textForFormat(format),
})); }));
const exportTypeOptions = Object.keys(ExportTypes).map((type) => { const exportTypeOptions = Object.keys(ExportType).map((type) => {
return ( return (
<option key={type} value={type}> <option key={type} value={type}>
{ textForType(type) } { textForType(type) }
@ -216,7 +216,7 @@ const ExportDialog: React.FC<IProps> = ({ room, onFinished }) => {
}); });
let messageCount = null; let messageCount = null;
if (exportType === ExportTypes.LAST_N_MESSAGES) { if (exportType === ExportType.LastNMessages) {
messageCount = ( messageCount = (
<Field <Field
element="input" element="input"
@ -322,7 +322,7 @@ const ExportDialog: React.FC<IProps> = ({ room, onFinished }) => {
<StyledRadioGroup <StyledRadioGroup
name="exportFormat" name="exportFormat"
value={exportFormat} value={exportFormat}
onChange={(key) => setExportFormat(ExportFormats[key])} onChange={(key) => setExportFormat(ExportFormat[key])}
definitions={exportFormatOptions} definitions={exportFormatOptions}
/> />
@ -334,7 +334,7 @@ const ExportDialog: React.FC<IProps> = ({ room, onFinished }) => {
element="select" element="select"
value={exportType} value={exportType}
onChange={(e) => { onChange={(e) => {
setExportType(ExportTypes[e.target.value]); setExportType(ExportType[e.target.value]);
}} }}
> >
{ exportTypeOptions } { exportTypeOptions }

4
src/components/views/messages/MFileBody.tsx
View file

@ -222,7 +222,8 @@ export default class MFileBody extends React.Component<IProps, IState> {
{ placeholder } { placeholder }
</a> </a>
</span>; </span>;
} else { }
const showDownloadLink = this.props.tileShape || !this.props.showGenericPlaceholder; const showDownloadLink = this.props.tileShape || !this.props.showGenericPlaceholder;
if (isEncrypted) { if (isEncrypted) {
@ -343,4 +344,3 @@ export default class MFileBody extends React.Component<IProps, IState> {
} }
} }
} }
}

17
src/utils/exportUtils/Exporter.ts
View file

@ -17,7 +17,7 @@ limitations under the License.
import { MatrixEvent } from "matrix-js-sdk/src/models/event"; import { MatrixEvent } from "matrix-js-sdk/src/models/event";
import { Room } from "matrix-js-sdk/src/models/room"; import { Room } from "matrix-js-sdk/src/models/room";
import { MatrixClientPeg } from "../../MatrixClientPeg"; import { MatrixClientPeg } from "../../MatrixClientPeg";
import { IExportOptions, ExportTypes } from "./exportUtils"; import { IExportOptions, ExportType } from "./exportUtils";
import { decryptFile } from "../DecryptFile"; import { decryptFile } from "../DecryptFile";
import { mediaFromContent } from "../../customisations/Media"; import { mediaFromContent } from "../../customisations/Media";
import { formatFullDateNoDay } from "../../DateUtils"; import { formatFullDateNoDay } from "../../DateUtils";
@ -38,13 +38,14 @@ export default abstract class Exporter {
protected constructor( protected constructor(
protected room: Room, protected room: Room,
protected exportType: ExportTypes, protected exportType: ExportType,
protected exportOptions: IExportOptions, protected exportOptions: IExportOptions,
protected exportProgressRef: MutableRefObject<HTMLParagraphElement>, protected exportProgressRef: MutableRefObject<HTMLParagraphElement>,
) { ) {
if (exportOptions.maxSize < 1 * 1024 * 1024|| if (exportOptions.maxSize < 1 * 1024 * 1024|| // Less than 1 MB
exportOptions.maxSize > 2000 * 1024 * 1024|| exportOptions.maxSize > 2000 * 1024 * 1024|| // More than ~ 2 GB
exportOptions.numberOfMessages > 10**8) { exportOptions.numberOfMessages > 10**8
) {
throw new Error("Invalid export options"); throw new Error("Invalid export options");
} }
this.cancelled = false; this.cancelled = false;
@ -118,10 +119,10 @@ export default abstract class Exporter {
public getLimit(): number { public getLimit(): number {
let limit: number; let limit: number;
switch (this.exportType) { switch (this.exportType) {
case ExportTypes.LAST_N_MESSAGES: case ExportType.LastNMessages:
limit = this.exportOptions.numberOfMessages; limit = this.exportOptions.numberOfMessages;
break; break;
case ExportTypes.TIMELINE: case ExportType.Timeline:
limit = 40; limit = 40;
break; break;
default: default:
@ -166,7 +167,7 @@ export default abstract class Exporter {
events.push(mxEv); events.push(mxEv);
} }
this.updateProgress( this.updateProgress(
("Fetched " + events.length + " events ") + (this.exportType === ExportTypes.LAST_N_MESSAGES ("Fetched " + events.length + " events ") + (this.exportType === ExportType.LastNMessages
? `out of ${this.exportOptions.numberOfMessages}` ? `out of ${this.exportOptions.numberOfMessages}`
: "so far"), : "so far"),
); );

4
src/utils/exportUtils/HtmlExport.tsx
View file

@ -32,7 +32,7 @@ import DateSeparator from "../../components/views/messages/DateSeparator";
import BaseAvatar from "../../components/views/avatars/BaseAvatar"; import BaseAvatar from "../../components/views/avatars/BaseAvatar";
import exportJS from "!!raw-loader!./exportJS"; import exportJS from "!!raw-loader!./exportJS";
import exportIcons from "./exportIcons"; import exportIcons from "./exportIcons";
import { ExportTypes } from "./exportUtils"; import { ExportType } from "./exportUtils";
import { IExportOptions } from "./exportUtils"; import { IExportOptions } from "./exportUtils";
import MatrixClientContext from "../../contexts/MatrixClientContext"; import MatrixClientContext from "../../contexts/MatrixClientContext";
import getExportCSS from "./exportCSS"; import getExportCSS from "./exportCSS";
@ -46,7 +46,7 @@ export default class HTMLExporter extends Exporter {
constructor( constructor(
room: Room, room: Room,
exportType: ExportTypes, exportType: ExportType,
exportOptions: IExportOptions, exportOptions: IExportOptions,
exportProgressRef: MutableRefObject<HTMLParagraphElement>, exportProgressRef: MutableRefObject<HTMLParagraphElement>,
) { ) {

10
src/utils/exportUtils/JSONExport.ts
View file

@ -19,24 +19,22 @@ import { Room } from "matrix-js-sdk/src/models/room";
import { MatrixEvent } from "matrix-js-sdk/src/models/event"; import { MatrixEvent } from "matrix-js-sdk/src/models/event";
import { formatFullDateNoDay, formatFullDateNoDayNoTime } from "../../DateUtils"; import { formatFullDateNoDay, formatFullDateNoDayNoTime } from "../../DateUtils";
import { haveTileForEvent } from "../../components/views/rooms/EventTile"; import { haveTileForEvent } from "../../components/views/rooms/EventTile";
import { ExportTypes } from "./exportUtils"; import { ExportType } from "./exportUtils";
import { IExportOptions } from "./exportUtils"; import { IExportOptions } from "./exportUtils";
import { EventType } from "matrix-js-sdk/src/@types/event"; import { EventType } from "matrix-js-sdk/src/@types/event";
import { MutableRefObject } from "react"; import { MutableRefObject } from "react";
export default class JSONExporter extends Exporter { export default class JSONExporter extends Exporter {
protected totalSize: number; protected totalSize = 0;
protected messages: any[]; protected messages: any[] = [];
constructor( constructor(
room: Room, room: Room,
exportType: ExportTypes, exportType: ExportType,
exportOptions: IExportOptions, exportOptions: IExportOptions,
exportProgressRef: MutableRefObject<HTMLParagraphElement>, exportProgressRef: MutableRefObject<HTMLParagraphElement>,
) { ) {
super(room, exportType, exportOptions, exportProgressRef); super(room, exportType, exportOptions, exportProgressRef);
this.totalSize = 0;
this.messages = [];
} }
protected createJSONString(): string { protected createJSONString(): string {

4
src/utils/exportUtils/PlainTextExport.ts
View file

@ -20,7 +20,7 @@ import { IContent, MatrixEvent } from "matrix-js-sdk/src/models/event";
import { formatFullDateNoDay } from "../../DateUtils"; import { formatFullDateNoDay } from "../../DateUtils";
import { _t } from "../../languageHandler"; import { _t } from "../../languageHandler";
import { haveTileForEvent } from "../../components/views/rooms/EventTile"; import { haveTileForEvent } from "../../components/views/rooms/EventTile";
import { ExportTypes } from "./exportUtils"; import { ExportType } from "./exportUtils";
import { IExportOptions } from "./exportUtils"; import { IExportOptions } from "./exportUtils";
import { textForEvent } from "../../TextForEvent"; import { textForEvent } from "../../TextForEvent";
import { MutableRefObject } from "react"; import { MutableRefObject } from "react";
@ -31,7 +31,7 @@ export default class PlainTextExporter extends Exporter {
constructor( constructor(
room: Room, room: Room,
exportType: ExportTypes, exportType: ExportType,
exportOptions: IExportOptions, exportOptions: IExportOptions,
exportProgressRef: MutableRefObject<HTMLParagraphElement>, exportProgressRef: MutableRefObject<HTMLParagraphElement>,
) { ) {

28
src/utils/exportUtils/exportUtils.ts
View file

@ -16,26 +16,26 @@ limitations under the License.
import { _t } from "../../languageHandler"; import { _t } from "../../languageHandler";
export enum ExportFormats { export enum ExportFormat {
HTML = "HTML", Html = "HTML",
PLAIN_TEXT = "PLAIN_TEXT", PlainText = "PLAIN_TEXT",
JSON = "JSON", Json = "JSON",
} }
export enum ExportTypes { export enum ExportType {
TIMELINE = "TIMELINE", Timeline = "TIMELINE",
BEGINNING = "BEGINNING", Beginning = "BEGINNING",
LAST_N_MESSAGES = "LAST_N_MESSAGES", LastNMessages = "LAST_N_MESSAGES",
// START_DATE = "START_DATE", // START_DATE = "START_DATE",
} }
export const textForFormat = (format: string): string => { export const textForFormat = (format: string): string => {
switch (format) { switch (format) {
case ExportFormats.HTML: case ExportFormat.Html:
return _t("HTML"); return _t("HTML");
case ExportFormats.JSON: case ExportFormat.Json:
return _t("JSON"); return _t("JSON");
case ExportFormats.PLAIN_TEXT: case ExportFormat.PlainText:
return _t("Plain Text"); return _t("Plain Text");
default: default:
throw new Error("Unknown format"); throw new Error("Unknown format");
@ -44,11 +44,11 @@ export const textForFormat = (format: string): string => {
export const textForType = (type: string): string => { export const textForType = (type: string): string => {
switch (type) { switch (type) {
case ExportTypes.BEGINNING: case ExportType.Beginning:
return _t("From the beginning"); return _t("From the beginning");
case ExportTypes.LAST_N_MESSAGES: case ExportType.LastNMessages:
return _t("Specify a number of messages"); return _t("Specify a number of messages");
case ExportTypes.TIMELINE: case ExportType.Timeline:
return _t("Current Timeline"); return _t("Current Timeline");
default: default:
throw new Error("Unknown type: " + type); throw new Error("Unknown type: " + type);

10
test/utils/export-test.tsx
View file

@ -16,7 +16,7 @@ limitations under the License.
import { IContent, MatrixClient, MatrixEvent, Room } from "matrix-js-sdk"; import { IContent, MatrixClient, MatrixEvent, Room } from "matrix-js-sdk";
import { MatrixClientPeg } from "../../src/MatrixClientPeg"; import { MatrixClientPeg } from "../../src/MatrixClientPeg";
import { textForFormat, IExportOptions, ExportTypes } from "../../src/utils/exportUtils/exportUtils"; import { textForFormat, IExportOptions, ExportType } from "../../src/utils/exportUtils/exportUtils";
import '../skinned-sdk'; import '../skinned-sdk';
import PlainTextExporter from "../../src/utils/exportUtils/PlainTextExport"; import PlainTextExporter from "../../src/utils/exportUtils/PlainTextExport";
import HTMLExporter from "../../src/utils/exportUtils/HtmlExport"; import HTMLExporter from "../../src/utils/exportUtils/HtmlExport";
@ -179,7 +179,7 @@ describe('export', function() {
it('checks if the export options are valid', function() { it('checks if the export options are valid', function() {
for (const exportOption of invalidExportOptions) { for (const exportOption of invalidExportOptions) {
try { try {
new PlainTextExporter(mockRoom, ExportTypes.BEGINNING, exportOption, null); new PlainTextExporter(mockRoom, ExportType.Beginning, exportOption, null);
throw new Error("Expected to throw an error"); throw new Error("Expected to throw an error");
} catch (e) { } catch (e) {
expect(e.message).toBe("Invalid export options"); expect(e.message).toBe("Invalid export options");
@ -188,7 +188,7 @@ describe('export', function() {
}); });
it('tests the file extension splitter', function() { it('tests the file extension splitter', function() {
const exporter = new PlainTextExporter(mockRoom, ExportTypes.BEGINNING, mockExportOptions, null); const exporter = new PlainTextExporter(mockRoom, ExportType.Beginning, mockExportOptions, null);
const fileNameWithExtensions = { const fileNameWithExtensions = {
"": ["", ""], "": ["", ""],
"name": ["name", ""], "name": ["name", ""],
@ -225,14 +225,14 @@ describe('export', function() {
"expectedText": "<@me:here \"This\"> Reply", "expectedText": "<@me:here \"This\"> Reply",
}, },
]; ];
const exporter = new PlainTextExporter(mockRoom, ExportTypes.BEGINNING, mockExportOptions, null); const exporter = new PlainTextExporter(mockRoom, ExportType.Beginning, mockExportOptions, null);
for (const content of eventContents) { for (const content of eventContents) {
expect(exporter.textForReplyEvent(content)).toBe(content.expectedText); expect(exporter.textForReplyEvent(content)).toBe(content.expectedText);
} }
}); });
it("checks if the render to string doesn't throw any error for different types of events", function() { it("checks if the render to string doesn't throw any error for different types of events", function() {
const exporter = new HTMLExporter(mockRoom, ExportTypes.BEGINNING, mockExportOptions, null); const exporter = new HTMLExporter(mockRoom, ExportType.Beginning, mockExportOptions, null);
for (const event of events) { for (const event of events) {
expect(renderToString(exporter.getEventTile(event, false))).toBeTruthy(); expect(renderToString(exporter.getEventTile(event, false))).toBeTruthy();
} }