feat(sidebar): rename folders from the sidebar (#999)

Follows the folder create/delete work: a typo'd directory could be
removed but not corrected, and for a folder holding models the only fix
was to move every model out by hand.

Adds POST /api/lm/{prefix}/rename-folder. Unlike the delete path this one
deliberately works on folders that hold models — a rename keeps every
file, so nothing is cascaded over: the directory is renamed on disk and
the scanner re-keys the records that pointed at the old prefix (recorded
folder list, cache file_path/folder/preview_url, hash and autov3 index
paths, excluded-model paths, and the metadata sidecars that travelled
with the directory). Ancestors are never touched, and only the leaf name
is accepted so a rename can never escape its parent.

Library roots, top-level symlinks and folders holding a staged delete are
refused; the last because a staging manifest records absolute
original/staged paths, so moving it would break undo and purge. A name
collision is a 409 target_exists conflict.

The sidebar reuses the inline-row idiom from folder creation: prefilled
with the current name, inserted in place of the node with that node
hidden while editing, Enter confirms and Escape/blur cancels. The
persisted selection and the expanded set are re-keyed across the rename
so the user keeps their place in the refreshed tree.
This commit is contained in:
Will Miao
2026-09-15 20:10:36 +08:00
parent 4938faa049
commit 9bbe57ee85
22 changed files with 1258 additions and 0 deletions
+1
View File
@@ -85,6 +85,7 @@ export function getApiEndpoints(modelType) {
moveBulk: `/api/lm/${modelType}/move_models_bulk`,
createFolder: `/api/lm/${modelType}/create-folder`,
deleteFolder: `/api/lm/${modelType}/delete-folder`,
renameFolder: `/api/lm/${modelType}/rename-folder`,
// CivitAI integration
fetchCivitai: `/api/lm/${modelType}/fetch-civitai`,
+31
View File
@@ -1364,6 +1364,37 @@ export class BaseModelApiClient {
return result;
}
/**
* Rename a folder inside the library roots.
*
* Works on folders that hold models too — the backend re-keys the affected
* cache records instead of cascading. A name collision or a staged delete
* inside the subtree surfaces as a 409 conflict, attached to the thrown
* Error as `code`.
*
* @param {string} folderPath Absolute business path of the folder
* @param {string} newName New leaf name (a single path segment)
*/
async renameFolder(folderPath, newName) {
const response = await fetch(this.apiConfig.endpoints.renameFolder, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({ folder_path: folderPath, new_name: newName })
});
const result = await response.json().catch(() => ({}));
if (!response.ok || result.success === false) {
const error = new Error(result.error || `Failed to rename folder`);
error.code = result.code || null;
throw error;
}
return result;
}
async fetchUnifiedFolderTree(options = {}) {
try {
const { includeEmpty = false } = options;
+222
View File
@@ -47,6 +47,8 @@ export class SidebarManager {
this.nonEmptyFolders = null; // models-only folder set used to dim empty nodes
this._createFolderBasePath = null;
this._createFolderTempChildren = null; // children container added for a leaf parent during inline creation
this._renameFolderPath = null;
this._renameFolderNode = null;
this._pendingDeleteFolderPath = null;
this._deleteFolderModalWired = false;
@@ -118,6 +120,7 @@ export class SidebarManager {
this.clearAllDropHighlights();
this.resetDragState();
this.hideCreateFolderInput();
this.hideRenameFolderInput();
this.hideSidebarHiddenIndicator();
@@ -136,6 +139,8 @@ export class SidebarManager {
this.nonEmptyFolders = null;
this._createFolderBasePath = null;
this._createFolderTempChildren = null;
this._renameFolderPath = null;
this._renameFolderNode = null;
this._pendingDeleteFolderPath = null;
// Reset container margin
@@ -763,6 +768,214 @@ export class SidebarManager {
this.hideCreateFolderInput();
}
// ===== Folder rename (inline row, file-explorer style) =====
/**
* Turn the folder node at *path* into an editable row.
*
* Mirrors the create-folder inline row (Enter confirms, Escape/blur
* cancels) but is inserted where the node sits and hides that node while
* editing, so the tree does not jump.
*/
showRenameFolderInput(path) {
if (!path) return;
this.hideRenameFolderInput();
const folderTree = document.getElementById('sidebarFolderTree');
if (!folderTree) return;
const node = this._findFolderNodeElement(folderTree, path);
if (!node) return;
const row = this._buildRenameFolderRow(this._folderLeafName(path));
node.parentElement.insertBefore(row, node);
node.style.display = 'none';
this._renameFolderNode = node;
this._renameFolderPath = path;
const input = row.querySelector('.sidebar-rename-folder-input');
if (!input) return;
input.focus();
input.select();
input.addEventListener('keydown', (e) => {
if (e.key === 'Enter') {
this.handleRenameFolderSubmit();
} else if (e.key === 'Escape') {
this.handleRenameFolderCancel();
}
});
// Clicking away cancels, mirroring the create-folder row
input.addEventListener('blur', () => {
setTimeout(() => {
if (this._renameFolderPath) {
this.handleRenameFolderCancel();
}
}, 100);
});
}
_buildRenameFolderRow(currentName) {
const isListMode = this.displayMode === 'list';
const row = document.createElement('div');
row.id = 'sidebarRenameFolderInput';
row.className = 'sidebar-create-folder-node sidebar-rename-folder-node';
row.innerHTML = `
<div class="${isListMode ? 'sidebar-node-content' : 'sidebar-tree-node-content'} sidebar-create-folder-row">
${isListMode ? '' : `
<div class="sidebar-tree-expand-icon sidebar-create-folder-spacer">
<i class="fas fa-chevron-right"></i>
</div>`}
<i class="fas fa-i-cursor sidebar-tree-folder-icon"></i>
<input type="text"
class="sidebar-create-folder-input sidebar-rename-folder-input"
aria-label="${escapeAttribute(translate('sidebar.renameFolder', {}, 'Rename folder'))}"
value="${escapeAttribute(currentName)}" />
</div>
`;
return row;
}
_findFolderNodeElement(folderTree, path) {
return [...folderTree.querySelectorAll('.sidebar-tree-node, .sidebar-folder-item')]
.find(element => element.dataset.path === path) || null;
}
_folderLeafName(path) {
if (!path) return '';
const index = path.lastIndexOf('/');
return index === -1 ? path : path.slice(index + 1);
}
hideRenameFolderInput() {
// Clear the flag first so the input's blur handler does not treat
// removing the row as a cancel.
this._renameFolderPath = null;
const row = document.getElementById('sidebarRenameFolderInput');
if (row) {
row.remove();
}
const node = this._renameFolderNode;
this._renameFolderNode = null;
if (node && node.isConnected) {
node.style.display = '';
}
}
handleRenameFolderCancel() {
this.hideRenameFolderInput();
}
async handleRenameFolderSubmit() {
const input = document.querySelector('#sidebarRenameFolderInput .sidebar-rename-folder-input');
const path = this._renameFolderPath;
if (!input || !path) {
return;
}
const newName = input.value.trim();
if (!newName) {
showToast('sidebar.dragDrop.emptyFolderName', {}, 'warning');
return;
}
if (/[\\/:*?"<>|]/.test(newName)) {
showToast('sidebar.dragDrop.invalidFolderName', {}, 'error');
return;
}
this.hideRenameFolderInput();
if (newName === this._folderLeafName(path)) {
return;
}
await this._renameFolder(path, newName);
}
async _renameFolder(relativePath, newName) {
if (!this._supportsFolderManagement() || typeof this.apiClient.renameFolder !== 'function') {
showToast('sidebar.renameFolderResult.unsupported', {}, 'error');
return false;
}
try {
const rootsData = await this.apiClient.fetchModelRoots();
const roots = rootsData?.roots || [];
const root = this._resolveDefaultRoot(roots);
if (!root) {
showToast('sidebar.renameFolderResult.noRoot', {}, 'error');
return false;
}
const absolutePath = this.combineRootAndRelativePath(root, relativePath);
const result = await this.apiClient.renameFolder(absolutePath, newName);
// Carry the user's place across the rename: the persisted
// selection and the expanded set would otherwise point at a folder
// the refreshed tree no longer contains.
const newPath = result.folder || this._siblingFolderPath(relativePath, newName);
this._rekeyFolderPath(relativePath, newPath);
await this.refresh();
showToast('sidebar.renameFolderResult.success', { name: newName }, 'success');
return true;
} catch (error) {
console.error('[SidebarManager] Error renaming folder:', error);
if (error?.code === 'target_exists') {
showToast('sidebar.renameFolderResult.targetExists', {}, 'warning');
} else if (error?.code === 'busy') {
showToast('sidebar.renameFolderResult.busy', {}, 'warning');
} else {
showToast(
'sidebar.renameFolderResult.failed',
{ message: error?.message || 'Unknown error' },
'error'
);
}
return false;
}
}
_siblingFolderPath(relativePath, newName) {
const index = relativePath.lastIndexOf('/');
const parent = index === -1 ? '' : relativePath.slice(0, index);
return parent ? `${parent}/${newName}` : newName;
}
_rekeyFolderPath(previousPath, newPath) {
if (!previousPath || !newPath || previousPath === newPath) return;
const prefix = `${previousPath}/`;
const newPrefix = `${newPath}/`;
const rekey = (value) => {
if (value === previousPath) return newPath;
if (value.startsWith(prefix)) return newPrefix + value.slice(prefix.length);
return value;
};
if (this.expandedNodes.size > 0) {
this.expandedNodes = new Set([...this.expandedNodes].map(rekey));
this.saveExpandedState();
}
if (this.selectedPath) {
const rekeyed = rekey(this.selectedPath);
if (rekeyed !== this.selectedPath) {
this.selectedPath = rekeyed;
if (this.pageControls?.pageState) {
this.pageControls.pageState.activeFolder = rekeyed;
}
setStorageItem(`${this.pageType}_activeFolder`, rekeyed);
}
}
}
/**
* Open the folder delete modal for *path*.
*
@@ -1435,6 +1648,12 @@ export class SidebarManager {
deleteItem.style.display = this._supportsFolderManagement() ? '' : 'none';
}
// Renaming an on-disk folder is likewise library-only.
const renameItem = menu.querySelector('[data-action="rename-folder"]');
if (renameItem) {
renameItem.style.display = this._supportsFolderManagement() ? '' : 'none';
}
menu.style.left = `${x}px`;
menu.style.top = `${y}px`;
menu.style.display = 'block';
@@ -1483,6 +1702,9 @@ export class SidebarManager {
case 'create-subfolder':
this.showCreateFolderInput(path);
break;
case 'rename-folder':
this.showRenameFolderInput(path);
break;
case 'delete-folder':
this.showDeleteFolderModal(path);
break;