From 6e06d71a76252a45383cdb184f221d659da03a77 Mon Sep 17 00:00:00 2001
From: Pit64 <yrigaud@icloud.com>
Date: Sun, 16 Nov 2025 11:08:45 +0100
Subject: [PATCH] fix(frontend): add userscripts back

---
 RELEASE-NOTES.md                              |   1 -
 projects/frontend/data/resources/menu.xml     |   4 +-
 .../es-app/src/guis/menus/MenuProvider.cpp    |   7 ++
 .../menus/modaltasks/MenuModalUserScript.cpp  | 101 ++++++++++++++++++
 .../menus/modaltasks/MenuModalUserScript.h    |  94 ++++++++++++++++
 .../ScriptOutputListenerInterface.h           |   1 +
 6 files changed, 205 insertions(+), 3 deletions(-)
 create mode 100644 projects/frontend/es-app/src/guis/menus/modaltasks/MenuModalUserScript.cpp
 create mode 100644 projects/frontend/es-app/src/guis/menus/modaltasks/MenuModalUserScript.h

diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
index 7ff375fb39..1d5ea68367 100644
--- a/RELEASE-NOTES.md
+++ b/RELEASE-NOTES.md
@@ -31,7 +31,6 @@ as release notes for end user on a Recalbox upgrade.
 - Add Hyper Neo-Geo 64 virtual system
 - Add VVVVVV port
 - Add support customize iso from Raspberry Pi Imager (add sshkey, wifi, hostname and password)
-- Add manual script runnable from Recalbox interface
 - Add Tamagotchi (tamalibretro core)
 - Add NetPlay support for cores libretro-gpsp and libretro-dosbox-pure
 - Add original xbox emulator (xemu)
diff --git a/projects/frontend/data/resources/menu.xml b/projects/frontend/data/resources/menu.xml
index 0f4e629f35..638f05e1b3 100644
--- a/projects/frontend/data/resources/menu.xml
+++ b/projects/frontend/data/resources/menu.xml
@@ -489,9 +489,9 @@
 				<item id="KodiOnStartup" caption="RUN KODI ON STARTUP" help="Automatically start into Kodi on boot." />
 				<item id="KodiOnX" caption="START KODI WITH X BUTTON" help="Use the X button to start Kodi." />
 			</menu>
-			<!--menu id="UserScripts" caption="USER SCRIPTS" help="Run your own scripts in shell or python">
+			<menu id="UserScripts" caption="USER SCRIPTS" help="Run your own scripts in shell or python">
 				<item id="UserScript" foreach="scripts.all" caption="{SCRIPT.NAME}" caption2="RUN" help="Run custom script {SCRIPT.NAME}" />
-			</menu-->
+			</menu>
 			<item id="WebManagerEnable" caption="ENABLE WEB MANAGER" help="Enable or disable the Recalbox Manager.\nThe Recalbox Manager is a web application available on http://recalbox , if you are on windows, http://recalbox.local , if you are on Linux or Mac, or directly with your recalbox IP : http://192.168.1.XX.\nYou can configure many options from within the manager, and even manage games, saves, and scrapes!" />
 			<item id="EmulatorsReset" caption="RESET EMULATOR SETTINGS" caption2="RESET!" help="This option reset all emulator settings to their factory default. It does not affect any Recalbox setting." />
 			<item id="FactoryReset" caption="RESET TO FACTORY SETTINGS" caption2="RESET!" help="WARNING! This option erase all recalbox and emulator configurations! Use it carefully!" />
diff --git a/projects/frontend/es-app/src/guis/menus/MenuProvider.cpp b/projects/frontend/es-app/src/guis/menus/MenuProvider.cpp
index dadd623188..f604955a98 100644
--- a/projects/frontend/es-app/src/guis/menus/MenuProvider.cpp
+++ b/projects/frontend/es-app/src/guis/menus/MenuProvider.cpp
@@ -55,6 +55,7 @@
 #include <guis/menus/base/ItemSubMenu.h>
 #include <audio/AudioController.h>
 #include <scraping/ScraperSeamless.h>
+#include "guis/menus/modaltasks/MenuModalUserScript.h"
 
 void MenuProvider::BuildMenu(MenuContainerType identifier, const InheritableContext& context, const ItemBase* itemParent)
 {
@@ -596,6 +597,12 @@ void MenuProvider::MenuActionTriggered(ItemAction& item, int id)
       }
       break;
     }
