Add startup task, setting to launch application on login

doc/cascadia/SettingsSchema.md

@@ -1,6 +1,7 @@
 # Settings.json Documentation
 
 ## Globals
+
 Properties listed below affect the entire window, regardless of the profile settings.
 
 | Property | Necessity | Type | Default | Description |
@@ -21,11 +22,13 @@ Properties listed below affect the entire window, regardless of the profile sett
 | `tabWidthMode` | Optional | String | `equal` | Sets the width of the tabs. Possible values: `"equal"`, `"titleLength"` |
 | `wordDelimiters` | Optional | String | <code>&nbsp;&#x2f;&#x5c;&#x28;&#x29;&#x22;&#x27;&#x2d;&#x3a;&#x2c;&#x2e;&#x3b;&#x3c;&#x3e;&#x7e;&#x21;&#x40;&#x23;&#x24;&#x25;&#x5e;&#x26;&#x2a;&#x7c;&#x2b;&#x3d;&#x5b;&#x5d;&#x7b;&#x7d;&#x7e;&#x3f;│</code><br>_(`│` is `U+2502 BOX DRAWINGS LIGHT VERTICAL`)_ | Determines the delimiters used in a double click selection. |
 | `confirmCloseAllTabs` | Optional | Boolean | `true` | When set to `true` closing a window with multiple tabs open WILL require confirmation.  When set to `false` closing a window with multiple tabs open WILL NOT require confirmation. |
