Skip to content

armgit / ente

Public Imported from GitHub
0

💚 End-to-end encrypted cloud for everything.

[web][locker] Rename files before upload

Aswin Asokbca53619758d
diff --git a/web/apps/locker/src/components/collections/RenameCollectionDialog.tsx b/web/apps/locker/src/components/collections/RenameCollectionDialog.tsx
index faa1c655ad..5cefb3cde7 100644
--- a/web/apps/locker/src/components/collections/RenameCollectionDialog.tsx
+++ b/web/apps/locker/src/components/collections/RenameCollectionDialog.tsx
@@ -1,20 +1,5 @@
-import { FormField } from "@/components/ui/FormField";
-import { lockerSheetContainerSx, lockerSheetPaperSx } from "@/styles/dialog";
-import {
- lockerHeaderIconButtonSx,
- lockerPrimaryButtonSx,
-} from "@/styles/fields";
-import {
- lockerColorSx,
- lockerTextBodyBoldSx,
- lockerTextH2Sx,
- lockerTextMiniSx,
-} from "@/styles/tokens";
+import { NameInputDialog } from "@/components/ui/NameInputDialog";
import type { LockerCollection } from "@/types";
-import { Cancel01Icon } from "@hugeicons/core-free-icons";
-import { HugeiconsIcon } from "@hugeicons/react";
-import { Box, Dialog, IconButton, Stack, Typography } from "@mui/material";
-import { LoadingButton } from "ente-base/components/mui/LoadingButton";
import log from "ente-base/log";
import { t } from "i18next";
import { useCallback, useEffect, useState } from "react";
@@ -96,99 +81,20 @@ export function RenameCollectionDialog({
setRenameError(null);
};
return (
- <Dialog
- slotProps={{
- paper: { sx: lockerSheetPaperSx },
- container: { sx: lockerSheetContainerSx },
- }}
+ <NameInputDialog
open={renameCollectionOpen}
- onClose={() => {
- if (!renamingCollection) {
- onCloseRenameDialog();
- }
+ title={t("renameCollection")}
+ label={t("enterCollectionName")}
+ value={renameValue}
+ required
+ loading={renamingCollection}
+ disabled={!renameValue.trim()}
+ error={renameError ?? undefined}
+ onChange={handleNameChange}
+ onClose={onCloseRenameDialog}
+ onSubmit={() => {
+ void handleRenameConfirm();
}}
- fullWidth
- maxWidth="xs"
- >
- <Stack>
- <Stack
- direction="row"
- sx={{ alignItems: "center", gap: 1.5, minHeight: 38 }}
- >
- <Typography
- sx={{ ...lockerTextH2Sx, flex: 1, minWidth: 0 }}
- >
- {t("renameCollection")}
- </Typography>
- <IconButton
- aria-label={t("close")}
- onClick={onCloseRenameDialog}
- disabled={renamingCollection}
- sx={lockerHeaderIconButtonSx}
- >
- <HugeiconsIcon
- icon={Cancel01Icon}
- size={18}
- strokeWidth={1.5}
- />
- </IconButton>
- </Stack>
- <Box sx={{ mt: 2.5 }}>
- <FormField
- value={renameValue}
- onChange={(event) =>
- handleNameChange(event.target.value)
- }
- label={t("enterCollectionName")}
- required
- autoFocus
- disabled={renamingCollection}
- onKeyDown={(event) => {
- if (event.key === "Enter") {
- void handleRenameConfirm();
- }
- }}
- />
- </Box>
- {renameError && (
- <Typography
- sx={(theme) => ({
- ...lockerTextMiniSx,
- mt: 1.5,
- ...lockerColorSx(theme, { color: "warning" }),
- })}
- >
- {renameError}
- </Typography>
- )}
- <LoadingButton
- fullWidth
- color="primary"
- loading={renamingCollection}
- disabled={!renameValue.trim()}
- onClick={handleRenameConfirm}
- sx={(theme) => ({
- ...lockerTextBodyBoldSx,
- mt: 3,
- borderRadius: "20px",
- textTransform: "none",
- ...lockerColorSx(theme, {
- backgroundColor: "primary",
- color: "specialWhite",
- }),
- "&:hover": {
- ...lockerColorSx(theme, {
- backgroundColor: "primaryDark",
- }),
- },
- ...lockerPrimaryButtonSx(theme, {
- loading: renamingCollection,
- }),
- })}
- >
- {t("save")}
- </LoadingButton>
- </Stack>
- </Dialog>
+ />
);
}
diff --git a/web/apps/locker/src/components/create-item/CreateItemDialog.tsx b/web/apps/locker/src/components/create-item/CreateItemDialog.tsx
index 4f4d5c8e72..57b2c96436 100644
--- a/web/apps/locker/src/components/create-item/CreateItemDialog.tsx
+++ b/web/apps/locker/src/components/create-item/CreateItemDialog.tsx
@@ -463,6 +463,17 @@ export const CreateItemDialog: React.FC<CreateItemDialogProps> = ({
),
)
}
+ onRenameItem={(fileKey, uploadName) => {
+ if (uploading || completedFileKeys.has(fileKey))
+ return;
+ setSelectedUploadItems((current) =>
+ current.map((item) =>
+ uploadQueueItemKey(item) === fileKey
+ ? { ...item, uploadName }
+ : item,
+ ),
+ );
+ }}
onRemoveItem={(fileKey) => {
setSelectedUploadItems((current) =>
current.filter(
diff --git a/web/apps/locker/src/components/create-item/FileUploadSection.tsx b/web/apps/locker/src/components/create-item/FileUploadSection.tsx
index 2506394f38..f05c124461 100644
--- a/web/apps/locker/src/components/create-item/FileUploadSection.tsx
+++ b/web/apps/locker/src/components/create-item/FileUploadSection.tsx
@@ -2,10 +2,15 @@ import { CollectionChipRow } from "@/components/create-item/CollectionChipRow";
import { lockerScrollAreaSx } from "@/components/create-item/create-item-dialog-styles";
import { CreateCollectionRow } from "@/components/create-item/CreateCollectionRow";
import { lockerItemIcon } from "@/components/items/locker-item-icons";
+import { NameInputDialog } from "@/components/ui/NameInputDialog";
import type { LockerUploadProgress } from "@/services/uploads";
import { lockerPrimaryButtonSx } from "@/styles/fields";
import type { LockerCollection, LockerUploadCandidate } from "@/types";
-import { Cancel01Icon, FileUploadIcon } from "@hugeicons/core-free-icons";
+import {
+ Cancel01Icon,
+ Edit02Icon,
+ FileUploadIcon,
+} from "@hugeicons/core-free-icons";
import { HugeiconsIcon } from "@hugeicons/react";
import CheckRoundedIcon from "@mui/icons-material/CheckRounded";
import ErrorOutlineRoundedIcon from "@mui/icons-material/ErrorOutlineRounded";
@@ -35,7 +40,9 @@ import {
dedupeCollectionNames,
formatFileSize,
normalizeCollectionName,
+ renamedUploadFileName,
toggleCollectionName,
+ uploadFileExtension,
uploadItemParentPath,
uploadProgressValue,
uploadQueueItemKey,
@@ -60,6 +67,7 @@ interface FileUploadSectionProps {
onAddAvailableCollectionName: (name: string) => void;
onSetCollectionNamesForAllItems: (names: string[]) => void;
onRemoveItem: (fileKey: string) => void;
+ onRenameItem: (fileKey: string, name: string) => void;
onUpload: () => Promise<void>;
}
@@ -82,8 +90,16 @@ export function FileUploadSection({
onAddAvailableCollectionName,
onSetCollectionNamesForAllItems,
onRemoveItem,
+ onRenameItem,
onUpload,
}: FileUploadSectionProps) {
+ const [renameItem, setRenameItem] = useState<LockerUploadCandidate | null>(
+ null,
+ );
+ const [renameValue, setRenameValue] = useState("");
+ const renamedName = renameItem
+ ? renamedUploadFileName(renameItem.file.name, renameValue)
+ : undefined;
const [settledCompletedFileKeys, setSettledCompletedFileKeys] = useState<
Set<string>
>(() => new Set());
@@ -240,6 +256,25 @@ export function FileUploadSection({
return (
<Stack sx={{ flex: 1, minHeight: 0 }}>
+ <NameInputDialog
+ open={renameItem !== null}
+ title={t("rename_file")}
+ label={t("file_name")}
+ value={renameValue}
+ onChange={setRenameValue}
+ onClose={() => setRenameItem(null)}
+ error={
+ renameItem !== null && !renamedName
+ ? t("invalidUploadFileName")
+ : undefined
+ }
+ disabled={!renamedName || uploading}
+ onSubmit={() => {
+ if (!renameItem || !renamedName || uploading) return;
+ onRenameItem(uploadQueueItemKey(renameItem), renamedName);
+ setRenameItem(null);
+ }}
+ />
<input
ref={fileInputRef}
type="file"
@@ -379,6 +414,23 @@ export function FileUploadSection({
onAddCollectionName={(name: string) =>
onAddCollectionName(fileKey, name)
}
+ onRename={() => {
+ const name =
+ item.uploadName ??
+ item.file.name;
+ const extension =
+ uploadFileExtension(
+ item.file.name,
+ );
+ setRenameValue(
+ name.slice(
+ 0,
+ name.length -
+ extension.length,
+ ),
+ );
+ setRenameItem(item);
+ }}
canRemove={!uploading}
onRemove={() => onRemoveItem(fileKey)}
/>
@@ -455,6 +507,7 @@ interface UploadItemCardProps {
onAddCollectionName: (name: string) => void;
canRemove: boolean;
onRemove: () => void;
+ onRename: () => void;
}
const UploadItemCard = React.memo(function UploadItemCard({
@@ -475,6 +528,7 @@ const UploadItemCard = React.memo(function UploadItemCard({
onAddCollectionName,
canRemove,
onRemove,
+ onRename,
}: UploadItemCardProps) {
return (
<Stack
@@ -502,19 +556,32 @@ const UploadItemCard = React.memo(function UploadItemCard({
})}
>
{lockerItemIcon("file", {
- fileName: item.file.name,
+ fileName: item.uploadName ?? item.file.name,
size: 24,
strokeWidth: 1.5,
})}
</Box>
<Box sx={{ flex: 1, minWidth: 0 }}>
<Typography variant="small" noWrap>
- {item.file.name}
+ {item.uploadName ?? item.file.name}
</Typography>
<Typography variant="mini" sx={{ color: "text.muted" }}>
{formatFileSize(item.file.size)}
</Typography>
</Box>
+ {!uploadInFlight && !isDone && (
+ <IconButton
+ aria-label={t("rename_file")}
+ onClick={onRename}
+ size="small"
+ >
+ <HugeiconsIcon
+ icon={Edit02Icon}
+ size={18}
+ strokeWidth={1.5}
+ />
+ </IconButton>
+ )}
<Box
sx={{
width: 28,
diff --git a/web/apps/locker/src/components/create-item/file-upload-helpers.ts b/web/apps/locker/src/components/create-item/file-upload-helpers.ts
index e0552614ae..ac0c6e9dcf 100644
--- a/web/apps/locker/src/components/create-item/file-upload-helpers.ts
+++ b/web/apps/locker/src/components/create-item/file-upload-helpers.ts
@@ -108,3 +108,28 @@ export const formatFileSize = (bytes: number) => {
}
return `${(bytes / (1024 * 1024 * 1024)).toFixed(1)} GB`;
};
+
+export const uploadFileExtension = (name: string) => {
+ const dot = name.lastIndexOf(".");
+ return dot > 0 ? name.slice(dot) : "";
+};
+
+export const renamedUploadFileName = (originalName: string, value: string) => {
+ const extension = uploadFileExtension(originalName);
+ let name = value.replace(/[/\\]|[^\u0020-\uFFFF]/g, "").trim();
+ if (extension && name.toLowerCase().endsWith(extension.toLowerCase())) {
+ name = name.slice(0, -extension.length).trim();
+ }
+ if (!name || name === "." || name === "..") return undefined;
+ name += extension;
+ return new TextEncoder().encode(name).length <= 255 ? name : undefined;
+};
+
+/** Keep queue identity and collection assignments tied to the original file. */
+export const fileForUpload = (item: LockerUploadCandidate) =>
+ item.uploadName && item.uploadName !== item.file.name
+ ? new File([item.file], item.uploadName, {
+ type: item.file.type,
+ lastModified: item.file.lastModified,
+ })
+ : item.file;
diff --git a/web/apps/locker/src/components/create-item/use-upload-queue.ts b/web/apps/locker/src/components/create-item/use-upload-queue.ts
index 1c51bea45b..bb34a38349 100644
--- a/web/apps/locker/src/components/create-item/use-upload-queue.ts
+++ b/web/apps/locker/src/components/create-item/use-upload-queue.ts
@@ -21,6 +21,7 @@ import {
} from "react";
import {
dedupeCollectionNames,
+ fileForUpload,
filterNonEmptyUploadItems,
normalizeCollectionName,
uploadQueueItemKey,
@@ -283,7 +284,7 @@ export function useUploadQueue({
try {
await onUploadProgress(
- item.file,
+ fileForUpload(item),
collectionIDs,
(progress) => {
setUploadProgressByFileKey((current) => ({
diff --git a/web/apps/locker/src/components/ui/NameInputDialog.tsx b/web/apps/locker/src/components/ui/NameInputDialog.tsx
new file mode 100644
index 0000000000..94ecf5c60e
--- /dev/null
+++ b/web/apps/locker/src/components/ui/NameInputDialog.tsx
@@ -0,0 +1,128 @@
+import { FormField } from "@/components/ui/FormField";
+import { lockerSheetContainerSx, lockerSheetPaperSx } from "@/styles/dialog";
+import {
+ lockerHeaderIconButtonSx,
+ lockerPrimaryButtonSx,
+} from "@/styles/fields";
+import {
+ lockerColorSx,
+ lockerTextBodyBoldSx,
+ lockerTextH2Sx,
+} from "@/styles/tokens";
+import { Cancel01Icon } from "@hugeicons/core-free-icons";
+import { HugeiconsIcon } from "@hugeicons/react";
+import { Box, Dialog, IconButton, Stack, Typography } from "@mui/material";
+import { LoadingButton } from "ente-base/components/mui/LoadingButton";
+import { t } from "i18next";
+
+interface NameInputDialogProps {
+ open: boolean;
+ title: string;
+ label: string;
+ value: string;
+ required?: boolean;
+ loading?: boolean;
+ disabled: boolean;
+ error?: string;
+ onChange: (value: string) => void;
+ onClose: () => void;
+ onSubmit: () => void;
+}
+
+export function NameInputDialog({
+ open,
+ title,
+ label,
+ value,
+ required,
+ loading = false,
+ disabled,
+ error,
+ onChange,
+ onClose,
+ onSubmit,
+}: NameInputDialogProps) {
+ return (
+ <Dialog
+ open={open}
+ onClose={() => {
+ if (!loading) onClose();
+ }}
+ fullWidth
+ maxWidth="xs"
+ slotProps={{
+ paper: { sx: lockerSheetPaperSx },
+ container: { sx: lockerSheetContainerSx },
+ }}
+ >
+ <Box
+ component="form"
+ onSubmit={(event) => {
+ event.preventDefault();
+ if (open && !loading && !disabled) onSubmit();
+ }}
+ >
+ <Stack
+ direction="row"
+ sx={{ alignItems: "center", gap: 1.5, minHeight: 38 }}
+ >
+ <Typography
+ component="h2"
+ sx={{ ...lockerTextH2Sx, flex: 1, minWidth: 0 }}
+ >
+ {title}
+ </Typography>
+ <IconButton
+ aria-label={t("close")}
+ onClick={onClose}
+ disabled={loading}
+ sx={lockerHeaderIconButtonSx}
+ >
+ <HugeiconsIcon
+ icon={Cancel01Icon}
+ size={18}
+ strokeWidth={1.5}
+ />
+ </IconButton>
+ </Stack>
+ <Box sx={{ mt: 2.5 }}>
+ <FormField
+ autoFocus
+ label={label}
+ value={value}
+ required={required}
+ disabled={loading}
+ onChange={(event) => onChange(event.target.value)}
+ error={open && !!error}
+ helperText={open ? error : undefined}
+ />
+ </Box>
+ <LoadingButton
+ fullWidth
+ color="primary"
+ type="submit"
+ loading={loading}
+ disabled={disabled}
+ sx={(theme) => ({
+ ...lockerTextBodyBoldSx,
+ mt: 3,
+ borderRadius: "20px",
+ textTransform: "none",
+ ...lockerColorSx(theme, {
+ backgroundColor: "primary",
+ color: "specialWhite",
+ }),
+ "&:hover": {
+ ...lockerColorSx(theme, {
+ backgroundColor: "primaryDark",
+ }),
+ },
+ ...lockerPrimaryButtonSx(theme, { loading }),
+ })}
+ >
+ {t("save")}
+ </LoadingButton>
+ </Box>
+ </Dialog>
+ );
+}
diff --git a/web/apps/locker/src/locales/en-US/translation.json b/web/apps/locker/src/locales/en-US/translation.json
index d6906145bc..e42b4e128f 100644
--- a/web/apps/locker/src/locales/en-US/translation.json
+++ b/web/apps/locker/src/locales/en-US/translation.json
@@ -1,4 +1,5 @@
{
+ "invalidUploadFileName": "Enter a valid file name of at most 255 bytes, including its extension.",
"discardUnsavedChangesTitle": "Discard unsaved changes?",
"discardUnsavedChangesBody": "You have unsaved changes. Discarding will lose them.",
"discardPendingUploadsBody": "Files that haven’t been uploaded will be removed from this queue. Files already uploaded will stay in Locker.",
diff --git a/web/apps/locker/src/types.ts b/web/apps/locker/src/types.ts
index ac2803cdc6..8d029410d3 100644
--- a/web/apps/locker/src/types.ts
+++ b/web/apps/locker/src/types.ts
@@ -80,6 +80,7 @@ export interface LockerCollection {
export interface LockerUploadCandidate {
file: File;
+ uploadName?: string;
relativePath?: string;
suggestedCollectionNames: string[];
}
diff --git a/web/apps/locker/tests/upload-rename.test.ts b/web/apps/locker/tests/upload-rename.test.ts
new file mode 100644
index 0000000000..69ea1dab97
--- /dev/null
+++ b/web/apps/locker/tests/upload-rename.test.ts
@@ -0,0 +1,43 @@
+import { expect, test } from "vitest";
+import {
+ fileForUpload,
+ renamedUploadFileName,
+ uploadQueueItemKey,
+} from "../src/components/create-item/file-upload-helpers";
+
+test("renaming preserves extension and validates filesystem names", () => {
+ expect(renamedUploadFileName("scan.PDF", " Passport.pdf ")).toBe(
+ "Passport.PDF",
+ );
+ expect(renamedUploadFileName("scan.pdf", "a/b\\c\u0000")).toBe("abc.pdf");
+ for (const value of ["", " ", ".", "..", "/\\"]) {
+ expect(renamedUploadFileName("scan.pdf", value)).toBeUndefined();
+ }
+ expect(renamedUploadFileName("scan.pdf", "é".repeat(126))).toBeUndefined();
+ expect(renamedUploadFileName("scan.pdf", "a".repeat(251))).toHaveLength(
+ 255,
+ );
+ expect(renamedUploadFileName("README", "Notes")).toBe("Notes");
+ expect(renamedUploadFileName(".env", "config")).toBe("config");
+});
+
+test("upload uses chosen name without changing queue identity or file data", async () => {
+ const file = new File(["document"], "scan.pdf", {
+ type: "application/pdf",
+ lastModified: 123,
+ });
+ const original = {
+ file,
+ relativePath: "folder/scan.pdf",
+ suggestedCollectionNames: ["folder"],
+ };
+ const renamed = { ...original, uploadName: "Passport.pdf" };
+ expect(uploadQueueItemKey(renamed)).toBe(uploadQueueItemKey(original));
+ const uploaded = fileForUpload(renamed);
+ expect(uploaded.name).toBe("Passport.pdf");
+ expect(uploaded.type).toBe(file.type);
+ expect(uploaded.lastModified).toBe(123);
+ expect(await uploaded.text()).toBe("document");
+ expect(file.name).toBe("scan.pdf");
+ expect(fileForUpload(original)).toBe(file);
+});