PowerToys/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeWhatsNew.xaml.cs

// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using CommunityToolkit.WinUI.Controls;
using global::PowerToys.GPOWrapper;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Helpers;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.PowerToys.Settings.UI.Library.HotkeyConflicts;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
using Microsoft.PowerToys.Settings.UI.OOBE.Enums;
using Microsoft.PowerToys.Settings.UI.OOBE.ViewModel;
using Microsoft.PowerToys.Settings.UI.SerializationContext;
using Microsoft.PowerToys.Settings.UI.Services;
using Microsoft.PowerToys.Settings.UI.Views;
using Microsoft.PowerToys.Telemetry;
using Microsoft.UI.Text;
using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Controls;
using Microsoft.UI.Xaml.Media;
using Microsoft.UI.Xaml.Navigation;

namespace Microsoft.PowerToys.Settings.UI.OOBE.Views
{
    public sealed partial class OobeWhatsNew : Page, INotifyPropertyChanged
    {
        public OobePowerToysModule ViewModel { get; set; }

        private AllHotkeyConflictsData _allHotkeyConflictsData = new AllHotkeyConflictsData();

        public bool ShowDataDiagnosticsInfoBar => GetShowDataDiagnosticsInfoBar();

        private int _conflictCount;

        public AllHotkeyConflictsData AllHotkeyConflictsData
        {
            get => _allHotkeyConflictsData;
            set
            {
                if (_allHotkeyConflictsData != value)
                {
                    _allHotkeyConflictsData = value;

                    UpdateConflictCount();

                    OnPropertyChanged(nameof(AllHotkeyConflictsData));
                    OnPropertyChanged(nameof(HasConflicts));
                }
            }
        }

        public bool HasConflicts => _conflictCount > 0;

        private void UpdateConflictCount()
        {
            int count = 0;
            if (AllHotkeyConflictsData == null)
            {
                _conflictCount = count;
            }

            if (AllHotkeyConflictsData.InAppConflicts != null)
            {
                foreach (var inAppConflict in AllHotkeyConflictsData.InAppConflicts)
                {
                    if (!inAppConflict.ConflictIgnored)
                    {
                        count++;
                    }
                }
            }

            if (AllHotkeyConflictsData.SystemConflicts != null)
            {
                foreach (var systemConflict in AllHotkeyConflictsData.SystemConflicts)
                {
                    if (!systemConflict.ConflictIgnored)
                    {
                        count++;
                    }
                }
            }

            _conflictCount = count;
        }

        public event PropertyChangedEventHandler PropertyChanged;

        /// <summary>
        /// Initializes a new instance of the <see cref="OobeWhatsNew"/> class.
        /// </summary>
        public OobeWhatsNew()
        {
            this.InitializeComponent();
            ViewModel = new OobePowerToysModule(OobeShellPage.OobeShellHandler.Modules[(int)PowerToysModules.WhatsNew]);
            DataContext = this;

            // Subscribe to hotkey conflict updates
            if (GlobalHotkeyConflictManager.Instance != null)
            {
                GlobalHotkeyConflictManager.Instance.ConflictsUpdated += OnConflictsUpdated;
                GlobalHotkeyConflictManager.Instance.RequestAllConflicts();
            }
        }

        private void OnConflictsUpdated(object sender, AllHotkeyConflictsEventArgs e)
        {
            this.DispatcherQueue.TryEnqueue(Microsoft.UI.Dispatching.DispatcherQueuePriority.Normal, () =>
            {
                var allConflictData = e.Conflicts;
                foreach (var inAppConflict in allConflictData.InAppConflicts)
                {
                    var hotkey = inAppConflict.Hotkey;
                    var hotkeySetting = new HotkeySettings(hotkey.Win, hotkey.Ctrl, hotkey.Alt, hotkey.Shift, hotkey.Key);
                    inAppConflict.ConflictIgnored = HotkeyConflictIgnoreHelper.IsIgnoringConflicts(hotkeySetting);
                }

                foreach (var systemConflict in allConflictData.SystemConflicts)
                {
                    var hotkey = systemConflict.Hotkey;
                    var hotkeySetting = new HotkeySettings(hotkey.Win, hotkey.Ctrl, hotkey.Alt, hotkey.Shift, hotkey.Key);
                    systemConflict.ConflictIgnored = HotkeyConflictIgnoreHelper.IsIgnoringConflicts(hotkeySetting);
                }

                AllHotkeyConflictsData = e.Conflicts ?? new AllHotkeyConflictsData();
            });
        }

