Encoding/Decoding AppNotificationBuilder arguments

dev/AppNotifications/AppNotificationActivatedEventArgs.cpp

@@ -0,0 +1,42 @@
+// 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

@@ -26,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");
 
-        m_arguments.Insert(key, value);
+        m_arguments.Insert(Encode(key.c_str()), Encode(value.c_str()));
         return *this;
     }
 

dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilderUtility.h

@@ -1,9 +1,11 @@
 // 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>
 
 constexpr size_t c_maxAppNotificationPayload{ 5120 };
 constexpr uint8_t c_maxTextElements{ 3 };
@@ -14,6 +16,12 @@ namespace AppNotificationBuilder
     using namespace winrt::Microsoft::Windows::AppNotifications::Builder;
 }
 
+inline std::map<wchar_t, PCWSTR> GetCharacterEncodings()
+{
+    static std::map<wchar_t, PCWSTR> encodings = { { L'%', L"%25"}, { L';', L"%3B"}, { L'=', L"%3D"}};
+    return encodings;
+}
+
 inline PCWSTR GetWinSoundEventString(AppNotificationBuilder::AppNotificationSoundEvent soundEvent)
 {
     switch (soundEvent)
@@ -70,3 +78,38 @@ inline PCWSTR GetWinSoundEventString(AppNotificationBuilder::AppNotificationSoun
         return L"ms-winsoundevent:Notification.Default";
     }
 }
+
+inline std::wstring Encode(std::wstring const& value)
+{
+    std::wstring encodedValue{};
+
+    auto encodings{ GetCharacterEncodings() };
+    for (auto ch : value)
+    {
+        if(encodings.find(ch) != encodings.end())
+        {
+            encodedValue.append(encodings[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{ value };
+
+    // Need to unescape special characters
+    for (auto encoding : GetCharacterEncodings())
+    {
+        std::wstring specialCharacter{ encoding.first };
+        result = std::regex_replace(result, std::wregex(encoding.second), specialCharacter);
+    }
+
+    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(Encode(key.c_str()), Encode(value.c_str()));
         return *this;
     }
 

dev/AppNotifications/AppNotifications.idl

@@ -4,7 +4,7 @@ import "..\AppLifecycle\AppLifecycle.idl";
 
 namespace Microsoft.Windows.AppNotifications
 {
-    [contractversion(2)]
+    [contractversion(3)]
     apicontract AppNotificationsContract {}
 
     // Event args for the Notification Activation
@@ -16,6 +16,10 @@ namespace Microsoft.Windows.AppNotifications
 
         // The data from the input elements of a Notification like a TextBox
         Windows.Foundation.Collections.IMap<String, String> UserInput{ get; };
+
+        // Arguments from the invoked button built from AppNotificationBuilder
+        [contract(AppNotificationsContract, 3)]
+        Windows.Foundation.Collections.IMap<String, String> Arguments{ get; };
     }
 
     // Notification Progress Data

dev/AppNotifications/AppNotifications.vcxitems

@@ -26,6 +26,7 @@
     <ClInclude Include="$(MSBuildThisFileDirectory)ShellLocalization.h" />
   </ItemGroup>
   <ItemGroup>
+    <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationActivatedEventArgs.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationManager.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotification.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)AppNotificationProgressData.cpp" />