Merge branch 'feature/win2dparser' of https://github.com/ratishphilip/WindowsCommunityToolkit into feature/win2dparser

Author: ratishphilip

Microsoft.Toolkit.Uwp.Notifications/Toasts/Compat/Desktop/Win32AppInfo.cs

@@ -5,10 +5,12 @@
 #if WIN32
 
 using System;
+using System.Collections.Specialized;
 using System.Diagnostics;
 using System.Drawing;
 using System.Drawing.Imaging;
 using System.IO;
+using System.Linq;
 using System.Reflection;
 using System.Runtime.InteropServices;
 using System.Security.Cryptography;
@@ -18,6 +20,11 @@ namespace Microsoft.Toolkit.Uwp.Notifications
 {
     internal class Win32AppInfo
     {
+        /// <summary>
+        /// If an AUMID is greater than 129 characters, scheduled toast notification APIs will throw an exception.
+        /// </summary>
+        private const int AUMID_MAX_LENGTH = 129;
+
         public string Aumid { get; set; }
 
         public string DisplayName { get; set; }
@@ -32,6 +39,9 @@ public static Win32AppInfo Get()
             IApplicationResolver appResolver = (IApplicationResolver)new CAppResolver();
             appResolver.GetAppIDForProcess(Convert.ToUInt32(process.Id), out string appId, out _, out _, out _);
 
+            // Use app ID (or hashed app ID) as AUMID
+            string aumid = appId.Length > AUMID_MAX_LENGTH ? HashAppId(appId) : appId;
+
             // Then try to get the shortcut (for display name and icon)
             IShellItem shortcutItem = null;
             try
@@ -98,12 +108,21 @@ public static Win32AppInfo Get()
 
             return new Win32AppInfo()
             {
-                Aumid = appId,
+                Aumid = aumid,
                 DisplayName = displayName,
                 IconPath = iconPath
             };
         }
 
+        private static string HashAppId(string appId)
+        {
+            using (SHA1 sha1 = SHA1.Create())
+            {
+                byte[] hashedBytes = sha1.ComputeHash(Encoding.UTF8.GetBytes(appId));
+                return string.Join(string.Empty, hashedBytes.Select(b => b.ToString("X2")));
+            }
+        }
+
         private static string GetDisplayNameFromCurrentProcess(Process process)
         {
             // If AssemblyTitle is set, use that

Microsoft.Toolkit.Uwp.Notifications/Toasts/Compat/ToastNotificationHistoryCompat.cs

@@ -53,14 +53,18 @@ public IReadOnlyList<ToastNotification> GetHistory()
         /// <param name="tag">The tag label of the toast notification to be removed.</param>
         public void Remove(string tag)
         {
+#if WIN32
             if (_aumid != null)
             {
-                _history.Remove(tag, string.Empty, _aumid);
+                _history.Remove(tag, ToastNotificationManagerCompat.DEFAULT_GROUP, _aumid);
             }
             else
             {
                 _history.Remove(tag);
             }
+#else
+            _history.Remove(tag);
+#endif
         }
 
         /// <summary>

Microsoft.Toolkit.Uwp.Notifications/Toasts/Compat/ToastNotificationManagerCompat.cs

@@ -26,6 +26,8 @@ public static class ToastNotificationManagerCompat
     {
 #if WIN32
         private const string TOAST_ACTIVATED_LAUNCH_ARG = "-ToastActivated";
+        private const string REG_HAS_SENT_NOTIFICATION = "HasSentNotification";
+        internal const string DEFAULT_GROUP = "toolkitGroupNull";
 
         private const int CLASS_E_NOAGGREGATION = -2147221232;
         private const int E_NOINTERFACE = -2147467262;
@@ -37,6 +39,8 @@ public static class ToastNotificationManagerCompat
         private static bool _registeredOnActivated;
         private static List<OnActivated> _onActivated = new List<OnActivated>();
 
+        private static bool _hasSentNotification;
+
         /// <summary>
         /// Event that is triggered when a notification or notification button is clicked. Subscribe to this event in your app's initial startup code.
         /// </summary>
@@ -145,7 +149,7 @@ private static void Initialize()
             var activatorType = CreateAndRegisterActivator();
 
             // Register via registry
-            using (var rootKey = Registry.CurrentUser.CreateSubKey(@"Software\Classes\AppUserModelId\" + _win32Aumid))
+            using (var rootKey = Registry.CurrentUser.CreateSubKey(GetRegistrySubKey()))
             {
                 // If they don't have identity, we need to specify the display assets
                 if (!DesktopBridgeHelpers.HasIdentity())
@@ -168,12 +172,20 @@ private static void Initialize()
                     // Background color only appears in the settings page, format is
                     // hex without leading #, like "FFDDDDDD"
                     rootKey.SetValue("IconBackgroundColor", "FFDDDDDD");
+
+                    // Additionally, we need to read whether they've sent a notification before
+                    _hasSentNotification = rootKey.GetValue(REG_HAS_SENT_NOTIFICATION) != null;
                 }
 
                 rootKey.SetValue("CustomActivator", string.Format("{{{0}}}", activatorType.GUID));
             }
         }
 
+        private static string GetRegistrySubKey()
+        {
+            return @"Software\Classes\AppUserModelId\" + _win32Aumid;
+        }
+
         private static Type CreateActivatorType()
         {
             // https://stackoverflow.com/questions/24069352/c-sharp-typebuilder-generate-class-with-function-dynamically
@@ -332,8 +344,8 @@ private static extern int CoRegisterClassObject(
         /// <summary>
         /// Creates a toast notifier.
         /// </summary>
-        /// <returns><see cref="ToastNotifier"/></returns>
-        public static ToastNotifier CreateToastNotifier()
+        /// <returns><see cref="ToastNotifierCompat"/>An instance of the toast notifier.</returns>
+        public static ToastNotifierCompat CreateToastNotifier()
         {
 #if WIN32
             if (_initializeEx != null)
@@ -343,14 +355,14 @@ public static ToastNotifier CreateToastNotifier()
 
             if (DesktopBridgeHelpers.HasIdentity())
             {
-                return ToastNotificationManager.CreateToastNotifier();
+                return new ToastNotifierCompat(ToastNotificationManager.CreateToastNotifier());
             }
             else
             {
-                return ToastNotificationManager.CreateToastNotifier(_win32Aumid);
+                return new ToastNotifierCompat(ToastNotificationManager.CreateToastNotifier(_win32Aumid));
             }
 #else
-            return ToastNotificationManager.CreateToastNotifier();
+            return new ToastNotifierCompat(ToastNotificationManager.CreateToastNotifier());
 #endif
         }
 
@@ -437,7 +449,7 @@ public static void Uninstall()
                 // Remove registry key
                 if (_win32Aumid != null)
                 {
-                    Registry.CurrentUser.DeleteSubKey(@"Software\Classes\AppUserModelId\" + _win32Aumid);
+                    Registry.CurrentUser.DeleteSubKey(GetRegistrySubKey());
                 }
             }
             catch
@@ -472,6 +484,51 @@ public static void Uninstall()
             }
         }
 #endif
+
+#if WIN32
+        internal static void SetHasSentToastNotification()
+        {
+            // For plain Win32 apps, record that we've sent a notification
+            if (!_hasSentNotification && !DesktopBridgeHelpers.HasIdentity())
+            {
+                _hasSentNotification = true;
+
+                try
+                {
+                    using (var rootKey = Registry.CurrentUser.CreateSubKey(GetRegistrySubKey()))
+                    {
+                        rootKey.SetValue(REG_HAS_SENT_NOTIFICATION, 1);
+                    }
+                }
+                catch
+                {
+                }
+            }
+        }
+
+        internal static void PreRegisterIdentityLessApp()
+        {
+            // For plain Win32 apps, we first have to have send a toast notification once before using scheduled toasts.
+            if (!_hasSentNotification && !DesktopBridgeHelpers.HasIdentity())
+            {
+                const string tag = "toolkit1stNotif";
+
+                // Show the toast
+                new ToastContentBuilder()
+                    .AddText("New notification")
+                    .Show(toast =>
+                    {
+                        // We'll hide the popup and set the toast to expire in case removing doesn't work
+                        toast.SuppressPopup = true;
+                        toast.Tag = tag;
+                        toast.ExpirationTime = DateTime.Now.AddSeconds(15);
+                    });
+
+                // And then remove it
+                ToastNotificationManagerCompat.History.Remove(tag);
+            }
+        }
+#endif
     }
 }
 

Microsoft.Toolkit.Uwp.Notifications/Toasts/Compat/ToastNotifierCompat.cs

@@ -0,0 +1,172 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+#if WINDOWS_UWP
+
+using System.Collections.Generic;
+using Windows.UI.Notifications;
+
+namespace Microsoft.Toolkit.Uwp.Notifications
+{
+    /// <summary>
+    /// Allows you to show and schedule toast notifications.
+    /// </summary>
+    public sealed class ToastNotifierCompat
+    {
+        private ToastNotifier _notifier;
+
+        internal ToastNotifierCompat(ToastNotifier notifier)
+        {
+            _notifier = notifier;
+        }
+
+        /// <summary>
+        /// Displays the specified toast notification.
+        /// </summary>
+        /// <param name="notification">The object that contains the content of the toast notification to display.</param>
+        public void Show(ToastNotification notification)
+        {
+#if WIN32
+            PreprocessToast(notification);
+#endif
+
+            _notifier.Show(notification);
+
+#if WIN32
+            ToastNotificationManagerCompat.SetHasSentToastNotification();
+#endif
+        }
+
+        /// <summary>
+        /// Hides the specified toast notification from the screen (moves it into Action Center).
+        /// </summary>
+        /// <param name="notification">The object that specifies the toast to hide.</param>
+        public void Hide(ToastNotification notification)
+        {
+#if WIN32
+            PreprocessToast(notification);
+#endif
+
+            _notifier.Hide(notification);
+        }
+
+        /// <summary>
+        /// Adds a ScheduledToastNotification for later display by Windows.
+        /// </summary>
+        /// <param name="scheduledToast">The scheduled toast notification, which includes its content and timing instructions.</param>
+        public void AddToSchedule(ScheduledToastNotification scheduledToast)
+        {
+#if WIN32
+            ToastNotificationManagerCompat.PreRegisterIdentityLessApp();
+
+            PreprocessScheduledToast(scheduledToast);
+#endif
+
+            _notifier.AddToSchedule(scheduledToast);
+        }
+
+        /// <summary>
+        /// Cancels the scheduled display of a specified ScheduledToastNotification.
+        /// </summary>
+        /// <param name="scheduledToast">The notification to remove from the schedule.</param>
+        public void RemoveFromSchedule(ScheduledToastNotification scheduledToast)
+        {
+#if WIN32
+            PreprocessScheduledToast(scheduledToast);
+#endif
+
+            _notifier.RemoveFromSchedule(scheduledToast);
+        }
+
+        /// <summary>
+        /// Gets the collection of ScheduledToastNotification objects that this app has scheduled for display.
+        /// </summary>
+        /// <returns>The collection of scheduled toast notifications that the app bound to this notifier has scheduled for timed display.</returns>
+        public IReadOnlyList<ScheduledToastNotification> GetScheduledToastNotifications()
+        {
+            return _notifier.GetScheduledToastNotifications();
+        }
+
+        /// <summary>
+        /// Updates the existing toast notification that has the specified tag and belongs to the specified notification group.
+        /// </summary>
+        /// <param name="data">An object that contains the updated info.</param>
+        /// <param name="tag">The identifier of the toast notification to update.</param>
+        /// <param name="group">The ID of the ToastCollection that contains the notification.</param>
+        /// <returns>A value that indicates the result of the update (failure, success, etc).</returns>
+        public NotificationUpdateResult Update(NotificationData data, string tag, string group)
+        {
+            return _notifier.Update(data, tag, group);
+        }
+
+        /// <summary>
+        /// Updates the existing toast notification that has the specified tag.
+        /// </summary>
+        /// <param name="data">An object that contains the updated info.</param>
+        /// <param name="tag">The identifier of the toast notification to update.</param>
+        /// <returns>A value that indicates the result of the update (failure, success, etc).</returns>
+        public NotificationUpdateResult Update(NotificationData data, string tag)
+        {
+#if WIN32
+            // For apps that don't have identity...
+            if (!DesktopBridgeHelpers.HasIdentity())
+            {
+                // If group isn't specified, we have to add a group since otherwise can't remove without a group
+                return Update(data, tag, ToastNotificationManagerCompat.DEFAULT_GROUP);
+            }
+#endif
+
+            return _notifier.Update(data, tag);
+        }
+
+        /// <summary>
+        /// Gets a value that tells you whether there is an app, user, or system block that prevents the display of a toast notification.
+        /// </summary>
+        public NotificationSetting Setting
+        {
+            get
+            {
+#if WIN32
+                // Just like scheduled notifications, apps need to have sent a notification
+                // before checking the setting value works
+                ToastNotificationManagerCompat.PreRegisterIdentityLessApp();
+#endif
+
+                return _notifier.Setting;
+            }
+        }
+
+#if WIN32
+        private void PreprocessToast(ToastNotification notification)
+        {
+            // For apps that don't have identity...
+            if (!DesktopBridgeHelpers.HasIdentity())
+            {
+                // If tag is specified
+                if (!string.IsNullOrEmpty(notification.Tag))
+                {
+                    // If group isn't specified, we have to add a group since otherwise can't remove without a group
+                    notification.Group = ToastNotificationManagerCompat.DEFAULT_GROUP;
+                }
+            }
+        }
+
+        private void PreprocessScheduledToast(ScheduledToastNotification notification)
+        {
+            // For apps that don't have identity...
+            if (!DesktopBridgeHelpers.HasIdentity())
+            {
+                // If tag is specified
+                if (!string.IsNullOrEmpty(notification.Tag))
+                {
+                    // If group isn't specified, we have to add a group since otherwise can't remove without a group
+                    notification.Group = ToastNotificationManagerCompat.DEFAULT_GROUP;
+                }
+            }
+        }
+#endif
+    }
+}
+
+#endif