d30c85772a
* Update all non-major dependencies * Pin back eslint-plugin-deprecate * Fix types * typo * Fix more typos --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
115 lines
4.3 KiB
TypeScript
115 lines
4.3 KiB
TypeScript
/*
|
|
Copyright 2015 - 2021 The Matrix.org Foundation C.I.C.
|
|
Copyright 2021 Šimon Brandner <simon.bra.ag@gmail.com>
|
|
|
|
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 {
|
|
filesize,
|
|
FileSizeOptionsArray,
|
|
FileSizeOptionsBase,
|
|
FileSizeOptionsExponent,
|
|
FileSizeOptionsObject,
|
|
FileSizeOptionsString,
|
|
FileSizeReturnArray,
|
|
FileSizeReturnObject,
|
|
} from "filesize";
|
|
|
|
import { IMediaEventContent } from "../customisations/models/IMediaEventContent";
|
|
import { _t } from "../languageHandler";
|
|
|
|
/**
|
|
* Extracts a human-readable label for the file attachment to use as
|
|
* link text.
|
|
*
|
|
* @param {IMediaEventContent} content The "content" key of the matrix event.
|
|
* @param {string} fallbackText The fallback text
|
|
* @param {boolean} withSize Whether to include size information. Default true.
|
|
* @param {boolean} shortened Ensure the extension of the file name is visible. Default false.
|
|
* @return {string} the human-readable link text for the attachment.
|
|
*/
|
|
export function presentableTextForFile(
|
|
content: IMediaEventContent,
|
|
fallbackText = _t("common|attachment"),
|
|
withSize = true,
|
|
shortened = false,
|
|
): string {
|
|
let text = fallbackText;
|
|
if (content.body?.length) {
|
|
// The content body should be the name of the file including a
|
|
// file extension.
|
|
text = content.body;
|
|
}
|
|
|
|
// We shorten to 15 characters somewhat arbitrarily, and assume most files
|
|
// will have a 3 character (plus full stop) extension. The goal is to knock
|
|
// the label down to 15-25 characters, not perfect accuracy.
|
|
if (shortened && text.length > 19) {
|
|
const parts = text.split(".");
|
|
let fileName = parts
|
|
.slice(0, parts.length - 1)
|
|
.join(".")
|
|
.substring(0, 15);
|
|
const extension = parts[parts.length - 1];
|
|
|
|
// Trim off any full stops from the file name to avoid a case where we
|
|
// add an ellipsis that looks really funky.
|
|
fileName = fileName.replace(/\.*$/g, "");
|
|
|
|
text = `${fileName}...${extension}`;
|
|
}
|
|
|
|
if (content.info?.size && withSize) {
|
|
// If we know the size of the file then add it as human readable
|
|
// string to the end of the link text so that the user knows how
|
|
// big a file they are downloading.
|
|
// The content.info also contains a MIME-type but we don't display
|
|
// it since it is "ugly", users generally aren't aware what it
|
|
// means and the type of the attachment can usually be inferred
|
|
// from the file extension.
|
|
text += " (" + <string>fileSize(content.info.size, { base: 2, standard: "jedec" }) + ")";
|
|
}
|
|
return text;
|
|
}
|
|
|
|
type FileSizeOptions =
|
|
| FileSizeOptionsString
|
|
| FileSizeOptionsBase
|
|
| FileSizeOptionsArray
|
|
| FileSizeOptionsExponent
|
|
| FileSizeOptionsObject;
|
|
|
|
/**
|
|
* wrapper function to set default values for filesize function
|
|
*
|
|
* @param byteCount size of file
|
|
* @param options options to customize the response type or size type conversion e.g. 12kB, 12KB
|
|
* @returns {string | number | any[] | {
|
|
* value: any;
|
|
* symbol: any;
|
|
* exponent: number;
|
|
* unit: string;}} formatted file size with unit e.g. 12kB, 12KB
|
|
*/
|
|
export function fileSize(byteCount: number, options: FileSizeOptionsString | FileSizeOptionsBase): string;
|
|
export function fileSize(byteCount: number, options: FileSizeOptionsArray): FileSizeReturnArray;
|
|
export function fileSize(byteCount: number, options: FileSizeOptionsExponent): number;
|
|
export function fileSize(byteCount: number, options: FileSizeOptionsObject): FileSizeReturnObject;
|
|
export function fileSize(byteCount: number): string;
|
|
export function fileSize(
|
|
byteCount: number,
|
|
options?: FileSizeOptions,
|
|
): string | number | FileSizeReturnArray | FileSizeReturnObject {
|
|
const defaultOption: FileSizeOptions = { base: 2, standard: "jedec", ...options };
|
|
return filesize(byteCount, defaultOption);
|
|
}
|