Encoding/Decoding AppNotificationBuilder arguments (#2805)

* Encode arguments

* Argument encode/decode

* Fix merge issues

* Add Decode unit test

* Use regex_replace instead

* Address nits

* Simplify encoding

* Added XML escape encodings, need to improve Decode efficiency

* Implement efficient decode

* Update APITests.cpp

* Add unit tests and encode all custom strings

Co-authored-by: eric langlois <email@ericlanglois.com>

dev/AppNotifications/AppNotificationActivatedEventArgs.cpp

@@ -0,0 +1,43 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+#include "pch.h"
+#include "AppNotificationActivatedEventArgs.h"
+#include "Microsoft.Windows.AppNotifications.AppNotificationActivatedEventArgs.g.cpp"
+#include "AppNotificationBuilder/AppNotificationBuilderUtility.h"
+
+namespace winrt::Microsoft::Windows::AppNotifications::implementation
+{
+    winrt::Windows::Foundation::Collections::IMap<hstring, hstring> AppNotificationActivatedEventArgs::DecodeArguments(std::wstring arguments)
+    {
+        auto result{ winrt::single_threaded_map<winrt::hstring, winrt::hstring>() };
+
+        std::vector<std::wstring> pairs{};
+        size_t pos{ 0 };
+
+        // Separate the key/value pairs by ';' as the delimiter
+        while ((pos = arguments.find(L';')) != std::wstring::npos)
+        {
+            pairs.push_back(arguments.substr(0, pos));
+            arguments.erase(0, pos + 1);
+        }
+
+        // Need to push back final string
+        pairs.push_back(arguments);
+
+        for (auto pair : pairs)
+        {
+            // Get the key/value individual values separated by '='
+            pos = pair.find(L'=');
+            if (pos == std::wstring::npos)
+            {
+                result.Insert(Decode(pair).c_str(), L"");
+            }
+            else
+            {
+                result.Insert(Decode(pair.substr(0, pos)).c_str(), Decode(pair.substr(pos + 1)).c_str());
+            }
+        }
+        return result;
+    }
+}

dev/AppNotifications/AppNotificationActivatedEventArgs.h

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 #pragma once
@@ -10,12 +10,17 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
     {
         AppNotificationActivatedEventArgs() = default;
 
-        AppNotificationActivatedEventArgs(winrt::hstring const& arguments, winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> const& userInput) : m_arguments(arguments), m_userInput(userInput) {};
-        winrt::hstring Argument() { return m_arguments; };
+        AppNotificationActivatedEventArgs(winrt::hstring const& argument, winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> const& userInput)
+            : m_argument(argument), m_userInput(userInput), m_arguments(DecodeArguments(argument.c_str())) {};
+        winrt::hstring Argument() { return m_argument; };
         winrt::Windows::Foundation::Collections::IMap<hstring, hstring> UserInput() { return m_userInput; };
+        winrt::Windows::Foundation::Collections::IMap<hstring, hstring> Arguments() { return m_arguments; };
 
     private:
-        winrt::hstring m_arguments;
+        winrt::Windows::Foundation::Collections::IMap<hstring, hstring> DecodeArguments(std::wstring arguments);
+
+        winrt::hstring m_argument;
         winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> m_userInput;
+        winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> m_arguments{ nullptr };
     };
 }

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.cpp

@@ -31,7 +31,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
     {
         THROW_HR_IF_MSG(E_INVALIDARG, key.empty(), "You must provide a key when adding an argument");
 
-        m_arguments.Insert(key, value);
+        m_arguments.Insert(EncodeArgument(key.c_str()), EncodeArgument(value.c_str()));
         return *this;
     }
 
@@ -64,7 +64,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
     {
         THROW_HR_IF_MSG(E_INVALIDARG, m_textLines.size() >= c_maxTextElements, "Maximum number of text elements added");
 
-        m_textLines.push_back(wil::str_printf<std::wstring>(L"<text>%ls</text>", text.c_str()).c_str());
+        m_textLines.push_back(wil::str_printf<std::wstring>(L"<text>%ls</text>", EncodeXml(text).c_str()).c_str());
         return *this;
     }
 
