// /*************************************************************************** // The Disc Image Chef // ---------------------------------------------------------------------------- // // Filename : Settings.cs // Author(s) : Natalia Portillo // // Component : DiscImageChef settings. // // --[ Description ] ---------------------------------------------------------- // // Stores and retrieves settings. // // --[ License ] -------------------------------------------------------------- // // This library is free software; you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as // published by the Free Software Foundation; either version 2.1 of the // License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License along with this library; if not, see . // // ---------------------------------------------------------------------------- // Copyright © 2011-2018 Natalia Portillo // ****************************************************************************/ using System; using System.IO; using System.Xml.Serialization; using Claunia.PropertyList; using DiscImageChef.CommonTypes.Interop; using Microsoft.Win32; using PlatformID = DiscImageChef.CommonTypes.Interop.PlatformID; namespace DiscImageChef.Settings { /// /// Settings /// public class DicSettings { /// /// Level for GDPR compliance checking. Every time a new feature may share user information this level should go up, /// and the user asked to opt-in. /// public const ulong GdprLevel = 1; /// /// Set of GDPR compliance, if lower than , ask user for compliance. /// public ulong GdprCompliance; /// /// If set to true, reports will be saved locally /// public bool SaveReportsGlobally; /// /// If set to true, reports will be sent to DiscImageChef.Server /// public bool ShareReports; /// /// Statistics /// public StatsSettings Stats; } // TODO: Use this /// /// User settings, for media dumps, completely unused /// public class UserSettings { public string Email; public string Name; } /// /// Statistics settings /// public class StatsSettings { /// /// If set to true, benchmark statistics will be stored /// public bool BenchmarkStats; /// /// If set to true, command usage statistics will be stored /// public bool CommandStats; /// /// If set to true, device statistics will be stored /// public bool DeviceStats; /// /// If set to true, filesystem statistics will be stored /// public bool FilesystemStats; /// /// If set to true, filters statistics will be stored /// public bool FilterStats; /// /// If set to true, dump media images statistics will be stored /// public bool MediaImageStats; /// /// If set to true, media scan statistics will be stored /// public bool MediaScanStats; /// /// If set to true, media types statistics will be stored /// public bool MediaStats; /// /// If set to true, partition schemes statistics will be stored /// public bool PartitionStats; /// /// If set to true, statistics will be sent to DiscImageChef.Server /// public bool ShareStats; /// /// If set to true, dump media verification statistics will be stored /// public bool VerifyStats; } /// /// Manages statistics /// public static class Settings { const string XDG_DATA_HOME = "XDG_DATA_HOME"; const string XDG_CONFIG_HOME = "XDG_CONFIG_HOME"; const string OLD_DATA_HOME = ".claunia.com"; const string XDG_DATA_HOME_RESOLVED = ".local/share"; const string XDG_CONFIG_HOME_RESOLVED = ".config"; /// /// Current statistcs /// public static DicSettings Current; /// /// Global path to save reports /// static string ReportsPath { get; set; } /// /// Global path to save statistics /// public static string StatsPath { get; private set; } /// /// Loads settings /// public static void LoadSettings() { Current = new DicSettings(); PlatformID ptId = DetectOS.GetRealPlatformID(); string homePath = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile); try { switch(ptId) { // In case of macOS or iOS statistics and reports will be saved in ~/Library/Application Support/Claunia.com/DiscImageChef case PlatformID.MacOSX: case PlatformID.iOS: { string appSupportPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), "Library", "Application Support", "Claunia.com"); if(!Directory.Exists(appSupportPath)) Directory.CreateDirectory(appSupportPath); string dicPath = Path.Combine(appSupportPath, "DiscImageChef"); if(!Directory.Exists(dicPath)) Directory.CreateDirectory(dicPath); ReportsPath = Path.Combine(dicPath, "Reports"); if(!Directory.Exists(ReportsPath)) Directory.CreateDirectory(ReportsPath); StatsPath = Path.Combine(dicPath, "Statistics"); if(!Directory.Exists(StatsPath)) Directory.CreateDirectory(StatsPath); } break; // In case of Windows statistics and reports will be saved in %APPDATA%\Claunia.com\DiscImageChef case PlatformID.Win32NT: case PlatformID.Win32S: case PlatformID.Win32Windows: case PlatformID.WinCE: case PlatformID.WindowsPhone: { string appSupportPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "Claunia.com"); if(!Directory.Exists(appSupportPath)) Directory.CreateDirectory(appSupportPath); string dicPath = Path.Combine(appSupportPath, "DiscImageChef"); if(!Directory.Exists(dicPath)) Directory.CreateDirectory(dicPath); ReportsPath = Path.Combine(dicPath, "Reports"); if(!Directory.Exists(ReportsPath)) Directory.CreateDirectory(ReportsPath); StatsPath = Path.Combine(dicPath, "Statistics"); if(!Directory.Exists(StatsPath)) Directory.CreateDirectory(StatsPath); } break; // Otherwise, statistics and reports will be saved in ~/.claunia.com/DiscImageChef default: { string xdgDataPath = Path.Combine(homePath, Environment.GetEnvironmentVariable(XDG_DATA_HOME) ?? XDG_DATA_HOME_RESOLVED); string oldDicPath = Path.Combine(homePath, ".claunia.com", "DiscImageChef"); string dicPath = Path.Combine(xdgDataPath, "DiscImageChef"); if(Directory.Exists(oldDicPath) && !Directory.Exists(dicPath)) { Directory.Move(oldDicPath, dicPath); Directory.Delete(Path.Combine(homePath, ".claunia.com")); } if(!Directory.Exists(dicPath)) Directory.CreateDirectory(dicPath); ReportsPath = Path.Combine(dicPath, "Reports"); if(!Directory.Exists(ReportsPath)) Directory.CreateDirectory(ReportsPath); StatsPath = Path.Combine(dicPath, "Statistics"); if(!Directory.Exists(StatsPath)) Directory.CreateDirectory(StatsPath); } break; } } catch { ReportsPath = null; } FileStream prefsFs = null; StreamReader prefsSr = null; try { switch(ptId) { // In case of macOS or iOS settings will be saved in ~/Library/Preferences/com.claunia.discimagechef.plist case PlatformID.MacOSX: case PlatformID.iOS: { string preferencesPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), "Library", "Preferences"); string preferencesFilePath = Path.Combine(preferencesPath, "com.claunia.discimagechef.plist"); if(!File.Exists(preferencesFilePath)) { SetDefaultSettings(); SaveSettings(); } prefsFs = new FileStream(preferencesFilePath, FileMode.Open, FileAccess.Read); NSDictionary parsedPreferences = (NSDictionary)BinaryPropertyListParser.Parse(prefsFs); if(parsedPreferences != null) { Current.SaveReportsGlobally = parsedPreferences.TryGetValue("SaveReportsGlobally", out NSObject obj) && ((NSNumber)obj).ToBool(); Current.ShareReports = parsedPreferences.TryGetValue("ShareReports", out obj) && ((NSNumber)obj).ToBool(); if(parsedPreferences.TryGetValue("Stats", out obj)) { NSDictionary stats = (NSDictionary)obj; if(stats != null) Current.Stats = new StatsSettings { ShareStats = stats.TryGetValue("ShareStats", out NSObject obj2) && ((NSNumber)obj2).ToBool(), BenchmarkStats = stats.TryGetValue("BenchmarkStats", out obj2) && ((NSNumber)obj2).ToBool(), CommandStats = stats.TryGetValue("CommandStats", out obj2) && ((NSNumber)obj2).ToBool(), DeviceStats = stats.TryGetValue("DeviceStats", out obj2) && ((NSNumber)obj2).ToBool(), FilesystemStats = stats.TryGetValue("FilesystemStats", out obj2) && ((NSNumber)obj2).ToBool(), FilterStats = stats.TryGetValue("FilterStats", out obj2) && ((NSNumber)obj2).ToBool(), MediaImageStats = stats.TryGetValue("MediaImageStats", out obj2) && ((NSNumber)obj2).ToBool(), MediaScanStats = stats.TryGetValue("MediaScanStats", out obj2) && ((NSNumber)obj2).ToBool(), PartitionStats = stats.TryGetValue("PartitionStats", out obj2) && ((NSNumber)obj2).ToBool(), MediaStats = stats.TryGetValue("MediaStats", out obj2) && ((NSNumber)obj2).ToBool(), VerifyStats = stats.TryGetValue("VerifyStats", out obj2) && ((NSNumber)obj2).ToBool() }; } else Current.Stats = null; Current.GdprCompliance = parsedPreferences.TryGetValue("GdprCompliance", out obj) ? (ulong)((NSNumber)obj).ToLong() : 0; prefsFs.Close(); } else { prefsFs.Close(); SetDefaultSettings(); SaveSettings(); } } break; #if !NETSTANDARD2_0 // In case of Windows settings will be saved in the registry: HKLM/SOFTWARE/Claunia.com/DiscImageChef case PlatformID.Win32NT: case PlatformID.Win32S: case PlatformID.Win32Windows: case PlatformID.WinCE: case PlatformID.WindowsPhone: { RegistryKey parentKey = Registry.CurrentUser.OpenSubKey("SOFTWARE")?.OpenSubKey("Claunia.com"); if(parentKey == null) { SetDefaultSettings(); SaveSettings(); return; } RegistryKey key = parentKey.OpenSubKey("DiscImageChef"); if(key == null) { SetDefaultSettings(); SaveSettings(); return; } Current.SaveReportsGlobally = Convert.ToBoolean(key.GetValue("SaveReportsGlobally")); Current.ShareReports = Convert.ToBoolean(key.GetValue("ShareReports")); Current.GdprCompliance = Convert.ToUInt64(key.GetValue("GdprCompliance")); bool stats = Convert.ToBoolean(key.GetValue("Statistics")); if(stats) Current.Stats = new StatsSettings { ShareStats = Convert.ToBoolean(key.GetValue("ShareStats")), BenchmarkStats = Convert.ToBoolean(key.GetValue("BenchmarkStats")), CommandStats = Convert.ToBoolean(key.GetValue("CommandStats")), DeviceStats = Convert.ToBoolean(key.GetValue("DeviceStats")), FilesystemStats = Convert.ToBoolean(key.GetValue("FilesystemStats")), FilterStats = Convert.ToBoolean(key.GetValue("FilterStats")), MediaImageStats = Convert.ToBoolean(key.GetValue("MediaImageStats")), MediaScanStats = Convert.ToBoolean(key.GetValue("MediaScanStats")), PartitionStats = Convert.ToBoolean(key.GetValue("PartitionStats")), MediaStats = Convert.ToBoolean(key.GetValue("MediaStats")), VerifyStats = Convert.ToBoolean(key.GetValue("VerifyStats")) }; } break; #endif // Otherwise, settings will be saved in ~/.config/DiscImageChef.xml default: { string oldConfigPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), ".config"); string oldSettingsPath = Path.Combine(oldConfigPath, "DiscImageChef.xml"); string xdgConfigPath = Path.Combine(homePath, Environment.GetEnvironmentVariable(XDG_CONFIG_HOME) ?? XDG_CONFIG_HOME_RESOLVED); string settingsPath = Path.Combine(xdgConfigPath, "DiscImageChef.xml"); if(File.Exists(oldSettingsPath) && !File.Exists(settingsPath)) { if(!Directory.Exists(xdgConfigPath)) Directory.CreateDirectory(xdgConfigPath); File.Move(oldSettingsPath, settingsPath); } if(!File.Exists(settingsPath)) { SetDefaultSettings(); SaveSettings(); return; } XmlSerializer xs = new XmlSerializer(Current.GetType()); prefsSr = new StreamReader(settingsPath); Current = (DicSettings)xs.Deserialize(prefsSr); } break; } } catch { prefsFs?.Close(); prefsSr?.Close(); SetDefaultSettings(); SaveSettings(); } } public static void SaveSettings() { try { PlatformID ptId = DetectOS.GetRealPlatformID(); switch(ptId) { // In case of macOS or iOS settings will be saved in ~/Library/Preferences/com.claunia.discimagechef.plist case PlatformID.MacOSX: case PlatformID.iOS: { NSDictionary root = new NSDictionary { {"SaveReportsGlobally", Current.SaveReportsGlobally}, {"ShareReports", Current.ShareReports}, {"GdprCompliance", Current.GdprCompliance} }; if(Current.Stats != null) { NSDictionary stats = new NSDictionary { {"ShareStats", Current.Stats.ShareStats}, {"BenchmarkStats", Current.Stats.BenchmarkStats}, {"CommandStats", Current.Stats.CommandStats}, {"DeviceStats", Current.Stats.DeviceStats}, {"FilesystemStats", Current.Stats.FilesystemStats}, {"FilterStats", Current.Stats.FilterStats}, {"MediaImageStats", Current.Stats.MediaImageStats}, {"MediaScanStats", Current.Stats.MediaScanStats}, {"PartitionStats", Current.Stats.PartitionStats}, {"MediaStats", Current.Stats.MediaStats}, {"VerifyStats", Current.Stats.VerifyStats} }; root.Add("Stats", stats); } string preferencesPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), "Library", "Preferences"); string preferencesFilePath = Path.Combine(preferencesPath, "com.claunia.discimagechef.plist"); FileStream fs = new FileStream(preferencesFilePath, FileMode.Create); BinaryPropertyListWriter.Write(fs, root); fs.Close(); } break; #if !NETSTANDARD2_0 // In case of Windows settings will be saved in the registry: HKLM/SOFTWARE/Claunia.com/DiscImageChef case PlatformID.Win32NT: case PlatformID.Win32S: case PlatformID.Win32Windows: case PlatformID.WinCE: case PlatformID.WindowsPhone: { RegistryKey parentKey = Registry.CurrentUser.OpenSubKey("SOFTWARE", true)?.CreateSubKey("Claunia.com"); RegistryKey key = parentKey?.CreateSubKey("DiscImageChef"); if(key != null) { key.SetValue("SaveReportsGlobally", Current.SaveReportsGlobally); key.SetValue("ShareReports", Current.ShareReports); key.SetValue("GdprCompliance", Current.GdprCompliance); if(Current.Stats != null) { key.SetValue("Statistics", true); key.SetValue("ShareStats", Current.Stats.ShareStats); key.SetValue("BenchmarkStats", Current.Stats.BenchmarkStats); key.SetValue("CommandStats", Current.Stats.CommandStats); key.SetValue("DeviceStats", Current.Stats.DeviceStats); key.SetValue("FilesystemStats", Current.Stats.FilesystemStats); key.SetValue("FilterStats", Current.Stats.FilterStats); key.SetValue("MediaImageStats", Current.Stats.MediaImageStats); key.SetValue("MediaScanStats", Current.Stats.MediaScanStats); key.SetValue("PartitionStats", Current.Stats.PartitionStats); key.SetValue("MediaStats", Current.Stats.MediaStats); key.SetValue("VerifyStats", Current.Stats.VerifyStats); } else { key.SetValue("Statistics", true); key.DeleteValue("ShareStats", false); key.DeleteValue("BenchmarkStats", false); key.DeleteValue("CommandStats", false); key.DeleteValue("DeviceStats", false); key.DeleteValue("FilesystemStats", false); key.DeleteValue("MediaImageStats", false); key.DeleteValue("MediaScanStats", false); key.DeleteValue("PartitionStats", false); key.DeleteValue("MediaStats", false); key.DeleteValue("VerifyStats", false); } } } break; #endif // Otherwise, settings will be saved in ~/.config/DiscImageChef.xml default: { string homePath = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile); string xdgConfigPath = Path.Combine(homePath, Environment.GetEnvironmentVariable(XDG_CONFIG_HOME) ?? XDG_CONFIG_HOME_RESOLVED); string settingsPath = Path.Combine(xdgConfigPath, "DiscImageChef.xml"); if(!Directory.Exists(xdgConfigPath)) Directory.CreateDirectory(xdgConfigPath); FileStream fs = new FileStream(settingsPath, FileMode.Create); XmlSerializer xs = new XmlSerializer(Current.GetType()); xs.Serialize(fs, Current); fs.Close(); } break; } } #pragma warning disable RECS0022 // A catch clause that catches System.Exception and has an empty body catch { // ignored } #pragma warning restore RECS0022 // A catch clause that catches System.Exception and has an empty body } /// /// Sets default settings as all statistics, share everything /// static void SetDefaultSettings() { Current = new DicSettings { SaveReportsGlobally = true, ShareReports = true, GdprCompliance = 0, Stats = new StatsSettings { BenchmarkStats = true, CommandStats = true, DeviceStats = true, FilesystemStats = true, MediaImageStats = true, MediaScanStats = true, FilterStats = true, MediaStats = true, PartitionStats = true, ShareStats = true, VerifyStats = true } }; } } }