Links GREP Rename
Script for Adobe InDesign
Use GREP (regular expressions) to change the file names of existing links and update each link.
For files already renamed, see Links GREP Relink.
- Rename links and update using GREP pattern replacement
- Option to ignore letter case
- Adapt open source to customize or create other scripts
Links GREP Rename
How-to Videos
How to use the script
The interface has one section: Link file name. Set the GREP pattern and replacement, then click the OK button to begin. A progress bar is displayed as links are processed.
Section 1: Link file name
Find what — the GREP pattern to match. Works the same as when using the InDesign Find/Change dialog. For each link in the document, the file’s base name (file name without extension) is tested against the pattern. By excluding extension, GREP patterns never change the file type to which a graphic is linked.
Change to — the GREP replacement to use when the pattern above is matched. Works the same as when using the InDesign Find/Change dialog. For each link that matches the find pattern, the file’s base name (file name without extension) is renamed using the change value, and then the file is relinked.
Ignore letter case — adds the “i” switch to the regular expression, making it case-insensitive.
Source code
(download button below)
/*
Links GREP Rename
Copyright 2023 William Campbell
All Rights Reserved
https://www.marspremedia.com/contact
Permission to use, copy, modify, and/or distribute this software
for any purpose with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
(function () {
var title = "Links GREP Rename";
if (!/indesign/i.test(app.name)) {
alert("Script for InDesign", title, false);
return;
}
var count;
var doc; // Document
var doneMessage;
var error;
var progress;
// Reusable UI variables.
var g; // group
var gc1; // group (column)
var gc2; // group (column)
var p; // panel
var w; // window
// Permanent UI variables.
var btnCancel;
var btnOk;
var cbIgnoreCase;
var inpFind;
var inpChange;
// SETUP
// Script requires open document.
if (!app.documents.length) {
alert("Open a document", title, false);
return;
}
doc = app.activeDocument;
// CREATE PROGRESS WINDOW
progress = new Window("palette", "Progress", undefined, {
"closeButton": false
});
progress.t = progress.add("statictext");
progress.t.preferredSize.width = 450;
progress.b = progress.add("progressbar");
progress.b.preferredSize.width = 450;
progress.display = function (message) {
message && (this.t.text = message);
this.show();
this.update();
};
progress.increment = function () {
this.b.value++;
};
progress.set = function (steps) {
this.b.value = 0;
this.b.minvalue = 0;
this.b.maxvalue = steps;
};
// CREATE USER INTERFACE
w = new Window("dialog", title);
w.alignChildren = "fill";
// Panel 'Link file name'.
p = w.add("panel", undefined, "Link file name");
p.alignChildren = "left";
p.margins = [24, 24, 24, 18];
p.spacing = 24;
// Group of 2 columns.
g = p.add("group");
// Groups, columns 1 and 2.
gc1 = g.add("group");
gc1.orientation = "column";
gc1.alignChildren = "left";
gc2 = g.add("group");
gc2.orientation = "column";
gc2.alignChildren = "left";
// Rows.
gc1.add("statictext", undefined, "Find what:").preferredSize.height = 23;
inpFind = gc2.add("edittext");
inpFind.preferredSize = [360, 23];
gc1.add("statictext", undefined, "Change to:").preferredSize.height = 23;
inpChange = gc2.add("edittext");
inpChange.preferredSize = [360, 23];
// Checkbox ignore case.
cbIgnoreCase = p.add("checkbox", undefined, "Ignore letter case");
// Action Buttons
g = w.add("group");
g.alignment = "center";
btnOk = g.add("button", undefined, "OK");
btnCancel = g.add("button", undefined, "Cancel");
// Panel Copyright
p = w.add("panel");
p.add("statictext", undefined, "Copyright 2023 William Campbell");
// UI ELEMENT EVENT HANDLERS
btnOk.onClick = function () {
if (!inpFind.text) {
alert("Enter a value for 'Find what'");
return;
}
if (!confirm("WARNING!\nFiles on disk will be renamed and this cannot be undone. Make backup copies of files before proceeding. Are you sure you want to continue?", true, title)) {
return;
}
w.close(1);
};
btnCancel.onClick = function () {
w.close(0);
};
// DISPLAY THE DIALOG
if (w.show() == 1) {
doneMessage = "";
try {
process();
doneMessage = count + " links renamed";
} catch (e) {
error = error || e;
doneMessage = "An error has occurred.\nLine " + error.line + ": " + error.message;
}
progress.close();
doneMessage && alert(doneMessage, title, error);
}
//====================================================================
// END PROGRAM EXECUTION, BEGIN FUNCTIONS
//====================================================================
function process() {
var extension;
var file;
var fileNew;
var fileVersion;
var i;
var ii;
var link;
var baseName;
var nameChanged;
var nameNew;
var pattern;
progress.display("Initializing...");
count = 0;
pattern = new RegExp(inpFind.text, "g" + (cbIgnoreCase.value ? "i" : ""));
progress.set(doc.links.length);
for (i = 0; i < doc.links.length; i++) {
link = doc.links[i];
file = new File(link.filePath);
progress.increment();
progress.display(link.name);
// Split filename into base name and extension.
baseName = link.name.replace(/\.[^\.]*$/, "");
extension = String(String(link.name.match(/\..*$/) || "").match(/[^\.]*$/) || "");
nameChanged = baseName.replace(pattern, inpChange.text);
// Did name change?
if (nameChanged != baseName) {
// Test if file with name exists.
nameNew = nameChanged;
fileVersion = 0;
fileNew = new File(file.path + "/" + nameNew + "." + extension);
while (fileNew.exists) {
// File exists. Add version suffix.
fileVersion++;
nameNew = nameChanged + "~" + fileVersion;
fileNew = new File(file.path + "/" + nameNew + "." + extension);
}
// Rename and relink.
if (file.exists) {
progress.display(link.name + " -> " + nameNew + "." + extension);
file.rename(nameNew + "." + extension);
// Loop through all graphics and relink.
// Graphic could be placed more than once.
for (ii = 0; ii < doc.links.length; ii++) {
if (doc.links[ii].name == link.name) {
doc.links[ii].relink(file);
doc.links[ii].update();
count++;
}
}
}
}
}
}
})();Links GREP Rename
For help installing scripts, see How to Install and Use Scripts in Adobe Creative Cloud Applications.
IMPORTANT: scripts are developed for the latest Adobe Creative Cloud applications. Many scripts work in CC 2018 and later, even some as far back as CS6, but may not perform as expected, or run at all, when used in versions prior to 2018. Photoshop features Select Subject and Preserve Details 2.0 definitely fail prior to CC 2018 (version 19) as the features do not exist in earlier versions. For best results use the latest versions of Adobe Creative Cloud applications.
IMPORTANT: by downloading any of the scripts on this page you agree that the software is provided without any warranty, express or implied. USE AT YOUR OWN RISK. Always make backups of important data.
IMPORTANT: fees paid for software products are the purchase of a non-exclusive license to use the software product and do not grant the purchaser any degree of ownership of the software code. Author of the intellectual property and copyright holder William Campbell retains 100% ownership of all code used in all software products regardless of the inspiration for the software product design or functionality.
