Add a *search as you type* option to filter found entries in Auto-Type Entry Selection form

Author: Rookiestyle

README.md

@@ -18,14 +18,24 @@ This KeePass plugin enhances KeePass' Auto-Type feature.
 
 # Configuration
 Alternate Auto-Type integrates into KeePass' options form.\
-<img src="images/AlternateAutoType%20-%20Options.png" alt="Options" />
+<img src="images/AlternateAutoType%20-%20Options.png" alt="Options 1" />  
+<img src="images/AlternateAutoType%20-%20Options%202.png" alt="Options 2" />
 
-In the upper area you can configure the hotkeys Alternate Auto-Type will react on.  
-In the lower area you can (de)activate the enhancements to the Auto-Type entry selection.
+In the first tab  you can configure the hotkeys Alternate Auto-Type will react on.  
+In the second tab you can (de)activate the enhancements to the Auto-Type entry selection.
 # Usage
+## Auto-Type hotkey configuration  
+This tab basically mimics KeePass' integration tab with regards to hotkeys.  
+You can define hotkeys for *Global Auto-Type* and *Global Auto-Type password only* in both tabs.
+
+In addition, you can define whether *Global Auto-Type password only* will send an [Enter] key after the password was auto-typed.  
+You can also define the hotkey for the Alternate Auto-Type specific sequence.
+
+This is only possible on Windows.
 ## Auto-Type entry selection enhancements
 While the Auto-Type entry selection is a great way to pick one of the matching candidates, it still lacks some features that this plugin adds.
 
+- Search as you type allows filtering entries in the result list - can be helpful in case many entries are found
 - Sortable columns
 - Show database name if entries from more than one database are shown
 - Exclude entries in expired groups

Translations/AlternateAutoType.de.language.xml

@@ -1,6 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Translation>
-  <TranslationVersion>5</TranslationVersion>
+  <!-- 
+    Increment the TranslationVersion every time the translation file is updated
+	Also update the version.info file
+  -->
+  <TranslationVersion>6</TranslationVersion>
   <item>
     <key>ErrorHotKeyAAT</key>
     <value>{0} konnte nicht als Hotkey für Alternate Auto-Type registriert werden</value>
@@ -75,4 +79,8 @@
 Klicke '{1}', um einen weiteren Eintrag hinzuzufügen.
 Klicke '{2}', um nichts zu tun.</value>
   </item>
+  <item>
+    <key>SearchAsYouType</key>
+    <value>Filtermöglichkeit für gefundene Einträge</value>
+  </item>
 </Translation>

Translations/AlternateAutoType.template.language.xml

@@ -1,5 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Translation>
+  <!-- 
+    Increment the TranslationVersion every time the translation file is updated
+	Also update the version.info file
+  -->
   <TranslationVersion>0</TranslationVersion>
   <item>
     <key>ErrorHotKeyAAT</key>
@@ -75,4 +79,8 @@
 If you want to add another Auto-Type sequence, click '{1}'.
 If you want to skip these entries, please click '{2}'.</value>
   </item>
+  <item>
+    <key>SearchAsYouType</key>
+    <value>Allow filtering of entries</value>
+  </item>
 </Translation>

images/AlternateAutoType - Options 2.png