+| `startOnUserLogin` | Optional | Boolean | `false` | When set to `true` enables the launch of Windows Terminal at startup. Setting to `false` will disable the startup task entry. Note: if the Windows Terminal startup task entry is disabled either by org policy or by user action this setting will have no effect. |
 | `disabledProfileSources` | Optional | Array[String] | `[]` | Disables all the dynamic profile generators in this list, preventing them from adding their profiles to the list of profiles on startup. This array can contain any combination of `Windows.Terminal.Wsl`, `Windows.Terminal.Azure`, or `Windows.Terminal.PowershellCore`. For more information, see [UsingJsonSettings.md](https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md#dynamic-profiles) |
 | `experimental.rendering.forceFullRepaint` | Optional | Boolean | `false` | When set to true, we will redraw the entire screen each frame. When set to false, we will render only the updates to the screen between frames. |
 | `experimental.rendering.software` | Optional | Boolean | `false` | When set to true, we will use the software renderer (a.k.a. WARP) instead of the hardware one. |
 
 ## Profiles
+
 Properties listed below are specific to each unique profile.
 
 | Property | Necessity | Type | Default | Description |
@@ -64,6 +67,7 @@ Properties listed below are specific to each unique profile.
 | `experimental.retroTerminalEffect` | Optional | Boolean | `false` | When set to `true`, enable retro terminal effects. This is an experimental feature, and its continued existence is not guaranteed. |
 
 ## Schemes
+
 Properties listed below are specific to each color scheme. [ColorTool](https://github.com/microsoft/terminal/tree/master/src/tools/ColorTool) is a great tool you can use to create and explore new color schemes. All colors use hex color format.
 
 | Property | Necessity | Type | Description |
@@ -91,6 +95,7 @@ Properties listed below are specific to each color scheme. [ColorTool](https://g
 | `yellow` | _Required_ | String | Sets the color used as ANSI yellow. |
 
 ## Keybindings
+
 Properties listed below are specific to each custom key binding.
 
 | Property | Necessity | Type | Description |
@@ -146,6 +151,7 @@ For commands with arguments:
 `ctrl+`, `shift+`, `alt+`
 
 #### Keys
+
 | Type | Keys |
 | ---- | ---- |
 | Function and Alphanumeric Keys | `f1-f24`, `a-z`, `0-9` |
@@ -155,6 +161,7 @@ For commands with arguments:
 | Numpad Keys | `numpad_0-numpad_9`, `numpad0-numpad9`, `numpad_add`, `numpad_plus`, `numpad_decimal`, `numpad_period`, `numpad_divide`, `numpad_minus`, `numpad_subtract`, `numpad_multiply` |
 
 ## Background Images and Icons
+
 Some Terminal settings allow you to specify custom background images and icons. It is recommended that custom images and icons are stored in system-provided folders and are referred to using the correct [URI Schemes](https://docs.microsoft.com/en-us/windows/uwp/app-resources/uri-schemes). URI Schemes provide a way to reference files independent of their physical paths (which may change in the future).
 
 The most useful URI schemes to remember when customizing background images and icons are:
@@ -167,6 +174,7 @@ The most useful URI schemes to remember when customizing background images and i
 > ⚠ Note: Do not rely on file references using the `ms-appx` URI Scheme (i.e. icons). These files are considered an internal implementation detail and may change name/location or may be omitted in the future.
 
 ### Icons
+
 Terminal displays icons for each of your profiles which Terminal generates for any built-in shells - PowerShell Core, PowerShell, and any installed Linux/WSL distros. Each profile refers to a stock icon via the `ms-appx` URI Scheme.
 
 > ⚠ Note: Do not rely on the files referenced by the `ms-appx` URI Scheme - they are considered an internal implementation detail and may change name/location or may be omitted in the future.
@@ -180,6 +188,7 @@ You can refer to you own icons if you wish, e.g.:
 > 👉 Tip: Icons should be sized to 32x32px in an appropriate raster image format (e.g. .PNG, .GIF, or .ICO) to avoid having to scale your icons during runtime (causing a noticeable delay and loss of quality.)
 
 ### Custom Background Images
+
 You can apply a background image to each of your profiles, allowing you to configure/brand/style each of your profiles independently from one another if you wish.
 
 To do so, specify your preferred `backgroundImage`, position it using `backgroundImageAlignment`, set its opacity with `backgroundImageOpacity`, and/or specify how your image fill the available space using `backgroundImageStretchMode`.

src/cascadia/CascadiaPackage/Package-Dev.appxmanifest

@@ -11,6 +11,7 @@
   xmlns:desktop4="http://schemas.microsoft.com/appx/manifest/desktop/windows10/4"
   xmlns:desktop5="http://schemas.microsoft.com/appx/manifest/desktop/windows10/5"
   xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
+  xmlns:uap5="http://schemas.microsoft.com/appx/manifest/uap/windows10/5"
   IgnorableNamespaces="uap mp rescap">
 
   <Identity
@@ -62,6 +63,12 @@
             <desktop:ExecutionAlias Alias="wtd.exe" />
           </uap3:AppExecutionAlias>
         </uap3:Extension>
+        <uap5:Extension Category="windows.startupTask">
+          <uap5:StartupTask
+            TaskId="StartTerminalOnLoginTask"
+            Enabled="false"
+            DisplayName="ms-resource:AppNameDev" />
+        </uap5:Extension>
 
         <com:Extension Category="windows.comServer">
             <com:ComServer>

src/cascadia/CascadiaPackage/Package.appxmanifest

@@ -6,6 +6,7 @@
   xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
   xmlns:uap3="http://schemas.microsoft.com/appx/manifest/uap/windows10/3"
   xmlns:uap4="http://schemas.microsoft.com/appx/manifest/uap/windows10/4"
+  xmlns:uap5="http://schemas.microsoft.com/appx/manifest/uap/windows10/5"
   xmlns:uap7="http://schemas.microsoft.com/appx/manifest/uap/windows10/7"
   xmlns:desktop="http://schemas.microsoft.com/appx/manifest/desktop/windows10"
   xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
@@ -60,6 +61,12 @@
             <desktop:ExecutionAlias Alias="wt.exe" />
           </uap3:AppExecutionAlias>
         </uap3:Extension>
+        <uap5:Extension Category="windows.startupTask">
+          <uap5:StartupTask
+            TaskId="StartTerminalOnLoginTask"
+            Enabled="false"
+            DisplayName="ms-resource:AppName" />
+        </uap5:Extension>
 
         <com:Extension Category="windows.comServer">
             <com:ComServer>

src/cascadia/TerminalApp/App.cpp

@@ -6,7 +6,6 @@
 #include "App.g.cpp"
 
 using namespace winrt;
-using namespace winrt::Windows::ApplicationModel;
 using namespace winrt::Windows::ApplicationModel::Activation;
 using namespace winrt::Windows::Foundation;
 using namespace winrt::Windows::UI::Xaml;

src/cascadia/TerminalApp/AppLogic.cpp

@@ -8,6 +8,7 @@
 
 #include <LibraryResources.h>
 
+using namespace winrt::Windows::ApplicationModel;
 using namespace winrt::Windows::ApplicationModel::DataTransfer;
 using namespace winrt::Windows::UI::Xaml;
 using namespace winrt::Windows::UI::Core;
@@ -23,6 +24,7 @@ namespace winrt
     using IInspectable = Windows::Foundation::IInspectable;
 }
 
+static const winrt::hstring StartupTaskName = L"StartTerminalOnLoginTask";
 // clang-format off
 // !!! IMPORTANT !!!
 // Make sure that these keys are in the same order as the
@@ -243,6 +245,7 @@ namespace winrt::TerminalApp::implementation
         _root->Create();
 
         _ApplyTheme(_settings->GlobalSettings().GetTheme());
+        _ApplyStartupTaskStateChange();
 
         TraceLoggingWrite(
             g_hTerminalAppProvider,
@@ -755,6 +758,43 @@ namespace winrt::TerminalApp::implementation
         _ApplyTheme(_settings->GlobalSettings().GetTheme());
     }
 
+    fire_and_forget AppLogic::_ApplyStartupTaskStateChange()
+    {
+        co_await winrt::resume_foreground(_root->Dispatcher());
+
+        StartupTaskState state;
+        bool tryEnableStartupTask = _settings->GlobalSettings().StartOnUserLogin();
+        StartupTask task = co_await StartupTask::GetAsync(StartupTaskName);
+
+        state = task.State();
+        switch (state)
+        {
+        case StartupTaskState::Disabled:
+        {
+            if (tryEnableStartupTask)
+            {
+                co_await task.RequestEnableAsync();
+            }
+            break;
+        }
+        case StartupTaskState::DisabledByUser:
+        {
+            // TODO: how should we handle this?
+            break;
+        }
+        case StartupTaskState::Enabled:
+        {
+            if (!tryEnableStartupTask)
+            {
+                task.Disable();
+            }
+            break;
+        }
+        default:
+        {
+        }
+        }
+    }
     // Method Description:
     // - Reloads the settings from the profile.json.
     void AppLogic::_ReloadSettings()
@@ -783,6 +823,7 @@ namespace winrt::TerminalApp::implementation
         _root->SetSettings(_settings, true);
 
         _RefreshThemeRoutine();
+        _ApplyStartupTaskStateChange();
     }
 
     // Method Description:

src/cascadia/TerminalApp/AppLogic.h

@@ -83,6 +83,7 @@ namespace winrt::TerminalApp::implementation
         fire_and_forget _LoadErrorsDialogRoutine();
         fire_and_forget _ShowLoadWarningsDialogRoutine();
         fire_and_forget _RefreshThemeRoutine();
+        fire_and_forget _ApplyStartupTaskStateChange();
 
         void _OnLoaded(const IInspectable& sender, const Windows::UI::Xaml::RoutedEventArgs& eventArgs);
 

src/cascadia/TerminalApp/GlobalAppSettings.cpp

@@ -41,6 +41,7 @@ static constexpr std::wstring_view MaximizedLaunchModeValue{ L"maximized" };
 static constexpr std::wstring_view LightThemeValue{ L"light" };
 static constexpr std::wstring_view DarkThemeValue{ L"dark" };
 static constexpr std::wstring_view SystemThemeValue{ L"system" };
+static constexpr std::string_view EnableStartupTaskKey{ "startOnUserLogin" };
 
 static constexpr std::string_view ForceFullRepaintRenderingKey{ "experimental.rendering.forceFullRepaint" };
 static constexpr std::string_view SoftwareRenderingKey{ "experimental.rendering.software" };
@@ -73,6 +74,7 @@ GlobalAppSettings::GlobalAppSettings() :
     _copyOnSelect{ false },
     _copyFormatting{ false },
     _launchMode{ LaunchMode::DefaultMode },
+    _StartOnUserLogin{ false },
     _forceFullRepaintRendering{ false },
     _softwareRendering{ false },
     _debugFeatures{ debugFeaturesDefault }
@@ -333,6 +335,23 @@ void GlobalAppSettings::LayerJson(const Json::Value& json)
         _keybindingsWarnings.insert(_keybindingsWarnings.end(), warnings.begin(), warnings.end());
     }
 
+    if (auto tabWidthMode{ json[JsonKey(TabWidthModeKey)] })
+    {
+        _tabWidthMode = _ParseTabWidthMode(GetWstringFromJson(tabWidthMode));
+    }
+
+    if (auto keybindings{ json[JsonKey(KeybindingsKey)] })
+    {
+        auto warnings = _keybindings->LayerJson(keybindings);
+        // It's possible that the user provided keybindings have some warnings
+        // in them - problems that we should alert the user to, but we can
+        // recover from. Most of these warnings cannot be detected later in the
+        // Validate settings phase, so we'll collect them now. If there were any
+        // warnings generated from parsing these keybindings, add them to our
+        // list of warnings.
+        _keybindingsWarnings.insert(_keybindingsWarnings.end(), warnings.begin(), warnings.end());
+    }
+
     JsonUtils::GetBool(json, SnapToGridOnResizeKey, _SnapToGridOnResize);
 
     JsonUtils::GetBool(json, ForceFullRepaintRenderingKey, _forceFullRepaintRendering);
@@ -341,6 +360,8 @@ void GlobalAppSettings::LayerJson(const Json::Value& json)
 
     // GetBool will only override the current value if the key exists
     JsonUtils::GetBool(json, DebugFeaturesKey, _debugFeatures);
+
+    JsonUtils::GetBool(json, EnableStartupTaskKey, _StartOnUserLogin);
 }
 
 // Method Description:

