Ability to keep a local cache of icons (#16)

Co-authored-by: Alexandru Macocian <almacoci@microsoft.com>

Daybreak/Configuration/ApplicationConfiguration.cs

@@ -37,5 +37,7 @@ namespace Daybreak.Configuration
         public bool PlaceShortcut { get; set; }
         [JsonProperty("AutoCheckUpdate")]
         public bool AutoCheckUpdate { get; set; } = true;
+        [JsonProperty("KeepLocalIconCache")]
+        public bool KeepLocalIconCache { get; set; } = true;
     }
 }

Daybreak/Controls/Templates/AttributeTemplate.xaml.cs

@@ -15,6 +15,7 @@ namespace Daybreak.Controls
     public partial class AttributeTemplate : UserControl
     {
         public event EventHandler<AttributeEntry> HelpClicked;
+        public event EventHandler<AttributeEntry> AttributeChanged;
         
         [GenerateDependencyProperty(InitialValue = false)]
         private bool canAdd;
@@ -50,6 +51,7 @@ namespace Daybreak.Controls
                 this.DataContext.As<AttributeEntry>().Points--;
                 this.CanSubtract = this.DataContext.As<AttributeEntry>().Points > 0;
                 this.CanAdd = true;
+                this.AttributeChanged?.Invoke(this, this.DataContext.As<AttributeEntry>());
             }
         }
 
@@ -60,6 +62,7 @@ namespace Daybreak.Controls
                 this.DataContext.As<AttributeEntry>().Points++;
                 this.CanAdd = this.DataContext.As<AttributeEntry>().Points < 12;
                 this.CanSubtract = true;
+                this.AttributeChanged?.Invoke(this, this.DataContext.As<AttributeEntry>());
             }
         }
 

Daybreak/Controls/Templates/BuildTemplate.xaml

@@ -75,7 +75,7 @@
                      HorizontalContentAlignment="Stretch" BorderThickness="0">
                 <ListBox.ItemTemplate>
                     <DataTemplate>
-                        <local:AttributeTemplate HelpClicked="AttributeTemplate_HelpClicked"></local:AttributeTemplate>
+                        <local:AttributeTemplate HelpClicked="AttributeTemplate_HelpClicked" AttributeChanged="AttributeTemplate_AttributeChanged"></local:AttributeTemplate>
                     </DataTemplate>
                 </ListBox.ItemTemplate>
             </ListBox>

Daybreak/Controls/Templates/BuildTemplate.xaml.cs

@@ -3,6 +3,7 @@ using Daybreak.Services.BuildTemplates;
 using Daybreak.Services.Configuration;
 using Daybreak.Services.IconRetrieve;
 using Microsoft.Extensions.Logging;
+using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Extensions;
@@ -23,10 +24,13 @@ namespace Daybreak.Controls
         private const string InfoNamePlaceholder = "[NAME]";
         private const string BaseAddress = $"https://wiki.guildwars.com/wiki/{InfoNamePlaceholder}";
 
+        private bool suppressBuildChanged = false;
         private bool loadedProperties = false;
         private BuildEntry loadedBuild;
         private SkillTemplate selectingSkillTemplate;
 
+        public event EventHandler BuildChanged;
+
         [GenerateDependencyProperty]
         private Profession primaryProfession;
         [GenerateDependencyProperty]
@@ -95,6 +99,33 @@ namespace Daybreak.Controls
                 }
                 this.LoadSkills();
                 this.LoadAttributes();
+                if (this.suppressBuildChanged is false)
+                {
+                    this.BuildChanged?.Invoke(this, new EventArgs());
+                }
+            }
+
+            if (e.Property == Skill0Property ||
+                e.Property == Skill1Property ||
+                e.Property == Skill2Property ||
+                e.Property == Skill3Property ||
+                e.Property == Skill4Property ||
+                e.Property == Skill5Property ||
+                e.Property == Skill6Property ||
+                e.Property == Skill7Property)
+            {
+                if (this.suppressBuildChanged is false)
+                {
+                    this.loadedBuild.Build.Skills[0] = this.Skill0;
+                    this.loadedBuild.Build.Skills[1] = this.Skill1;
+                    this.loadedBuild.Build.Skills[2] = this.Skill2;
+                    this.loadedBuild.Build.Skills[3] = this.Skill3;
+                    this.loadedBuild.Build.Skills[4] = this.Skill4;
+                    this.loadedBuild.Build.Skills[5] = this.Skill5;
+                    this.loadedBuild.Build.Skills[6] = this.Skill6;
+                    this.loadedBuild.Build.Skills[7] = this.Skill7;
+                    this.BuildChanged?.Invoke(this, new EventArgs());
+                }
             }
         }
 
