Cross Frame Search with Ctrl+F3 (#215)

* stub in new ctrl handler

* fill in current frame portion of ctrl+f3

* combine search functions

* simplify search invocation logic

* Start simplifying ParseHTTPPayload

* Simplify ParseHTTPPayload further

* simplify further

* simplify

* Simplify

* implement cross frame seach

* remove "Number" from SessionNavigator

* simplify sessions handling

* Move import event to single entry point
Always init the session navigator

* Make SessionNavigator init on demand

* reset navigator on new sessions

* Make SessionNavigator a lightwight singleton

* simplify

* simplify

* Ensure visible on matches and set status text

* better palceholder text

* simplify

* simplify

* simplify

* simplify

* slight tweaks

Author: stephenegriffin

MAPIInspector/Source/MAPIControl.Designer.cs

@@ -1,3 +1,5 @@
+using Fiddler;
+using MAPIInspector.Parsers;
 using System;
 using System.Text;
 using System.Windows.Forms;
@@ -6,6 +8,10 @@ namespace MapiInspector
 {
     public partial class MAPIControl
     {
+        public static readonly string SearchDefaultText = "Search (Ctrl+F) F3 to search. Hold SHIFT to search backwards. Hold CTRL to search across frames.";
+        private readonly System.Drawing.Color SearchDefaultColor = System.Drawing.Color.Gray;
+        private readonly System.Drawing.Color SearchNormalColor = System.Drawing.Color.Black;
+
         private void InitializeContextMenus()
         {
             // TreeView context menu
@@ -69,6 +75,7 @@ private string GetNodeText(TreeNode node)
             {
                 return CleanString(position.SourceBlock.Text);
             }
+
             return CleanString(node.Text);
         }
 
@@ -207,43 +214,47 @@ private void CropsHexBox_CopyHex_Click(object sender, EventArgs e)
 
         private void SearchButton_Click(object sender, EventArgs e)
         {
-            bool bIsShift = (ModifierKeys & Keys.Shift) == Keys.Shift;
-            PerformSearch(bIsShift);
+            var isCtrl = (ModifierKeys & Keys.Control) == Keys.Control;
+            var isShift = (ModifierKeys & Keys.Shift) == Keys.Shift;
+            PerformSearch(isShift, isCtrl);
+
         }
 
         private void SearchTextBox_KeyDown(object sender, KeyEventArgs e)
         {
             bool bEnter = e.KeyCode == Keys.Enter;
-            bool bShiftEnter = (e.KeyCode == Keys.Enter) && (e.Modifiers == Keys.Shift);
+            bool isCtrl = (ModifierKeys & Keys.Control) == Keys.Control;
+            bool isShift = (ModifierKeys & Keys.Shift) == Keys.Shift;
 
-            if (bEnter || bShiftEnter)
+            if (bEnter)
             {
-                PerformSearch(e.Modifiers == Keys.Shift);
+                PerformSearch(isShift, isCtrl);
                 e.Handled = true;
                 e.SuppressKeyPress = true;
             }
         }
 
         private void SearchTextBox_GotFocus(object sender, EventArgs e)
         {
-            if (searchTextBox.Text == "Search (Ctrl+F)")
+            if (searchTextBox.Text == SearchDefaultText)
             {
                 searchTextBox.Text = "";
+                searchTextBox.ForeColor = SearchNormalColor;
             }
         }
 
         private void SearchTextBox_LostFocus(object sender, EventArgs e)
         {
             if (string.IsNullOrWhiteSpace(searchTextBox.Text))
             {
-                searchTextBox.Text = "Search (Ctrl+F)";
+                searchTextBox.Text = SearchDefaultText;
+                searchTextBox.ForeColor = SearchDefaultColor;
             }
         }
 
-        protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
+        protected override bool ProcessCmdKey(ref System.Windows.Forms.Message msg, Keys keyData)
         {
-            bool isF3 = keyData == Keys.F3;
-            bool isShiftF3 = keyData == (Keys.Shift | Keys.F3);
+            bool isF3 = keyData.HasFlag(Keys.F3);
             bool isCtrlF = keyData == (Keys.Control | Keys.F);
             bool isCtrlRight = keyData == (Keys.Control | Keys.Right);
 
@@ -287,43 +298,74 @@ protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
                 return true;
             }
 
-            if (isF3 || isShiftF3)
+            if (isF3)
             {
-                PerformSearch(keyData.HasFlag(Keys.Shift));
+                PerformSearch(keyData.HasFlag(Keys.Shift), keyData.HasFlag(Keys.Control));
                 return true;
             }
 
             return base.ProcessCmdKey(ref msg, keyData);
         }
 
-        private void PerformSearch(bool searchUp)
+        // Combined search logic for single and multi-frame search
+        private void PerformSearch(bool searchUp, bool searchFrames)
         {
-            string searchText = searchTextBox.Text.Trim();
-            if (mapiTreeView.Nodes.Count == 0 ||
-                string.IsNullOrEmpty(searchText) ||
-                searchText == "Search (Ctrl+F)")
+            var searchText = searchTextBox.Text.Trim();
+            if (string.IsNullOrEmpty(searchText) || searchText == SearchDefaultText) return;
+
+            FiddlerApplication.UI.SetStatusText($"Searching for {searchText}");
+            var startNode = mapiTreeView?.SelectedNode;
+            if (startNode == null && mapiTreeView?.Nodes.Count > 0)
             {
-                return;
+                startNode = mapiTreeView.Nodes[0];
             }
 
-            var startNode = mapiTreeView.SelectedNode ?? mapiTreeView.Nodes[0];
-            if (startNode == null)
-                return;
+            if (startNode != null)
+            {
+                var nodes = mapiTreeView.Nodes;
+                TreeNode foundNode = searchUp
+                    ? FindPrevNode(nodes, startNode, searchText, !searchFrames)
+                    : FindNextNode(nodes, startNode, searchText, !searchFrames);
 
-            var foundNode = searchUp
-                ? FindPrevNode(mapiTreeView.Nodes, startNode, searchText)
-                : FindNextNode(mapiTreeView.Nodes, startNode, searchText);
+                if (foundNode != null)
+                {
+                    mapiTreeView.SelectedNode = foundNode;
+                    mapiTreeView.Focus();
+                    foundNode.EnsureVisible();
+                    return;
+                }
+            }
 
-            if (foundNode != null)
+            if (searchFrames)
             {
-                mapiTreeView.SelectedNode = foundNode;
-                mapiTreeView.Focus();
-                foundNode.EnsureVisible();
+                var currentSession = Inspector.session;
+                while (currentSession != null)
+                {
+                    var nextSession = searchUp ? currentSession?.Previous() : currentSession?.Next();
+                    if (nextSession == null) break;
+                    var parseResult = MAPIParser.ParseHTTPPayload(nextSession, Inspector.Direction, out var bytes);
+                    var rootNode = new TreeNode();
+                    var node = BaseStructure.AddBlock(parseResult, false);
+                    rootNode.Nodes.Add(node);
+                    var foundMatch = searchUp
+                        ? FindPrevNode(rootNode.Nodes, node, searchText, true)
+                        : FindNextNode(rootNode.Nodes, node, searchText, true);
+                    if (foundMatch != null)
+                    {
+                        FiddlerApplication.UI.SelectSessionsMatchingCriteria(s => s.id == nextSession.id);
+                        nextSession.ViewItem.EnsureVisible();
+                        return;
+                    }
+
+                    currentSession = nextSession;
+                }
             }
+
+            FiddlerApplication.UI.SetStatusText("No match found");
         }
 
         // Find next node (downwards, wraps around)
-        private TreeNode FindNextNode(TreeNodeCollection nodes, TreeNode startNode, string searchText)
+        private TreeNode FindNextNode(TreeNodeCollection nodes, TreeNode startNode, string searchText, bool wrap)
         {
             bool foundStart = false;
             TreeNode firstMatch = null;
@@ -335,18 +377,20 @@ private TreeNode FindNextNode(TreeNodeCollection nodes, TreeNode startNode, stri
                     continue;
                 }
 
-                if (foundStart && GetNodeText(node).IndexOf(searchText, StringComparison.OrdinalIgnoreCase) >= 0)
-                    return node;
-                if (firstMatch == null && GetNodeText(node).IndexOf(searchText, StringComparison.OrdinalIgnoreCase) >= 0)
-                    firstMatch = node;
+                if (GetNodeText(node).IndexOf(searchText, StringComparison.OrdinalIgnoreCase) >= 0)
+                {
+                    if (foundStart)
+                        return node;
+                    if (firstMatch == null)
+                        firstMatch = node;
+                }
             }
 
-            // Wrap around
-            return firstMatch;
+            return wrap ? firstMatch : null;
         }
 
         // Find previous node (upwards, wraps around)
-        private TreeNode FindPrevNode(TreeNodeCollection nodes, TreeNode startNode, string searchText)
+        private TreeNode FindPrevNode(TreeNodeCollection nodes, TreeNode startNode, string searchText, bool wrap)
         {
             TreeNode lastMatch = null;
             foreach (var node in FlattenNodes(nodes))
@@ -357,8 +401,7 @@ private TreeNode FindPrevNode(TreeNodeCollection nodes, TreeNode startNode, stri
                     lastMatch = node;
             }
 
-            // Wrap around: if nothing before, search from end
-            if (lastMatch == null)
+            if (lastMatch == null && wrap)
             {
                 foreach (var node in FlattenNodes(nodes))
                 {

MAPIInspector/Source/MAPIControl.Events.cs

@@ -6,7 +6,7 @@
 using Be.Windows.Forms;
 using BlockParser;
 using Fiddler;
-using global::MAPIInspector.Parsers;
+using MAPIInspector.Parsers;
 using static MapiInspector.MAPIParser;
 
 namespace MapiInspector
@@ -54,7 +54,7 @@ public abstract class MAPIInspector : Inspector2
         /// <summary>
         /// Gets the direction of the traffic
         /// </summary>
-        public MAPIParser.TrafficDirection Direction
+        public TrafficDirection Direction
         {
             get
             {
@@ -142,6 +142,8 @@ public override void AddToTab(TabPage o)
             MAPIViewControl.AfterSelect -= TreeView_AfterSelect;
             MAPIViewControl.AfterSelect += TreeView_AfterSelect;
             DecodingContext dc = new DecodingContext();
+            FiddlerApplication.OnLoadSAZ += AfterCallDoImport;
+            FiddlerApplication.AfterSessionComplete += (Session oSession) => SessionExtensions.AllSessionsNavigator.Init();
         }
 
         /// <summary>
@@ -353,6 +355,7 @@ public void ToggleDebug()
         private void UpdateView()
         {
             Clear();
+            SessionExtensions.AllSessionsNavigator.Init();
             byte[] bytesForHexView;
             Block parserResult;
             IsLooperCall = false;
@@ -362,23 +365,11 @@ private void UpdateView()
 
             if (IsMapihttp)
             {
-                List<Session> allSessionsList = new List<Session>();
-                Session session0 = new Session(new byte[0], new byte[0]);
-                Session[] sessionsInFiddler = FiddlerApplication.UI.GetAllSessions();
-                allSessionsList.AddRange(sessionsInFiddler);
-                FiddlerApplication.OnLoadSAZ += AfterCallDoImport;
-                allSessionsList.Sort(delegate (Session p1, Session p2)
-                {
-                    return p1.id.CompareTo(p2.id);
-                });
-                allSessionsList.Insert(0, session0);
-                SessionExtensions.AllSessionsNavigator = new SessionNavigator(allSessionsList.ToArray());
-
                 try
                 {
                     if (Direction == TrafficDirection.In)
                     {
-                        parserResult = ParseHTTPPayload(BaseHeaders, session, session.requestBodyBytes, TrafficDirection.In, out bytesForHexView);
+                        parserResult = ParseHTTPPayload(session, TrafficDirection.In, out bytesForHexView);
                     }
                     else
                     {
@@ -388,7 +379,7 @@ private void UpdateView()
                             return;
                         }
 
-                        parserResult = ParseHTTPPayload(BaseHeaders, session, session.responseBodyBytes, TrafficDirection.Out, out bytesForHexView);
+                        parserResult = ParseHTTPPayload(session, TrafficDirection.Out, out bytesForHexView);
                     }
 
                     DisplayObject(parserResult, bytesForHexView);
@@ -422,11 +413,11 @@ private void UpdateView()
         /// <param name="autoCaseName">The test case name to parse</param>
         /// <param name="allRops">All ROPs contained in list</param>
         /// <returns>Parse result, true means success</returns>
-        public bool ParseCaptureFile(Fiddler.Session[] sessionsFromCore, string pathName, string autoCaseName, out List<string> allRops)
+        public bool ParseCaptureFile(Session[] sessionsFromCore, string pathName, string autoCaseName, out List<string> allRops)
         {
             var errorStringList = new List<string>();
             StringBuilder stringBuilder = new StringBuilder();
-            SessionExtensions.AllSessionsNavigator = new SessionNavigator(sessionsFromCore);
+            SessionExtensions.AllSessionsNavigator.Init(sessionsFromCore);
 
             DecodingContext decodingContext = new DecodingContext();
             Partial.ResetPartialParameters();
@@ -446,12 +437,11 @@ public bool ParseCaptureFile(Fiddler.Session[] sessionsFromCore, string pathName
                         IsLooperCall = false;
                         Partial.ResetPartialParameters();
                         BaseHeaders = session.RequestHeaders;
-                        byte[] bytes;
-                        object obj = ParseHTTPPayload(BaseHeaders, session, session.requestBodyBytes, TrafficDirection.In, out bytes);
+                        object obj = ParseHTTPPayload(session, TrafficDirection.In, out byte[] bytes);
                         JsonResult += Utilities.ConvertCSharpToJson(i, isRequest: true, obj);
                         if (session["X-ResponseCode"] == "0")
                         {
-                            object obj2 = ParseHTTPPayload(BaseHeaders, session, session.responseBodyBytes, TrafficDirection.Out, out bytes);
+                            object obj2 = ParseHTTPPayload(session, TrafficDirection.Out, out byte[] bytes2);
                             JsonResult += Utilities.ConvertCSharpToJson(i, isRequest: false, obj2);
                         }
                     }

MAPIInspector/Source/MAPIInspector.cs

@@ -754,6 +754,7 @@
       <DesignTime>True</DesignTime>
       <DependentUpon>Resources.resx</DependentUpon>
     </Compile>
+    <Compile Include="SessionDebugView.cs" />
     <Compile Include="SessionExtensions.cs" />
     <Compile Include="SessionNavigator.cs" />
     <Compile Include="Utilities.cs" />