Feature: Added experimental terminal integration

src/Files.App.CsWin32/NativeMethods.txt

@@ -5,6 +5,7 @@ WNDPROC
 WNDCLASSEXW
 RegisterClassEx
 CreateWindowEx
+ShowWindow
 DestroyWindow
 GetModuleHandle
 RECT
@@ -31,7 +32,6 @@ LPARAM
 WM_LBUTTONUP
 WM_RBUTTONUP
 WM_DESTROY
-SetForegroundWindow
 GetForegroundWindow
 GetCurrentThreadId
 GetWindowThreadProcessId
@@ -99,7 +99,6 @@ SendMessage
 IsWindowVisible
 COPYDATASTRUCT
 SetWindowLongPtr
-GetDpiForWindow
 CallWindowProc
 MINMAXINFO
 SUBCLASSPROC
@@ -120,7 +119,6 @@ WindowsCreateString
 WindowsDeleteString
 IPreviewHandler
 AssocQueryString
-GetModuleHandle
 SHEmptyRecycleBin
 SHFileOperation
 SHGetFolderPath
@@ -143,15 +141,12 @@ COMPRESSION_FORMAT
 FILE_ACCESS_RIGHTS
 FindFirstFileEx
 FindNextFile
-CreateFile
 GetFileSizeEx
 WIN32_FIND_DATAW
-FILE_ACCESS_RIGHTS
 SHAddToRecentDocs
 SHARD
 BHID_EnumItems
 FOLDERID_RecycleBinFolder
-CoTaskMemFree
 SHGetIDListFromObject
 SHCreateItemFromIDList
 BHID_SFUIObject
@@ -166,10 +161,31 @@ IApplicationDocumentLists
 ApplicationDocumentLists
 IApplicationActivationManager
 MENU_ITEM_TYPE
-COMPRESSION_FORMAT
 FSCTL_SET_COMPRESSION
 FSCTL_DISMOUNT_VOLUME
 FSCTL_LOCK_VOLUME
 FILE_FILE_COMPRESSION
 WM_WINDOWPOSCHANGING
 WINDOWPOS
+// Console api
+AllocConsole
+GetConsoleWindow
+GetStdHandle
+SetConsoleMode
+GetConsoleMode
+COORD
+CreatePseudoConsole
+ResizePseudoConsole
+ClosePseudoConsole
+CreatePipe
+PROC_THREAD_ATTRIBUTE_PSEUDOCONSOLE
+STARTUPINFOEXW
+STARTUPINFOW
+PROCESS_CREATION_FLAGS
+PROCESS_INFORMATION
+SECURITY_ATTRIBUTES
+CloseHandle
+DeleteProcThreadAttributeList
+UpdateProcThreadAttribute
+InitializeProcThreadAttributeList
+CreateProcess

src/Files.App/Data/Contracts/IGeneralSettingsService.cs

@@ -255,6 +255,11 @@ public interface IGeneralSettingsService : IBaseSettingsService, INotifyProperty
 		/// </summary>
 		bool ShowSystemTrayIcon { get; set; }
 
+		/// <summary>
+		/// Gets or sets a value indicating whether to enable terminal integration.
+		/// </summary>
+		bool IsTerminalIntegrationEnabled { get; set; }
+
 		/// <summary>
 		/// Gets or sets a value indicating the default option to resolve conflicts.
 		/// </summary>

src/Files.App/Data/Models/TerminalModel.cs

@@ -0,0 +1,21 @@
+using Microsoft.UI.Xaml.Controls;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Files.App.Data.Models
+{
+	public class TerminalModel : IDisposable
+	{
+		public string Id { get; init; }
+		public string Name { get; init; }
+		public Control Control { get; init; }
+
+		public void Dispose()
+		{
+			(Control as IDisposable)?.Dispose();
+		}
+	}
+}

src/Files.App/Extensions/StringExtensions.cs

@@ -54,6 +54,14 @@ public static string WithEnding(this string str, string ending)
 			return result;
 		}
 
