🚧 [new module] Environment variables editor (#28722)

* Init EnvironmentVariables UI project * Models TitleBar MainPage init Icon * User and system variables * Profiles init * XAML cleanup * Missing ItemTemplate * EditDialog * ModuleInterface * Signing and processes lists * Installer * spellcheck * Fix ARM64 build and consolidate packages * spellcheck2 * Fix installer * Single instance. C# telemetry. Wait on PT pid * ElevationHelper * Add profile wip * Init EnvironmentVariables UI project * Models TitleBar MainPage init Icon * User and system variables * Profiles init * XAML cleanup * Missing ItemTemplate * EditDialog * ModuleInterface * Signing and processes lists * Installer * spellcheck * Fix ARM64 build and consolidate packages * spellcheck2 * Fix installer * Single instance. C# telemetry. Wait on PT pid * ElevationHelper * Add profile wip * show run as administrator in title (#28516) * Environment Variables added to Run plugin (#28466) * UI tweaks * Remove style * Add profile - init working * Applied variables * Read/Write profiles * Fixes * Add separator and fix loading profiles * Only allow to edit System vars if running elevated * Add tmp progress ring to show applying changes progress Ignore not needed json fields * Remove variable and profile logic * Do not read data async Update System and User variables on change * Add isCorrectlyApplied() * Sort variables in Applied variables * WIP WndProc * spellcheck * Revert "WIP WndProc" This reverts commit 0c0b6c67de. * WHY CRASH??? * UI tweaks * WIP modified state warning * Add cancel button in dialogs * Add buttons validations * Set variables - fire and forget notify * Revert "Revert "WIP WndProc"" This reverts commit 1b2306eeb7. * Listen to WM_SETTINGSCHANGED Add Infobar reload button * spellcheck * spellcheck again * Fix build * InfoBar runAsAdmin visibility * Fix comment * Confirm dialog when deleting variable Fix add variable button when creating profile * Edit profile * Sort variables on Load * Select existing variables on edit * Add default variable * Fix adding existing vars to profile * update notice.md * Handle PATH properly * Add tooltips and fix dialogs text wrapping * Fix applied values for duplicates Fix add/eddit variable txt box validation * Add horizontal scroll bar for applied values * Fix duplicate variables handling Fix user variable handling and preview * spellcheck * Try fix spellcheck * Revert "spellcheck" This reverts commit ee76231974. * Revert "Try fix spellcheck" This reverts commit dc8f04afb9. * Fix path and duplicates conflict * Fix PATH handling Fix unapply on delete active variable Fix ordering in applied variables * Show variables as lists and add drag-to-reorder feature * Only show specific variables as list Update list in edit dialog on editing the value * spellcheck * Update GPO policy * Add Edit and Remove variable buttons Remove context menu * Remove drag&drop when editing list variable and add buttons to move up/down * Fix Edit profile dialog title * Fix backup and restore variables when editing variable from applied profile * Apply var to system WIP * Tweaks * Simplify edit variable logic * Minor fixes * Spellcheck * Update src/modules/EnvironmentVariables/EnvironmentVariables/app.manifest Co-authored-by: Jaime Bernardo <jaime@janeasystems.com> * spellcheck 2 * Remove unneeded string * Add more telemetry * Do not allow adding existing variables with the same name into the profile * Adding icon * Fix the crash when opening existing variables dialog * Update Settings and OOBE screenshots * Fix crash when malformed profiles.json and jsonignore not needed properties * Fix selecting duplicates in existing variables dialog * Add user variable name limit (<255 chars) Check if profile is applicable on apply Show message if profile is not applicable * XamlStyling * Better Flyout positioning Add Cancel button to the flyout * Fix UI glitches by using ItemsControl (no virtualization) * Fix spellcheck * Fix XAML style * Add horizontal scrollbar to applied variables * Revert to ItemsRepeater * Fix UI glitches by adding a decent minimum cache * Fixing UI bugs * Fix spellcheck * Fix crash while trying to edit a User variable when there's no Parent profile * Fix issue overwriting backup var when you edit var on applied profile * Fix nuking of variables when adding to applied profile * Fix profile not being saved when deleting a variable * Fix ValuesList empty crash, issues and no serialization * fix spellcheck * Allow in-line edit of list variables * Fix xaml style * Fix add profile variable cancel button logic * Fix add profile variable cancel button logic - clean the list * Bump VerticalCacheLength to 10 as in some cases UI glitch on expanding System variables was still present * Fix profile Add variable button enable/disable logic * Remove unneeded using * Add to Dashboard --------- Co-authored-by: Niels Laute <niels.laute@live.nl> Co-authored-by: Davide Giacometti <davide.giacometti@outlook.it> Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
2026-02-24 04:00:02 +01:00 · 2023-10-20 16:28:07 +02:00
parent 1f936df3eb
commit 812b343776
109 changed files with 4978 additions and 37 deletions
--- a/src/modules/EnvironmentVariables/EnvironmentVariablesModuleInterface/dllmain.cpp
+++ b/src/modules/EnvironmentVariables/EnvironmentVariablesModuleInterface/dllmain.cpp
@@ -0,0 +1,280 @@
+// dllmain.cpp : Defines the entry point for the DLL application.
+#include "pch.h"
+
+#include "Generated Files/resource.h"
+#include "trace.h"
+
+#include <common/interop/shared_constants.h>
+#include <common/logger/logger.h>
+#include <common/utils/EventWaiter.h>
+#include <common/utils/gpo.h>
+#include <common/utils/logger_helper.h>
+#include <common/utils/resources.h>
+#include <common/utils/winapi_error.h>
+#include <interface/powertoy_module_interface.h>
+
+#include <shellapi.h>
+
+extern "C" IMAGE_DOS_HEADER __ImageBase;
+
+BOOL APIENTRY DllMain( HMODULE hModule,
+                       DWORD  ul_reason_for_call,
+                       LPVOID lpReserved
+                     )
+{
+    switch (ul_reason_for_call)
+    {
+    case DLL_PROCESS_ATTACH:
+        Trace::RegisterProvider();
+        break;
+    case DLL_THREAD_ATTACH:
+    case DLL_THREAD_DETACH:
+        break;
+    case DLL_PROCESS_DETACH:
+        Trace::UnregisterProvider();
+        break;
+    }
+    return TRUE;
+}
+
+namespace
+{
+    // Name of the powertoy module.
+    inline const std::wstring ModuleKey = L"EnvironmentVariables";
+}
+
+class EnvironmentVariablesModuleInterface : public PowertoyModuleIface
+{
+private:
+    bool m_enabled = false;
+
+    std::wstring app_name;
+
+    //contains the non localized key of the powertoy
+    std::wstring app_key;
+
+    HANDLE m_hProcess;
+
+    HANDLE m_hShowEvent;
+
+    EventWaiter m_showEventWaiter;
+
+    HANDLE m_hShowAdminEvent;
+
+    EventWaiter m_showAdminEventWaiter;
+
+    bool is_process_running()
+    {
+        return WaitForSingleObject(m_hProcess, 0) == WAIT_TIMEOUT;
+    }
+
+    void bring_process_to_front()
+    {
+        auto enum_windows = [](HWND hwnd, LPARAM param) -> BOOL {
+            HANDLE process_handle = reinterpret_cast<HANDLE>(param);
+            DWORD window_process_id = 0;
+
+            GetWindowThreadProcessId(hwnd, &window_process_id);
+            if (GetProcessId(process_handle) == window_process_id)
+            {
+                SetForegroundWindow(hwnd);
+                return FALSE;
+            }
+            return TRUE;
+        };
+
+        EnumWindows(enum_windows, (LPARAM)m_hProcess);
+    }
+
+    void launch_process(bool runas)
+    {
+        Logger::trace("EnvironmentVariablesModuleInterface::launch_process()");
+        unsigned long powertoys_pid = GetCurrentProcessId();
+
+        std::wstring executable_args = L"";
+        executable_args.append(std::to_wstring(powertoys_pid));
+
+        SHELLEXECUTEINFOW sei{ sizeof(sei) };
+        sei.fMask = { SEE_MASK_NOCLOSEPROCESS | SEE_MASK_FLAG_NO_UI };
+        sei.lpFile = L"WinUI3Apps\\PowerToys.EnvironmentVariables.exe";
+        sei.nShow = SW_SHOWNORMAL;
+        sei.lpParameters = executable_args.data();
+
+        if (runas)
+        {
+            sei.lpVerb = L"runas";
+        }
+
+        if (ShellExecuteExW(&sei))
+        {
+            Logger::trace("Successfully started the Environment Variables process");
+        }
+        else
+        {
+            Logger::error(L"Environment Variables failed to start. {}", get_last_error_or_default(GetLastError()));
+        }
+
+        m_hProcess = sei.hProcess;
+    }
+
+public:
+    EnvironmentVariablesModuleInterface()
+    {
+        app_name = GET_RESOURCE_STRING(IDS_ENVIRONMENT_VARIABLES_NAME);
+        app_key = ModuleKey;
+        LoggerHelpers::init_logger(app_key, L"ModuleInterface", LogSettings::environmentVariablesLoggerName);
+
+        m_hShowEvent = CreateDefaultEvent(CommonSharedConstants::SHOW_ENVIRONMENT_VARIABLES_EVENT);
+        if (!m_hShowEvent)
+        {
+            Logger::error(L"Failed to create show Environment Variables event");
+            auto message = get_last_error_message(GetLastError());
+            if (message.has_value())
+            {
+                Logger::error(message.value());
+            }
+        }
+
+        m_hShowAdminEvent = CreateDefaultEvent(CommonSharedConstants::SHOW_ENVIRONMENT_VARIABLES_ADMIN_EVENT);
+        if (!m_hShowAdminEvent)
+        {
+            Logger::error(L"Failed to create show Environment Variables admin event");
+            auto message = get_last_error_message(GetLastError());
+            if (message.has_value())
+            {
+                Logger::error(message.value());
+            }
+        }
+
+        m_showEventWaiter = EventWaiter(CommonSharedConstants::SHOW_ENVIRONMENT_VARIABLES_EVENT, [&](int err) {
+            if (m_enabled && err == ERROR_SUCCESS)
+            {
+                Logger::trace(L"{} event was signaled", CommonSharedConstants::SHOW_ENVIRONMENT_VARIABLES_EVENT);
+
+                if (is_process_running())
+                {
+                    bring_process_to_front();
+                }
+                else
+                {
+                    launch_process(false);
+                }
+
+                Trace::ActivateEnvironmentVariables();
+            }
+        });
+
+        m_showAdminEventWaiter = EventWaiter(CommonSharedConstants::SHOW_ENVIRONMENT_VARIABLES_ADMIN_EVENT, [&](int err) {
+            if (m_enabled && err == ERROR_SUCCESS)
+            {
+                Logger::trace(L"{} event was signaled", CommonSharedConstants::SHOW_ENVIRONMENT_VARIABLES_ADMIN_EVENT);
+
+                if (is_process_running())
+                {
+                    bring_process_to_front();
+                }
+                else
+                {
+                    launch_process(true);
+                }
+
+                Trace::ActivateEnvironmentVariables();
+            }
+        });
+    }
+
+    ~EnvironmentVariablesModuleInterface()
+    {
+        m_enabled = false;
+    }
+
+    // Destroy the powertoy and free memory
+    virtual void destroy() override
+    {
+        Logger::trace("EnvironmentVariablesModuleInterface::destroy()");
+
+        if (m_hShowEvent)
+        {
+            CloseHandle(m_hShowEvent);
+            m_hShowEvent = nullptr;
+        }
+
+        if (m_hShowAdminEvent)
+        {
+            CloseHandle(m_hShowAdminEvent);
+            m_hShowAdminEvent = nullptr;
+        }
+
+        delete this;
+    }
+
+    // Return the localized display name of the powertoy
+    virtual const wchar_t* get_name() override
+    {
+        return app_name.c_str();
+    }
+
+    // Return the non localized key of the powertoy, this will be cached by the runner
+    virtual const wchar_t* get_key() override
+    {
+        return app_key.c_str();
+    }
+
+    // Return the configured status for the gpo policy for the module
+    virtual powertoys_gpo::gpo_rule_configured_t gpo_policy_enabled_configuration() override
+    {
+        return powertoys_gpo::getConfiguredEnvironmentVariablesEnabledValue();
+    }
+
+    virtual bool get_config(wchar_t* /*buffer*/, int* /*buffer_size*/) override
+    {
+        return false;
+    }
+
+    virtual void call_custom_action(const wchar_t* /*action*/) override
+    {
+    }
+
+    virtual void set_config(const wchar_t* /*config*/) override
+    {
+    }
+
+    virtual bool is_enabled() override
+    {
+        return m_enabled;
+    }
+
+    virtual void enable()
+    {
+        Logger::trace("EnvironmentVariablesModuleInterface::enable()");
+        m_enabled = true;
+        Trace::EnableEnvironmentVariables(true);
+    }
+
+    virtual void disable()
+    {
+        Logger::trace("EnvironmentVariablesModuleInterface::disable()");
+        if (m_enabled)
+        {
+            if (m_hShowEvent)
+            {
+                ResetEvent(m_hShowEvent);
+            }
+
+            if (m_hShowAdminEvent)
+            {
+                ResetEvent(m_hShowAdminEvent);
+            }
+
+            TerminateProcess(m_hProcess, 1);
+        }
+
+        m_enabled = false;
+        Trace::EnableEnvironmentVariables(false);
+    }
+};
+
+extern "C" __declspec(dllexport) PowertoyModuleIface * __cdecl powertoy_create()
+{
+    return new EnvironmentVariablesModuleInterface();
+}