src/cascadia/TerminalApp/GlobalAppSettings.h

@@ -91,6 +91,8 @@ class TerminalApp::GlobalAppSettings final
 
     GETSET_PROPERTY(bool, SnapToGridOnResize, true);
 
+    GETSET_PROPERTY(bool, StartOnUserLogin, false);
+
 private:
     GUID _defaultProfile;
     winrt::com_ptr<winrt::TerminalApp::implementation::AppKeyBindings> _keybindings;

src/cascadia/TerminalApp/defaults.json

@@ -20,6 +20,7 @@
 
     // Miscellaneous
     "confirmCloseAllTabs": true,
+    "startOnUserLogin":  false,
     "theme": "system",
     "rowsToScroll": "system",
     "snapToGridOnResize": true,

src/cascadia/TerminalApp/lib/pch.h

@@ -39,6 +39,7 @@
 #include "winrt/Windows.UI.Xaml.Markup.h"
 #include "winrt/Windows.UI.Xaml.Documents.h"
 #include "winrt/Windows.UI.Xaml.Automation.h"
+#include <winrt/Windows.ApplicationModel.h>
 #include <winrt/Windows.ApplicationModel.DataTransfer.h>
 
 #include <winrt/Microsoft.Toolkit.Win32.UI.XamlHost.h>