mattercontrol/SlicerConfiguration/Settings/ProfileManager.cs
Matt Moening 5b42eac301 Fixed import to not rely on layer_height validation
- Import preset no longer checks for slicer and will validate import on weather or not any settigns were valid
 - calling Import from MenuOptionFIle will cause the same error message as importing a printer form the settings import page
 - Import to new printer now attempts to load values and validates success on importing a valid setting
2016-08-11 14:59:33 -07:00

445 lines
No EOL
13 KiB
C#

/*
Copyright (c) 2016, 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.UI;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
namespace MatterHackers.MatterControl.SlicerConfiguration
{
using Agg;
using Localizations;
using DataStorage;
using SettingsManagement;
using System.Collections.ObjectModel;
using System.Net;
using VersionManagement;
using System.Threading.Tasks;
public class ProfileManager
{
public static RootedObjectEventHandler ProfilesListChanged = new RootedObjectEventHandler();
public static ProfileManager Instance { get; set; }
public const string ProfileExtension = ".printer";
private static EventHandler unregisterEvents;
private static readonly string userDataPath = ApplicationDataStorage.ApplicationUserDataPath;
private static string ProfilesPath
{
get
{
string path = Path.Combine(userDataPath, "Profiles");
if (!Directory.Exists(path))
{
Directory.CreateDirectory(path);
}
return path;
}
}
public const string ConfigFileExtension = ".slice";
private const string userDBExtension = ".profiles";
private const string guestDBFileName = "guest" + userDBExtension;
private static string GuestDBPath => Path.Combine(ProfilesPath, guestDBFileName);
internal static string ProfilesDBPath
{
get
{
string username = UserSettings.Instance.get("ActiveUserName");
return string.IsNullOrEmpty(username) ? GuestDBPath : Path.Combine(ProfilesPath, $"{username}{userDBExtension}");
}
}
static ProfileManager()
{
SliceSettingsWidget.SettingChanged.RegisterEvent(SettingsChanged, ref unregisterEvents);
// Ensure the profiles directory exists
Directory.CreateDirectory(ProfilesPath);
Reload();
}
public ProfileManager()
{
}
[JsonIgnore]
public bool IsGuestProfile => Path.GetFileName(ProfilesDBPath) == guestDBFileName;
public static void Reload()
{
if (Instance?.Profiles != null)
{
// Release event registration
Instance.Profiles.CollectionChanged -= Profiles_CollectionChanged;
}
// Load the profiles document
if (File.Exists(ProfilesDBPath))
{
string json = File.ReadAllText(ProfilesDBPath);
Instance = JsonConvert.DeserializeObject<ProfileManager>(json);
}
else
{
Instance = new ProfileManager();
}
// Load the last selected printer profile or an empty profile
ActiveSliceSettings.Instance = Instance.LoadLastProfile() ?? LoadEmptyProfile();
// In either case, wire up the CollectionChanged event
Instance.Profiles.CollectionChanged += Profiles_CollectionChanged;
}
internal static ProfileManager LoadGuestDB()
{
if (File.Exists(GuestDBPath))
{
string json = File.ReadAllText(GuestDBPath);
return JsonConvert.DeserializeObject<ProfileManager>(json);
}
return null;
}
internal static void SettingsChanged(object sender, EventArgs e)
{
string settingsKey = ((StringEventArgs)e).Data;
switch (settingsKey)
{
case SettingsKey.printer_name:
Instance.ActiveProfile.Name = ActiveSliceSettings.Instance.GetValue(SettingsKey.printer_name);
Instance.Save();
break;
case SettingsKey.com_port:
Instance.ActiveProfile.ComPort = ActiveSliceSettings.Instance.Helpers.ComPort();
Instance.Save();
break;
}
}
public ObservableCollection<PrinterInfo> Profiles { get; set; } = new ObservableCollection<PrinterInfo>();
[JsonIgnore]
public IEnumerable<PrinterInfo> ActiveProfiles => Profiles.Where(profile => !profile.MarkedForDelete);
[JsonIgnore]
public PrinterInfo ActiveProfile => this[ActiveSliceSettings.Instance.ID];
public PrinterInfo this[string profileID]
{
get
{
return Profiles.Where(p => p.ID == profileID).FirstOrDefault();
}
}
public static PrinterSettings LoadEmptyProfile()
{
var emptyProfile = new PrinterSettings() { ID = "EmptyProfile" };
emptyProfile.UserLayer[SettingsKey.printer_name] = "Printers...".Localize();
return emptyProfile;
}
public static PrinterSettings LoadProfileFromMCWS(string deviceToken)
{
WebClient client = new WebClient();
string json = client.DownloadString($"{MatterControlApplication.MCWSBaseUri}/api/1/device/get-profile?PrinterToken={deviceToken}");
var printerSettings = JsonConvert.DeserializeObject<PrinterSettings>(json);
return printerSettings;
}
[JsonIgnore]
public string LastProfileID
{
get
{
string activeUserName = UserSettings.Instance.get("ActiveUserName");
string settingsKey = $"ActiveProfileID-{activeUserName}";
return UserSettings.Instance.get(settingsKey);
}
}
public bool PrintersImported { get; set; } = false;
public PrinterSettings LoadLastProfile()
{
return LoadProfile(this.LastProfileID);
}
public void SetLastProfile(string printerID)
{
string activeUserName = UserSettings.Instance.get("ActiveUserName");
string settingsKey = $"ActiveProfileID-{activeUserName}";
UserSettings.Instance.set(settingsKey, printerID);
}
public string ProfilePath(PrinterInfo printer)
{
return Path.Combine(ProfileManager.ProfilesPath, printer.ID + ProfileExtension);
}
public string ProfilePath(string printerID)
{
return Path.Combine(ProfileManager.ProfilesPath, printerID + ProfileExtension);
}
/// <summary>
/// Loads the specified PrinterProfile
/// </summary>
/// <param name="profileID">The profile ID to load</param>
/// <param name="useActiveInstance">Return the in memory instance if already loaded. Alternatively, reload from disk</param>
/// <returns></returns>
public static PrinterSettings LoadProfile(string profileID, bool useActiveInstance = true)
{
// Only load profiles by ID that are defined in the profiles document
if (ProfileManager.Instance[profileID] == null)
{
return null;
}
if (useActiveInstance && ActiveSliceSettings.Instance?.ID == profileID)
{
return ActiveSliceSettings.Instance;
}
string profilePath = Path.Combine(ProfilesPath, profileID + ProfileManager.ProfileExtension);
return File.Exists(profilePath) ? LoadProfileFromDisk(profilePath) : null;
}
internal static PrinterSettings LoadProfileFromDisk(string profilePath)
{
if (File.Exists(profilePath))
{
return PrinterSettings.LoadFile(profilePath);
}
else
{
return LoadEmptyProfile();
}
}
internal static bool ImportFromExisting(string settingsFilePath)
{
if (string.IsNullOrEmpty(settingsFilePath) || !File.Exists(settingsFilePath))
{
return false;
}
var printerInfo = new PrinterInfo
{
Name = Path.GetFileNameWithoutExtension(settingsFilePath),
ID = Guid.NewGuid().ToString()
};
bool importSuccessful = false;
string importType = Path.GetExtension(settingsFilePath).ToLower();
switch (importType)
{
case ProfileManager.ProfileExtension:
var profile = ProfileManager.LoadProfileFromDisk(settingsFilePath);
profile.ID = printerInfo.ID;
profile.ClearValue(SettingsKey.device_token);
printerInfo.DeviceToken = "";
// TODO: Resolve name conflicts
profile.Helpers.SetName(printerInfo.Name);
Instance.Profiles.Add(printerInfo);
profile.Save();
importSuccessful = true;
break;
case ".ini":
//Scope variables
{
var settingsToImport = PrinterSettingsLayer.LoadFromIni(settingsFilePath);
var layeredProfile = new PrinterSettings()
{
ID = printerInfo.ID,
};
bool containsValidSetting = false;
var activeSettings = layeredProfile;
foreach (var item in settingsToImport)
{
if (activeSettings.Contains(item.Key))
{
containsValidSetting = true;
string currentValue = activeSettings.GetValue(item.Key).Trim();
// Compare the value to import to the layer cascade value and only set if different
if (currentValue != item.Value)
{
activeSettings.OemLayer[item.Key] = item.Value;
}
}
}
if(containsValidSetting)
{
// TODO: Resolve name conflicts
layeredProfile.UserLayer[SettingsKey.printer_name] = printerInfo.Name;
layeredProfile.ClearValue(SettingsKey.device_token);
printerInfo.DeviceToken = "";
Instance.Profiles.Add(printerInfo);
layeredProfile.Save();
importSuccessful = true;
}
}
break;
}
return importSuccessful;
}
internal static async void AcquireNewProfile(string make, string model, string printerName)
{
string guid = Guid.NewGuid().ToString();
var newProfile = await LoadHttpOemProfile(make, model);
newProfile.ID = guid;
newProfile.DocumentVersion = PrinterSettings.LatestVersion;
newProfile.UserLayer[SettingsKey.printer_name.ToString()] = printerName;
// Import named macros as defined in the following printers: (Airwolf Axiom, HD, HD-R, HD2x, HDL, HDx, Me3D Me2, Robo R1[+])
var classicDefaultMacros = newProfile.GetValue("default_macros");
if (!string.IsNullOrEmpty(classicDefaultMacros))
{
var namedMacros = new Dictionary<string, string>();
namedMacros["Lights On"] = "M42 P6 S255";
namedMacros["Lights Off"] = "M42 P6 S0";
namedMacros["Offset 0.8"] = "M565 Z0.8;\nM500";
namedMacros["Offset 0.9"] = "M565 Z0.9;\nM500";
namedMacros["Offset 1"] = "M565 Z1;\nM500";
namedMacros["Offset 1.1"] = "M565 Z1.1;\nM500";
namedMacros["Offset 1.2"] = "M565 Z1.2;\nM500";
namedMacros["Z Offset"] = "G1 Z10;\nG28;\nG29;\nG1 Z10;\nG1 X5 Y5 F4000;\nM117;";
foreach (string namedMacro in classicDefaultMacros.Split(','))
{
string gcode;
if (namedMacros.TryGetValue(namedMacro.Trim(), out gcode))
{
newProfile.Macros.Add(new GCodeMacro()
{
Name = namedMacro.Trim(),
GCode = gcode
});
}
}
}
// Set initial theme to current theme
newProfile.SetValue(SettingsKey.active_theme_index, ActiveSliceSettings.Instance.GetValue(SettingsKey.active_theme_index));
Instance.Profiles.Add(new PrinterInfo
{
Name = printerName,
ID = guid,
Make = make,
Model = model
});
// Update SHA1
newProfile.Save();
UserSettings.Instance.set("ActiveProfileID", guid);
ActiveSliceSettings.Instance = newProfile;
}
private async static Task<PrinterSettings> LoadHttpOemProfile(string make, string model)
{
string deviceToken = OemSettings.Instance.OemProfiles[make][model];
string cacheKey = deviceToken + ProfileManager.ProfileExtension;
string cachePath = Path.Combine(ApplicationDataStorage.ApplicationUserDataPath, "data", "temp", "cache", "profiles", cacheKey);
return await ApplicationController.LoadCacheableAsync<PrinterSettings>(
cacheKey,
"profiles",
async () =>
{
if(File.Exists(cachePath))
{
return null;
}
else
{
// If the cache file for the current deviceToken does not exist, attempt to download it
return await ApplicationController.DownloadPublicProfileAsync(deviceToken);
}
},
Path.Combine("Profiles",make, model + ProfileManager.ProfileExtension));
}
public void EnsurePrintersImported()
{
if (IsGuestProfile && !PrintersImported)
{
// Import Sqlite printer profiles into local json files
DataStorage.ClassicDB.ClassicSqlitePrinterProfiles.ImportPrinters(Instance, ProfilesPath);
PrintersImported = true;
Save();
}
}
private static void Profiles_CollectionChanged(object sender, System.Collections.Specialized.NotifyCollectionChangedEventArgs e)
{
// Any time the list changes, persist the updates to disk
Instance.Save();
ProfilesListChanged.CallEvents(null, null);
}
public void Save()
{
File.WriteAllText(ProfilesDBPath, JsonConvert.SerializeObject(this, Formatting.Indented));
}
}
}