@@ -186,11 +186,14 @@ private void HotkeysDeactivate()
 		private void OnWindowAdded(object sender, GwmWindowEventArgs e)
 		{
 			if (!(e.Form is AutoTypeCtxForm)) return;
-			if (m_host.MainWindow.DocumentManager.GetOpenDatabases().Count < 1) return;
+			int iOpenedDatabases = m_host.MainWindow.DocumentManager.GetOpenDatabases().Count;
+			if (!Config.SearchAsYouType && iOpenedDatabases < 1) return;
 			e.Form.Shown += OnAutoTypeFormShown;
 
+			if (iOpenedDatabases < 1) return;
 			PluginDebug.AddInfo("Auto-Type entry selection window added", 0);
 
+
 			List<AutoTypeCtx> lCtx = (List<AutoTypeCtx>)Tools.GetField("m_lCtxs", e.Form);
 			if (lCtx == null) return;
 			// Adjust content
@@ -253,8 +256,17 @@ private void OnWindowRemoved(object sender, GwmWindowEventArgs e)
 
 		private void OnAutoTypeFormShown(object sender, EventArgs e)
 		{
-			Form f = sender as AutoTypeCtxForm;
+			if (m_host.MainWindow.DocumentManager.GetOpenDatabases().Count >= 1) InitializeAutoTypeListView(sender, e);
+
+			if (Config.SearchAsYouType) AddSearchfield(sender as AutoTypeCtxForm);
+		}
+
+		private void InitializeAutoTypeListView(object sender, EventArgs e)
+		{
+			AutoTypeCtxForm f = sender as AutoTypeCtxForm;
 			if (f == null) return;
+			//AddSearchfield(f);
+			if (m_host.MainWindow.DocumentManager.GetOpenDatabases().Count < 1) return;
 			ListView lv = Tools.GetControl("m_lvItems", f) as ListView;
 			PluginDebug.AddInfo("Auto-Type entry selection window shown", 0);
 			if ((lv != null) && (lv.Items.Count == 0) && !KeePass.Program.Config.Integration.AutoTypeAlwaysShowSelDialog)
@@ -343,7 +355,62 @@ private void OnAutoTypeFormShown(object sender, EventArgs e)
 			catch (Exception) { }
 		}
 
-		private void AutoTypeForm_ShowGroups_CheckedChanged(object sender, EventArgs e)
+		private class _SearchAsYouTypeData
+        {
+			internal ListView ShownEntries;
+			internal List<ListViewItem> AllEntries;
+        }
+        private void AddSearchfield(AutoTypeCtxForm f)
+        {
+			var lvShownEntries = Tools.GetControl("m_lvItems", f) as ListView;
+			if (lvShownEntries == null)
+			{
+				PluginDebug.AddError("Could not locate m_lvItems, search-as-you-type field not added");
+				return;
+			}
+			var c = lvShownEntries.Parent;
+			Label lSearch = new Label();
+			TextBox tbSearch = new TextBox();
+			c.Controls.Add(lSearch);
+			c.Controls.Add(tbSearch);
+			lSearch.Text = KeePass.Resources.KPRes.FindEntries;
+			lSearch.AutoSize = true;
+			tbSearch.Left = lvShownEntries.Left + lSearch.Width + DpiUtil.ScaleIntX(10);
+			lSearch.Left = lvShownEntries.Left;
+			tbSearch.Top = lvShownEntries.Top;
+			lSearch.Top = lvShownEntries.Top + tbSearch.Height / 2 - lSearch.Height / 2;
+			tbSearch.Width = lvShownEntries.Width / 2;
+			List<ListViewItem> lvAllEntries = new List<ListViewItem>(lvShownEntries.Items.Cast< ListViewItem>());
+			tbSearch.Tag = new _SearchAsYouTypeData() { AllEntries = lvAllEntries, ShownEntries = lvShownEntries };
+			tbSearch.TextChanged += OnFilterSearchResults;
+			int iGap = DpiUtil.ScaleIntY(10);
+			int iHeight = lvShownEntries.Height;
+			tbSearch.Dock = lvShownEntries.Dock = DockStyle.None;
+			lvShownEntries.Top += tbSearch.Height + iGap -1;
+			lvShownEntries.Height = iHeight - tbSearch.Height - iGap;
+        }
+
+        private void OnFilterSearchResults(object sender, EventArgs e)
+        {
+			TextBox tbSearch = sender as TextBox;
+			if (tbSearch == null) return;
+			_SearchAsYouTypeData st = tbSearch.Tag as _SearchAsYouTypeData;
+			if (st == null) return;
+			string s = tbSearch.Text.ToLowerInvariant();
+			st.ShownEntries.BeginUpdate();
+			st.ShownEntries.Items.Clear();
+			st.ShownEntries.Items.AddRange(st.AllEntries.Where(x => 
+				x.Text.ToLowerInvariant().Contains(s) // Entry title
+				||
+				x.SubItems[1].Text.ToLowerInvariant().Contains(s) // User name
+				).ToArray());
+			st.ShownEntries.EndUpdate();
+			if (!st.ShownEntries.ShowGroups) return;
+			int column = st.ShownEntries.Columns.IndexOf(m_SortColumn);
+			AdjustGroups(st.ShownEntries, column);
+        }
+
+        private void AutoTypeForm_ShowGroups_CheckedChanged(object sender, EventArgs e)
 		{
 			Form f = (sender as Control).FindForm();
 			ListView lv = Tools.GetControl("m_lvItems", f) as ListView;
@@ -597,6 +664,7 @@ private void OptionsFormShown(object sender, Tools.OptionsFormsEventArgs e)
 			options.cbSpecialColumnsRespectPWEnter.Checked = Config.SpecialColumnsRespectPWEnter;
 			options.cbKeepATOpen.Checked = Config.KeepATOpen;
 			options.cbExcludeExpiredGroups.Checked = Config.ExcludeExpiredGroups;
+			options.cbSearchAsYouType.Checked = Config.SearchAsYouType;
 			e.form.Shown += options.OptionsForm_Shown;
 			Tools.AddPluginToOptionsForm(this, options);
 		}
@@ -623,6 +691,7 @@ private void OptionsForm_Closed(object sender, Tools.OptionsFormsEventArgs e)
 			Config.SpecialColumnsRespectPWEnter = options.cbSpecialColumnsRespectPWEnter.Checked;
 			Config.KeepATOpen = options.cbKeepATOpen.Checked;
 			Config.ExcludeExpiredGroups = options.cbExcludeExpiredGroups.Checked;
+			Config.SearchAsYouType = options.cbSearchAsYouType.Checked;
 
 			if ((Config.AATHotkey != Keys.None) || (Config.PWOnlyHotkey != Keys.None))
 				HotkeysActivate();

images/AlternateAutoType - Options.png

@@ -42,6 +42,11 @@ static Config()
 			}
 		}
 
+		public static bool SearchAsYouType
+		{
+			get { return Program.Config.CustomConfig.GetBool(m_SearchAsYouType, true); }
+			set { Program.Config.CustomConfig.SetBool(m_SearchAsYouType, value); }
+		}
 		public static bool AddDBColumn
 		{
 			get { return Program.Config.CustomConfig.GetBool(m_AddDBColumnConfig, false); }
@@ -134,6 +139,7 @@ public static bool ExcludeExpiredGroups
 		private static string m_AATHotkeyConfig = "AlternateAutoType.AATHotkey";
 		private static string m_PWOnlyHotkeyConfig = "AlternateAutoType.PWOnlyHotkey";
 		private static string m_PWEnterConfig = "AlternateAutoType.PWEnter";
+		private static string m_SearchAsYouType = "AlternateAutoType.SearchAsYouType";
 		private static string m_AddDBColumnConfig = "AlternateAutoType.AddDBColumn";
 		private static string m_ColumnsSortableConfig = "AlternateAutoType.ColumnsSortable";
 		private static string m_ColumnsRememberSorting = "AlternateAutoType.ColumnsRememberSorting";