DocumentationBrowserViewExtension Upgrade + Insert

src/DocumentationBrowserViewExtension/DocumentationBrowserUtils.cs

@@ -1,4 +1,4 @@
-using Dynamo.Utilities;
+using Dynamo.Utilities;
 using System.IO;
 using System.Reflection;
 
@@ -17,7 +17,14 @@ internal static string GetDPIScript()
         {
             return ResourceUtilities.DPISCRIPT;
         }
-
+        /// <summary>
+        /// Returns the Image Navigation Script
+        /// </summary>
+        /// <returns></returns>
+        internal static string GetImageNavigationScript()
+        {
+            return ResourceUtilities.IMGNAVIGATIONSCRIPT;
+        }
         /// <summary>
         /// Returns the content of an embedded resource file.
         /// </summary>

src/DocumentationBrowserViewExtension/DocumentationBrowserView.xaml.cs

@@ -1,4 +1,4 @@
-using Dynamo.Logging;
+using Dynamo.Logging;
 using Dynamo.Utilities;
 using Microsoft.Web.WebView2.Core;
 using Microsoft.Web.WebView2.Wpf;
@@ -113,6 +113,7 @@ protected virtual void Dispose(bool disposing)
                 this.documentationBrowser.Dispose();
             }
             this.documentationBrowser.DpiChanged -= DocumentationBrowser_DpiChanged;
+            this.documentationBrowser.CoreWebView2.WebMessageReceived -= CoreWebView2OnWebMessageReceived;
         }
 
         async void InitializeAsync()
@@ -138,6 +139,18 @@ async void InitializeAsync()
             {
                 this.documentationBrowser.NavigateToString(htmlContent);
             }));
+
+            this.documentationBrowser.CoreWebView2.WebMessageReceived += CoreWebView2OnWebMessageReceived;
+        }
+
+        private void CoreWebView2OnWebMessageReceived(object sender, CoreWebView2WebMessageReceivedEventArgs e)
+        {
+            var message = e.TryGetWebMessageAsString();
+            if (string.Equals(message, "insert"))
+            {
+                // Insert the graph inside the current worskspace
+                this.viewModel.InsertGraph();
+            }
         }
 
         /// <summary>

src/DocumentationBrowserViewExtension/DocumentationBrowserViewExtension.cs

@@ -1,24 +1,37 @@
 using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.IO;
 using System.Linq;
+using System.Security.Permissions;
+using System.Web.UI.WebControls;
 using System.Threading;
 using System.Windows;
-using System.Windows.Controls;
+using System.Windows.Threading;
+using DesignScript.Builtin;
+using Dynamo.Configuration;
+using Dynamo.Core;
 using Dynamo.DocumentationBrowser.Properties;
+using Dynamo.Graph;
+using Dynamo.Graph.Workspaces;
 using Dynamo.Logging;
+using Dynamo.Selection;
+using Dynamo.Models;
 using Dynamo.PackageManager;
 using Dynamo.ViewModels;
 using Dynamo.Wpf.Extensions;