@@ -218,6 +249,7 @@ namespace Daybreak.Controls
 
         private void LoadBuild()
         {
+            this.suppressBuildChanged = true;
             var build = this.DataContext.As<BuildEntry>();
             this.loadedBuild = build;
             this.PrimaryProfession = build.Build.Primary;
@@ -230,6 +262,7 @@ namespace Daybreak.Controls
             this.Skill5 = build.Build.Skills[5];
             this.Skill6 = build.Build.Skills[6];
             this.Skill7 = build.Build.Skills[7];
+            this.suppressBuildChanged = false;
         }
 
         private void BrowseToInfo(string infoName)
@@ -294,6 +327,11 @@ namespace Daybreak.Controls
             this.BrowseToInfo(e.Attribute.Name);
         }
 
+        private void AttributeTemplate_AttributeChanged(object sender, AttributeEntry e)
+        {
+            this.BuildChanged?.Invoke(this, new EventArgs());
+        }
+
         private void SkillTemplate_Clicked(object sender, RoutedEventArgs e)
         {
             var skill = sender.As<SkillTemplate>().DataContext.As<Skill>();

Daybreak/Daybreak.csproj

@@ -10,7 +10,7 @@
     <LangVersion>preview</LangVersion>
     <ApplicationIcon>Daybreak.ico</ApplicationIcon>
     <IncludePackageReferencesDuringMarkupCompilation>true</IncludePackageReferencesDuringMarkupCompilation>
-    <Version>0.9.0.1</Version>
+    <Version>0.9.2</Version>
   </PropertyGroup>
 
   <ItemGroup>

Daybreak/Services/IconRetrieve/IconRetriever.cs

@@ -1,4 +1,5 @@
 using Daybreak.Models.Builds;
+using Daybreak.Services.Configuration;
 using HtmlAgilityPack;
 using Microsoft.Extensions.Logging;
 using System;
@@ -15,20 +16,48 @@ namespace Daybreak.Services.IconRetrieve
         private const string NamePlaceholder = "[SKILLNAME]";
         private const string BaseUrl = "https://wiki.guildwars.com";
         private const string QueryUrl = $"wiki/File:{NamePlaceholder}.jpg";
+        private const string IconsDirectoryName = "Icons";
+        private const string IconsLocation = $"{IconsDirectoryName}/{NamePlaceholder}.jpg";
 
         private readonly IHttpClient<IconRetriever> httpClient;
         private readonly ILogger<IconRetriever> logger;
+        private readonly IConfigurationManager configurationManager;
 
         public IconRetriever(
             ILogger<IconRetriever> logger,
-            IHttpClient<IconRetriever> httpClient)
+            IHttpClient<IconRetriever> httpClient,
+            IConfigurationManager configurationManager)
         {
             this.logger = logger.ThrowIfNull(nameof(logger));
             this.httpClient = httpClient.ThrowIfNull(nameof(httpClient));
+            this.configurationManager = configurationManager.ThrowIfNull(nameof(configurationManager));
             this.httpClient.BaseAddress = new Uri(BaseUrl);
+            if (Directory.Exists(IconsDirectoryName) is false)
+            {
+                Directory.CreateDirectory(IconsDirectoryName);
+            }
         }
 
         public async Task<Optional<Stream>> GetIcon(Skill skill)
