Community Expert
,
Downloading JavaScript Files Many legacy ExtendScript-based scripts are offered in .js or .jsx or even .jsxbin formats. Simply downloa...
TOPICS
Actions and scripting
,
macOS
,
Windows
Explore related tutorials & articles
4
Replies
4
4
Replies
Stephen Marsh
AUTHOR
Community Expert
,
This is a game changer - thank you so much for taking time to write this!
By kimikalfoto
Thank you, I'm glad that you found this useful and took the time to comment.
Stephen Marsh
AUTHOR
Community Expert
,
I have combined both session scripts into a single script with an interface!
* Preserves Document State: Automatically saves and closes all open documents.
* Restores Active Documents: The previously active document regains focus when the session is restored.
* Session Overview: Optionally view the list of documents from the saved session.
* Permanent Session Saving: Save and restore sessions even after quitting Photoshop.
* Multiple Version Support: Each session is linked to the Photoshop version used when the script is run. This way you can keep projects separate when using version-specific features.
At this time, only one session is saved. Looking at how Krita works with sessions, a future version may offer the ability to save and restore multiple sessions...
/*
Save & Restore Photoshop Session scriptUI GUI.jsx
v1.0 - 27th October 2024, Stephen Marsh
https://community.adobe.com/t5/photoshop-ecosystem-discussions/scripts-to-save-amp-restore-photoshop-sessions/m-p/14239969
Inspiration from:
https://community.adobe.com/t5/photoshop-ecosystem-ideas/please-session-saving/idc-p/14169472
https://community.adobe.com/t5/photoshop-ecosystem-ideas/restore-previous-session/idc-p/14189928
*/
#target photoshop
// Set the main UI window
var dlg = new Window("dialog", "Photoshop Session Manager (v1.0)");
dlg.orientation = "column";
dlg.alignChildren = ["fill", "top"];
dlg.preferredSize.width = 425;
// Radio buttons to select which script to run
var radioGroup = dlg.add("panel", undefined, "Save or Restore Session Documents");
radioGroup.orientation = "row";
radioGroup.alignChildren = ["left", "center"];
var saveRadio = radioGroup.add("radiobutton", undefined, "Save Current Session");
var restoreRadio = radioGroup.add("radiobutton", undefined, "Restore Saved Session");
saveRadio.value = true;
// Add checkbox for viewing saved sessions
var viewSessionsCheckbox = dlg.add("checkbox", undefined, "View Saved Session Document List");
viewSessionsCheckbox.enabled = false; // Initially disabled since Save Session is selected by default
// Update checkbox enabled state when radio buttons change
saveRadio.onClick = function () {
viewSessionsCheckbox.enabled = false;
viewSessionsCheckbox.value = false;
};
restoreRadio.onClick = function () {
viewSessionsCheckbox.enabled = true;
};
// Create button group
var buttonGroup = dlg.add("group");
buttonGroup.orientation = "row";
buttonGroup.alignChildren = ["right", "center"];
var cancelButton = buttonGroup.add("button", undefined, "Cancel");
var okButton = buttonGroup.add("button", undefined, "OK", { name: "ok" });
cancelButton.onClick = function () {
dlg.close();
};
okButton.onClick = function () {
if (saveRadio.value) {
// Check for open documents before proceeding with save
if (app.documents.length === 0) {
alert('A document must be open when running this script!');
return;
}
saveSession();
} else if (restoreRadio.value) {
if (viewSessionsCheckbox.value) {
showRestoreSessionWindow(); // Open the restore session window
} else {
restoreSession(); // Direct restore without showing the list
}
}
dlg.close();
};
// Function to show the restore session window
function showRestoreSessionWindow() {
// ~/Library/Preferences/Adobe Photoshop 2024 Settings/
var logFilePath = new File(app.preferencesFolder + "/" + "Photoshop Session Document Paths.log");
if (logFilePath.exists && logFilePath.length > 0) {
var logContents = readPref(logFilePath);
// Create a new window to display the log contents
var restoreWindow = new Window("dialog", "Saved Session List");
restoreWindow.orientation = "column";
restoreWindow.alignChildren = ["fill", "top"];
restoreWindow.preferredSize.width = 375;
// Add a static text area to show log contents
var logTextArea = restoreWindow.add("edittext", undefined, logContents.join("\n"), { multiline: true, scrollable: true });
logTextArea.preferredSize.height = 200;
logTextArea.enabled = false; // Make it read-only
// Create a button group for Restore and Cancel
var restoreButtonGroup = restoreWindow.add("group");
restoreButtonGroup.orientation = "row";
restoreButtonGroup.alignChildren = ["right", "center"];
var restoreCancelButton = restoreButtonGroup.add("button", undefined, "Cancel");
var restoreButton = restoreButtonGroup.add("button", undefined, "Restore", { name: "restore" });
restoreCancelButton.onClick = function () {
restoreWindow.close();
};
restoreButton.onClick = function () {
restoreSession();
restoreWindow.close();
};
restoreWindow.show(); // Show the restore session window
} else {
alert("The log file 'Photoshop Session Document Paths.log' doesn't exist or is empty!");
}
}
// Functions
function saveSession() {
try {
// ~/Library/Preferences/Adobe Photoshop 2024 Settings/
var logFile = new File(app.preferencesFolder + "/" + "Photoshop Session Document Paths.log");
if (logFile.exists) logFile.remove();
// Log the active document name on line 2
logFile.open("a");
logFile.writeln("--------------------\nActive Doc:\n" + activeDocument.name + "\n--------------------");
logFile.close();
while (app.documents.length > 0) {
app.activeDocument = app.documents[0];
try {
activeDocument.path;
if (ExternalObject.AdobeXMPScript === undefined)
ExternalObject.AdobeXMPScript = new ExternalObject('lib:AdobeXMPScript');
var xmp = new XMPMeta(activeDocument.xmpMetadata.rawData);
var crsMeta = xmp.getProperty(XMPConst.NS_CAMERA_RAW, "Version");
if ((/\.(RAF|CR2|CR3|NRW|ERF|RW2|NEF|ARW|RWZ|EIP|DNG|BAY|DCR|RAW|CRW|3FR|K25|KC2|MEF|DNG|CS1|ORF|ARI|SR2|MOS|CR3|GPR|SRW|MFW|FFF|SRF|KDC|MRW|J6I|RWL|X3F|PEF|IIQ|CXI|NKSC|MDC)$/i).test(activeDocument.fullName) === true && crsMeta !== undefined) {
saveAsDefault();
writePathToLog();
activeDocument.close(SaveOptions.DONOTSAVECHANGES);
} else if (activeDocument.path) {
writePathToLog();
activeDocument.close(SaveOptions.SAVECHANGES);
}
} catch (e) {
executeAction(stringIDToTypeID("save"), undefined, DialogModes.ALL);
writePathToLog();
activeDocument.close(SaveOptions.SAVECHANGES);
}
}
} catch (e) {
alert("Error: " + e.message);
}
}
function restoreSession() {
try {
var logFilePath = readPref(app.preferencesFolder + "/" + "Photoshop Session Document Paths.log");
var hasAlerted = false;
if (logFilePath.length > 0) {
// Restore documents from the log file
for (var m = 4; m < logFilePath.length; m++) {
var filePath = logFilePath[m].replace(/^\s+|\s+$/g, ''); // Remove leading/trailing whitespace
if (filePath !== "") { // Check if the path is not empty
var docFile = new File(filePath);
if (docFile.exists) {
open(docFile);
} else {
alert("File not found: " + filePath);
}
}
}
// Set the previously active document after the session has been restored
var theActiveDocName = logFilePath[2]; // zero indexed, third line
for (var a = 0; a < app.documents.length; a++) {
if (app.documents[a].name === theActiveDocName) {
app.activeDocument = app.documents[a];
break;
}
}
} else {
alert("The log file 'Photoshop Session Document Paths.log' doesn't exist or is empty!");
hasAlerted = true;
}
} catch (e) {
alert("Error: " + e.message);
}
}
function writePathToLog() {
var decodedPath = decodeURI(activeDocument.path);
var decodedFilename = decodeURI(activeDocument.name);
var logFile = new File(app.preferencesFolder + "/" + "Photoshop Session Document Paths.log");
var os = $.os.toLowerCase().indexOf("mac") >= 0 ? "mac" : "windows";
logFile.open("a");
logFile.encoding = "UTF-8";
logFile.lineFeed = os === "mac" ? "Unix" : "Windows";
logFile.writeln(decodedPath + "/" + decodedFilename);
logFile.close();
}
function saveAsDefault() {
function s2t(s) { return app.stringIDToTypeID(s); }
var descriptor = new ActionDescriptor();
descriptor.putObject(s2t("as"), s2t("photoshop35Format"), descriptor);
descriptor.putPath(s2t("in"), new File("~/Desktop" + "/" + activeDocument.name));
descriptor.putBoolean(s2t("lowerCase"), true);
executeAction(s2t("save"), descriptor, DialogModes.ALL);
}
function readPref(thePath) {
var logFile = new File(thePath);
var logContents = [];
if (logFile.exists) {
logFile.open("r");
while (!logFile.eof) {
logContents.push(logFile.readln());
}
logFile.close();
}
return logContents;
}
// Show the main dialog
dlg.show();
https://prepression.blogspot.com/2017/11/downloading-and-installing-adobe-scripts.html
I have updated the v1.0 GUI script to v2.X, now supporting multiple auto-named or custom-named sessions!
Features:
* Preserves Document State: Automatically saves and closes all open documents.
* Session Naming: Save the session log using an automatic date/time stamp or an optional custom name.
* Restore Active Document Focus: The previously active document regains focus when the session is restored.
* Session List: View and select from a list of multiple saved session logs.
* View Log: Optionally view the list of documents from the saved session logs.
* Log Management: Options to delete selected log files or open the preference folder for manual management of log files.
* Permanent Session Saving: Save and restore sessions even after quitting Photoshop.
* Multiple Version Support: Each session is linked to the Photoshop version used when running the script. This way you can keep projects separate when using version-specific features.
/*
Save & Restore Photoshop Session scriptUI GUI v2-3.jsx
Stephen Marsh
v1.0 - 27th October 2024, Single session save/restore
v2.0 - 27th October 2024, Extended the script to work with multiple sessions
v2.1 - 2nd November 2024, Minor cosmetic layout changes, log files now listed in descending modified sort order
v2.2 - 9th November 2024, Geek update - exploring semi-structured data, the log files are written and read in .json format instead of plain .txt format
v2.3 - 13th November 2024, Added an option to prompt to save modified documents when closing a session, in addition to the previous save and close option
https://community.adobe.com/t5/photoshop-ecosystem-discussions/scripts-to-save-amp-restore-photoshop-sessions/m-p/14239969
Inspiration from:
https://community.adobe.com/t5/photoshop-ecosystem-ideas/please-session-saving/idc-p/14169472
https://community.adobe.com/t5/photoshop-ecosystem-ideas/restore-previous-session/idc-p/14189928
*/
#target photoshop
// Set the main UI window
var dlg = new Window("dialog", "Photoshop Session Manager (v2.3)");
dlg.orientation = "column";
dlg.alignChildren = ["fill", "top"];
dlg.preferredSize.width = 450;
// Checkbox panel to select the save or restore functions
var checkboxGroup = dlg.add("panel", undefined, "Save or Restore Session Documents");
checkboxGroup.orientation = "column";
checkboxGroup.alignChildren = ["left", "center"];
// Group the checkboxes in a nested panel to keep them mutually exclusive
var buttonPanel = checkboxGroup.add("group");
buttonPanel.orientation = "column";
buttonPanel.alignChildren = ["left", "center"];
// "Save Current Session" checkbox
var saveCheckbox = buttonPanel.add("checkbox", undefined, "Save Current Session Documents");
saveCheckbox.value = true;
// Add radio buttons for save behavior
var saveOptionsGroup = buttonPanel.add("group");
saveOptionsGroup.orientation = "row";
saveOptionsGroup.alignChildren = ["left", "center"];
saveOptionsGroup.margins = [20, 0, 0, 0]; // Add left margin for indentation
var saveAndCloseRadio = saveOptionsGroup.add("radiobutton", undefined, "Save && Close");
var promptAndCloseRadio = saveOptionsGroup.add("radiobutton", undefined, "Prompt to Save && Close");
saveAndCloseRadio.value = true; // Default selection
// Optional session naming field label
var sessionNameHelp = buttonPanel.add("statictext", undefined, "Optional Custom Session Name:");
// Optional session naming field
var sessionNameInput = buttonPanel.add("edittext", undefined, "");
sessionNameInput.helpTip = "(Leave blank to use timestamp as session name)";
sessionNameInput.preferredSize.width = 450;
// Panel separator line
var separatorLine = buttonPanel.add("panel");
separatorLine.alignment = "fill";
separatorLine.preferredSize.height = 1;
// "Restore Saved Session" checkbox
var restoreCheckbox = buttonPanel.add("checkbox", undefined, "Restore Saved Session Documents");
// Create restore session panel (initially inactive)
var restorePanel = dlg.add("panel", undefined, "Restore Saved Session Options");
restorePanel.orientation = "column";
restorePanel.alignChildren = ["fill", "top"];
restorePanel.visible = true;
// Create listbox for session logs
var logList = restorePanel.add("listbox", undefined, [], { multiselect: false });
logList.preferredSize = [450, 150];
// Add management controls checkbox
var enableManagementCheckbox = restorePanel.add("checkbox", undefined, "Session Log File Management");
enableManagementCheckbox.value = false;
// Create management buttons group
var managementButtonGroup = restorePanel.add("group");
managementButtonGroup.orientation = "row";
managementButtonGroup.alignChildren = ["fill", "center"];
var viewButton = managementButtonGroup.add("button", undefined, "View Log");
var deleteButton = managementButtonGroup.add("button", undefined, "Delete Selected Log");
var openFolderButton = managementButtonGroup.add("button", undefined, "Open Log Directory");
// Initially disable the management buttons
openFolderButton.enabled = false;
deleteButton.enabled = false;
viewButton.enabled = false;
// Create button group for main dialog
var buttonGroup = dlg.add("group");
buttonGroup.orientation = "row";
buttonGroup.alignChildren = ["right", "center"];
var cancelButton = buttonGroup.add("button", undefined, "Cancel");
var saveButton = buttonGroup.add("button", undefined, "Save", { name: "save" });
saveButton.preferredSize.width = 90;
// Checkbox handlers for radio button-like behavior
saveCheckbox.onClick = function () {
// If trying to uncheck the currently checked box
if (!saveCheckbox.value && !restoreCheckbox.value) {
// Prevent unchecking by keeping this checkbox checked
saveCheckbox.value = true;
return;
}
if (saveCheckbox.value) {
restoreCheckbox.value = false;
setPanelEnabledState(false);
saveButton.text = "Save";
saveButton.enabled = true;
}
dlg.layout.layout(true);
};
restoreCheckbox.onClick = function () {
// If trying to uncheck the currently checked box
if (!restoreCheckbox.value && !saveCheckbox.value) {
// Prevent unchecking by keeping this checkbox checked
restoreCheckbox.value = true;
return;
}
if (restoreCheckbox.value) {
saveCheckbox.value = false;
setPanelEnabledState(true);
saveButton.text = "Restore";
refreshLogListByModifed();
saveButton.enabled = logList.selection && logList.selection.file;
}
dlg.layout.layout(true);
};
// Initialize with save checkbox selected by default
saveCheckbox.value = true;
restoreCheckbox.value = false;
setPanelEnabledState(false);
// Ensure Save button state updates if logList selection changes
logList.onChange = function () {
if (restoreCheckbox.value) {
saveButton.enabled = logList.selection && logList.selection.file;
}
};
// Checkbox handler
enableManagementCheckbox.onClick = function () {
openFolderButton.enabled = this.value;
deleteButton.enabled = this.value && logList.selection && logList.selection.file;
};
// Open folder button handler
openFolderButton.onClick = function () {
Folder(app.preferencesFolder).execute();
};
// Delete button handler
deleteButton.onClick = function () {
if (logList.selection && logList.selection.file) {
var selectedFile = logList.selection.file;
var confirmDelete = confirm("Are you sure you want to delete the selected log file?\n" + decodeURI(selectedFile.name));
if (confirmDelete) {
try {
selectedFile.remove();
refreshLogListByModifed();
} catch (e) {
alert("Error deleting file: " + e.message);
}
}
}
};
// View button handler
viewButton.onClick = function () {
if (logList.selection && logList.selection.file) {
viewLogContents(logList.selection.file);
}
};
// Cancel button handler
cancelButton.onClick = function () {
dlg.close();
};
// Save button handler with exit/return
saveButton.onClick = function () {
if (saveCheckbox.value) {
if (app.documents.length === 0) {
alert("No documents open in the current session to save.");
dlg.close();
return;
}
saveSession();
dlg.close();
} else if (restoreCheckbox.value && logList.selection && logList.selection.file) {
restoreSession(logList.selection.file);
dlg.close();
}
};
// Show the main script dialog window
dlg.show();
// Functions
function setPanelEnabledState(state) {
logList.enabled = state;
enableManagementCheckbox.enabled = state;
openFolderButton.enabled = state && enableManagementCheckbox.value;
deleteButton.enabled = state && enableManagementCheckbox.value;
viewButton.enabled = state && logList.selection && logList.selection.file;
sessionNameInput.enabled = !state; // Enable session name input only when saving
saveOptionsGroup.enabled = !state; // Enable radio buttons only when saving
// Set the text color to dimmed gray when restore is active
sessionNameHelp.graphics.foregroundColor = sessionNameHelp.graphics.newPen(
sessionNameHelp.graphics.PenType.SOLID_COLOR,
state ? [0.5, 0.5, 0.5] : [1, 1, 1],
1
);
}
function refreshLogListByModifed() {
logList.removeAll();
// ~/Library/Preferences/Adobe Photoshop #### Settings
var logFilePath = Folder(app.preferencesFolder);
var logFiles = logFilePath.getFiles("Photoshop Session - *.json");
if (logFiles && logFiles.length > 0) {
// Sort the files by modified date in descending order
logFiles.sort(function (a, b) {
return b.modified - a.modified;
});
// Add each log file to the list
for (var i = 0; i < logFiles.length; i++) {
var logFile = logFiles[i];
var item = logList.add("item", decodeURI(logFile.name));
item.file = logFile;
}
logList.selection = 0;
deleteButton.enabled = enableManagementCheckbox.value;
openFolderButton.enabled = enableManagementCheckbox.value;
viewButton.enabled = true;
saveButton.enabled = true;
} else {
logList.add("item", "No session log files found");
deleteButton.enabled = false;
openFolderButton.enabled = false;
viewButton.enabled = false;
saveButton.enabled = false;
}
}
function restoreSession(jsonFile) {
try {
// Read and parse JSON file
jsonFile.open("r");
var jsonData = jsonFile.read();
jsonFile.close();
var sessionData = JSON.parse(jsonData);
var filePaths = sessionData.filePaths;
var theActiveDocName = sessionData.activeDocumentName;
// Open each file in the session data
for (var i = 0; i < filePaths.length; i++) {
var filePath = filePaths[i];
var docFile = new File(filePath);
if (docFile.exists) {
open(docFile);
} else {
alert("File not found: " + filePath);
}
}
// Set the active document based on session data
for (var a = 0; a < app.documents.length; a++) {
if (app.documents[a].name === theActiveDocName) {
app.activeDocument = app.documents[a];
break;
}
}
} catch (e) {
alert("Error restoring session: " + e.message);
}
}
function saveSession() {
try {
var theDate = new Date();
var year = theDate.getFullYear();
var month = ('0' + (theDate.getMonth() + 1)).slice(-2);
var day = ('0' + theDate.getDate()).slice(-2);
var hours = ('0' + theDate.getHours()).slice(-2);
var minutes = ('0' + theDate.getMinutes()).slice(-2);
var seconds = ('0' + theDate.getSeconds()).slice(-2);
var formattedDate = year + '-' + month + '-' + day + '_' + hours + ':' + minutes + ':' + seconds;
var sessionName = sessionNameInput.text.replace(/^\s+|\s+$/g, ''); // remove leading and trailing whitespace
var fileName = sessionName !== "" ? sessionName : formattedDate;
fileName = fileName.replace(/[<>:"\/\\|?*]/g, "-");
var jsonFile = new File(app.preferencesFolder + "/" + "Photoshop Session - " + fileName + ".json");
// Add confirmation check if file exists
if (jsonFile.exists) {
var confirmOverwrite = confirm("A session file with this name already exists:\n" +
decodeURI(jsonFile.name) +
"\n\nDo you want to overwrite it?");
if (!confirmOverwrite) {
// If user cancels, return without saving
return;
}
// If confirmed, remove the existing file
jsonFile.remove();
}
// Create JSON structure for the session data
var sessionData = {
sessionName: fileName,
activeDocumentName: activeDocument.name,
filePaths: []
};
// Collect file paths from open documents
while (app.documents.length > 0) {
app.activeDocument = app.documents[0];
try {
var filePath = activeDocument.fullName.fsName;
sessionData.filePaths.push(filePath);
} catch (e) { }
// Use the selected save option
var saveOption = saveAndCloseRadio.value ? SaveOptions.SAVECHANGES : SaveOptions.PROMPTTOSAVECHANGES;
activeDocument.close(saveOption);
}
// Write JSON data to file
jsonFile.open("w");
jsonFile.write(JSON.stringify(sessionData, null, 4)); // Beautify output with 4 space indent/tab
jsonFile.close();
} catch (e) {
alert("Error saving session: " + e.message);
}
}
function viewLogContents(logFile) {
// Read the log file contents and join lines with a newline character
var logContents = readPref(logFile).join("\n");
// Remove unwanted characters and replace specific terms
logContents = logContents
.replace(/[\{\\"\[\],]/g, "") // Remove unwanted characters
.replace(/sessionName:/g, "Session Name:")
.replace(/activeDocumentName:/g, "Active Document Name:")
.replace(/filePaths:/g, "Session File Paths:");
// Create a view window to display the log contents
var viewWindow = new Window("dialog", "Log Contents: " + decodeURI(logFile.name));
viewWindow.orientation = "column";
viewWindow.alignChildren = ["fill", "top"];
// Add a scrollable text area to display the log contents
var logTextArea = viewWindow.add("edittext", undefined, logContents, {
multiline: true,
scrollable: true
});
logTextArea.preferredSize.width = 550;
logTextArea.preferredSize.height = 300;
// Intercept key events to prevent modifications
logTextArea.addEventListener('keydown', function (event) {
event.preventDefault();
});
// Add a close button
var closeButtonGroup = viewWindow.add("group");
closeButtonGroup.orientation = "row";
closeButtonGroup.alignChildren = ["right", "center"];
var closeButton = closeButtonGroup.add("button", undefined, "Close");
closeButton.onClick = function () {
viewWindow.close();
};
// Show the log view window
viewWindow.show();
}
function writePref(logFile, string) {
logFile.open("e");
logFile.seek(0, 2);
logFile.writeln(string);
logFile.close();
}
function readPref(logFile) {
if (!logFile.exists) return [];
logFile.open("r");
var logContents = [];
while (!logFile.eof) {
logContents.push(logFile.readln());
}
logFile.close();
return logContents;
}
https://prepression.blogspot.com/2017/11/downloading-and-installing-adobe-scripts.html
AdChoices