Restore SEBPatch

SafeExamBrowser.Proctoring/ScreenProctoring/Data/IntervalTrigger.cs

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2024 ETH Zürich, IT Services
+ * 
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+namespace SafeExamBrowser.Proctoring.ScreenProctoring.Data
+{
+	internal class IntervalTrigger
+	{
+		public int ConfigurationValue { get; internal set; }
+	}
+}

SafeExamBrowser.Proctoring/ScreenProctoring/Data/KeyboardTrigger.cs

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2024 ETH Zürich, IT Services
+ * 
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+using System.Windows.Input;
+using SafeExamBrowser.WindowsApi.Contracts.Events;
+
+namespace SafeExamBrowser.Proctoring.ScreenProctoring.Data
+{
+	internal class KeyboardTrigger
+	{
+		public Key Key { get; internal set; }
+		public KeyModifier Modifier { get; internal set; }
+		public KeyState State { get; internal set; }
+	}
+}

SafeExamBrowser.Proctoring/ScreenProctoring/Data/MetaDataAggregator.cs

@@ -0,0 +1,171 @@
+/*
+ * Copyright (c) 2024 ETH Zürich, IT Services
+ * 
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+using System;
+using System.Linq;
+using System.Text;
+using SafeExamBrowser.Browser.Contracts;
+using SafeExamBrowser.Logging.Contracts;
+using SafeExamBrowser.Monitoring.Contracts.Applications;
+using SafeExamBrowser.Settings.Proctoring;
+using SafeExamBrowser.WindowsApi.Contracts.Events;
+
+namespace SafeExamBrowser.Proctoring.ScreenProctoring.Data
+{
+	internal class MetaDataAggregator
+	{
+		private readonly IApplicationMonitor applicationMonitor;
+		private readonly IBrowserApplication browser;
+		private readonly ILogger logger;
+		private readonly MetaDataSettings settings;
+
+		private string applicationInfo;
+		private string browserInfo;
+		private TimeSpan elapsed;
+		private string triggerInfo;
+		private string urls;
+		private int urlCount;
+		private string windowTitle;
+
+		internal MetaData Data => new MetaData
+		{
+			ApplicationInfo = applicationInfo,
+			BrowserInfo = browserInfo,
+			Elapsed = elapsed,
+			TriggerInfo = triggerInfo,
+			Urls = urls,
+			WindowTitle = windowTitle
+		};
+
+		internal MetaDataAggregator(
+			IApplicationMonitor applicationMonitor,
+			IBrowserApplication browser,
+			TimeSpan elapsed,
+			ILogger logger,
+			MetaDataSettings settings)
+		{
+			this.applicationMonitor = applicationMonitor;
+			this.browser = browser;
+			this.elapsed = elapsed;
+			this.logger = logger;
+			this.settings = settings;
+		}
+
+		internal void Capture(IntervalTrigger interval = default, KeyboardTrigger keyboard = default, MouseTrigger mouse = default)
+		{
+			Initialize();
+			CaptureApplicationData();
+			CaptureBrowserData();
+
+			if (interval != default)
+			{
+				CaptureIntervalTrigger(interval);
+			}
+			else if (keyboard != default)
+			{
+				CaptureKeyboardTrigger(keyboard);
+			}
+			else if (mouse != default)
+			{
+				CaptureMouseTrigger(mouse);
+			}
+
+			logger.Debug($"Captured metadata: {applicationInfo} / {browserInfo} / {urlCount} URL(s) / {triggerInfo} / {windowTitle}.");
+		}
+
+		private void CaptureApplicationData()
+		{
+			if (applicationMonitor.TryGetActiveApplication(out var application))
+			{
+				if (settings.CaptureApplicationData)
+				{
+					applicationInfo = BuildApplicationInfo(application);
+				}
+
+				if (settings.CaptureWindowTitle)
+				{
+					windowTitle = string.IsNullOrEmpty(application.Window.Title) ? "-" : application.Window.Title;
+				}
+			}
+		}
+
+		private void CaptureBrowserData()
+		{
+			if (settings.CaptureBrowserData)
+			{
+				var windows = browser.GetWindows();
+
+				browserInfo = string.Join(", ", windows.Select(w => $"{(w.IsMainWindow ? "Main" : "Additional")} Window: {w.Title}"));
+				urls = string.Join(", ", windows.Select(w => w.Url));
+				urlCount = windows.Count();
+			}
+		}
+
+		private void CaptureIntervalTrigger(IntervalTrigger interval)
+		{
+			triggerInfo = $"Maximum interval of {interval.ConfigurationValue}ms has been reached.";
+		}
+
+		private void CaptureKeyboardTrigger(KeyboardTrigger keyboard)
+		{
+			var flags = Enum.GetValues(typeof(KeyModifier))
+				.OfType<KeyModifier>()
+				.Where(m => m != KeyModifier.None && keyboard.Modifier.HasFlag(m) && !keyboard.Key.ToString().Contains(m.ToString()));
+			var modifiers = flags.Any() ? string.Join(" + ", flags) + " + " : string.Empty;
+
+			if (flags.Any())
+			{
+				triggerInfo = $"'{modifiers}{keyboard.Key}' has been {keyboard.State.ToString().ToLower()}.";
+			}
+			else
+			{
+				triggerInfo = $"A key has been {keyboard.State.ToString().ToLower()}.";
+			}
+		}
+
+		private void CaptureMouseTrigger(MouseTrigger mouse)
+		{
+			if (mouse.Info.IsTouch)
+			{
+				triggerInfo = $"Tap as {mouse.Button} mouse button has been {mouse.State.ToString().ToLower()} at ({mouse.Info.X}/{mouse.Info.Y}).";
+			}
+			else
+			{
+				triggerInfo = $"{mouse.Button} mouse button has been {mouse.State.ToString().ToLower()} at ({mouse.Info.X}/{mouse.Info.Y}).";
+			}
+		}
+
+		private string BuildApplicationInfo(ActiveApplication application)
+		{
+			var info = new StringBuilder();
+
+			info.Append(application.Process.Name);
+
+			if (application.Process.OriginalName != default)
+			{
+				info.Append($" ({application.Process.OriginalName}{(application.Process.Signature == default ? ")" : "")}");
+			}
+
+			if (application.Process.Signature != default)
+			{
+				info.Append($"{(application.Process.OriginalName == default ? "(" : ", ")}{application.Process.Signature})");
+			}
+
+			return info.ToString();
+		}
+
+		private void Initialize()
+		{
+			applicationInfo = "-";
+			browserInfo = "-";
+			triggerInfo = "-";
+			urls = "-";
+			windowTitle = "-";
+		}
+	}
+}

SafeExamBrowser.Proctoring/ScreenProctoring/Data/Metadata.cs

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2024 ETH Zürich, IT Services
+ * 
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+using System;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using SafeExamBrowser.Proctoring.ScreenProctoring.Service.Requests;
+
+namespace SafeExamBrowser.Proctoring.ScreenProctoring.Data
+{
+	internal class MetaData
+	{
+		internal string ApplicationInfo { get; set; }
+		internal string BrowserInfo { get; set; }
+		internal TimeSpan Elapsed { get; set; }
+		internal string TriggerInfo { get; set; }
+		internal string Urls { get; set; }
+		internal string WindowTitle { get; set; }
+
+		internal string ToJson()
+		{
+			var json = new JObject
+			{
+				[Header.Metadata.ApplicationInfo] = ApplicationInfo,
+				[Header.Metadata.BrowserInfo] = BrowserInfo,
+				[Header.Metadata.BrowserUrls] = Urls,
+				[Header.Metadata.TriggerInfo] = TriggerInfo,
+				[Header.Metadata.WindowTitle] = WindowTitle
+			};
+
+			return json.ToString(Formatting.None);
+		}
+	}
+}

SafeExamBrowser.Proctoring/ScreenProctoring/Data/MouseTrigger.cs

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2024 ETH Zürich, IT Services
+ * 
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+using SafeExamBrowser.WindowsApi.Contracts.Events;
+
+namespace SafeExamBrowser.Proctoring.ScreenProctoring.Data
+{
+	internal class MouseTrigger
+	{
+		public MouseButton Button { get; internal set; }
+		public MouseInformation Info { get; internal set; }
+		public MouseButtonState State { get; internal set; }
+	}
+}