From d6d2dfa6b2758b0acfd8f4c13a5d32bde2a2ca0a Mon Sep 17 00:00:00 2001
From: Joel Wong <127782171+joel-wong-aws@users.noreply.github.com>
Date: Mon, 10 Jun 2024 11:50:20 -0500
Subject: [PATCH] feat: add KeyShot 2024 support (#91)

Signed-off-by: Joel Wong <127782171+joel-wong-aws@users.noreply.github.com>
---
 README.md                                     |  8 +-
 .../deadline-cloud-for-keyshot.xml            | 83 +++++++++++--------
 2 files changed, 51 insertions(+), 40 deletions(-)

diff --git a/README.md b/README.md
index ce1d136..7445518 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ AWS Deadline Cloud for KeyShot is a python package that allows users to create [
 ## Compatibility
 
 This library requires:
-1. KeyShot 2023
+1. KeyShot 2023 or 2024
 1. Python 3.9 or higher; and
 1. Windows, or a macOS operating system.
 
@@ -28,7 +28,7 @@ This package provides a KeyShot plugin script that creates jobs for AWS Deadline
 1. Install deadline and Pyside6
     - e.g. `pip install deadline[gui]`
 2. Copy or link the file `deadline-cloud-for-keyshot/keyshot_script/Submit to AWS Deadline Cloud.py` to the KeyShot scripts folder.
-    - e.g. On Windows `C:/Users/<USER>/Documents/KeyShot 12/Scripts`
+    - e.g. On Windows `C:/Users/<USER>/Documents/KeyShot/Scripts`
 3. Set the following environment variables
     - Set the environment variable `DEADLINE_PYTHON` as the path to the Python installation where deadline-cloud and PySide2 were installed in step 1.
       - e.g. On Windows if using Python 3.10 it might be `set DEADLINE_PYTHON=C:/Users/<USER>/AppData/Local/Programs/Python/Python310/python`
@@ -70,8 +70,8 @@ Jobs created by the submitter use this adaptor by default.
 3. Configure licensing for KeyShot by setting the environment variable `LUXION_LICENSE_FILE=<PORT>:<ADDRESS>` to point towards the license server to use
     - e.g. `setx LUXION_LICENSE_FILE "2703@127.0.0.1"`
 4. The adaptor expects the keyshot_headless executable is available through the PATH environment variable.
-    - e.g. Local install: `setx PATH "%LOCALAPPDATA%\KeyShot12\bin;%PATH%"`
-    - e.g. System install: `setx PATH "%PROGRAMFILES%\KeyShot12\bin;%PATH%"`
+    - e.g. Local install: `setx PATH "%LOCALAPPDATA%\KeyShot\bin;%PATH%"`
+    - e.g. System install: `setx PATH "%PROGRAMFILES%\KeyShot\bin;%PATH%"`
     - Verify by running `keyshot_headless -h`
 
 ## Versioning
diff --git a/install_builder/deadline-cloud-for-keyshot.xml b/install_builder/deadline-cloud-for-keyshot.xml
index a836deb..d2771ae 100644
--- a/install_builder/deadline-cloud-for-keyshot.xml
+++ b/install_builder/deadline-cloud-for-keyshot.xml
@@ -1,6 +1,6 @@
 <component>
     <name>deadline_cloud_for_keyshot</name>
-    <description>Deadline Cloud for KeyShot 12</description>
+    <description>Deadline Cloud for KeyShot 2023/2024</description>
     <detailedDescription>KeyShot plugin for submitting jobs to AWS Deadline Cloud.</detailedDescription>
     <canBeEdited>1</canBeEdited>
     <selected>0</selected>
@@ -8,7 +8,7 @@
     <folderList>
         <folder>
             <description>KeyShot Plug-in Script</description>
-            <destination>${keyshot_scripts_folder}</destination>
+            <destination>${keyshot_scripts_directory}</destination>
             <name>keyshotplugin</name>
             <platforms>all</platforms>
             <distributionFileList>
@@ -56,8 +56,6 @@
                 <setInstallerVariable name="component(deadline_cloud_for_keyshot).show" value="0"/>
             </elseActionList>
         </if>
-    </initializationActionList>
-    <readyToInstallActionList>
         <setInstallerVariable name="keyshot_installdir" value="${installdir}\Submitters\KeyShot" />
         <if>
             <conditionRuleList>
@@ -65,54 +63,55 @@
             </conditionRuleList>
             <actionList>
                 <setInstallerVariable name="keyshot_deps_platform" value="windows" />
-                <setInstallerVariable name="win_user_keyshot_script_folder" value="${user_home_directory}\Documents\KeyShot 12\Scripts" />
-                <setInstallerVariable name="win_system_keyshot_script_folder" value="${windows_folder_common_documents}\KeyShot 12\Scripts" />
-                <if>
-                    <conditionRuleList>
-                        <fileExists path="${win_user_keyshot_script_folder}" />
-                    </conditionRuleList>
-                    <actionList>
-                        <setInstallerVariable name="keyshot_scripts_folder" value="${win_user_keyshot_script_folder}" />
-                    </actionList>
-                    <elseActionList>
-                        <if>
-                            <conditionRuleList>
-                                <fileExists path="${win_system_keyshot_script_folder}" />
-                            </conditionRuleList>
-                            <actionList>
-                                <setInstallerVariable name="keyshot_scripts_folder" value="${win_system_keyshot_script_folder}" />
-                            </actionList>
-                            <elseActionList>
-                                <setInstallerVariable name="keyshot_scripts_folder" value="${keyshot_installdir}" />
-                                <showWarning text="No installation of KeyShot 12 was found. Please manually move the 'Submit to AWS Deadline Cloud.py' script into the KeyShot scripts folder to use the plug-in." />
-                            </elseActionList>
-                        </if>
-                    </elseActionList>
-                </if>
             </actionList>
         </if>
         <if>
             <conditionRuleList>
-                <platformTest type="osx"/>
+                <compareText>
+                    <text>${env(KEYSHOT)}</text>
+                    <logic>does_not_equal</logic>
+                    <value></value>
+                </compareText>
             </conditionRuleList>
             <actionList>
-                <setInstallerVariable name="keyshot_deps_platform" value="macos"/>
-                <setInstallerVariable name="mac_keyshot_scripts_folder" value="${platform_install_prefix}/Application Support/KeyShot12/Scripts"/>
+                <!-- KeyShot 2024 (and possibly beyond) env var -->
+                <setInstallerVariable name="keyshot_resources_directory" value="${env(KEYSHOT)}"/>
+            </actionList>
+            <elseActionList>
                 <if>
                     <conditionRuleList>
-                        <fileExists path="${mac_keyshot_scripts_folder}" />
+                        <compareText>
+                            <text>${env(KEYSHOT12)}</text>
+                            <logic>does_not_equal</logic>
+                            <value></value>
+                        </compareText>
                     </conditionRuleList>
                     <actionList>
-                        <setInstallerVariable name="keyshot_scripts_folder" value="${mac_keyshot_scripts_folder}"/>
+                        <!-- KeyShot 2023 env var -->
+                        <setInstallerVariable name="keyshot_resources_directory" value="${env(KEYSHOT12)}"/>
                     </actionList>
                     <elseActionList>
-                        <setInstallerVariable name="keyshot_scripts_folder" value="${keyshot_installdir}" />
-                        <showWarning text="No installation of KeyShot 12 was found. Please manually move the 'Submit to AWS Deadline Cloud.py' script into the KeyShot scripts folder to use the plug-in." />
+                        <setInstallerVariable name="keyshot_resources_directory" value=""/>
                     </elseActionList>
                 </if>
+            </elseActionList>
+        </if>
+        <if>
+            <conditionRuleList>
+                <compareText>
+                    <text>${keyshot_resources_directory}</text>
+                    <logic>does_not_equal</logic>
+                    <value></value>
+                </compareText>
+            </conditionRuleList>
+            <actionList>
+                <setInstallerVariable name="keyshot_scripts_directory" value="${keyshot_resources_directory}\Scripts"/>
             </actionList>
+            <elseActionList>
+                <setInstallerVariable name="keyshot_scripts_directory" value=""/>
+            </elseActionList>
         </if>
-    </readyToInstallActionList>
+    </initializationActionList>
     <parameterList>
         <stringParameter name="deadline_cloud_for_keyshot_summary" ask="0" cliOptionShow="0">
             <value>Deadline Cloud for KeyShot
@@ -121,6 +120,18 @@
 - Sets the DEADLINE_KEYSHOT environment variable to point the Submit to AWS Deadline Cloud script to the submitter module
             </value>
         </stringParameter>
+        <directoryParameter>
+            <name>keyshot_scripts_directory</name>
+            <description>KeyShot Scripts Directory</description>
+            <explanation>Path to scripts directory in the KeyShot resources directory. For easiest installation, KeyShot should be installed before installing Deadline Cloud for KeyShot.</explanation>
+            <allowEmptyValue>0</allowEmptyValue>
+            <default>Will be detected from the KEYSHOT or KEYSHOT12 environment variables during installation. If neither exists and the KeyShot component is enabled, this must be input.</default>
+            <ask>yes</ask>
+            <cliOptionName>keyshot-scripts-directory</cliOptionName>
+            <cliOptionText>Path to scripts directory in the KeyShot resources directory. For easiest installation, KeyShot should be installed before installing Deadline Cloud for KeyShot.</cliOptionText>
+            <mustBeWritable>yes</mustBeWritable>
+            <mustExist>1</mustExist>
+        </directoryParameter>
     </parameterList>
     <postInstallationActionList>
         <unzip>