+		/// <summary>
+		/// Compares two strings for equality, but assumes that null string is equal to an empty string.
+		/// </summary>
+		public static bool NullableEqualTo(this string original, string other,
+			StringComparison stringComparison = StringComparison.Ordinal) => string.IsNullOrEmpty(original)
+			? string.IsNullOrEmpty(other)
+			: original.Equals(other, stringComparison);
+
 		private static readonly ResourceMap resourcesTree = new ResourceManager().MainResourceMap.TryGetSubtree("Resources");
 
 		private static readonly ConcurrentDictionary<string, string> cachedResources = new();

src/Files.App/Extensions/WebView2Extensions.cs

@@ -0,0 +1,222 @@
+// Copyright (c) Mahmoud Al-Qudsi, NeoSmart Technoogies. All rights reserved.  
+// Licensed under the MIT License.
+
+using CommunityToolkit.WinUI;
+using Microsoft.UI.Xaml.Controls;
+using Microsoft.Web.WebView2.Core;
+using System.Reflection;
+using System.Text;
+using System.Text.Encodings.Web;
+using Windows.Foundation;
+
+namespace Files.App.Extensions
+{
+	using WebViewMessageReceivedHandler = TypedEventHandler<WebView2, CoreWebView2WebMessageReceivedEventArgs>;
+
+	/// <summary>
+	/// Code modified from https://gist.github.com/mqudsi/ceb4ecee76eb4c32238a438664783480
+	/// </summary>
+	public static class WebView2Extensions
+	{
+		public static void Navigate(this WebView2 webview, Uri url)
+		{
+			webview.Source = url;
+		}
+
+		private enum PropertyAction
+		{
+			Read = 0,
+			Write = 1,
+		}
+
+		private struct WebMessage
+		{
+			public Guid Guid { get; set; }
+		}
+
+		private struct MethodWebMessage
+		{
+			public long Id { get; set; }
+			public string Method { get; set; }
+			public string Args { get; set; }
+		}
+
+		private struct PropertyWebMessage
+		{
+			public long Id { get; set; }
+			public string Property { get; set; }
+			public PropertyAction Action { get; set; }
+			public string Value { get; set; }
+		}
+
+		public static List<WebViewMessageReceivedHandler> _handlers = new();
+		public static async Task AddWebAllowedObject<T>(this WebView2 webview, string name, T @object)
+		{
+			var sb = new StringBuilder();
+			sb.AppendLine($"window.{name} = {{ ");
+
+			var methodsGuid = Guid.NewGuid();
+			var methodInfo = typeof(T).GetMethods(BindingFlags.Public | BindingFlags.Instance);
+			var methods = new Dictionary<string, MethodInfo>(methodInfo.Length);
+			foreach (var method in methodInfo)
+			{
+				var functionName = $"{char.ToLower(method.Name[0])}{method.Name.Substring(1)}";
+				sb.AppendLine($@"{functionName}: function() {{ window.chrome.webview.postMessage(JSON.stringify({{ guid: ""{methodsGuid}"", id: this._callbackIndex++, method: ""{functionName}"", args: JSON.stringify([...arguments]) }})); const promise = new Promise((accept, reject) => this._callbacks.set(this._callbackIndex, {{ accept: accept, reject: reject }})); return promise; }},");
+				methods.Add(functionName, method);
+			}
+
+			var propertiesGuid = Guid.NewGuid();
+			var propertyInfo = typeof(T).GetProperties(BindingFlags.Public | BindingFlags.Instance);
+			var properties = new Dictionary<string, PropertyInfo>(propertyInfo.Length);
+			//foreach (var property in propertyInfo)
+			//{
+			//    var propertyName = $"{char.ToLower(property.Name[0])}{property.Name.Substring(1)}";
+			//    if (property.CanRead)
+			//    {
+			//        sb.AppendLine($@"get {propertyName}() {{ window.chrome.webview.postMessage(JSON.stringify({{ guid: ""{propertiesGuid}"", id: this._callbackIndex++, property: ""{propertyName}"", action: ""{(int) PropertyAction.Read}"" }})); const promise = new Promise((accept, reject) => this._callbacks.set(this._callbackIndex, {{ accept: accept, reject: reject }})); return promise; }},");
+			//    }
+			//    if (property.CanWrite)
+			//    {
+			//        sb.AppendLine($@"set {propertyName}(value) {{ window.chrome.webview.postMessage(JSON.stringify({{ guid: ""{propertiesGuid}"", id: this._callbackIndex++, property: ""{propertyName}"", action: ""{(int)PropertyAction.Write}"", value: JSON.stringify(value) }}));  const promise = new Promise((accept, reject) => this._callbacks.set(this._callbackIndex, {{ accept: accept, reject: reject }})); return promise; }},");
+			//    }
+			//    properties[propertyName] = property;
+			//}
+
+			// Add a map<int, (promiseAccept, promiseReject)> to the object used to resolve results
+			sb.AppendLine($@"_callbacks: new Map(),");
+			// And a shared counter to index into that map
+			sb.Append($@"_callbackIndex: 0,");
+
+			sb.AppendLine("}");
+
+			try
+			{
+				//await webview.ExecuteScriptAsync($"try {{ {sb} }} catch (ex) {{ console.error(ex); }}").AsTask();
+				await webview.ExecuteScriptAsync($"{sb}").AsTask();
+			}
+			catch (Exception ex)
+			{
+				// So we can see it in the JS debugger
+			}
+
+			var handler = (WebViewMessageReceivedHandler)(async (_, e) =>
+			{
+				var message = JsonSerializer.Deserialize<WebMessage>(e.TryGetWebMessageAsString(), new JsonSerializerOptions() { PropertyNameCaseInsensitive = true });
+				if (message.Guid == methodsGuid)
+				{
+
+					var methodMessage = JsonSerializer.Deserialize<MethodWebMessage>(e.TryGetWebMessageAsString(), new JsonSerializerOptions() { PropertyNameCaseInsensitive = true });
+					var method = methods[methodMessage.Method];
+					try
+					{
+						var args = JsonSerializer.Deserialize<JsonElement[]>(methodMessage.Args).Zip(method.GetParameters(), (val, args) => new { val, args.ParameterType }).Select(item => item.val.Deserialize(item.ParameterType));
+						var result = method.Invoke(@object, args.ToArray());
+						if (result is object)
+						{
+							var resultType = result.GetType();
+							dynamic task = null;
+							if (resultType.Name.StartsWith("TaskToAsyncOperationAdapter")
+								|| resultType.IsInstanceOfType(typeof(IAsyncInfo)))
+							{
+								// IAsyncOperation that needs to be converted to a task first
+								if (resultType.GenericTypeArguments.Length > 0)
+								{
+									var asTask = typeof(WindowsRuntimeSystemExtensions)
+										.GetMethods(BindingFlags.Public | BindingFlags.Static)
+										.Where(method => method.GetParameters().Length == 1
+											&& method.Name == "AsTask"
+											&& method.ToString().Contains("Windows.Foundation.IAsyncOperation`1[TResult]"))
+										.FirstOrDefault();
+
+									//var asTask = typeof(WindowsRuntimeSystemExtensions)
+									//    .GetMethod(nameof(WindowsRuntimeSystemExtensions.AsTask),
+									//            new[] { typeof(IAsyncOperation<>).MakeGenericType(resultType.GenericTypeArguments[0]) }
+									//    );
+
+									asTask = asTask.MakeGenericMethod(resultType.GenericTypeArguments[0]);
+									task = (Task)asTask.Invoke(null, new[] { result });
+								}
+								else
+								{
+									task = WindowsRuntimeSystemExtensions.AsTask((dynamic)result);
+								}
+							}
+							else
+							{
+								var awaiter = resultType.GetMethod(nameof(Task.GetAwaiter));
+								if (awaiter is object)
+								{
+									task = result;
+								}
+							}
+							if (task is object)
+							{
+								result = await task;
+							}
+						}
+						var json = JsonSerializer.Serialize(result, new JsonSerializerOptions() { Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping }); ;
+						await webview.ExecuteScriptAsync($@"{name}._callbacks.get({methodMessage.Id}).accept(JSON.parse({json})); {name}._callbacks.delete({methodMessage.Id});");
+					}
+					catch (Exception ex)
+					{
+						var json = JsonSerializer.Serialize(ex, new JsonSerializerOptions() { Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping });
+						await webview.ExecuteScriptAsync($@"{name}._callbacks.get({methodMessage.Id}).reject(JSON.parse({json})); {name}._callbacks.delete({methodMessage.Id});");
+						//throw;
+					}
+				}
+				else if (message.Guid == propertiesGuid)
+				{
+					var propertyMessage = JsonSerializer.Deserialize<PropertyWebMessage>(e.TryGetWebMessageAsString(), new JsonSerializerOptions() { PropertyNameCaseInsensitive = true });
+					var property = properties[propertyMessage.Property];
+					try
+					{
+						object result;
+						if (propertyMessage.Action == PropertyAction.Read)
+						{
+							result = property.GetValue(@object);
+						}
+						else
+						{
+							var value = JsonSerializer.Deserialize(propertyMessage.Value, property.PropertyType);
+							property.SetValue(@object, value);
+							result = new object();
+						}
+
+						var json = JsonSerializer.Serialize(result, new JsonSerializerOptions() { Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping });
+						await webview.ExecuteScriptAsync($@"{name}._callbacks.get({propertyMessage.Id}).accept(JSON.parse({json})); {name}._callbacks.delete({propertyMessage.Id});");
+					}
+					catch (Exception ex)
+					{
+						//var json = JsonSerializer.Serialize(ex, new JsonSerializerOptions() { Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping });
+						//await webview.ExecuteScriptAsync($@"{name}._callbacks.get({propertyMessage.Id}).reject(JSON.parse({json})); {name}._callbacks.delete({propertyMessage.Id});");
+						//throw;
+					}
+				}
+			});
+
+			_handlers.Add(handler);
+			webview.WebMessageReceived += handler;
+		}
+
+		public static async Task<string> InvokeScriptAsync(this WebView2 webview, string function, params object[] args)
+		{
+			var array = JsonSerializer.Serialize(args, new JsonSerializerOptions() { Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping });
+			string result = null;
+			// Tested and checked: this dispatch is required, even though the web view is in a different process
+			await webview.DispatcherQueue.EnqueueAsync(async () =>
+			{
+				var script = $"{function}(...{array});";
+				try
+				{
+					result = await webview.ExecuteScriptAsync(script).AsTask();
+					result = JsonSerializer.Deserialize<string>(result);
+				}
+				catch (Exception ex)
+				{
+				}
+			}, Microsoft.UI.Dispatching.DispatcherQueuePriority.Normal);
+
+			return result;
+		}
+	}
+}

