mattercontrol/MatterControlLib/SettingsManagement/OemSettings.cs

/*
Copyright (c) 2019, Lars Brubaker, John Lewin
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/

using MatterHackers.Agg.Image;
using MatterHackers.Agg.Platform;
using MatterHackers.Agg.UI;
using MatterHackers.Agg.VertexSource;
using MatterHackers.MatterControl.SlicerConfiguration;
using Newtonsoft.Json;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Runtime.Serialization;
using System.Threading.Tasks;

namespace MatterHackers.MatterControl.SettingsManagement
{
    public class OemSettings
    {
        private static OemSettings instance = null;

        public static OemSettings Instance
        {
            get
            {
                if (instance == null)
                {
                    string oemSettings = StaticData.Instance.ReadAllText(Path.Combine("OEMSettings", "Settings.json"));
                    instance = JsonConvert.DeserializeObject<OemSettings>(oemSettings) as OemSettings;
                }

                return instance;
            }
        }

        public bool UseSimpleModeByDefault = false;

        public string ThemeColor = "";

        public string AffiliateCode = "";

        public string WindowTitleExtra = "";

        public bool ShowShopButton = true;

        public bool DesignToolsOnly = true;

        public bool CheckForUpdatesOnFirstRun = false;

        public string UnregisteredProductName { get; set; } = "MatterControl";
        public string RegisteredProductName { get; set; } = "MatterControl Pro";

        public List<string> PrinterWhiteList { get; private set; } = new List<string>();

        public List<ManufacturerNameMapping> ManufacturerNameMappings { get; set; }

        public ImageBuffer GetIcon(string oemName, ThemeConfig theme)
        {
            var size = (int)(16 * GuiWidget.DeviceScale);
            var imageBuffer = new ImageBuffer(size, size);

            string oemUrl = ApplicationController.Instance.GetFavIconUrl(oemName);

            if (!string.IsNullOrWhiteSpace(oemUrl))
            {
                WebCache.RetrieveImageAsync(imageBuffer, oemUrl, scaleToImageX: true);
            }
            else
            {
                var graphics = imageBuffer.NewGraphics2D();
                graphics.Clear(AppContext.Theme.SlightShade);
            }

            if (theme.IsDarkTheme)
            {
                // put the icon on a light background
                var background = new ImageBuffer(size, size);
                background.NewGraphics2D().Render(new RoundedRect(background.GetBoundingRect(), 1), theme.TextColor);
                background.NewGraphics2D().Render(imageBuffer, 0, 0);
                imageBuffer.CopyFrom(background);
            }

            return imageBuffer;
        }

        internal void SetManufacturers(IEnumerable<KeyValuePair<string, string>> unorderedManufacturers, List<string> whitelist = null)
        {
            // Sort manufacturers by name
            var manufacturers = new List<KeyValuePair<string, string>>();
            var otherInfo = new KeyValuePair<string, string>(null, null);

            foreach (var printer in unorderedManufacturers.OrderBy(k => k.Value))
            {
                if (printer.Value == "Other")
                {
                    otherInfo = printer;
                }
                else
                {
                    manufacturers.Add(printer);
                }
            }

            if (otherInfo.Key != null)
            {
                // add it at the end
                manufacturers.Add(otherInfo);
            }

            if (whitelist != null)
            {
                this.PrinterWhiteList = whitelist;
            }

            // Apply whitelist
            var whiteListedItems = manufacturers?.Where(keyValue => PrinterWhiteList.Contains(keyValue.Key));

            if (whiteListedItems == null
                || whiteListedItems.Count() == 0)
            {
                // No whitelist means all items
                whiteListedItems = manufacturers;
            }

            var newItems = new List<KeyValuePair<string, string>>();

            // Apply manufacturer name mappings
            foreach (var keyValue in whiteListedItems)
            {
                string labelText = keyValue.Value;

                // Override the manufacturer name if a manufacturerNameMappings exists
                string mappedName = ManufacturerNameMappings.Where(m => m.NameOnDisk == keyValue.Key).FirstOrDefault()?.NameOnDisk;
                if (!string.IsNullOrEmpty(mappedName))
                {
                    labelText = mappedName;
                }

                newItems.Add(new KeyValuePair<string, string>(keyValue.Key, labelText));
            }

            AllOems = newItems;
        }

        public List<KeyValuePair<string, string>> AllOems { get; private set; }

        public OemProfileDictionary OemProfiles { get; set; }

        public Dictionary<string, string> OemUrls { get; }

        public Dictionary<string, StorePrinterID> OemPrinters { get; }

        [OnDeserialized]
        private void Deserialized(StreamingContext context)
        {
            // Load local OemProfile content during initial startup
            OemProfiles = this.LoadOemProfiles();

            var manufacturesList = OemProfiles.Keys.ToDictionary(oem => oem);
            SetManufacturers(manufacturesList);
        }

        private OemProfileDictionary LoadOemProfiles()
        {
            string cachePath = ApplicationController.CacheablePath("public-profiles", "oemprofiles.json");

            // Load data from cache or fall back to stale StaticData content
            string json = File.Exists(cachePath) ? File.ReadAllText(cachePath) : null;

            if (string.IsNullOrWhiteSpace(json))
            {
                // If empty, purge the cache file and fall back to StaticData
                File.Delete(cachePath);

                json = StaticData.Instance.ReadAllText(Path.Combine("Profiles", "oemprofiles.json"));
            }

            try
            {
                return JsonConvert.DeserializeObject<OemProfileDictionary>(json);
            }
            catch
            {
                // If json parse fails, purge the cache file and fall back to StaticData
                File.Delete(cachePath);

                json = StaticData.Instance.ReadAllText(Path.Combine("Profiles", "oemprofiles.json"));
                return JsonConvert.DeserializeObject<OemProfileDictionary>(json);
            }
        }

        public async Task ReloadOemProfiles()
        {
            // In public builds this won't be assigned to and we should exit
            if (ApplicationController.GetPublicProfileList == null)
            {
                return;
            }

            await ApplicationController.LoadCacheableAsync<OemProfileDictionary>(
                "oemprofiles.json",
                "public-profiles",
                async () =>
                {
                    var result = await ApplicationController.GetPublicProfileList();
                    if (result != null)
                    {
                        // Refresh the in memory instance any time the server responds with updated content - caller will serialize
                        OemProfiles = result;

                        SetManufacturers(result.Keys.ToDictionary(oem => oem));
                    }

                    return result;
                });

            await DownloadMissingProfiles();
        }

        private async Task DownloadMissingProfiles()
        {
            int index = 0;
            foreach (string oem in OemProfiles.Keys)
            {
                string cacheScope = Path.Combine("public-profiles", oem);

                index++;
                foreach (var model in OemProfiles[oem].Keys)
                {
                    var publicDevice = OemProfiles[oem][model];
                    string cachePath = ApplicationController.CacheablePath(cacheScope, publicDevice.CacheKey);
                    if (!File.Exists(cachePath))
                    {
                        await Task.Delay(20000);
                        await ProfileManager.LoadOemSettingsAsync(publicDevice, oem, model);

                        if (ApplicationController.Instance.ApplicationExiting)
                        {
                            return;
                        }
                    }
                }
            }
        }

        private OemSettings()
        {
            this.ManufacturerNameMappings = new List<ManufacturerNameMapping>();
            this.OemUrls = JsonConvert.DeserializeObject<Dictionary<string, string>>(StaticData.Instance.ReadAllText(Path.Combine("OEMSettings", "OEMUrls.json")));
            this.OemPrinters = JsonConvert.DeserializeObject<Dictionary<string, StorePrinterID>>(StaticData.Instance.ReadAllText(Path.Combine("OEMSettings", "Printers.json")));
        }
    }

    public class StorePrinterID
    {
        public string SID { get; set; }

        public string AltInfoUrl { get; set; }
    }

    public class ManufacturerNameMapping
    {
        public string NameOnDisk { get; set; }

        public string NameToDisplay { get; set; }
    }
}