+        {
+            if (this.configurationManager.GetConfiguration().KeepLocalIconCache)
+            {
+                this.logger.LogInformation($"{nameof(IconRetriever)} configured to look first in cache before downloading icons");
+                var maybeIcon = await this.GetLocalIcon(skill);
+                if (maybeIcon.ExtractValue() is Stream stream)
+                {
+                    return stream;
+                }
+            }
+            else
+            {
+                this.logger.LogInformation($"{nameof(IconRetriever)} configured to skip local cache. Downloading icon");
+            }
+
+            return await this.DownloadIcon(skill);
+        }
+
+        private async Task<Optional<Stream>> DownloadIcon(Skill skill)
         {
             var curedSkillName = skill.Name
                 .Replace(" ", "_");
@@ -56,13 +85,42 @@ namespace Daybreak.Services.IconRetrieve
             if (response.IsSuccessStatusCode)
             {
                 this.logger.LogInformation("Retrieved latest icon stream");
-                return new MemoryStream(await iconResponse.Content.ReadAsByteArrayAsync());
+                var iconData = await iconResponse.Content.ReadAsByteArrayAsync();
+                if (this.configurationManager.GetConfiguration().KeepLocalIconCache)
+                {
+                    await this.SaveIconLocally(skill, iconData);
+                }
+                return new MemoryStream(iconData);
             }
 
             this.logger.LogError($"Failed to retrieve icon from {BaseUrl + "/" + url}");
             return Optional.None<Stream>();
         }
 
