[Share] Rename attachments

[ramonmi]

Description

replace the "Rename attachments" function from Zutilo
Use the parent item's metadata to rename its attachments.
Zotero omits to rename newly added attachments when there is any file attached to the item. This script provides a convenient method for renaming attachments.
Compose a workflow together with the previous script. #290

Event

None

Operation

Script

Data

// Rename attachments based on the parent item's metadata
// @author ramonmi
// @usage Trigger with shortcuts
// @Link https://github.com/windingwind/zotero-actions-tags/discussions/290
// @refered to Zutilo

if (!item) {
    return;
}

if (item.isAttachment()) {
    Zotero.getActiveZoteroPane().renameSelectedAttachmentsFromParents();
    return "The selected attachment has been renamed according to the Filename Template!";
} else {
    return "No target attachments!";
}

Anything else

Personal Filename Template
{{ authors max="1" name-part-separator="" name="family-given" initialize="given" initialize-with="" suffix="_" }}{{ year suffix="_" }}{{ title truncate="80" }}

[1067237855]

我想从剪贴板或者弹窗输入内容 来修改附件名称，但是”ZoteroPane.renameSelectedAttachments(clipboardText); “这一句代码有问题，想请教一下大佬怎么修改

// 从剪贴板获取重命名信息
const clipboard = new Zotero.ActionsTags.api.utils.ClipboardHelper(); // 创建剪贴板辅助对象
var clipboardText = clipboard.copy(); // 从剪贴板复制文本

if (!clipboardText) {
    return "No text found in clipboard!"; // 如果剪贴板中没有文本，则返回提示信息
}

if (item.isAttachment()) {
    // 如果当前条目是附件类型
    var ZoteroPane = Zotero.getActiveZoteroPane(); // 获取当前活动的 Zotero 面板
    ZoteroPane.renameSelectedAttachments(clipboardText); // 使用剪贴板中的文本重命名选中的附件
    return "The selected attachment has been renamed using the text from the clipboard!"; // 返回重命名成功的提示信息
} else {
    // 如果当前条目不是附件类型
    return "No target attachments!"; // 返回没有目标附件的提示信息
}

[ramonmi]

之前我也有这个想法，但是没找到对应的api，只找到了renameSelectedAttachmentsFromParents()，不过应该不能像你的代码里那样之间拆开来。有时间我也再看看如何实现。

[thalient-ai]

Updated the rename script. This will update both the Attachment Title and the Attachment Filename based on the Parent Item Metadata. I am using the script as part of the context menu when selecting multiple items.

const Zotero = require("Zotero");

// Function to process renaming of each attachment
async function processRenaming(attachment, processedAttachmentIds) {
    if (!attachment || processedAttachmentIds.has(attachment.id)) {
        // Skip processing if attachment is undefined or already processed
        return { renamed: 0, errors: 0 };
    }

    if (attachment.attachmentLinkMode === Zotero.Attachments.LINK_MODE_LINKED_URL) {
        Zotero.logError(`Cannot rename linked URL attachment ${attachment.id}.`);
        return { renamed: 0, errors: 1 };
    }

    if (!attachment.parentItemID) {
        Zotero.logError(`Attachment ${attachment.id} does not have a parent item.`);
        return { renamed: 0, errors: 1 };
    }

    const parentItem = await Zotero.Items.getAsync(attachment.parentItemID);
    if (!parentItem) {
        Zotero.logError(`No parent item found for attachment ${attachment.id}.`);
        return { renamed: 0, errors: 1 };
    }

    const currentPath = await attachment.getFilePathAsync();
    if (!currentPath) {
        Zotero.logError(`No local file path available for attachment ${attachment.id}.`);
        return { renamed: 0, errors: 1 };
    }

    const newName = Zotero.Attachments.getFileBaseNameFromItem(parentItem);
    const currentName = currentPath.split(/(\\|\/)/g).pop();
    const extension = currentName.includes('.') ? currentName.split('.').pop() : '';
    const finalName = extension ? `${newName}.${extension}` : newName;

    if (newName !== currentName) {
        try {
            await attachment.renameAttachmentFile(finalName);
            attachment.setField('title', finalName);
            await attachment.saveTx();
            processedAttachmentIds.add(attachment.id);
            return { renamed: 1, errors: 0 };
        } catch (error) {
            Zotero.logError(`Error renaming attachment ${attachment.id}: ${error}`);
            return { renamed: 0, errors: 1 };
        }
    }

    return { renamed: 0, errors: 0 };
}