src/Files.App/Files.App.csproj

@@ -46,6 +46,10 @@
         <Content Update="Assets\Resources\**">
             <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
         </Content>
+        <Content Include="Utils\Terminal\UI\bundle.js" />
+        <Content Include="Utils\Terminal\UI\index.html" />
+        <Content Include="Utils\Terminal\UI\style.css" />
+        <Content Include="Utils\Terminal\UI\xterm.css" />
         <Content Update="Assets\FilesOpenDialog\SetFilesAsDefault.reg">
             <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
         </Content>

src/Files.App/Services/Settings/GeneralSettingsService.cs

@@ -315,6 +315,12 @@ public bool ShowSystemTrayIcon
 			set => Set(value);
 		}
 
+		public bool IsTerminalIntegrationEnabled
+		{
+			get => Get(false);
+			set => Set(value);
+		}
+
 		public FileNameConflictResolveOptionType ConflictsResolveOption
 		{
 			get => (FileNameConflictResolveOptionType)Get((long)FileNameConflictResolveOptionType.GenerateNewName);

src/Files.App/Strings/en-US/Resources.resw

@@ -4016,6 +4016,9 @@
   <data name="Total" xml:space="preserve">
     <value>Total</value>
   </data>
+  <data name="SettingsTerminalIntegration" xml:space="preserve">
+    <value>Enable Terminal integration</value>
+  </data>
   <data name="AlwaysSwitchToNewlyOpenedTab" xml:space="preserve">
     <value>Always switch focus to newly created tab</value>
   </data>