+        private async Task<Optional<Stream>> GetLocalIcon(Skill skill)
+        {
+            var curedSkillName = skill.Name
+                .Replace(" ", "_")
+                .Replace("\"", "");
+            this.logger.LogInformation("Checking local icon cache");
+            if (File.Exists(IconsLocation.Replace(NamePlaceholder, curedSkillName)))
+            {
+                this.logger.LogInformation("Local icon cache found. Retrieving icon");
+                return new MemoryStream(await File.ReadAllBytesAsync(IconsLocation.Replace(NamePlaceholder, curedSkillName)));
+            }
+
+            this.logger.LogWarning("No local icon cache found");
+            return Optional.None<Stream>();
+        }
+
+        private async Task SaveIconLocally(Skill skill, byte[] data)
+        {
+            var curedSkillName = skill.Name
+                .Replace(" ", "_")
+                .Replace("\"", "");
+            await File.WriteAllBytesAsync(IconsLocation.Replace(NamePlaceholder, curedSkillName), data);
+        }
+
         private static string GetHref(HtmlDocument doc)
         {
             foreach (var child in doc.DocumentNode.Descendants("a"))

Daybreak/Views/BuildTemplateView.xaml

@@ -11,6 +11,7 @@
              d:DesignHeight="450" d:DesignWidth="800">
     <Grid Background="#A0202020">
         <Grid.RowDefinitions>
+            <RowDefinition Height="auto"></RowDefinition>
             <RowDefinition Height="auto"></RowDefinition>
             <RowDefinition Height="*"></RowDefinition>
         </Grid.RowDefinitions>
@@ -35,7 +36,17 @@
             <controls:SaveButton Foreground="White" Height="30" Width="30" HorizontalAlignment="Left" VerticalAlignment="Top" Margin="5"
                              Clicked="SaveButton_Clicked" Grid.Column="2" IsEnabled="{Binding ElementName=_this, Path=SaveButtonEnabled, Mode=OneWay}"></controls:SaveButton>
         </Grid>
-        <controls:BuildTemplate x:Name="BuildTemplate" Grid.Row="1" DataContext="{Binding ElementName=_this, Path=CurrentBuild, Mode=OneWay}">
+        <Grid Grid.Row="1" Margin="10, 0, 10, 0">
+            <Grid.ColumnDefinitions>
+                <ColumnDefinition Width="auto"></ColumnDefinition>
+                <ColumnDefinition Width="*"></ColumnDefinition>
+            </Grid.ColumnDefinitions>
+            <TextBlock Text="Code: " Foreground="White" Background="Transparent" FontSize="16"></TextBlock>
+            <TextBox Grid.Column="1" Foreground="White" Background="Transparent" FontSize="16"
+                     Text="{Binding ElementName=_this, Path=CurrentBuildCode, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"></TextBox>
+        </Grid>
+        <controls:BuildTemplate x:Name="BuildTemplate" Grid.Row="2" DataContext="{Binding ElementName=_this, Path=CurrentBuild, Mode=OneWay}"
+                                BuildChanged="BuildTemplate_BuildChanged">
         </controls:BuildTemplate>
     </Grid>
 </UserControl>

Daybreak/Views/BuildTemplateView.xaml.cs

@@ -11,6 +11,7 @@ using System.Linq;
 using System.Windows;
 using System.Windows.Controls;
 using System.Windows.Extensions;
+using System.Windows.Input;
 
 namespace Daybreak.Views
 {
@@ -21,51 +22,89 @@ namespace Daybreak.Views
     {
         private const string DisallowedChars = "\r\n\\/.";
 
-        public readonly static DependencyProperty CurrentBuildProperty =
-            DependencyPropertyExtensions.Register<BuildTemplateView, BuildEntry>(nameof(CurrentBuild));
-        public readonly static DependencyProperty SaveButtonEnabledProperty =
-            DependencyPropertyExtensions.Register<BuildTemplateView, bool>(nameof(SaveButtonEnabled), new PropertyMetadata(false));
+        private bool supressDecode = false;
 
         private readonly IViewManager viewManager;
         private readonly IBuildTemplateManager buildTemplateManager;
+        private readonly ILogger<BuildTemplateView> logger;
 
-        public bool SaveButtonEnabled
-        {
-            get => this.GetTypedValue<bool>(SaveButtonEnabledProperty);
-            set => this.SetValue(SaveButtonEnabledProperty, value);
-        }
-
-        public BuildEntry CurrentBuild
-        {
-            get => this.GetTypedValue<BuildEntry>(CurrentBuildProperty);
-            set => this.SetValue(CurrentBuildProperty, value);
-        }
+        [GenerateDependencyProperty(InitialValue = false)]
+        private bool saveButtonEnabled;
+        [GenerateDependencyProperty]
+        private BuildEntry currentBuild;
+        [GenerateDependencyProperty]
+        private string currentBuildCode;
 
         public BuildTemplateView(
             IViewManager viewManager,
             IBuildTemplateManager buildTemplateManager,
             IIconRetriever iconRetriever,
             IConfigurationManager configurationManager,
-            ILogger<ChromiumBrowserWrapper> logger)
+            ILogger<ChromiumBrowserWrapper> chromiumLogger,
+            ILogger<BuildTemplateView> logger)
         {
             this.buildTemplateManager = buildTemplateManager.ThrowIfNull(nameof(buildTemplateManager));
+            this.logger = logger.ThrowIfNull(nameof(logger));
             this.viewManager = viewManager.ThrowIfNull(nameof(viewManager));
             this.InitializeComponent();
-            this.BuildTemplate.InitializeTemplate(iconRetriever, configurationManager, buildTemplateManager, logger);
+            this.BuildTemplate.InitializeTemplate(iconRetriever, configurationManager, buildTemplateManager, chromiumLogger);
             this.DataContextChanged += (sender, contextArgs) =>
             {
                 if (contextArgs.NewValue is BuildEntry)
                 {
+                    this.logger.LogInformation("Received data context. Setting current build");
                     this.CurrentBuild = contextArgs.NewValue.As<BuildEntry>();
+                    this.CurrentBuildCode = this.buildTemplateManager.EncodeTemplate(this.CurrentBuild.Build);
                 }
             };
         }
 
+        protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
+        {
+            base.OnPropertyChanged(e);
+            if (e.Property == CurrentBuildCodeProperty && this.supressDecode is false)
+            {
+                this.logger.LogInformation($"Attempting to decode provided template {this.CurrentBuildCode}");
+                try
+                {
+                    this.CurrentBuild = new BuildEntry
+                    {
+                        Name = this.CurrentBuild.Name,
+                        PreviousName = this.CurrentBuild.PreviousName,
+                        Build = this.buildTemplateManager.DecodeTemplate(this.CurrentBuildCode)
+                    };
+
+                    this.logger.LogInformation($"Template {CurrentBuildCode} decoded");
+                }
+                catch
+                {
+                    this.logger.LogWarning($"Failed to decode {this.CurrentBuildCode}. Reverting to default build");
+                    this.CurrentBuild = new BuildEntry
+                    {
+                        Name = this.CurrentBuild.Name,
+                        PreviousName = this.CurrentBuild.PreviousName,
+                        Build = new Build()
+                    };
+                }
+            }
+        }
+
+        private void BuildTemplate_BuildChanged(object sender, EventArgs e)
+        {
+            try
+            {
+                this.supressDecode = true;
+                this.CurrentBuildCode = this.buildTemplateManager.EncodeTemplate(this.CurrentBuild.Build);
+            }
+            finally
+            {
+                this.supressDecode = false;
+            }
+        }
         private void BackButton_Clicked(object sender, EventArgs e)
         {
             this.viewManager.ShowView<BuildsListView>();
         }
-
         private void SaveButton_Clicked(object sender, EventArgs e)
         {
             this.buildTemplateManager.SaveBuild(this.CurrentBuild);
@@ -79,7 +118,6 @@ namespace Daybreak.Views
                 e.Handled = true;
             }
         }
-
         private void TextBox_TextChanged(object sender, TextChangedEventArgs e)
         {
             if (string.IsNullOrWhiteSpace(sender.As<TextBox>().Text))

Daybreak/Views/SettingsView.xaml

@@ -94,6 +94,7 @@
                 <TextBlock Text="Desired screen id: " FontSize="22" Foreground="White" Height="30"></TextBlock>
                 <TextBlock Text="Place Shortcut: " FontSize="22" Foreground="White" Height="30"></TextBlock>
                 <TextBlock Text="Shortcut folder: " FontSize="22" Foreground="White" Height="30"></TextBlock>
+                <TextBlock Text="Keep local cache of icons: " FontSize="22" Foreground="White" Height="30"></TextBlock>
             </StackPanel>
             <StackPanel Orientation="Vertical" Grid.Row="1" Grid.Column="1">
                 <ToggleButton HorizontalAlignment="Center" HorizontalContentAlignment="Stretch" Style="{StaticResource AnimatedSwitch}" Height="30" Width="40"
@@ -148,6 +149,8 @@
                                       Foreground="White" BorderBrush="Gray" BorderThickness="0"
                                       Clicked="ShortcutFolderPickerGlyph_Clicked"></controls:FilePickerGlyph>
                 </Grid>
+                <ToggleButton HorizontalAlignment="Center" HorizontalContentAlignment="Stretch" Style="{StaticResource AnimatedSwitch}" Height="30" Width="40"
+                            FontSize="22" Foreground="White" IsChecked="{Binding ElementName=_this, Path=KeepLocalIconCache, Mode=TwoWay}"></ToggleButton>
             </StackPanel>
         </Grid>
     </ScrollViewer>

Daybreak/Views/SettingsView.xaml.cs

@@ -45,6 +45,8 @@ namespace Daybreak.Views
         private bool shortcutPlaced;
         [GenerateDependencyProperty]
         private bool autoCheckUpdate;
+        [GenerateDependencyProperty]
+        private bool keepLocalIconCache;
 
         public SettingsView(
             IConfigurationManager configurationManager,
@@ -71,6 +73,7 @@ namespace Daybreak.Views
             this.ShortcutFolder = config.ShortcutLocation;
             this.ShortcutPlaced = config.PlaceShortcut;
             this.AutoCheckUpdate = config.AutoCheckUpdate;
+            this.KeepLocalIconCache = config.KeepLocalIconCache;
         }
 
         private void SaveButton_Clicked(object sender, EventArgs e)
@@ -88,6 +91,7 @@ namespace Daybreak.Views
             currentConfig.ShortcutLocation = this.ShortcutFolder;
             currentConfig.PlaceShortcut = this.ShortcutPlaced;
             currentConfig.AutoCheckUpdate = this.AutoCheckUpdate;
+            currentConfig.KeepLocalIconCache = this.KeepLocalIconCache;
             this.configurationManager.SaveConfiguration(currentConfig);
             this.viewManager.ShowView<SettingsCategoryView>();
         }