+using Dynamo.Wpf.Interfaces;
+using MenuItem = System.Windows.Controls.MenuItem;
 
 namespace Dynamo.DocumentationBrowser
 {
     /// <summary>
     /// The DocumentationBrowser view extension displays web or local html files on the Dynamo right panel.
     /// It reacts to documentation display request events in Dynamo to know what and when to display documentation.
     /// </summary>
-    public class DocumentationBrowserViewExtension : ViewExtensionBase, IViewExtension, ILogSource
+    public class DocumentationBrowserViewExtension : ViewExtensionBase, IViewExtension, ILogSource, ILayoutSpecSource
     {
+        private ViewStartupParams viewStartupParamsReference;
         private ViewLoadedParams viewLoadedParamsReference;
         private MenuItem documentationBrowserMenuItem;
         private PackageManagerExtension pmExtension;
@@ -27,8 +40,11 @@ public class DocumentationBrowserViewExtension : ViewExtensionBase, IViewExtensi
         internal DirectoryInfo fallbackDocPath;
         internal DirectoryInfo webBrowserUserDataFolder;
 
+        internal Dictionary<string, string> BreadCrumbsDict { get; set; }
+
         internal DocumentationBrowserView BrowserView { get; private set; }
         internal DocumentationBrowserViewModel ViewModel { get; private set; }
+        private DynamoViewModel DynamoViewModel { get; set; }
 
         /// <summary>
         /// Extension Name
@@ -59,8 +75,20 @@ internal void OnMessageLogged(ILogMessage msg)
 
         #region IViewExtension lifecycle
 
+        private Func<LayoutSpecification> layouthandler;
+
+        public event Action<string> RequestApplyLayoutSpec;
+
+        public event Func<LayoutSpecification> RequestLayoutSpec
+        {
+            add { layouthandler += value; }
+            remove { layouthandler -= value; }
+        }
+
         public override void Startup(ViewStartupParams viewStartupParams)
         {
+            this.viewStartupParamsReference = viewStartupParams;
+
             pmExtension = viewStartupParams.ExtensionManager.Extensions.OfType<PackageManagerExtension>().FirstOrDefault();
             PackageDocumentationManager.Instance.AddDynamoPaths(viewStartupParams.PathManager);
 
@@ -101,11 +129,12 @@ public override void Startup(ViewStartupParams viewStartupParams)
         public override void Loaded(ViewLoadedParams viewLoadedParams)
         {
             if (viewLoadedParams == null) throw new ArgumentNullException(nameof(viewLoadedParams));
+            this.viewLoadedParamsReference = viewLoadedParams; 
 
             this.ViewModel.MessageLogged += OnViewModelMessageLogged;
+            this.ViewModel.HandleInsertFile += OnInsertFile;
             PackageDocumentationManager.Instance.MessageLogged += OnMessageLogged;
 
-            this.viewLoadedParamsReference = viewLoadedParams; 
 
             // Add a button to Dynamo View menu to manually show the window
             this.documentationBrowserMenuItem = new MenuItem { Header = Resources.MenuItemText, IsCheckable = true };
@@ -132,8 +161,173 @@ public override void Loaded(ViewLoadedParams viewLoadedParams)
             {
                 OnPackageLoaded(pkg);
             }
+
+            this.DynamoViewModel = (viewLoadedParams.DynamoWindow.DataContext as DynamoViewModel);
+        }
+
+        private void OnInsertFile(object sender, InsertDocumentationLinkEventArgs e)
+        {
+            if (DynamoViewModel.Model.CurrentWorkspace.GetType() == typeof(HomeWorkspaceModel))
+            {
+                var homeWorkspace = DynamoViewModel.Model.CurrentWorkspace as HomeWorkspaceModel;
+                if (homeWorkspace != null && homeWorkspace.RunSettings.RunType != RunType.Manual)
+                {
+                    DynamoViewModel.MainGuideManager.CreateRealTimeInfoWindow("Example file added to workspace. Run mode changed to Manual.", true);
+                    homeWorkspace.RunSettings.RunType = RunType.Manual;
+                }
+            }
+
+            var existingGroups = GetExistingGroups();
+
+            // Insert the file and select all the elements that were inserted 
+            this.DynamoViewModel.Model.InsertFileFromPath(e.Data);
+
+            if (!DynamoSelection.Instance.Selection.Any()) return;
+            DoEvents();
+
+            GroupInsertedGraph(existingGroups, e.Name);
+            DoEvents();
+
+            // We have selected all the nodes and notes from the inserted graph
+            // Now is the time to auto layout the inserted nodes
+            this.DynamoViewModel.GraphAutoLayoutCommand.Execute(null);
+            DoEvents();
+
+            this.DynamoViewModel.FitViewCommand.Execute(null);
+            DoEvents();
+        }
+
+
+        private void GroupInsertedGraph(List<AnnotationViewModel> existingGroups, string graphName)
+        {
+            var selection = GetCurrentSelection();
+            var hostGroups = GetAllHostingGroups(existingGroups);
+
+            foreach (var group in hostGroups)
+            {
+                group.DissolveNestedGroupsCommand.Execute(null);
+            }
+
+
+            foreach (var group in hostGroups)
+            {
+                selection.RemoveAll(x => group.AnnotationModel.ContainsModel(x as ModelBase));
+            }
+
+            DynamoSelection.Instance.Selection.AddRange(selection);
+            DynamoSelection.Instance.Selection.AddRange(hostGroups.Select(x => x.AnnotationModel));
+            DoEvents();
+
+            var annotation = this.DynamoViewModel.Model.CurrentWorkspace.AddAnnotation("Inserted Dynamo graph", Guid.NewGuid());
+            annotation.AnnotationText = graphName;
+            DoEvents();
+
+            var annotationViewModel = DynamoViewModel.CurrentSpaceViewModel.Annotations
+                    .First(x => x.AnnotationModel == annotation);
+
+            // Is that the correct way of getting a GroupStyleItem from StyleItem?
+            var styleItem = annotationViewModel.GroupStyleList.First(x => x.Name.Equals("Review"));
+            var groupStyleItem = new GroupStyleItem {Name = styleItem.Name, HexColorString = styleItem.HexColorString};
+            annotationViewModel.UpdateGroupStyle(groupStyleItem);
+
+            DynamoSelection.Instance.ClearSelection();
+            DynamoSelection.Instance.Selection.AddRange(annotation.Nodes);
+            DoEvents();
+        }
+
+        private List<AnnotationViewModel> GetAllHostingGroups(List<AnnotationViewModel> existingGroups)
+        {
+            List<AnnotationViewModel> hostGroups = new List<AnnotationViewModel>();
+
+            foreach (var group in this.DynamoViewModel.CurrentSpaceViewModel.Annotations)
+            {
+                if (existingGroups.Contains(group)) continue;
+
+                if (group.AnnotationModel.HasNestedGroups)
+                {
+                    hostGroups.Add(group);
+                }
+            }
+
+            return hostGroups;
+        }
+
+        private List<ISelectable> GetCurrentSelection()
+        {
+            List<ISelectable> selection = new List<ISelectable>();
+
+            foreach (var selected in DynamoSelection.Instance.Selection)
+            {
+                selection.Add(selected);
+            }
+
+            return selection;
+        }
+        private List<AnnotationViewModel> GetExistingGroups()
+        {
+            List<AnnotationViewModel> result = new List<AnnotationViewModel>();
+
+            foreach (var group in this.DynamoViewModel.CurrentSpaceViewModel.Annotations)
+            {
+                result.Add(group);
+            }
+
+            return result;
         }
 
+        private void RequestLoadLayoutSpecs()
+        {
+            if (BreadCrumbsDict != null) return;
+
+            var output = layouthandler?.Invoke();
+            if (output == null) return;
+
+            PopulateBreadCrumbsDictionary(output);
+        }
+
+        private void PopulateBreadCrumbsDictionary(LayoutSpecification layoutSpec)
+        {
+            var section = layoutSpec.sections.First();
+            var breadCrumb = string.Empty;
+
+            BreadCrumbsDict = new Dictionary<string, string>();
+
+            if (section.childElements.Count == 0) return;
+
+            foreach (var child in section.childElements)
+            {
+                breadCrumb = child.text + " / ";
+
+                RecursiveIncludeSearch(child, breadCrumb);
+            }
+
+            this.ViewModel.BreadCrumbsDictionary = BreadCrumbsDict;
+        }
+
+        private void RecursiveIncludeSearch(LayoutElement child, string breadCrumb)
+        {
+            string crumb = breadCrumb;
+
+            if (child.childElements.Any())
+            {
+                foreach (var grandchild in child.childElements)
+                {
+                    crumb = breadCrumb + grandchild.text + " / ";
+
+                    RecursiveIncludeSearch(grandchild, crumb);
+                }
+            }
+
+            foreach (var info in child.include)
+            {
+                var typeArray = info.path.Split('.');
+                var type = typeArray[typeArray.Length - 2] + "." + typeArray[typeArray.Length - 1];
+
+                BreadCrumbsDict[type] = crumb.Remove(crumb.Length-3);
+            }
+        }
+
+
         private void OnPackageLoaded(Package pkg)
         {
             // Add documentation files from the package to the DocManager
@@ -147,6 +341,7 @@ private void MenuItemUnCheckedHandler(object sender, RoutedEventArgs e)
 
         private void MenuItemCheckHandler(object sender, RoutedEventArgs e)
         {
+
             AddToSidebar(true);
         }
 
@@ -161,6 +356,7 @@ protected virtual void Dispose(bool disposing)
             if (this.ViewModel != null)
             {
                 this.ViewModel.MessageLogged -= OnViewModelMessageLogged;
+                this.ViewModel.HandleInsertFile -= OnInsertFile;
             }
 
             if (this.documentationBrowserMenuItem != null)
@@ -209,6 +405,9 @@ public void HandleRequestOpenDocumentationLink(OpenDocumentationLinkEventArgs ar
             if (args.IsRemoteResource)
                 return;
 
+            // make sure the breadcrumbs dictionary has been loaded
+            RequestLoadLayoutSpecs();
+
             // make sure the view is added to the Sidebar
             // this also forces the Sidebar to open
             AddToSidebar(false);
@@ -263,5 +462,33 @@ public override void Closed()
                 this.documentationBrowserMenuItem.IsChecked = false;
             }
         }
+
+        #region helper methods
+
+        /// <summary>
+        ///     Force the Dispatcher to empty it's queue
+        /// </summary>
+        [SecurityPermission(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)]
+        public static void DoEvents()
+        {
+            var frame = new DispatcherFrame();
+            Dispatcher.CurrentDispatcher.Invoke(DispatcherPriority.Background,
+                new DispatcherOperationCallback(ExitFrame), frame);
+            Dispatcher.PushFrame(frame);
+        }
+
+        /// <summary>
+        ///     Helper method for DispatcherUtil
+        /// </summary>
+        /// <param name="frame"></param>
+        /// <returns></returns>
+        private static object ExitFrame(object frame)
+        {
+            ((DispatcherFrame)frame).Continue = false;
+            return null;
+        }
+
+        #endregion
+
     }
 }

src/DocumentationBrowserViewExtension/DocumentationBrowserViewExtension.csproj

@@ -41,6 +41,7 @@
       <Project>{B5F435CB-0D8A-40B1-A4F7-5ECB3CE792A9}</Project>
       <Name>DynamoUtilities</Name>
     </ProjectReference>
+    <ProjectReference Include="..\LibraryViewExtensionMSWebBrowser\LibraryViewExtensionMSWebBrowser.csproj" />
     <ProjectReference Include="..\NodeServices\DynamoServices.csproj">
       <Project>{ef879a10-041d-4c68-83e7-3192685f1bae}</Project>
       <Name>DynamoServices</Name>
@@ -96,9 +97,6 @@
   <ItemGroup>
     <None Include="README.md" />
   </ItemGroup>
-  <ItemGroup>
-    <Folder Include="Resources\" />
-  </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="Docs\IntegerOverflow.html" />
   </ItemGroup>