[WIP] Use BaseJsonSettingsModel import/export and reload settings

gave92 · gave92 · commit a7de0c1417ca · 2021-11-24T00:40:31.000+01:00
diff --git a/Common/FileTagsDb.cs b/Common/FileTagsDb.cs
@@ -1,6 +1,7 @@
 ﻿using LiteDB;
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace Common
 {
@@ -149,6 +150,18 @@ public void Dispose()
             db.Dispose();
         }
 
+        public void Import(string json)
+        {
+            var dataValues = JsonSerializer.DeserializeArray(json);
+            db.Engine.Delete("taggedfiles", Query.All());
+            db.Engine.InsertBulk("taggedfiles", dataValues.Select(x => x.AsDocument));
+        }
+
+        public string Export()
+        {
+            return JsonSerializer.Serialize(new BsonArray(db.Engine.FindAll("taggedfiles")));
+        }
+
         public class TaggedFile
         {
             [BsonId]
diff --git a/Files/Controllers/SidebarPinnedController.cs b/Files/Controllers/SidebarPinnedController.cs
@@ -29,6 +29,12 @@ public async Task InitializeAsync()
             await LoadAsync();
         }
 
+        public async Task ReloadAsync()
+        {
+            await LoadAsync();
+            Model.RemoveStaleSidebarItems();
+        }
+
         private async Task LoadAsync()
         {
             StorageFolder Folder = await FilesystemTasks.Wrap(() => ApplicationData.Current.LocalFolder.CreateFolderAsync("settings", CreationCollisionOption.OpenIfExists).AsTask());
diff --git a/Files/Services/IBundlesSettingsService.cs b/Files/Services/IBundlesSettingsService.cs
@@ -1,9 +1,13 @@
-﻿using System.Collections.Generic;
+﻿using Files.EventArguments;
+using System;
+using System.Collections.Generic;
 
 namespace Files.Services
 {
     public interface IBundlesSettingsService
     {
+        event EventHandler<SettingChangedEventArgs> OnSettingChangedEvent;
+
         bool FlushSettings();
 
         object ExportSettings();
diff --git a/Files/Services/IFileTagsSettingsService.cs b/Files/Services/IFileTagsSettingsService.cs
@@ -1,14 +1,22 @@
-﻿using Files.Filesystem;
+﻿using Files.EventArguments;
+using Files.Filesystem;
+using System;
 using System.Collections.Generic;
 
 namespace Files.Services
 {
     public interface IFileTagsSettingsService
     {
+        event EventHandler<SettingChangedEventArgs> OnSettingChangedEvent;
+
         IList<FileTag> FileTagList { get; set; }
 
         FileTag GetTagById(string uid);
 
         IEnumerable<FileTag> GetTagsByName(string tagName);
+
+        object ExportSettings();
+
+        bool ImportSettings(object import);
     }
 }
diff --git a/Files/Services/Implementation/BundlesSettingsService.cs b/Files/Services/Implementation/BundlesSettingsService.cs
@@ -1,4 +1,5 @@
-﻿using Files.Models.JsonSettings;
+﻿using Files.Extensions;
+using Files.Models.JsonSettings;
 using System.Collections.Generic;
 using Windows.Storage;
 
@@ -20,19 +21,22 @@ public Dictionary<string, List<string>> SavedBundles
 
         public override bool ImportSettings(object import)
         {
-            try
+            if (import is string importString)
             {
-                SavedBundles = (Dictionary<string, List<string>>)import;
-                
-                FlushSettings();
-
-                return true;
+                SavedBundles = jsonSettingsSerializer.DeserializeFromJson<Dictionary<string, List<string>>>(importString);
             }
-            catch
+            else if (import is Dictionary<string, List<string>> importDict)
             {
-                // TODO: Display the error?
-                return false;
+                SavedBundles = importDict;
             }
+
+            if (SavedBundles != null)
+            {
+                FlushSettings();
+                return true;
+            }
+
+            return false;
         }
 
         public override object ExportSettings()
diff --git a/Files/Services/Implementation/FileTagsSettingsService.cs b/Files/Services/Implementation/FileTagsSettingsService.cs
@@ -51,5 +51,33 @@ public IEnumerable<FileTag> GetTagsByName(string tagName)
         {
             return FileTagList.Where(x => x.TagName.StartsWith(tagName, StringComparison.OrdinalIgnoreCase));
         }
+
+        public override bool ImportSettings(object import)
+        {
+            if (import is string importString)
+            {
+                FileTagList = jsonSettingsSerializer.DeserializeFromJson<List<FileTag>>(importString);
+            }
+            else if (import is List<FileTag> importList)
+            {
+                FileTagList = importList;
+            }
+
+            FileTagList ??= s_defaultFileTags;
+
+            if (FileTagList != null)
+            {
+                FlushSettings();
+                return true;
+            }
+
+            return false;
+        }
+
+        public override object ExportSettings()
+        {
+            // Return string in Json format
+            return jsonSettingsSerializer.SerializeToJson(FileTagList);
+        }
     }
 }
diff --git a/Files/Services/Implementation/UserSettingsService.cs b/Files/Services/Implementation/UserSettingsService.cs
@@ -63,7 +63,15 @@ public override object ExportSettings()
 
         public override bool ImportSettings(object import)
         {
-            var settingsImport = jsonSettingsSerializer.DeserializeFromJson<Dictionary<string, object>>((string)import);
+            Dictionary<string, object> settingsImport = null;
+            if (import is string importString)
+            {
+                settingsImport = jsonSettingsSerializer.DeserializeFromJson<Dictionary<string, object>>(importString);
+            }
+            else if (import is Dictionary<string, object> importDict)
+            {
+                settingsImport = importDict;
+            }
 
             if (!settingsImport.IsEmpty())
             {
diff --git a/Files/ViewModels/ItemViewModel.cs b/Files/ViewModels/ItemViewModel.cs
@@ -58,6 +58,7 @@ public class ItemViewModel : ObservableObject, IDisposable
         private List<ListedItem> filesAndFolders;
 
         private IUserSettingsService UserSettingsService { get; } = Ioc.Default.GetService<IUserSettingsService>();
+        private IFileTagsSettingsService FileTagsSettingsService { get; } = Ioc.Default.GetService<IFileTagsSettingsService>();
 
         // only used for Binding and ApplyFilesAndFoldersChangesAsync, don't manipulate on this!
         public BulkConcurrentObservableCollection<ListedItem> FilesAndFolders { get; }
@@ -359,9 +360,20 @@ public ItemViewModel(FolderSettingsViewModel folderSettingsViewModel)
             shouldDisplayFileExtensions =  UserSettingsService.PreferencesSettingsService.ShowFileExtensions;
 
             UserSettingsService.OnSettingChangedEvent += UserSettingsService_OnSettingChangedEvent;
+            FileTagsSettingsService.OnSettingChangedEvent += FileTagsSettingsService_OnSettingChangedEvent;
             AppServiceConnectionHelper.ConnectionChanged += AppServiceConnectionHelper_ConnectionChanged;
         }
 
+        private void FileTagsSettingsService_OnSettingChangedEvent(object sender, SettingChangedEventArgs e)
+        {
+            switch (e.settingName)
+            {
+                case nameof(FileTagsSettingsService.FileTagList):
+                    // Reload tags
+                    break;
+            }
+        }
+
         private async void UserSettingsService_OnSettingChangedEvent(object sender, SettingChangedEventArgs e)
         {
             switch (e.settingName)
@@ -2251,6 +2263,7 @@ public void Dispose()
                 Connection.RequestReceived -= Connection_RequestReceived;
             }
             UserSettingsService.OnSettingChangedEvent -= UserSettingsService_OnSettingChangedEvent;
+            FileTagsSettingsService.OnSettingChangedEvent -= FileTagsSettingsService_OnSettingChangedEvent;
             AppServiceConnectionHelper.ConnectionChanged -= AppServiceConnectionHelper_ConnectionChanged;
             DefaultIcons.Clear();
         }
diff --git a/Files/ViewModels/SettingsViewModels/AboutViewModel.cs b/Files/ViewModels/SettingsViewModels/AboutViewModel.cs
@@ -1,4 +1,5 @@
-﻿using Files.Extensions;
+﻿using Files.Filesystem;
+using Files.Filesystem.StorageItems;
 using Files.Helpers;
 using Files.Services;
 using Microsoft.Toolkit.Mvvm.ComponentModel;
@@ -22,6 +23,8 @@ namespace Files.ViewModels.SettingsViewModels
     public class AboutViewModel : ObservableObject
     {
         private IUserSettingsService UserSettingsService { get; } = Ioc.Default.GetService<IUserSettingsService>();
+        private IBundlesSettingsService BundlesSettingsService { get; } = Ioc.Default.GetService<IBundlesSettingsService>();
+        protected IFileTagsSettingsService FileTagsSettingsService { get; } = Ioc.Default.GetService<IFileTagsSettingsService>();
 
         public RelayCommand OpenLogLocationCommand => new RelayCommand(() => SettingsViewModel.OpenLogLocation());
         public RelayCommand CopyVersionInfoCommand => new RelayCommand(() => CopyVersionInfo());
@@ -42,31 +45,92 @@ public AboutViewModel()
         private async Task ExportSettings()
         {
             FileSavePicker filePicker = new FileSavePicker();
-            filePicker.FileTypeChoices.Add("Json File", Path.GetExtension(Constants.LocalSettings.UserSettingsFileName).CreateList());
+            filePicker.FileTypeChoices.Add("Zip File", new[] { ".zip" });
+            filePicker.SuggestedFileName = $"Files_{App.AppVersion}";
 
             StorageFile file = await filePicker.PickSaveFileAsync();
             if (file != null)
             {
-                string export = (string)UserSettingsService.ExportSettings();
-                await FileIO.WriteTextAsync(file, export);
+                try
+                {
+                    var zipFolder = await ZipStorageFolder.FromStorageFileAsync(file);
+                    if (zipFolder == null)
+                    {
+                        return;
+                    }
+                    var localFolderPath = ApplicationData.Current.LocalFolder.Path;
+                    // Export user settings
+                    var userSettings = await zipFolder.CreateFileAsync(Constants.LocalSettings.UserSettingsFileName, CreationCollisionOption.ReplaceExisting);
+                    string exportSettings = (string)UserSettingsService.ExportSettings();
+                    await userSettings.WriteTextAsync(exportSettings);
+                    // Export bundles
+                    var bundles = await zipFolder.CreateFileAsync(Constants.LocalSettings.BundlesSettingsFileName, CreationCollisionOption.ReplaceExisting);
+                    string exportBundles = (string)BundlesSettingsService.ExportSettings();
+                    await bundles.WriteTextAsync(exportBundles);
+                    // Export pinned items
+                    var pinnedItems = await BaseStorageFile.GetFileFromPathAsync(Path.Combine(localFolderPath, Constants.LocalSettings.SettingsFolderName, App.SidebarPinnedController.JsonFileName));
+                    await pinnedItems.CopyAsync(zipFolder, pinnedItems.Name, NameCollisionOption.ReplaceExisting);
+                    // Export terminals config
+                    var terminals = await BaseStorageFile.GetFileFromPathAsync(Path.Combine(localFolderPath, Constants.LocalSettings.SettingsFolderName, App.TerminalController.JsonFileName));
+                    await terminals.CopyAsync(zipFolder, terminals.Name, NameCollisionOption.ReplaceExisting);
+                    // Export file tags list and DB
+                    var fileTagsList = await zipFolder.CreateFileAsync(Constants.LocalSettings.FileTagSettingsFileName, CreationCollisionOption.ReplaceExisting);
+                    string exportTags = (string)FileTagsSettingsService.ExportSettings();
+                    await fileTagsList.WriteTextAsync(exportTags);
+                    var fileTagsDB = await zipFolder.CreateFileAsync(Path.GetFileName(FileTagsHelper.FileTagsDbPath), CreationCollisionOption.ReplaceExisting);
+                    string exportTagsDB = FileTagsHelper.DbInstance.Export();
+                    await fileTagsDB.WriteTextAsync(exportTagsDB);
+                }
+                catch (Exception ex)
+                {
+                    App.Logger.Warn(ex, "Error exporting settings");
+                }
             }
         }
 
         private async Task ImportSettings()
         {
             FileOpenPicker filePicker = new FileOpenPicker();
-            filePicker.FileTypeFilter.Add(Path.GetExtension(Constants.LocalSettings.UserSettingsFileName));
+            filePicker.FileTypeFilter.Add(".zip");
 
             StorageFile file = await filePicker.PickSingleFileAsync();
             if (file != null)
             {
                 try
                 {
-                    string import = await FileIO.ReadTextAsync(file);
-                    UserSettingsService.ImportSettings(import);
+                    var zipFolder = await ZipStorageFolder.FromStorageFileAsync(file);
+                    if (zipFolder == null)
+                    {
+                        return;
+                    }
+                    var localFolderPath = ApplicationData.Current.LocalFolder.Path;
+                    var settingsFolder = await StorageFolder.GetFolderFromPathAsync(Path.Combine(localFolderPath, Constants.LocalSettings.SettingsFolderName));
+                    // Import user settings
+                    var userSettingsFile = await zipFolder.GetFileAsync(Constants.LocalSettings.UserSettingsFileName);
+                    string importSettings = await userSettingsFile.ReadTextAsync();
+                    UserSettingsService.ImportSettings(importSettings);
+                    // Import bundles
+                    var bundles = await zipFolder.GetFileAsync(Constants.LocalSettings.BundlesSettingsFileName);
+                    string importBundles = await bundles.ReadTextAsync();
+                    BundlesSettingsService.ImportSettings(importBundles);
+                    // Import pinned items
+                    var pinnedItems = await zipFolder.GetFileAsync(App.SidebarPinnedController.JsonFileName);
+                    await pinnedItems.CopyAsync(settingsFolder, pinnedItems.Name, NameCollisionOption.ReplaceExisting);
+                    await App.SidebarPinnedController.ReloadAsync();
+                    // Import terminals config
+                    var terminals = await zipFolder.GetFileAsync(App.TerminalController.JsonFileName);
+                    await terminals.CopyAsync(settingsFolder, terminals.Name, NameCollisionOption.ReplaceExisting);
+                    // Import file tags list and DB
+                    var fileTagsList = await zipFolder.GetFileAsync(Constants.LocalSettings.FileTagSettingsFileName);
+                    string importTags = await fileTagsList.ReadTextAsync();
+                    FileTagsSettingsService.ImportSettings(importTags);
+                    var fileTagsDB = await zipFolder.GetFileAsync(Path.GetFileName(FileTagsHelper.FileTagsDbPath));
+                    string importTagsDB = await fileTagsDB.ReadTextAsync();
+                    FileTagsHelper.DbInstance.Import(importTagsDB);
                 }
-                catch
+                catch (Exception ex)
                 {
+                    App.Logger.Warn(ex, "Error importing settings");
                     UIHelpers.CloseAllDialogs();
                     await DialogDisplayHelper.ShowDialogAsync("SettingsImportErrorTitle".GetLocalized(), "SettingsImportErrorDescription".GetLocalized());
                 }
diff --git a/Files/ViewModels/Widgets/Bundles/BundlesViewModel.cs b/Files/ViewModels/Widgets/Bundles/BundlesViewModel.cs
@@ -104,6 +104,8 @@ public BundlesViewModel()
             AddBundleCommand = new RelayCommand(() => AddBundle(BundleNameTextInput));
             ImportBundlesCommand = new AsyncRelayCommand(ImportBundles);
             ExportBundlesCommand = new AsyncRelayCommand(ExportBundles);
+
+            BundlesSettingsService.OnSettingChangedEvent += BundlesSettingsService_OnSettingChangedEvent;
         }
 
         #endregion Constructor
@@ -228,15 +230,12 @@ private async Task ImportBundles()
             filePicker.FileTypeFilter.Add(System.IO.Path.GetExtension(Constants.LocalSettings.BundlesSettingsFileName));
 
             StorageFile file = await filePicker.PickSingleFileAsync();
-
             if (file != null)
             {
                 try
                 {
                     string data = NativeFileOperationsHelper.ReadStringFromFile(file.Path);
-                    var deserialized = JsonConvert.DeserializeObject<Dictionary<string, List<string>>>(data);
-                    BundlesSettingsService.ImportSettings(JsonConvert.DeserializeObject<Dictionary<string, List<string>>>(data));
-                    await Load(); // Update the collection
+                    BundlesSettingsService.ImportSettings(data);
                 }
                 catch // Couldn't deserialize, data is corrupted
                 {
@@ -250,7 +249,6 @@ private async Task ExportBundles()
             filePicker.FileTypeChoices.Add("Json File", new List<string>() { System.IO.Path.GetExtension(Constants.LocalSettings.BundlesSettingsFileName) });
 
             StorageFile file = await filePicker.PickSaveFileAsync();
-
             if (file != null)
             {
                 NativeFileOperationsHelper.WriteStringToFile(file.Path, (string)BundlesSettingsService.ExportSettings());
@@ -261,6 +259,16 @@ private async Task ExportBundles()
 
         #region Handlers
 
+        private async void BundlesSettingsService_OnSettingChangedEvent(object sender, EventArguments.SettingChangedEventArgs e)
+        {
+            switch (e.settingName)
+            {
+                case nameof(BundlesSettingsService.SavedBundles):
+                    await Load();
+                    break;
+            }
+        }
+
         private void OpenPathHandle(string path, FilesystemItemType itemType, bool openSilent, bool openViaApplicationPicker, IEnumerable<string> selectItems)
         {
             OpenPathEvent?.Invoke(this, new BundlesOpenPathEventArgs(path, itemType, openSilent, openViaApplicationPicker, selectItems));
@@ -277,6 +285,8 @@ private void OpenPathInNewPaneHandle(string path)
         /// <param name="item"></param>
         private void NotifyItemRemovedHandle(BundleContainerViewModel item)
         {
+            BundlesSettingsService.OnSettingChangedEvent -= BundlesSettingsService_OnSettingChangedEvent;
+
             Items.Remove(item);
             item?.Dispose();
 

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,12 @@ public async Task InitializeAsync()`
`29`	`29`	`await LoadAsync();`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ public async Task ReloadAsync()`
	`33`	`+ {`
	`34`	`+ await LoadAsync();`
	`35`	`+ Model.RemoveStaleSidebarItems();`
	`36`	`+ }`
	`37`	`+`
`32`	`38`	`private async Task LoadAsync()`
`33`	`39`	`{`
`34`	`40`	`StorageFolder Folder = await FilesystemTasks.Wrap(() => ApplicationData.Current.LocalFolder.CreateFolderAsync("settings", CreationCollisionOption.OpenIfExists).AsTask());`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,13 @@`
`1`		`-using System.Collections.Generic;`
	`1`	`+using Files.EventArguments;`
	`2`	`+using System;`
	`3`	`+using System.Collections.Generic;`
`2`	`4`
`3`	`5`	`namespace Files.Services`
`4`	`6`	`{`
`5`	`7`	`public interface IBundlesSettingsService`
`6`	`8`	`{`
	`9`	`+ event EventHandler<SettingChangedEventArgs> OnSettingChangedEvent;`
	`10`	`+`
`7`	`11`	`bool FlushSettings();`
`8`	`12`
`9`	`13`	`object ExportSettings();`
Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,22 @@`
`1`		`-using Files.Filesystem;`
	`1`	`+using Files.EventArguments;`
	`2`	`+using Files.Filesystem;`
	`3`	`+using System;`
`2`	`4`	`using System.Collections.Generic;`
`3`	`5`
`4`	`6`	`namespace Files.Services`
`5`	`7`	`{`
`6`	`8`	`public interface IFileTagsSettingsService`
`7`	`9`	`{`
	`10`	`+ event EventHandler<SettingChangedEventArgs> OnSettingChangedEvent;`
	`11`	`+`
`8`	`12`	`IList<FileTag> FileTagList { get; set; }`
`9`	`13`
`10`	`14`	`FileTag GetTagById(string uid);`
`11`	`15`
`12`	`16`	`IEnumerable<FileTag> GetTagsByName(string tagName);`
	`17`	`+`
	`18`	`+ object ExportSettings();`
	`19`	`+`
	`20`	`+ bool ImportSettings(object import);`
`13`	`21`	`}`
`14`	`22`	`}`