@@ -73,7 +73,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         THROW_HR_IF_MSG(E_INVALIDARG, m_textLines.size() >= c_maxTextElements, "Maximum number of text elements added");
 
         std::wstring props{ properties.as<winrt::Windows::Foundation::IStringable>().ToString() };
-        m_textLines.push_back(wil::str_printf<std::wstring>(L"%ls%ls</text>", props.c_str(), text.c_str()).c_str());
+        m_textLines.push_back(wil::str_printf<std::wstring>(L"%ls%ls</text>", props.c_str(), EncodeXml(text).c_str()).c_str());
 
         if (properties.IncomingCallAlignment())
         {
@@ -84,15 +84,15 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::SetAttributionText(hstring const& text)
     {
-        m_attributionText = wil::str_printf<std::wstring>(L"<text placement='attribution'>%ls</text>", text.c_str());
+        m_attributionText = wil::str_printf<std::wstring>(L"<text placement='attribution'>%ls</text>", EncodeXml(text).c_str());
         return *this;
     }
 
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::SetAttributionText(hstring const& text, hstring const& language)
     {
         THROW_HR_IF_MSG(E_INVALIDARG, language.empty(), "You must provide a language calling SetAttributionText");
 
-        m_attributionText = wil::str_printf<std::wstring>(L"<text placement='attribution' lang='%ls'>%ls</text>", language.c_str(), text.c_str());
+        m_attributionText = wil::str_printf<std::wstring>(L"<text placement='attribution' lang='%ls'>%ls</text>", language.c_str(), EncodeXml(text).c_str());
         return *this;
     }
 
@@ -121,7 +121,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         THROW_HR_IF_MSG(E_INVALIDARG, alternateText.empty(), "You must provide an alternate text string calling SetInlineImage");
 
         std::wstring hintCrop { imageCrop == AppNotificationImageCrop::Circle ? L" hint-crop='circle'" : L"" };
-        m_inlineImage = wil::str_printf<std::wstring>(L"<image src='%ls' alt='%ls'%ls/>", imageUri.ToString().c_str(), alternateText.c_str(), hintCrop.c_str());
+        m_inlineImage = wil::str_printf<std::wstring>(L"<image src='%ls' alt='%ls'%ls/>", imageUri.ToString().c_str(), EncodeXml(alternateText).c_str(), hintCrop.c_str());
 
         return *this;
     }
@@ -151,7 +151,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         THROW_HR_IF_MSG(E_INVALIDARG, alternateText.empty(), "You must provide an alternate text string calling SetAppLogoOverride");
 
         std::wstring hintCrop{ imageCrop == AppNotificationImageCrop::Circle ? L" hint-crop='circle'" : L"" };
-        m_appLogoOverride = wil::str_printf<std::wstring>(L"<image placement='appLogoOverride' src='%ls' alt='%ls'%ls/>", imageUri.ToString().c_str(), alternateText.c_str(), hintCrop.c_str());
+        m_appLogoOverride = wil::str_printf<std::wstring>(L"<image placement='appLogoOverride' src='%ls' alt='%ls'%ls/>", imageUri.ToString().c_str(), EncodeXml(alternateText).c_str(), hintCrop.c_str());
 
         return *this;
     }
@@ -166,7 +166,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
     {
         THROW_HR_IF_MSG(E_INVALIDARG, alternateText.empty(), "You must provide an alternate text string calling SetHeroImage");
 
-        m_heroImage = wil::str_printf<std::wstring>(L"<image placement='hero' src='%ls' alt='%ls'/>", imageUri.ToString().c_str(), alternateText.c_str());
+        m_heroImage = wil::str_printf<std::wstring>(L"<image placement='hero' src='%ls' alt='%ls'/>", imageUri.ToString().c_str(), EncodeXml(alternateText).c_str());
         return *this;
     }
 
@@ -213,7 +213,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the TextBox");
 
 
-        m_textBoxList.push_back(wil::str_printf<std::wstring>(L"<input id='%ls' type='text'/>", id.c_str()));
+        m_textBoxList.push_back(wil::str_printf<std::wstring>(L"<input id='%ls' type='text'/>", EncodeXml(id).c_str()));
         return *this;
     }
 
@@ -222,7 +222,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         ThrowIfMaxInputItemsExceeded();
         THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the TextBox");
 