        private void OnPropertyChanged(string propertyName)
        {
            PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
        }

        private bool GetShowDataDiagnosticsInfoBar()
        {
            var isDataDiagnosticsGpoDisallowed = GPOWrapper.GetAllowDataDiagnosticsValue() == GpoRuleConfigured.Disabled;

            if (isDataDiagnosticsGpoDisallowed)
            {
                return false;
            }

            bool userActed = DataDiagnosticsSettings.GetUserActionValue();

            if (userActed)
            {
                return false;
            }

            bool registryValue = DataDiagnosticsSettings.GetEnabledValue();

            bool isFirstRunAfterUpdate = (App.Current as Microsoft.PowerToys.Settings.UI.App).ShowScoobe;
            if (isFirstRunAfterUpdate && registryValue == false)
            {
                return true;
            }

            return false;
        }

        /// <summary>
        /// Regex to remove installer hash sections from the release notes.
        /// </summary>
        private const string RemoveInstallerHashesRegex = @"(\r\n)+## Installer Hashes(\r\n.*)+## Highlights";
        private const string RemoveHotFixInstallerHashesRegex = @"(\r\n)+## Installer Hashes(\r\n.*)+$";
        private const RegexOptions RemoveInstallerHashesRegexOptions = RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.CultureInvariant;
        private bool _loadingReleaseNotes;

        private static async Task<string> GetReleaseNotesMarkdown()
        {
            string releaseNotesJSON = string.Empty;

            // Let's use system proxy
            using var proxyClientHandler = new HttpClientHandler
            {
                DefaultProxyCredentials = CredentialCache.DefaultCredentials,
                Proxy = WebRequest.GetSystemWebProxy(),
                PreAuthenticate = true,
            };

            using var getReleaseInfoClient = new HttpClient(proxyClientHandler);

            // GitHub APIs require sending an user agent
            // https://docs.github.com/rest/overview/resources-in-the-rest-api#user-agent-required
            getReleaseInfoClient.DefaultRequestHeaders.TryAddWithoutValidation("User-Agent", "PowerToys");
            releaseNotesJSON = await getReleaseInfoClient.GetStringAsync("https://api.github.com/repos/microsoft/PowerToys/releases");
            IList<PowerToysReleaseInfo> releases = JsonSerializer.Deserialize<IList<PowerToysReleaseInfo>>(releaseNotesJSON, SourceGenerationContextContext.Default.IListPowerToysReleaseInfo);

            // Get the latest releases
            var latestReleases = releases.OrderByDescending(release => release.PublishedDate).Take(5);

            StringBuilder releaseNotesHtmlBuilder = new StringBuilder(string.Empty);

            // Regex to remove installer hash sections from the release notes.
            Regex removeHashRegex = new Regex(RemoveInstallerHashesRegex, RemoveInstallerHashesRegexOptions);

            // Regex to remove installer hash sections from the release notes, since there'll be no Highlights section for hotfix releases.
            Regex removeHotfixHashRegex = new Regex(RemoveHotFixInstallerHashesRegex, RemoveInstallerHashesRegexOptions);
            int counter = 0;
            foreach (var release in latestReleases)
            {
                releaseNotesHtmlBuilder.AppendLine("# " + release.Name);
                var notes = removeHashRegex.Replace(release.ReleaseNotes, "\r\n### Highlights");

                // Add a unique counter to [github-current-release-work] to distinguish each release,
                // since this variable is used for all latest releases when they are merged.
                notes = notes.Replace("[github-current-release-work]", $"[github-current-release-work{++counter}]");
                notes = removeHotfixHashRegex.Replace(notes, string.Empty);
                releaseNotesHtmlBuilder.AppendLine(notes);
                releaseNotesHtmlBuilder.AppendLine("&nbsp;");
            }

            return releaseNotesHtmlBuilder.ToString();
        }

