[Share] Rename attachments in the form {{ciationkey}}_ItemKey_{{item key of attachment}}

[siocean]

Description

This script allows the user to rename .pdf and .epub attachments in the format of {{ciationkey}}_ItemKey_{{item key of attachment}} allowing external applications to take advantage of the item key to open the attachment directly in zotero by calling zotero://open-pdf/library/items/{item_key}.

It is recommended that you change your file renaming format to " " and turn off automatically rename attachments option in attanger or zotfile if you are using them because this is a renaming script they will interfere or overlap with its features.

Review and fixes are always warmly welcome!

Event

None

Operation

Script

Data

/**
 * Renames attachment of an in the format {{ciationkey}}_ItemKey_{{itemkey of attachment}}
 * @author siocean
 * @To open the attachment from outside of zotero into zotero if it is present in zotero in the first place
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/
 */
const Zotero = require("Zotero");

async function renameAttachment(attachment) {
    if (!attachment) {
        return { renamed: 0, errors: 1 };
    }

    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 };
    }

    // Get the citation key from the parent item
    const citationKey = parentItem.getField('citationKey');
    if (!citationKey) {
        Zotero.logError(`Citation key not found for parent item ${parentItem.id}.`);
        return { renamed: 0, errors: 1 };
    }

    // Get the current path and check if it's a PDF or EPUB
    const currentPath = await attachment.getFilePathAsync();
    if (!currentPath || !currentPath.match(/\.(pdf|epub)$/i)) {
        return { renamed: 0, errors: 0 };
    }

    // Construct the new filename
    const itemKey = attachment.key;
    const extension = currentPath.split('.').pop();
    const newName = `${citationKey}_ItemKey_${itemKey}.${extension}`;

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

(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;

    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 renameAttachment(attachment);
            totalRenamed += result.renamed;
            totalErrors += result.errors;
        }
    }

    // Display a summary alert only if more than one attachment has been renamed
    if (totalRenamed > 1 || totalErrors > 0) {
        Zotero.alert(null, "Rename Attachments", `[Rename Attachments] Successfully renamed ${totalRenamed} attachments. Errors: ${totalErrors}`);
    }
})();

Anything else

No response

[wzr-ms]

Could you please explain the differences between your renaming script and attanger's renaming functionality?

[siocean]

To my understanding, attanger uses zotero's filename renaming functionality. In zotero's file rename format you cannot access the attachments item key. See here for the complete list of available fields. This script allows the user to rename each attachment of the item with their unique item key assigned by zotero. If zotero made the item key of attachments as an available field to rename the attachment then we wouldn't need this script.