-        m_textBoxList.push_back(wil::str_printf<std::wstring>(L"<input id='%ls' type='text' placeHolderContent='%ls' title='%ls'/>", id.c_str(), placeHolderText.c_str(), title.c_str()));
+        m_textBoxList.push_back(wil::str_printf<std::wstring>(L"<input id='%ls' type='text' placeHolderContent='%ls' title='%ls'/>", EncodeXml(id).c_str(), EncodeXml(placeHolderText).c_str(), EncodeXml(title).c_str()));
         return *this;
     }
 

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilderUtility.h

@@ -1,13 +1,17 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-#pragma once
 #include "pch.h"
 #include "winrt/Microsoft.Windows.AppNotifications.Builder.h"
+#include <algorithm>
+#include <regex>
+#include <map>
+#include <iostream>
 
 constexpr size_t c_maxAppNotificationPayload{ 5120 };
 constexpr uint8_t c_maxTextElements{ 3 };
 constexpr uint8_t c_maxButtonElements{ 5 };
+constexpr size_t c_maxEncodingSize{ 3 };
 constexpr uint8_t c_maxTextInputElements{ 5 };
 constexpr uint8_t c_maxSelectionElements{ 5 };
 
@@ -16,6 +20,24 @@ namespace AppNotificationBuilder
     using namespace winrt::Microsoft::Windows::AppNotifications::Builder;
 }
 
+inline std::unordered_map<wchar_t, std::wstring> GetXmlEscapeEncodings()
+{
+    static std::unordered_map<wchar_t, std::wstring> encodings = { { L'&', L"&amp;"}, { L'\"', L"&quot;"}, {L'<', L"&lt;"}, {L'>', L"&gt;"}, {L'\'', L"&apos;"}};
+    return encodings;
+}
+
+inline std::unordered_map<wchar_t, std::wstring> GetPercentEncodings()
+{
+    static std::unordered_map<wchar_t, std::wstring> encodings = {{ L'%', L"%25"}, {L';', L"%3B"}, {L'=', L"%3D"} };
+    return encodings;
+}
+
+inline std::unordered_map<std::wstring, wchar_t> GetPercentEncodingsReverse()
+{
+    static std::unordered_map<std::wstring, wchar_t> encodings = { { L"%25", L'%' }, {L"%3B", L';' }, { L"%3D", L'=' } };
+    return encodings;
+}
+
 inline PCWSTR GetWinSoundEventString(AppNotificationBuilder::AppNotificationSoundEvent soundEvent)
 {
     switch (soundEvent)
@@ -72,3 +94,73 @@ inline PCWSTR GetWinSoundEventString(AppNotificationBuilder::AppNotificationSoun
         return L"ms-winsoundevent:Notification.Default";
     }
 }
+
+inline std::wstring EncodeArgument(std::wstring const& value)
+{
+    std::wstring encodedValue{};
+
+    auto percentEncodings{ GetPercentEncodings() };
+    auto xmlEncodings{ GetXmlEscapeEncodings() };
+    for (auto ch : value)
+    {
+        if (percentEncodings.find(ch) != percentEncodings.end())
+        {
+            encodedValue.append(percentEncodings[ch]);
+        }
+        else if (xmlEncodings.find(ch) != xmlEncodings.end())
+        {
+            encodedValue.append(xmlEncodings[ch]);
+        }
+        else
+        {
+            encodedValue.push_back(ch);
+        }
+    }
+
+    return encodedValue;
+}
+
+inline std::wstring EncodeXml(winrt::hstring const& value)
+{
+    std::wstring encodedValue{};
+
+    auto xmlEncodings{ GetXmlEscapeEncodings() };
+    for (auto ch : value)
+    {
+        if (xmlEncodings.find(ch) != xmlEncodings.end())
+        {
+            encodedValue.append(xmlEncodings[ch]);
+        }
+        else
+        {
+            encodedValue.push_back(ch);
+        }
+    }
+
+    return encodedValue;
+}
+
+// Decoding process based off the Windows Community Toolkit:
+// https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.Notifications/Toasts/ToastArguments.cs#L389inline
+inline std::wstring Decode(std::wstring const& value)
+{
+    std::wstring result{};
+    auto percentEncodings{ GetPercentEncodingsReverse() };
+
+    // Need to unescape special characters
+    for (size_t index = 0; index < value.size();)
+    {
+        std::wstring curr{ value.substr(index, c_maxEncodingSize) };
+        if (percentEncodings.find(curr) != percentEncodings.end())
+        {
+            result.push_back(percentEncodings[curr]);
+            index += c_maxEncodingSize;
+        }
+        else
+        {
+            result.push_back(value.at(index));
+            index++;
+        }
+    }
+    return result;
+}

