1ae6e3b772
## Summary of the Pull Request `ApplicationLanguages::PrimaryLanguageOverride` requires packaged activation. This PR prevents any such application crashes, by skipping any calls to `PrimaryLanguageOverride`, as well as hiding the language selector in the settings UI. ## PR Checklist * [x] I work here * [x] Tests added/passed * [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [ ] Schema updated. ## Validation Steps Performed When WT is run unpackaged: * Doesn't crash during start ✔️ * SUI doesn't show the language selector ✔️
173 lines
6.6 KiB
C++
173 lines
6.6 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "pch.h"
|
|
#include "Jumplist.h"
|
|
|
|
#include <ShObjIdl.h>
|
|
#include <Propkey.h>
|
|
|
|
#include <WtExeUtils.h>
|
|
|
|
using namespace winrt::Microsoft::Terminal::Settings::Model;
|
|
|
|
// This property key isn't already defined in propkey.h, but is used by UWP Jumplist to determine the icon of the jumplist item.
|
|
// IShellLink's SetIconLocation isn't going to read "ms-appx://" icon paths, so we'll need to use this to set the icon.
|
|
DEFINE_PROPERTYKEY(PKEY_AppUserModel_DestListLogoUri, 0x9F4C2855, 0x9F79, 0x4B39, 0xA8, 0xD0, 0xE1, 0xD4, 0x2D, 0xE1, 0xD5, 0xF3, 29);
|
|
#define INIT_PKEY_AppUserModel_DestListLogoUri \
|
|
{ \
|
|
{ 0x9F4C2855, 0x9F79, 0x4B39, 0xA8, 0xD0, 0xE1, 0xD4, 0x2D, 0xE1, 0xD5, 0xF3 }, 29 \
|
|
}
|
|
|
|
// Function Description:
|
|
// - This function guesses whether a string is a file path.
|
|
static constexpr bool _isProbableFilePath(std::wstring_view path)
|
|
{
|
|
// "C:X", "C:\X", "\\?", "\\."
|
|
// _this function rejects \??\ as a path_
|
|
if (path.size() >= 3)
|
|
{
|
|
const auto firstColon{ path.find(L':') };
|
|
if (firstColon == 1)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
const auto prefix{ path.substr(0, 2) };
|
|
return prefix == LR"(//)" || prefix == LR"(\\)";
|
|
}
|
|
return false;
|
|
}
|
|
|
|
// Function Description:
|
|
// - DestListLogoUri cannot take paths that are separated by / unless they're URLs.
|
|
// This function uses std::filesystem to normalize strings that appear to be file
|
|
// paths to have the "correct" slash direction.
|
|
static std::wstring _normalizeIconPath(std::wstring_view path)
|
|
{
|
|
const auto fullPath{ wil::ExpandEnvironmentStringsW<std::wstring>(path.data()) };
|
|
if (_isProbableFilePath(fullPath))
|
|
{
|
|
std::filesystem::path asPath{ fullPath };
|
|
return asPath.make_preferred().wstring();
|
|
}
|
|
return std::wstring{ fullPath };
|
|
}
|
|
|
|
// Method Description:
|
|
// - Updates the items of the Jumplist based on the given settings.
|
|
// Arguments:
|
|
// - settings - The settings object to update the jumplist with.
|
|
// Return Value:
|
|
// - <none>
|
|
winrt::fire_and_forget Jumplist::UpdateJumplist(const CascadiaSettings& settings) noexcept
|
|
{
|
|
// make sure to capture the settings _before_ the co_await
|
|
const auto strongSettings = settings;
|
|
|
|
co_await winrt::resume_background();
|
|
|
|
try
|
|
{
|
|
auto jumplistInstance = winrt::create_instance<ICustomDestinationList>(CLSID_DestinationList, CLSCTX_ALL);
|
|
|
|
// Start the Jumplist edit transaction
|
|
uint32_t slots;
|
|
winrt::com_ptr<IObjectCollection> jumplistItems;
|
|
jumplistItems.capture(jumplistInstance, &ICustomDestinationList::BeginList, &slots);
|
|
|
|
// It's easier to clear the list and re-add everything. The settings aren't
|
|
// updated often, and there likely isn't a huge amount of items to add.
|
|
THROW_IF_FAILED(jumplistItems->Clear());
|
|
|
|
// Update the list of profiles.
|
|
THROW_IF_FAILED(_updateProfiles(jumplistItems.get(), strongSettings.ActiveProfiles().GetView()));
|
|
|
|
// TODO GH#1571: Add items from the future customizable new tab dropdown as well.
|
|
// This could either replace the default profiles, or be added alongside them.
|
|
|
|
// Add the items to the jumplist Task section.
|
|
// The Tasks section is immutable by the user, unlike the destinations
|
|
// section that can have its items pinned and removed.
|
|
THROW_IF_FAILED(jumplistInstance->AddUserTasks(jumplistItems.get()));
|
|
|
|
THROW_IF_FAILED(jumplistInstance->CommitList());
|
|
}
|
|
CATCH_LOG();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Creates and adds a ShellLink object to the Jumplist for each profile.
|
|
// Arguments:
|
|
// - jumplistItems - The jumplist item list
|
|
// - profiles - The profiles to add to the jumplist
|
|
// Return Value:
|
|
// - S_OK or HRESULT failure code.
|
|
[[nodiscard]] HRESULT Jumplist::_updateProfiles(IObjectCollection* jumplistItems, winrt::Windows::Foundation::Collections::IVectorView<Profile> profiles) noexcept
|
|
{
|
|
try
|
|
{
|
|
for (const auto& profile : profiles)
|
|
{
|
|
// Craft the arguments following "wt.exe"
|
|
auto args = fmt::format(L"-p {}", to_hstring(profile.Guid()));
|
|
|
|
// Create the shell link object for the profile
|
|
winrt::com_ptr<IShellLinkW> shLink;
|
|
const auto normalizedIconPath{ _normalizeIconPath(profile.Icon()) };
|
|
RETURN_IF_FAILED(_createShellLink(profile.Name(), normalizedIconPath, args, shLink.put()));
|
|
|
|
RETURN_IF_FAILED(jumplistItems->AddObject(shLink.get()));
|
|
}
|
|
|
|
return S_OK;
|
|
}
|
|
CATCH_RETURN();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Creates a ShellLink object. Each item in a jumplist is a ShellLink, which is sort of
|
|
// like a shortcut. It requires the path to the application (wt.exe), the arguments to pass,
|
|
// and the path to the icon for the jumplist item. The path to the application isn't passed
|
|
// into this function, as we'll determine it with GetWtExePath
|
|
// Arguments:
|
|
// - name: The name of the item displayed in the jumplist.
|
|
// - path: The path to the icon for the jumplist item.
|
|
// - args: The arguments to pass along with wt.exe
|
|
// - shLink: The shell link object to return.
|
|
// Return Value:
|
|
// - S_OK or HRESULT failure code.
|
|
[[nodiscard]] HRESULT Jumplist::_createShellLink(const std::wstring_view name,
|
|
const std::wstring_view path,
|
|
const std::wstring_view args,
|
|
IShellLinkW** shLink) noexcept
|
|
{
|
|
try
|
|
{
|
|
auto sh = winrt::create_instance<IShellLinkW>(CLSID_ShellLink, CLSCTX_ALL);
|
|
|
|
const auto module{ GetWtExePath() };
|
|
RETURN_IF_FAILED(sh->SetPath(module.data()));
|
|
RETURN_IF_FAILED(sh->SetArguments(args.data()));
|
|
|
|
PROPVARIANT titleProp;
|
|
titleProp.vt = VT_LPWSTR;
|
|
titleProp.pwszVal = const_cast<wchar_t*>(name.data());
|
|
|
|
PROPVARIANT iconProp;
|
|
iconProp.vt = VT_LPWSTR;
|
|
iconProp.pwszVal = const_cast<wchar_t*>(path.data());
|
|
|
|
auto propStore{ sh.as<IPropertyStore>() };
|
|
RETURN_IF_FAILED(propStore->SetValue(PKEY_Title, titleProp));
|
|
RETURN_IF_FAILED(propStore->SetValue(PKEY_AppUserModel_DestListLogoUri, iconProp));
|
|
|
|
RETURN_IF_FAILED(propStore->Commit());
|
|
|
|
*shLink = sh.detach();
|
|
|
|
return S_OK;
|
|
}
|
|
CATCH_RETURN();
|
|
}
|