// Main execution block
(async () => {
    if (!items && !item) {
        Zotero.alert(null, "Rename Attachments", "[Rename Attachments] No item or items array provided.");
        return;
    }

    let targetItems = items || (item ? [item] : []);
    let totalRenamed = 0;
    let totalErrors = 0;
    let processedAttachmentIds = new Set();

    for (const currentItem of targetItems) {
        const attachments = currentItem.itemType === 'attachment' ? [currentItem] : await Zotero.Items.getAsync(currentItem.getAttachments());
        for (const attachment of attachments) {
            const result = await processRenaming(attachment, processedAttachmentIds);
            totalRenamed += result.renamed;
            totalErrors += result.errors;
        }
    }

    // Display a summary alert only if there are significant outcomes to report
    if (totalRenamed > 0 || totalErrors > 0) {
        Zotero.alert(null, "Rename Attachments", `[Rename Attachments] Successfully renamed ${totalRenamed} attachments. Errors: ${totalErrors}`);
    }
})();

[thalient-ai]

Here is an alternative script that simply renames the Attachment Title to match the Attachment Filename

const Zotero = require("Zotero");

// Function to process renaming of each attachment
async function processRenaming(attachment, processedAttachmentIds) {
    if (!attachment || processedAttachmentIds.has(attachment.id)) {
        // Skip processing if attachment is undefined or already processed
        return { renamed: 0, errors: 0 };
    }

    if (attachment.attachmentLinkMode === Zotero.Attachments.LINK_MODE_LINKED_URL) {
        Zotero.logError(`Cannot rename linked URL attachment ${attachment.id}.`);
        return { renamed: 0, errors: 1 };
    }

    const currentPath = await attachment.getFilePathAsync();
    if (!currentPath) {
        Zotero.logError(`No local file path available for attachment ${attachment.id}.`);
        return { renamed: 0, errors: 1 };
    }

    const currentName = currentPath.split(/(\\|\/)/g).pop();

    try {
        attachment.setField('title', currentName);
        await attachment.saveTx();
        processedAttachmentIds.add(attachment.id);
        return { renamed: 1, errors: 0 };
    } catch (error) {
        Zotero.logError(`Error updating title for attachment ${attachment.id}: ${error}`);
        return { renamed: 0, errors: 1 };
    }
}

// Main execution block
(async () => {
    if (!items && !item) {
        Zotero.alert(null, "Update Attachment Titles", "[Update Attachment Titles] No item or items array provided.");
        return;
    }

    let targetItems = items || (item ? [item] : []);
    let totalUpdated = 0;
    let totalErrors = 0;
    let processedAttachmentIds = new Set();

    for (const currentItem of targetItems) {
        const attachments = currentItem.itemType === 'attachment' ? [currentItem] : await Zotero.Items.getAsync(currentItem.getAttachments());
        for (const attachment of attachments) {
            const result = await processRenaming(attachment, processedAttachmentIds);
            totalUpdated += result.renamed;
            totalErrors += result.errors;
        }
    }

    // Display a summary alert only if there are significant outcomes to report
    if (totalUpdated > 0 || totalErrors > 0) {
        Zotero.alert(null, "Update Attachment Titles", `[Update Attachment Titles] Successfully updated titles for ${totalUpdated} attachments. Errors: ${totalErrors}`);
    }
})();

[huachuman]

Awesome. Any way to do this automatically e very time a file is attached to a parent item? This used to be done automatically in Z6 (maybe with help of zutilo, not sure the reason)