dev/AppNotifications/AppNotificationBuilder/AppNotificationButton.cpp

@@ -5,6 +5,7 @@
 #include "AppNotificationButton.h"
 #include "Microsoft.Windows.AppNotifications.Builder.AppNotificationButton.g.cpp"
 #include <IsWindowsVersion.h>
+#include "AppNotificationBuilderUtility.h"
 
 namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 {
@@ -25,7 +26,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         THROW_HR_IF_MSG(E_INVALIDARG, key.empty(), "You must provide a key when adding an argument");
         THROW_HR_IF_MSG(E_INVALIDARG, m_protocolUri, "You cannot add an argument after calling SetInvokeUri");
 
-        m_arguments.Insert(key, value);
+        m_arguments.Insert(EncodeArgument(key.c_str()), EncodeArgument(value.c_str()));
         return *this;
     }
 
@@ -37,7 +38,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationButton AppNotificationButton::SetToolTip(winrt::hstring const& value)
     {
-        m_toolTip = value;
+        m_toolTip = EncodeXml(value.c_str()).c_str();
         return *this;
     }
 
@@ -55,7 +56,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationButton AppNotificationButton::SetInputId(winrt::hstring const& value)
     {
-        m_inputId = value;
+        m_inputId = EncodeXml(value.c_str()).c_str();
         return *this;
     }
 

dev/AppNotifications/AppNotificationBuilder/AppNotificationComboBox.cpp

@@ -8,24 +8,25 @@
 
 namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 {
-    AppNotificationComboBox::AppNotificationComboBox(hstring const& id) : m_id(id)
+    AppNotificationComboBox::AppNotificationComboBox(hstring const& id)
     {
         THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the ComboBox");
+        m_id = EncodeXml(id).c_str();
     };
 
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationComboBox AppNotificationComboBox::AddItem(winrt::hstring const& id, winrt::hstring const& content)
     {
         THROW_HR_IF_MSG(E_INVALIDARG, m_items.Size() >= c_maxSelectionElements, "Maximum number of items added");
         THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the item");
 
-        m_items.Insert(id, content);
+        m_items.Insert(EncodeXml(id).c_str(), EncodeXml(content).c_str());
 
         return *this;
     }
 
     winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationComboBox AppNotificationComboBox::SetTitle(winrt::hstring const& value)
     {
-        m_title = value;
+        m_title = EncodeXml(value).c_str();
 
         return *this;
     }
@@ -34,7 +35,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
     {
         THROW_HR_IF_MSG(E_INVALIDARG, id.empty(), "You must provide an id for the selected item");
 
-        m_selectedItem = id;
+        m_selectedItem = EncodeXml(id).c_str();
 
         return *this;
     }

dev/AppNotifications/AppNotificationBuilder/AppNotificationProgressBar.cpp

@@ -4,6 +4,7 @@
 #include "pch.h"
 #include "AppNotificationProgressBar.h"
 #include "Microsoft.Windows.AppNotifications.Builder.AppNotificationProgressBar.g.cpp"
+#include "AppNotificationBuilderUtility.h"
 
 namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 {
@@ -16,13 +17,13 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
     void AppNotificationProgressBar::Title(winrt::hstring const& value)
     {
-        m_title = value;
+        m_title = EncodeXml(value).c_str();
         m_titleBindMode = BindMode::Value;
     }
 
     void AppNotificationProgressBar::Status(winrt::hstring const& value)
     {
-        m_status = value;
+        m_status = EncodeXml(value).c_str();
         m_statusBindMode = BindMode::Value;
     }
 
@@ -36,7 +37,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
     void AppNotificationProgressBar::ValueStringOverride(winrt::hstring const& value)
     {
-        m_valueStringOverride = value;
+        m_valueStringOverride = EncodeXml(value).c_str();
         m_valueStringOverrideBindMode = BindMode::Value;
     }