[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" }}

[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)

[ramonmi]

There will be a native feature in Zotero beta, while the related PR is nearly being merged.

[darrylmy]

I have been using the script with great success! However, the recent update to 7.0.15 seems to have broken it. Can you confirm or provide fix?

[ramonmi]

So, which script are you using?

[darrylmy]

Sorry for not providing the details. I was referencing the first script provided above by thalient-ai.

[ramonmi]

I have tested it in both Zotero 7.0.15 and Zotero 7.1-beta and the script worked well for me. So what error appears? Better to provide more details about the reproduce procedures.