Changeset 16992

Timestamp:

05/29/19 11:20:22 (5 years ago)

Author:

gkronber

Message:

#2520: Use ContentManager in Clipboard and StartPage. Show info when objects cannot be restored.

Location:

trunk

Files:

• HeuristicLab.Common/3.3/Content/ContentManager.cs (modified) (2 diffs)
• HeuristicLab.Core.Views/3.3/Clipboard.cs (modified) (1 diff)
• HeuristicLab.Core/3.3/PersistenceContentManager.cs (modified) (2 diffs)
• HeuristicLab.Optimizer/3.3/FileManager.cs (modified) (2 diffs)
• HeuristicLab.Optimizer/3.3/StartPage.cs (modified) (2 diffs)

trunk/HeuristicLab.Common/3.3/Content/ContentManager.cs

@@ -21 +21 @@
 
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Threading;
+using System.Threading.Tasks;
+using HEAL.Attic;
 
 namespace HeuristicLab.Common {
   public abstract class ContentManager {
+    public class Info {
+      public Info() { }
+
+      public Info(string filename, TimeSpan duration) {
+        Filename = filename;
+        Duration = duration;
+      }
+
+      public Info(string filename, SerializationInfo serInfo) {
+        Filename = filename;
+        Duration = serInfo.Duration;
+        UnknownTypeGuids = serInfo.UnknownTypeGuids;
+        NumberOfSerializedObjects = serInfo.NumberOfSerializedObjects;
+        SerializedTypes = serInfo.SerializedTypes;        
+      }
+
+      public TimeSpan Duration { get; internal set; }
+      public IEnumerable<Guid> UnknownTypeGuids { get; internal set; } = Enumerable.Empty<Guid>();
+      public int NumberOfSerializedObjects { get; internal set; }
+      public IEnumerable<Type> SerializedTypes { get; internal set; } = Enumerable.Empty<Type>();
+      public string Filename { get; internal set; } = string.Empty;
+    }
+
     private static ContentManager instance;
 
@@ -36 +63 @@
 
     public static IStorableContent Load(string filename) {
+      return Load(filename, out var _);
+    }
+
+    public static IStorableContent Load(string filename, out Info serializationInfo) {
       if (instance == null) throw new InvalidOperationException("ContentManager is not initialized.");
-      IStorableContent content = instance.LoadContent(filename);
-      content.Filename = filename;
+      IStorableContent content = instance.LoadContent(filename, out serializationInfo);
+      
+      if (content != null) content.Filename = filename;
       return content;
     }
-    public static void LoadAsync(string filename, Action<IStorableContent, Exception> loadingCompletedCallback) {
+
+
+    public static Task LoadAsync(string filename, Action<IStorableContent, Exception> loadingCompletedCallback) {
+      return LoadAsync(filename, (content, error, info) => loadingCompletedCallback(content, error)); // drop info
+    }
+
+    public static async Task LoadAsync(string filename, Action<IStorableContent, Exception, Info> loadingCompletedCallback) {
       if (instance == null) throw new InvalidOperationException("ContentManager is not initialized.");
-      var func = new Func<string, IStorableContent>(instance.LoadContent);
-      func.BeginInvoke(filename, delegate (IAsyncResult result) {
-        Exception error = null;
-        IStorableContent content = null;
-        try {
-          content = func.EndInvoke(result);
-          content.Filename = filename;
-        } catch (Exception ex) {
-          error = ex;
-        }
-        loadingCompletedCallback(content, error);
-      }, null);
+
+      Exception error = null;
+      IStorableContent result = null;
+      Info serializationInfo = null;
+      try {
+        result = await Task.Run(() => {
+          var content = instance.LoadContent(filename, out serializationInfo);
+          if(content!=null) content.Filename = filename;
+          return content;
+        });
+      } catch(Exception ex) {
+        error = ex;
+      }
+      loadingCompletedCallback(result, error, serializationInfo);
     }
-    protected abstract IStorableContent LoadContent(string filename);
+
+    protected abstract IStorableContent LoadContent(string filename, out Info serializationInfo);
 
     public static void Save(IStorableContent content, string filename, bool compressed, CancellationToken cancellationToken = default(CancellationToken)) {

trunk/HeuristicLab.Core.Views/3.3/Clipboard.cs

@@ -157 +157 @@
       foreach (string filename in items) {
         try {
-          var ser = new ProtoBufSerializer();
-          T item = (T)ser.Deserialize(filename);
+          T item = (T)ContentManager.Load(filename);
           OnItemLoaded(item, progressBar.Maximum / items.Length);
-        } catch (Exception) {
-          try {
-            // try old format if protobuf deserialization fails
-            T item = XmlParser.Deserialize<T>(filename);
-            OnItemLoaded(item, progressBar.Maximum / items.Length);
-          } catch (Exception) { }
+        } catch(Exception) {
+          // ignore if loading a clipboad item fails.
         }
       }

trunk/HeuristicLab.Core/3.3/PersistenceContentManager.cs

@@ -25 +25 @@
 using HEAL.Attic;
 using System;
+using System.Diagnostics;
 
 namespace HeuristicLab.Core {
@@ -30 +31 @@
     public PersistenceContentManager() : base() { }
 
-    protected override IStorableContent LoadContent(string filename) {
+    protected override IStorableContent LoadContent(string filename, out Info info) {
       bool useOldPersistence = XmlParser.CanOpen(filename);
-      if (useOldPersistence) return XmlParser.Deserialize<IStorableContent>(filename);
+      IStorableContent content = null;
+      if (useOldPersistence) {
+        var sw = new Stopwatch();
+        sw.Start();
+        content = XmlParser.Deserialize<IStorableContent>(filename);
+        sw.Stop();
+        info = new Info(filename, sw.Elapsed);
+      } else {
+        var ser = new ProtoBufSerializer();
+        content = (IStorableContent)ser.Deserialize(filename, out SerializationInfo serInfo);
+        info = new Info(filename, serInfo);
+      }
+      if (content == null) throw new PersistenceException($"Cannot deserialize root element of {filename}");
+      return content;
+    }
 
-      var ser = new ProtoBufSerializer();
-      return (IStorableContent)ser.Deserialize(filename, out SerializationInfo info);
-    }
 
     protected override void SaveContent(IStorableContent content, string filename, bool compressed, CancellationToken cancellationToken) {

trunk/HeuristicLab.Optimizer/3.3/FileManager.cs

@@ -23 +23 @@
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Threading;
 using System.Windows.Forms;
@@ -73 +74 @@
     }
 
-    private static void LoadingCompleted(IStorableContent content, Exception error) {
+    private static void LoadingCompleted(IStorableContent content, Exception error, ContentManager.Info info) {
       try {
         if (error != null) throw error;
+        if (info!=null && info.UnknownTypeGuids.Any()) {
+          var message = "Unknown type guids: " + string.Join(Environment.NewLine, info.UnknownTypeGuids);
+          MessageBox.Show((Control)MainFormManager.MainForm, message, $"File {info.Filename} not restored completely", MessageBoxButtons.OK, MessageBoxIcon.Information);
+        }
         IView view = MainFormManager.MainForm.ShowContent(content);
         if (view == null)

trunk/HeuristicLab.Optimizer/3.3/StartPage.cs

@@ -30 +30 @@
 using HeuristicLab.Core;
 using HeuristicLab.MainForm;
-using HeuristicLab.Persistence.Default.Xml;
 
 namespace HeuristicLab.Optimizer {
@@ -121 +120 @@
         using (var stream = assembly.GetManifestResourceStream(name)) {
           WriteStreamToTempFile(stream, path); // create a file in a temporary folder (persistence cannot load these files directly from the stream)
-          var item = XmlParser.Deserialize<INamedItem>(path);
+          var item = (INamedItem)ContentManager.Load(path);
           OnSampleLoaded(item, group, 1.0 / count);
         }