        private async Task Reload()
        {
            if (_loadingReleaseNotes)
            {
                return;
            }

            try
            {
                _loadingReleaseNotes = true;
                ReleaseNotesMarkdown.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
                LoadingProgressRing.Visibility = Microsoft.UI.Xaml.Visibility.Visible;
                string releaseNotesMarkdown = await GetReleaseNotesMarkdown();
                ProxyWarningInfoBar.IsOpen = false;
                ErrorInfoBar.IsOpen = false;

                ReleaseNotesMarkdown.Text = releaseNotesMarkdown;
                ReleaseNotesMarkdown.Visibility = Microsoft.UI.Xaml.Visibility.Visible;
                LoadingProgressRing.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
            }
            catch (HttpRequestException httpEx)
            {
                Logger.LogError("Exception when loading the release notes", httpEx);
                if (httpEx.Message.Contains("407", StringComparison.CurrentCulture))
                {
                    ProxyWarningInfoBar.IsOpen = true;
                }
                else
                {
                    ErrorInfoBar.IsOpen = true;
                }
            }
            catch (Exception ex)
            {
                Logger.LogError("Exception when loading the release notes", ex);
                ErrorInfoBar.IsOpen = true;
            }
            finally
            {
                LoadingProgressRing.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
                _loadingReleaseNotes = false;
            }
        }

        private async void Page_Loaded(object sender, Microsoft.UI.Xaml.RoutedEventArgs e)
        {
            await Reload();
        }

        /// <inheritdoc/>
        protected override void OnNavigatedTo(NavigationEventArgs e)
        {
            ViewModel.LogOpeningModuleEvent();
        }

        /// <inheritdoc/>
        protected override void OnNavigatedFrom(NavigationEventArgs e)
        {
            ViewModel.LogClosingModuleEvent();

            // Unsubscribe from conflict updates when leaving the page
            if (GlobalHotkeyConflictManager.Instance != null)
            {
                GlobalHotkeyConflictManager.Instance.ConflictsUpdated -= OnConflictsUpdated;
            }
        }

        private void DataDiagnostics_InfoBar_YesNo_Click(object sender, Microsoft.UI.Xaml.RoutedEventArgs e)
        {
            string commandArg = string.Empty;
            if (sender is Button senderBtn)
            {
                commandArg = senderBtn.CommandParameter.ToString();
            }
            else if (sender is HyperlinkButton senderLink)
            {
                commandArg = senderLink.CommandParameter.ToString();
            }

            if (string.IsNullOrEmpty(commandArg))
            {
                return;
            }

            // Update UI
            if (commandArg == "Yes")
            {
                WhatsNewDataDiagnosticsInfoBar.Header = ResourceLoaderInstance.ResourceLoader.GetString("Oobe_WhatsNew_DataDiagnostics_Yes_Click_InfoBar_Title");
            }
            else
            {
                WhatsNewDataDiagnosticsInfoBar.Header = ResourceLoaderInstance.ResourceLoader.GetString("Oobe_WhatsNew_DataDiagnostics_No_Click_InfoBar_Title");
            }

            WhatsNewDataDiagnosticsInfoBarDescText.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
            WhatsNewDataDiagnosticsInfoBarDescTextYesClicked.Visibility = Microsoft.UI.Xaml.Visibility.Visible;
            DataDiagnosticsButtonYes.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
            DataDiagnosticsButtonNo.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;

            // Set Data Diagnostics registry values
            if (commandArg == "Yes")
            {
                DataDiagnosticsSettings.SetEnabledValue(true);
            }
            else
            {
                DataDiagnosticsSettings.SetEnabledValue(false);
            }

            DataDiagnosticsSettings.SetUserActionValue(true);

            this.DispatcherQueue.TryEnqueue(Microsoft.UI.Dispatching.DispatcherQueuePriority.Normal, () =>
            {
                ShellPage.ShellHandler?.SignalGeneralDataUpdate();
            });
        }

        private void DataDiagnostics_InfoBar_Close_Click(object sender, Microsoft.UI.Xaml.RoutedEventArgs e)
        {
            WhatsNewDataDiagnosticsInfoBar.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
        }

        private void DataDiagnostics_OpenSettings_Click(Microsoft.UI.Xaml.Documents.Hyperlink sender, Microsoft.UI.Xaml.Documents.HyperlinkClickEventArgs args)
        {
            Common.UI.SettingsDeepLink.OpenSettings(Common.UI.SettingsDeepLink.SettingsWindow.Overview);
        }

        private async void LoadReleaseNotes_Click(object sender, Microsoft.UI.Xaml.RoutedEventArgs e)
        {
            await Reload();
        }
    }
}