Better parsing of RopFastTransferSourceGetBufferResponse errors (#213)

unified interesting block concept for junk/exceptions
Mad aux error trace interesting

Author: stephenegriffin

MAPIInspector/Source/BlockParser/BlockException.cs

@@ -2,9 +2,10 @@
 
 namespace BlockParser
 {
-    public class BlockException : Block
+    public class BlockException : BlockInteresting
     {
-        public static readonly Color BackColor = Color.LightPink;
+        public override Color BackColor => Color.LightPink;
+        public override string InterestingLabel => "Exceptions found in this block";
 
         public static BlockException Create(string message, System.Exception ex, long offset)
         {

MAPIInspector/Source/BlockParser/BlockInteresting.cs

@@ -0,0 +1,13 @@
+using System.Drawing;
+
+namespace BlockParser
+{
+    /// <summary>
+    /// Represents an interesting block of data.
+    /// </summary>
+    public abstract class BlockInteresting : Block
+    {
+        public virtual Color BackColor => Color.PaleVioletRed;
+        public virtual string InterestingLabel => "Interesting block";
+    }
+}

MAPIInspector/Source/BlockParser/BlockJunk.cs

@@ -2,9 +2,10 @@
 
 namespace BlockParser
 {
-    public class BlockJunk : Block
+    public class BlockJunk : BlockInteresting
     {
-        public static readonly Color BackColor = Color.Coral;
+        public override Color BackColor => Color.Coral;
+        public override string InterestingLabel => "Exceptions found in this block";
 
         string Label;
         BlockBytes junkData;

MAPIInspector/Source/MAPIInspector.csproj

@@ -101,6 +101,7 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="BlockParser\BlockInteresting.cs" />
     <Compile Include="ByteArrayConverter.cs" />
     <Compile Include="MAPIControl.Events.cs">
       <SubType>UserControl</SubType>

MAPIInspector/Source/Parsers/BaseStructure.cs

@@ -27,22 +27,12 @@ public partial class BaseStructure
         public static TreeNode AddBlock(Block block, bool debug)
         {
             var node = AddBlock(block, 0, debug);
-            if (HasBlock<BlockException>(node))
+            var interestingBlock = FindInterestingBlock(node);
+            if (interestingBlock != null)
             {
-                var exNode = new TreeNode("Exceptions found in this block")
+                var exNode = new TreeNode(interestingBlock.InterestingLabel)
                 {
-                    BackColor = BlockException.BackColor,
-                    Tag = "ignore"
-                };
-                exNode.Nodes.Add(node);
-                return exNode;
-            }
-
-            if (HasBlock<BlockJunk>(node))
-            {
-                var exNode = new TreeNode("Unparsed data found in this block")
-                {
-                    BackColor = BlockJunk.BackColor,
+                    BackColor = interestingBlock.BackColor,
                     Tag = "ignore"
                 };
                 exNode.Nodes.Add(node);
@@ -156,8 +146,7 @@ private static TreeNode AddBlock(Block block, int blockRootOffset, bool debug)
                 }
             }
 
-            if (block is BlockException) ColorNodes(node, BlockException.BackColor);
-            if (block is BlockJunk) ColorNodes(node, BlockJunk.BackColor);
+            if (block is BlockInteresting interestingBlock) ColorNodes(node, interestingBlock.BackColor);
 
             return node;
         }
@@ -210,23 +199,24 @@ private static TreeNode TreeNodeForCompressed(TreeNode node, int current, int co
             return node;
         }
 
-        private static bool HasBlock<T>(TreeNode node) where T : Block
+        private static BlockInteresting FindInterestingBlock(TreeNode node)
         {
             var pos = node.Tag as Position;
-            if (pos?.SourceBlock is T)
+            if (pos?.SourceBlock is BlockInteresting interestingBlock)
             {
-                return true;
+                return interestingBlock;
             }
 
             foreach (TreeNode child in node.Nodes)
             {
-                if (HasBlock<T>(child))
+                var foundBlock = FindInterestingBlock(child);
+                if (foundBlock != null)
                 {
-                    return true;
+                    return foundBlock;
                 }
             }
 
-            return false;
+            return null;
         }
     }
 }

MAPIInspector/Source/Parsers/MSOXCFXICS/rops/RopFastTransferSourceGetBufferResponse.cs

@@ -67,15 +67,14 @@ protected override void Parse()
             RopId = ParseT<RopIdType>();
             InputHandleIndex = ParseT<byte>();
             ReturnValue = ParseT<ErrorCodes>();
+            TransferStatus = ParseT<TransferStatus>();
+            InProgressCount = ParseT<ushort>();
+            TotalStepCount = ParseT<ushort>();
+            Reserved = ParseT<byte>();
+            TransferBufferSize = ParseT<ushort>();
 
             if (ReturnValue == ErrorCodes.Success)
             {
-                TransferStatus = ParseT<TransferStatus>();
-                InProgressCount = ParseT<ushort>();
-                TotalStepCount = ParseT<ushort>();
-                Reserved = ParseT<byte>();
-                TransferBufferSize = ParseT<ushort>();
-
                 parser.PushCap(TransferBufferSize);
 
                 var transferBufferList = new List<Block>();

MAPIInspector/Source/Parsers/MSOXCMAPIHTTP/auxiliary/AUX_EXCEPTION_TRACE.cs

@@ -1,13 +1,17 @@
 using BlockParser;
 using System.Collections.Generic;
+using System.Drawing;
 
 namespace MAPIInspector.Parsers
 {
     /// <summary>
     /// A class indicates the AUX_TYPE_EXCEPTION_TRACE Auxiliary Block Structure
     /// </summary>
-    public class AUX_EXCEPTION_TRACE : Block
+    public class AUX_EXCEPTION_TRACE : BlockInteresting
     {
+        public override Color BackColor => Color.Salmon;
+        public override string InterestingLabel => "Aux Exception Trace found in this block";
+
         /// <summary>
         /// A flag that indicates that the server combines capabilities on a single endpoint.
         /// </summary>