+    case MenuItemType::UserScript:
+    {
+      assert(item.Context().HasScript() && "No script context");
+      MenuModalUserScript::CreateUserScriptRunner(mWindow, item.Context().Script()->mIndex);
+      break;
+    }
     case MenuItemType::DownloadGamePack:
     {
       assert(item.Context().HasSystem() && "No system context");
diff --git a/projects/frontend/es-app/src/guis/menus/modaltasks/MenuModalUserScript.cpp b/projects/frontend/es-app/src/guis/menus/modaltasks/MenuModalUserScript.cpp
new file mode 100644
index 0000000000..03dd17b7c7
--- /dev/null
+++ b/projects/frontend/es-app/src/guis/menus/modaltasks/MenuModalUserScript.cpp
@@ -0,0 +1,101 @@
+//
+// Created by Pit64 on 11/11/25
+//
+
+#include "MenuModalUserScript.h"
+#include <utils/locale/LocaleHelper.h>
+#include <usernotifications/NotificationManager.h>
+
+MenuModalUserScript::MenuModalUserScript(WindowManager& window, int scriptIndex)
+  : IMenuModalTask<int, bool>(window, _("Running script..."), scriptIndex)
+  , mWindowRef(window)
+  , mScriptResult(false)
+{
+}
+
+String MenuModalUserScript::ExtractScriptName(const Path& script, ScriptAttributes attributes)
+{
+  String name = script.FilenameWithoutDecorations();
+  if ((attributes & (ScriptAttributes::Synced | ScriptAttributes::ReportProgress)) != 0) name.Append(' ');
+  if (hasFlag(attributes, ScriptAttributes::Synced)) name.AppendUTF8(0xF1AF);
+  if (hasFlag(attributes, ScriptAttributes::ReportProgress)) name.AppendUTF8(0xF1AE);
+  return name;
+}
+
+void MenuModalUserScript::ScriptStarts(const Path& script, ScriptAttributes attributes)
+{
+  if ((attributes & ScriptAttributes::Synced) == 0)
+  {
+    // Asynchronous script - just show a message
+    mWindowRef.displayMessage((_F(_("Script {0} started successfully!")) / ExtractScriptName(script, attributes)).ToString());
+  }
+  else
+  {
+    // Synchronous script - update the modal dialog (thread-safe)
+    SetText((_F(_("Running {0}...")) / ExtractScriptName(script, attributes)).ToString());
+    // Force progress bar to show even if script only outputs text
+    if (hasFlag(attributes, ScriptAttributes::ReportProgress))
+      SetProgress(0);
+  }
+}
+
+void MenuModalUserScript::ScriptOutputLine(const Path& script, ScriptAttributes attributes, const String& line)
+{
+  (void)script;
+  // Only update progress for synchronous scripts (thread-safe)
+  if ((attributes & ScriptAttributes::Synced) != 0)
+  {
+    int percent = 0;
+    if (line.StartsWith('%') && line.TryAsInt(1, 0, percent))
+      SetProgress(percent);
+    else
+      SetSecondaryText(line);
+  }
+}
+
+void MenuModalUserScript::ScriptCompleted(const Path& script, ScriptAttributes attributes, const String& output, bool error, const String& errors)
+{
+  // Store result data (protected by mutex)
+  {
+    Mutex::AutoLock lock(mResultGuardian);
+    mResultData.mPath = script;
+    mResultData.mAttributes = attributes;
+    mResultData.mStdOut = output;
+    mResultData.mStdErr = errors;
+    mResultData.mError = error;
+    mScriptResult = !error;
+  }
+}
+
+bool MenuModalUserScript::TaskExecute(const int& scriptIndex)
+{
+  NotificationManager::Instance().RunManualScriptAt(scriptIndex, this);
+  return mScriptResult;
+}
+
+void MenuModalUserScript::TaskComplete(const bool& result)
+{
+  (void)result;
+
+  // Display final message (called from main thread)
+  Mutex::AutoLock lock(mResultGuardian);
+
+  if (hasFlag(mResultData.mAttributes, ScriptAttributes::Synced))
+  {
+    String title = _("Script execution complete");
+    if (mResultData.mError)
+    {
+      String text = (_F(_("Script {0} has failed!")) / ExtractScriptName(mResultData.mPath, mResultData.mAttributes)).ToString();
+      if (!mResultData.mStdErr.empty())
+        text.Append('\n').Append(_("With the following Error output:")).Append('\n').Append('\n').Append(mResultData.mStdErr);
+      mWindowRef.displayScrollMessage(title, text);
+    }
+    else
+    {
+      String text = (_F(_("Script {0} executed successfully!")) / ExtractScriptName(mResultData.mPath, mResultData.mAttributes)).ToString();
+      if (!hasFlag(mResultData.mAttributes, ScriptAttributes::ReportProgress) && !mResultData.mStdOut.empty())
+        text.Append('\n').Append(_("With the following output:")).Append('\n').Append('\n').Append(mResultData.mStdOut);
+      mWindowRef.displayScrollMessage(title, text);
+    }
+  }
+}
\ No newline at end of file
diff --git a/projects/frontend/es-app/src/guis/menus/modaltasks/MenuModalUserScript.h b/projects/frontend/es-app/src/guis/menus/modaltasks/MenuModalUserScript.h
new file mode 100644
index 0000000000..5d9032b1c6
--- /dev/null
+++ b/projects/frontend/es-app/src/guis/menus/modaltasks/MenuModalUserScript.h
@@ -0,0 +1,94 @@
+//
+// Created by Pit64 on 11/11/25
+//
+#pragma once
+
+#include "IMenuModelTask.h"
+#include <usernotifications/ScriptOutputListenerInterface.h>
+#include <utils/os/fs/Path.h>
+
+//! Forward declarations
+class WindowManager;
+
+/*!
+ * @brief Modal task to execute user scripts with visual feedback
+ *
+ * This class implements IMenuModalTask and ScriptOutputListenerInterface to provide
+ * visual feedback when executing user scripts from the menu. It handles:
+ * - Display of a nice modal window with background frame
+ * - Progress bars for scripts with ReportProgress attribute
+ * - Progress updates via percentage or text
+ * - Display of success/error messages at completion
+ * - Automatic cleanup via IMenuModalTask framework
+ */
+class MenuModalUserScript : private IMenuModalTask<int, bool>
+                          , private ScriptOutputListenerInterface
+{
+  public:
+    /*!
+     * @brief Factory method to create and start a user script execution
+     * @param window Window manager reference for displaying UI elements
+     * @param scriptIndex Index of the script to run
+     */
+    static void CreateUserScriptRunner(WindowManager& window, int scriptIndex)
+    {
+      // Create new instance
+      IMenuModalTask* task = new MenuModalUserScript(window, scriptIndex);
+      window.pushGui(task);
+      task->StartTask();
+    }
+
+  private:
+    //! Constructor
+    explicit MenuModalUserScript(WindowManager& window, int scriptIndex);
+
+    //! Window manager reference (for async scripts that don't show modal)
+    WindowManager& mWindowRef;
+
+    //! Script execution result
+    bool mScriptResult;
+
+    //! Result data for final message
+    struct ResultData
+    {
+      Path mPath;
+      ScriptAttributes mAttributes;
+      String mStdOut;
+      String mStdErr;
+      bool mError;
+    };
+    ResultData mResultData;
+    Mutex mResultGuardian;
+
+    /*!
+     * @brief Extract and format the script name with icons
+     * @param script Script path
+     * @param attributes Script attributes
+     * @return Formatted script name with icons
+     */
+    static String ExtractScriptName(const Path& script, ScriptAttributes attributes);
+
+    /*
+     * IMenuModalTask implementation
+     */
+
+    /*!
+     * @brief Execute the script (called in worker thread)
+     * @param scriptIndex Index of the script to run
+     * @return True if the script executed successfully
+     */
+    bool TaskExecute(const int& scriptIndex) final;
+
+    /*!
+     * @brief Called when script execution completes (called in main thread)
+     * @param result Result state
+     */
+    void TaskComplete(const bool& result) final;
+
+    /*
+     * ScriptOutputListenerInterface implementation (called from script thread)
+     */
+    void ScriptStarts(const Path& script, ScriptAttributes attributes) override;
+    void ScriptOutputLine(const Path& script, ScriptAttributes attributes, const String& line) override;
+    void ScriptCompleted(const Path& script, ScriptAttributes attributes, const String& output, bool error, const String& errors) override;
+};
\ No newline at end of file
diff --git a/projects/frontend/es-app/src/usernotifications/ScriptOutputListenerInterface.h b/projects/frontend/es-app/src/usernotifications/ScriptOutputListenerInterface.h
index 4bafdeafce..dea2e9a714 100644
--- a/projects/frontend/es-app/src/usernotifications/ScriptOutputListenerInterface.h
+++ b/projects/frontend/es-app/src/usernotifications/ScriptOutputListenerInterface.h
@@ -4,6 +4,7 @@
 #pragma once
 
 #include <utils/String.h>
+#include <utils/os/fs/Path.h>
 #include <usernotifications/ScriptAttributes.h>
 
 class ScriptOutputListenerInterface
-- 
GitLab