/// <summary>
/// Deserialize a function definition from a given path. A side effect of this function is that
/// the node is added to the dictionary of loadedNodes.
/// </summary>
/// <param name="funcDefGuid">The function guid we're currently loading</param>
/// <param name="def">The resultant function definition</param>
/// <returns></returns>
private bool GetDefinitionFromPath(Guid funcDefGuid, out CustomNodeDefinition def)
{
try
{
var xmlPath = GetNodePath(funcDefGuid);
#region read xml file
var xmlDoc = new XmlDocument();
xmlDoc.Load(xmlPath);
string funName = null;
string category = "";
double cx = 0;
double cy = 0;
string description = "";
string version = "";
double zoom = 1.0;
string id = "";
// load the header
// handle legacy workspace nodes called dynWorkspace
// and new workspaces without the dyn prefix
XmlNodeList workspaceNodes = xmlDoc.GetElementsByTagName("Workspace");
if(workspaceNodes.Count == 0)
workspaceNodes = xmlDoc.GetElementsByTagName("dynWorkspace");
foreach (XmlNode node in workspaceNodes)
{
foreach (XmlAttribute att in node.Attributes)
{
if (att.Name.Equals("X"))
cx = double.Parse(att.Value, CultureInfo.InvariantCulture);
else if (att.Name.Equals("Y"))
cy = double.Parse(att.Value, CultureInfo.InvariantCulture);
else if (att.Name.Equals("zoom"))
zoom = double.Parse(att.Value, CultureInfo.InvariantCulture);
else if (att.Name.Equals("Name"))
funName = att.Value;
else if (att.Name.Equals("Category"))
category = att.Value;
else if (att.Name.Equals("Description"))
description = att.Value;
else if (att.Name.Equals("ID"))
id = att.Value;
else if (att.Name.Equals("Version"))
version = att.Value;
}
}
Version fileVersion = MigrationManager.VersionFromString(version);
var currentVersion = MigrationManager.VersionFromWorkspace(dynamoModel.HomeSpace);
if (fileVersion > currentVersion)
{
bool resume = Utils.DisplayFutureFileMessage(this.dynamoModel, xmlPath, fileVersion, currentVersion);
if (!resume)
{
def = null;
return false;
}
}
var decision = MigrationManager.ShouldMigrateFile(fileVersion, currentVersion);
if (decision == MigrationManager.Decision.Abort)
{
Utils.DisplayObsoleteFileMessage(this.dynamoModel, xmlPath, fileVersion, currentVersion);
def = null;
return false;
}
else if (decision == MigrationManager.Decision.Migrate)
{
string backupPath = string.Empty;
bool isTesting = DynamoModel.IsTestMode; // No backup during test.
if (!isTesting && MigrationManager.BackupOriginalFile(xmlPath, ref backupPath))
{
string message = string.Format(
"Original file '{0}' gets backed up at '{1}'",
Path.GetFileName(xmlPath), backupPath);
dynamoModel.Logger.Log(message);
}
MigrationManager.Instance.ProcessWorkspaceMigrations(this.dynamoModel, xmlDoc, fileVersion);
MigrationManager.Instance.ProcessNodesInWorkspace(this.dynamoModel, xmlDoc, fileVersion);
}
// we have a dyf and it lacks an ID field, we need to assign it
// a deterministic guid based on its name. By doing it deterministically,
// files remain compatible
if (string.IsNullOrEmpty(id) && !string.IsNullOrEmpty(funName))
{
id = GuidUtility.Create(GuidUtility.UrlNamespace, funName).ToString();
}
#endregion
//DynamoCommands.WriteToLogCmd.Execute("Loading node definition for \"" + funName + "\" from: " + xmlPath);
this.dynamoModel.Logger.Log("Loading node definition for \"" + funName + "\" from: " + xmlPath);
var ws = new CustomNodeWorkspaceModel(dynamoModel,
funName, category.Length > 0
? category
: "Custom Nodes", description, cx, cy)
{
WatchChanges = false,
FileName = xmlPath,
Zoom = zoom
};
def = new CustomNodeDefinition(Guid.Parse(id))
{
WorkspaceModel = ws,
IsBeingLoaded = true
};
// set the node as loaded
LoadedCustomNodes.Remove(def.FunctionId);
LoadedCustomNodes.Add(def.FunctionId, def);
XmlNodeList elNodes = xmlDoc.GetElementsByTagName("Elements");
XmlNodeList cNodes = xmlDoc.GetElementsByTagName("Connectors");
XmlNodeList nNodes = xmlDoc.GetElementsByTagName("Notes");
if (elNodes.Count == 0)
elNodes = xmlDoc.GetElementsByTagName("dynElements");
if (cNodes.Count == 0)
cNodes = xmlDoc.GetElementsByTagName("dynConnectors");
if (nNodes.Count == 0)
nNodes = xmlDoc.GetElementsByTagName("dynNotes");
XmlNode elNodesList = elNodes[0];
XmlNode cNodesList = cNodes[0];
XmlNode nNodesList = nNodes[0];
#region instantiate nodes
foreach (XmlNode elNode in elNodesList.ChildNodes)
{
XmlAttribute typeAttrib = elNode.Attributes["type"];
XmlAttribute guidAttrib = elNode.Attributes["guid"];
XmlAttribute nicknameAttrib = elNode.Attributes["nickname"];
XmlAttribute xAttrib = elNode.Attributes["x"];
XmlAttribute yAttrib = elNode.Attributes["y"];
XmlAttribute lacingAttrib = elNode.Attributes["lacing"];
XmlAttribute isVisAttrib = elNode.Attributes["isVisible"];
XmlAttribute isUpstreamVisAttrib = elNode.Attributes["isUpstreamVisible"];
string typeName = typeAttrib.Value;
//test the GUID to confirm that it is non-zero
//if it is zero, then we have to fix it
//this will break the connectors, but it won't keep
//propagating bad GUIDs
var guid = new Guid(guidAttrib.Value);
if (guid == Guid.Empty)
{
guid = Guid.NewGuid();
}
string nickname = nicknameAttrib.Value;
double x = double.Parse(xAttrib.Value, CultureInfo.InvariantCulture);
double y = double.Parse(yAttrib.Value, CultureInfo.InvariantCulture);
bool isVisible = true;
if (isVisAttrib != null)
isVisible = isVisAttrib.Value == "true" ? true : false;
bool isUpstreamVisible = true;
if (isUpstreamVisAttrib != null)
isUpstreamVisible = isUpstreamVisAttrib.Value == "true" ? true : false;
// Retrieve optional 'function' attribute (only for DSFunction).
XmlAttribute signatureAttrib = elNode.Attributes["function"];
var signature = signatureAttrib == null ? null : signatureAttrib.Value;
NodeModel el = null;
XmlElement dummyElement = null;
try
{
// The attempt to create node instance may fail due to "type" being
// something else other than "NodeModel" derived object type. This
// is possible since some legacy nodes have been made to derive from
// "MigrationNode" object type that is not derived from "NodeModel".
//
typeName = Nodes.Utilities.PreprocessTypeName(typeName);
System.Type type = Nodes.Utilities.ResolveType(this.dynamoModel, typeName);
if (type != null)
el = ws.NodeFactory.CreateNodeInstance(type, nickname, signature, guid);
if (el != null)
{
el.Load(elNode);
}
else
{
var e = elNode as XmlElement;
dummyElement = MigrationManager.CreateMissingNode(e, 1, 1);
}
}
catch (UnresolvedFunctionException)
{
// If a given function is not found during file load, then convert the
// function node into a dummy node (instead of crashing the workflow).
//
var e = elNode as XmlElement;
dummyElement = MigrationManager.CreateUnresolvedFunctionNode(e);
}
if (dummyElement != null) // If a dummy node placement is desired.
{
// The new type representing the dummy node.
typeName = dummyElement.GetAttribute("type");
System.Type type = Dynamo.Nodes.Utilities.ResolveType(this.dynamoModel, typeName);
el = ws.NodeFactory.CreateNodeInstance(type, nickname, string.Empty, guid);
el.Load(dummyElement);
}
ws.Nodes.Add(el);
el.X = x;
el.Y = y;
if (lacingAttrib != null)
{
LacingStrategy lacing = LacingStrategy.First;
Enum.TryParse(lacingAttrib.Value, out lacing);
el.ArgumentLacing = lacing;
}
el.DisableReporting();
// This is to fix MAGN-3648. Method reference in CBN that gets
// loaded before method definition causes a CBN to be left in
// a warning state. This is to clear such warnings and set the
// node to "Dead" state (correct value of which will be set
// later on with a call to "EnableReporting" below). Please
// refer to the defect for details and other possible fixes.
//
if (el.State == ElementState.Warning && (el is CodeBlockNodeModel))
el.State = ElementState.Dead;
el.IsVisible = isVisible;
el.IsUpstreamVisible = isUpstreamVisible;
}
#endregion
#region instantiate connectors
foreach (XmlNode connector in cNodesList.ChildNodes)
{
XmlAttribute guidStartAttrib = connector.Attributes[0];
XmlAttribute intStartAttrib = connector.Attributes[1];
XmlAttribute guidEndAttrib = connector.Attributes[2];
XmlAttribute intEndAttrib = connector.Attributes[3];
XmlAttribute portTypeAttrib = connector.Attributes[4];
var guidStart = new Guid(guidStartAttrib.Value);
var guidEnd = new Guid(guidEndAttrib.Value);
int startIndex = Convert.ToInt16(intStartAttrib.Value);
int endIndex = Convert.ToInt16(intEndAttrib.Value);
var portType = ((PortType)Convert.ToInt16(portTypeAttrib.Value));
//find the elements to connect
NodeModel start = null;
NodeModel end = null;
foreach (NodeModel e in ws.Nodes)
{
if (e.GUID == guidStart)
{
start = e;
}
else if (e.GUID == guidEnd)
{
end = e;
}
if (start != null && end != null)
{
break;
}
}
try
{
var newConnector = ws.AddConnection(
start, end,
startIndex, endIndex,
portType);
}
catch
{
dynamoModel.WriteToLog(string.Format("ERROR : Could not create connector between {0} and {1}.", start.NickName, end.NickName));
}
}
#endregion
#region instantiate notes
if (nNodesList != null)
{
foreach (XmlNode note in nNodesList.ChildNodes)
{
XmlAttribute textAttrib = note.Attributes[0];
XmlAttribute xAttrib = note.Attributes[1];
XmlAttribute yAttrib = note.Attributes[2];
string text = textAttrib.Value;
double x = Convert.ToDouble(xAttrib.Value, CultureInfo.InvariantCulture);
double y = Convert.ToDouble(yAttrib.Value, CultureInfo.InvariantCulture);
ws.AddNote(false, x, y, text, Guid.NewGuid());
}
}
#endregion
foreach (var e in ws.Nodes)
e.EnableReporting();
def.IsBeingLoaded = false;
def.Compile(this.dynamoModel, this.dynamoModel.EngineController);
ws.WatchChanges = true;
OnGetDefinitionFromPath(def);
}
catch (Exception ex)
{
dynamoModel.WriteToLog("There was an error opening the workbench.");
dynamoModel.WriteToLog(ex);
if (DynamoModel.IsTestMode)
throw ex; // Rethrow for NUnit.
def = null;
return false;
}
return true;
}
/// <summary>
/// Deserialize a function definition from a given path. A side effect of this function is that
/// the node is added to the dictionary of loadedNodes.
/// </summary>
/// <param name="funcDefGuid">The function guid we're currently loading</param>
/// <param name="def">The resultant function definition</param>
/// <returns></returns>
private bool GetDefinitionFromPath(Guid funcDefGuid, out CustomNodeDefinition def)
{
try
{
var xmlPath = GetNodePath(funcDefGuid);
#region read xml file
var xmlDoc = new XmlDocument();
xmlDoc.Load(xmlPath);
string funName = null;
string category = "";
double cx = 0;
double cy = 0;
string description = "";
string version = "";
double zoom = 1.0;
string id = "";
// load the header
// handle legacy workspace nodes called dynWorkspace
// and new workspaces without the dyn prefix
XmlNodeList workspaceNodes = xmlDoc.GetElementsByTagName("Workspace");
if (workspaceNodes.Count == 0)
{
workspaceNodes = xmlDoc.GetElementsByTagName("dynWorkspace");
}
foreach (XmlNode node in workspaceNodes)
{
foreach (XmlAttribute att in node.Attributes)
{
if (att.Name.Equals("X"))
{
cx = double.Parse(att.Value, CultureInfo.InvariantCulture);
}
else if (att.Name.Equals("Y"))
{
cy = double.Parse(att.Value, CultureInfo.InvariantCulture);
}
else if (att.Name.Equals("zoom"))
{
zoom = double.Parse(att.Value, CultureInfo.InvariantCulture);
}
else if (att.Name.Equals("Name"))
{
funName = att.Value;
}
else if (att.Name.Equals("Category"))
{
category = att.Value;
}
else if (att.Name.Equals("Description"))
{
description = att.Value;
}
else if (att.Name.Equals("ID"))
{
id = att.Value;
}
else if (att.Name.Equals("Version"))
{
version = att.Value;
}
}
}
Version fileVersion = MigrationManager.VersionFromString(version);
var currentVersion = MigrationManager.VersionFromWorkspace(dynamoModel.HomeSpace);
if (fileVersion > currentVersion)
{
bool resume = Utils.DisplayFutureFileMessage(this.dynamoModel, xmlPath, fileVersion, currentVersion);
if (!resume)
{
def = null;
return(false);
}
}
var decision = MigrationManager.ShouldMigrateFile(fileVersion, currentVersion);
if (decision == MigrationManager.Decision.Abort)
{
Utils.DisplayObsoleteFileMessage(this.dynamoModel, xmlPath, fileVersion, currentVersion);
def = null;
return(false);
}
else if (decision == MigrationManager.Decision.Migrate)
{
string backupPath = string.Empty;
bool isTesting = DynamoModel.IsTestMode; // No backup during test.
if (!isTesting && MigrationManager.BackupOriginalFile(xmlPath, ref backupPath))
{
string message = string.Format(
"Original file '{0}' gets backed up at '{1}'",
Path.GetFileName(xmlPath), backupPath);
dynamoModel.Logger.Log(message);
}
MigrationManager.Instance.ProcessWorkspaceMigrations(this.dynamoModel, xmlDoc, fileVersion);
MigrationManager.Instance.ProcessNodesInWorkspace(this.dynamoModel, xmlDoc, fileVersion);
}
// we have a dyf and it lacks an ID field, we need to assign it
// a deterministic guid based on its name. By doing it deterministically,
// files remain compatible
if (string.IsNullOrEmpty(id) && !string.IsNullOrEmpty(funName))
{
id = GuidUtility.Create(GuidUtility.UrlNamespace, funName).ToString();
}
#endregion
//DynamoCommands.WriteToLogCmd.Execute("Loading node definition for \"" + funName + "\" from: " + xmlPath);
this.dynamoModel.Logger.Log("Loading node definition for \"" + funName + "\" from: " + xmlPath);
var ws = new CustomNodeWorkspaceModel(dynamoModel,
funName, category.Length > 0
? category
: "Custom Nodes", description, cx, cy)
{
WatchChanges = false,
FileName = xmlPath,
Zoom = zoom
};
def = new CustomNodeDefinition(Guid.Parse(id))
{
WorkspaceModel = ws,
IsBeingLoaded = true
};
// set the node as loaded
LoadedCustomNodes.Remove(def.FunctionId);
LoadedCustomNodes.Add(def.FunctionId, def);
XmlNodeList elNodes = xmlDoc.GetElementsByTagName("Elements");
XmlNodeList cNodes = xmlDoc.GetElementsByTagName("Connectors");
XmlNodeList nNodes = xmlDoc.GetElementsByTagName("Notes");
if (elNodes.Count == 0)
{
elNodes = xmlDoc.GetElementsByTagName("dynElements");
}
if (cNodes.Count == 0)
{
cNodes = xmlDoc.GetElementsByTagName("dynConnectors");
}
if (nNodes.Count == 0)
{
nNodes = xmlDoc.GetElementsByTagName("dynNotes");
}
XmlNode elNodesList = elNodes[0];
XmlNode cNodesList = cNodes[0];
XmlNode nNodesList = nNodes[0];
#region instantiate nodes
foreach (XmlNode elNode in elNodesList.ChildNodes)
{
XmlAttribute typeAttrib = elNode.Attributes["type"];
XmlAttribute guidAttrib = elNode.Attributes["guid"];
XmlAttribute nicknameAttrib = elNode.Attributes["nickname"];
XmlAttribute xAttrib = elNode.Attributes["x"];
XmlAttribute yAttrib = elNode.Attributes["y"];
XmlAttribute lacingAttrib = elNode.Attributes["lacing"];
XmlAttribute isVisAttrib = elNode.Attributes["isVisible"];
XmlAttribute isUpstreamVisAttrib = elNode.Attributes["isUpstreamVisible"];
string typeName = typeAttrib.Value;
//test the GUID to confirm that it is non-zero
//if it is zero, then we have to fix it
//this will break the connectors, but it won't keep
//propagating bad GUIDs
var guid = new Guid(guidAttrib.Value);
if (guid == Guid.Empty)
{
guid = Guid.NewGuid();
}
string nickname = nicknameAttrib.Value;
double x = double.Parse(xAttrib.Value, CultureInfo.InvariantCulture);
double y = double.Parse(yAttrib.Value, CultureInfo.InvariantCulture);
bool isVisible = true;
if (isVisAttrib != null)
{
isVisible = isVisAttrib.Value == "true" ? true : false;
}
bool isUpstreamVisible = true;
if (isUpstreamVisAttrib != null)
{
isUpstreamVisible = isUpstreamVisAttrib.Value == "true" ? true : false;
}
// Retrieve optional 'function' attribute (only for DSFunction).
XmlAttribute signatureAttrib = elNode.Attributes["function"];
var signature = signatureAttrib == null ? null : signatureAttrib.Value;
NodeModel el = null;
XmlElement dummyElement = null;
try
{
// The attempt to create node instance may fail due to "type" being
// something else other than "NodeModel" derived object type. This
// is possible since some legacy nodes have been made to derive from
// "MigrationNode" object type that is not derived from "NodeModel".
//
typeName = Nodes.Utilities.PreprocessTypeName(typeName);
System.Type type = Nodes.Utilities.ResolveType(this.dynamoModel, typeName);
if (type != null)
{
el = ws.NodeFactory.CreateNodeInstance(type, nickname, signature, guid);
}
if (el != null)
{
el.Load(elNode);
}
else
{
var e = elNode as XmlElement;
dummyElement = MigrationManager.CreateMissingNode(e, 1, 1);
}
}
catch (UnresolvedFunctionException)
{
// If a given function is not found during file load, then convert the
// function node into a dummy node (instead of crashing the workflow).
//
var e = elNode as XmlElement;
dummyElement = MigrationManager.CreateUnresolvedFunctionNode(e);
}
if (dummyElement != null) // If a dummy node placement is desired.
{
// The new type representing the dummy node.
typeName = dummyElement.GetAttribute("type");
System.Type type = Dynamo.Nodes.Utilities.ResolveType(this.dynamoModel, typeName);
el = ws.NodeFactory.CreateNodeInstance(type, nickname, string.Empty, guid);
el.Load(dummyElement);
}
ws.Nodes.Add(el);
el.X = x;
el.Y = y;
if (lacingAttrib != null)
{
LacingStrategy lacing = LacingStrategy.First;
Enum.TryParse(lacingAttrib.Value, out lacing);
el.ArgumentLacing = lacing;
}
el.DisableReporting();
// This is to fix MAGN-3648. Method reference in CBN that gets
// loaded before method definition causes a CBN to be left in
// a warning state. This is to clear such warnings and set the
// node to "Dead" state (correct value of which will be set
// later on with a call to "EnableReporting" below). Please
// refer to the defect for details and other possible fixes.
//
if (el.State == ElementState.Warning && (el is CodeBlockNodeModel))
{
el.State = ElementState.Dead;
}
el.IsVisible = isVisible;
el.IsUpstreamVisible = isUpstreamVisible;
}
#endregion
#region instantiate connectors
foreach (XmlNode connector in cNodesList.ChildNodes)
{
XmlAttribute guidStartAttrib = connector.Attributes[0];
XmlAttribute intStartAttrib = connector.Attributes[1];
XmlAttribute guidEndAttrib = connector.Attributes[2];
XmlAttribute intEndAttrib = connector.Attributes[3];
XmlAttribute portTypeAttrib = connector.Attributes[4];
var guidStart = new Guid(guidStartAttrib.Value);
var guidEnd = new Guid(guidEndAttrib.Value);
int startIndex = Convert.ToInt16(intStartAttrib.Value);
int endIndex = Convert.ToInt16(intEndAttrib.Value);
var portType = ((PortType)Convert.ToInt16(portTypeAttrib.Value));
//find the elements to connect
NodeModel start = null;
NodeModel end = null;
foreach (NodeModel e in ws.Nodes)
{
if (e.GUID == guidStart)
{
start = e;
}
else if (e.GUID == guidEnd)
{
end = e;
}
if (start != null && end != null)
{
break;
}
}
try
{
var newConnector = ws.AddConnection(
start, end,
startIndex, endIndex,
portType);
}
catch
{
dynamoModel.WriteToLog(string.Format("ERROR : Could not create connector between {0} and {1}.", start.NickName, end.NickName));
}
}
#endregion
#region instantiate notes
if (nNodesList != null)
{
foreach (XmlNode note in nNodesList.ChildNodes)
{
XmlAttribute textAttrib = note.Attributes[0];
XmlAttribute xAttrib = note.Attributes[1];
XmlAttribute yAttrib = note.Attributes[2];
string text = textAttrib.Value;
double x = Convert.ToDouble(xAttrib.Value, CultureInfo.InvariantCulture);
double y = Convert.ToDouble(yAttrib.Value, CultureInfo.InvariantCulture);
ws.AddNote(false, x, y, text, Guid.NewGuid());
}
}
#endregion
foreach (var e in ws.Nodes)
{
e.EnableReporting();
}
def.IsBeingLoaded = false;
def.Compile(this.dynamoModel, this.dynamoModel.EngineController);
ws.WatchChanges = true;
OnGetDefinitionFromPath(def);
}
catch (Exception ex)
{
dynamoModel.WriteToLog("There was an error opening the workbench.");
dynamoModel.WriteToLog(ex);
if (DynamoModel.IsTestMode)
{
throw ex; // Rethrow for NUnit.
}
def = null;
return(false);
}
return(true);
}
