Restore SEBPatch

SafeExamBrowser.Browser.Contracts/Events/DownloadEventArgs.cs

@@ -0,0 +1,36 @@
+/*
+ * 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.Browser.Contracts.Events
+{
+	/// <summary>
+	/// The event arguments used for all download events.
+	/// </summary>
+	public class DownloadEventArgs
+	{
+		/// <summary>
+		/// Determines whether the specified download is allowed.
+		/// </summary>
+		public bool AllowDownload { get; set; }
+
+		/// <summary>
+		/// Callback executed once a download has been finished.
+		/// </summary>
+		public DownloadFinishedCallback Callback { get; set; }
+
+		/// <summary>
+		/// The full path under which the specified file should be saved.
+		/// </summary>
+		public string DownloadPath { get; set; }
+
+		/// <summary>
+		/// The URL of the resource to be downloaded.
+		/// </summary>
+		public string Url { get; set; }
+	}
+}

SafeExamBrowser.Browser.Contracts/Events/DownloadFinishedCallback.cs

@@ -0,0 +1,16 @@
+/*
+ * 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.Browser.Contracts.Events
+{
+	/// <summary>
+	/// Defines the method signature for callbacks to be executed once a download has been finished. Indicates the URL of the resource,
+	/// whether the download was successful, and if so, where it was saved.
+	/// </summary>
+	public delegate void DownloadFinishedCallback(bool success, string url, string filePath = null);
+}

SafeExamBrowser.Browser.Contracts/Events/DownloadRequestedEventHandler.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.Browser.Contracts.Events
+{
+	/// <summary>
+	/// Event handler used to control (e.g. allow or prohibit) download requests.
+	/// </summary>
+	public delegate void DownloadRequestedEventHandler(string fileName, DownloadEventArgs args);
+}

SafeExamBrowser.Browser.Contracts/Events/LoseFocusRequestedEventHandler.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.Browser.Contracts.Events
+{
+	/// <summary>
+	/// Event handler used to indicate that the user wants to move the focus away from the item.
+	/// </summary>
+	public delegate void LoseFocusRequestedEventHandler(bool forward);
+}

SafeExamBrowser.Browser.Contracts/Events/TabPressedEventHandler.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.Browser.Contracts.Events
+{
+	/// <summary>
+	/// Event handler used to indicate that the user pressed the tab key to move the focus forward or backward.
+	/// </summary>
+	public delegate void TabPressedEventHandler(bool forward);
+}

SafeExamBrowser.Browser.Contracts/Events/TerminationRequestedEventHandler.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.Browser.Contracts.Events
+{
+	/// <summary>
+	/// Event handler used to indicate that a termination request has been detected.
+	/// </summary>
+	public delegate void TerminationRequestedEventHandler();
+}

SafeExamBrowser.Browser.Contracts/Events/UserIdentifierDetectedEventHandler.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.Browser.Contracts.Events
+{
+	/// <summary>
+	/// Event handler used to indicate that the browser has detected a user identifier of an LMS.
+	/// </summary>
+	public delegate void UserIdentifierDetectedEventHandler(string identifier);
+}

SafeExamBrowser.Browser.Contracts/Filters/IRequestFilter.cs

@@ -0,0 +1,33 @@
+/*
+ * 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.Settings.Browser.Filter;
+
+namespace SafeExamBrowser.Browser.Contracts.Filters
+{
+	/// <summary>
+	/// Defines the filter for browser requests.
+	/// </summary>
+	public interface IRequestFilter
+	{
+		/// <summary>
+		/// The default result to be returned by <see cref="Process(Request)"/> if no rule matches.
+		/// </summary>
+		FilterResult Default { get; set; }
+
+		/// <summary>
+		/// Loads the given filter rule to be used when processing requests.
+		/// </summary>
+		void Load(IRule rule);
+
+		/// <summary>
+		/// Filters the given request according to the loaded rules.
+		/// </summary>
+		FilterResult Process(Request request);
+	}
+}

SafeExamBrowser.Browser.Contracts/Filters/IRule.cs

@@ -0,0 +1,33 @@
+/*
+ * 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.Settings.Browser.Filter;
+
+namespace SafeExamBrowser.Browser.Contracts.Filters
+{
+	/// <summary>
+	/// Defines a request filter rule.
+	/// </summary>
+	public interface IRule
+	{
+		/// <summary>
+		/// The filter result to be used if the rule matches a request.
+		/// </summary>
+		FilterResult Result { get; }
+
+		/// <summary>
+		/// Initializes the rule for processing requests.
+		/// </summary>
+		void Initialize(FilterRuleSettings settings);
+
+		/// <summary>
+		/// Indicates whether the rule applies for the given request.
+		/// </summary>
+		bool IsMatch(Request request);
+	}
+}

SafeExamBrowser.Browser.Contracts/Filters/IRuleFactory.cs

@@ -0,0 +1,23 @@
+/*
+ * 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.Settings.Browser.Filter;
+
+namespace SafeExamBrowser.Browser.Contracts.Filters
+{
+	/// <summary>
+	/// Builds request filter rules.
+	/// </summary>
+	public interface IRuleFactory
+	{
+		/// <summary>
+		/// Creates a filter rule for the given type.
+		/// </summary>
+		IRule CreateRule(FilterRuleType type);
+	}
+}

SafeExamBrowser.Browser.Contracts/Filters/Request.cs

@@ -0,0 +1,21 @@
+/*
+ * 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.Browser.Contracts.Filters
+{
+	/// <summary>
+	/// Holds data relevant for filtering requests.
+	/// </summary>
+	public class Request
+	{
+		/// <summary>
+		/// The full URL of the request.
+		/// </summary>
+		public string Url { get; set; }
+	}
+}

SafeExamBrowser.Browser.Contracts/IBrowserApplication.cs

@@ -0,0 +1,45 @@
+/*
+ * 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.Applications.Contracts;
+using SafeExamBrowser.Browser.Contracts.Events;
+
+namespace SafeExamBrowser.Browser.Contracts
+{
+	/// <summary>
+	/// Controls the lifetime and functionality of the browser application.
+	/// </summary>
+	public interface IBrowserApplication : IApplication<IBrowserWindow>
+	{
+		/// <summary>
+		/// Event fired when the browser application detects a download request for an application configuration file.
+		/// </summary>
+		event DownloadRequestedEventHandler ConfigurationDownloadRequested;
+
+		/// <summary>
+		/// Event fired when the user tries to focus the taskbar.
+		/// </summary>
+		event LoseFocusRequestedEventHandler LoseFocusRequested;
+
+		/// <summary>
+		/// Event fired when the browser application detects a request to terminate SEB.
+		/// </summary>
+		event TerminationRequestedEventHandler TerminationRequested;
+
+		/// <summary>
+		/// Event fired when the browser application detects a user identifier of an LMS.
+		/// </summary>
+		event UserIdentifierDetectedEventHandler UserIdentifierDetected;
+
+		/// <summary>
+		/// Transfers the focus to the browser application. If the parameter is <c>true</c>, the first focusable element in the browser window
+		/// receives focus (passing forward of focus). Otherwise, the last element receives focus.
+		/// </summary>
+		void Focus(bool forward);
+	}
+}

SafeExamBrowser.Browser.Contracts/IBrowserWindow.cs

@@ -0,0 +1,28 @@
+/*
+ * 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.Applications.Contracts;
+
+namespace SafeExamBrowser.Browser.Contracts
+{
+	/// <summary>
+	/// Defines a window of the <see cref="IBrowserApplication"/>.
+	/// </summary>
+	public interface IBrowserWindow : IApplicationWindow
+	{
+		/// <summary>
+		/// Indicates whether the window is the main browser window.
+		/// </summary>
+		bool IsMainWindow { get; }
+
+		/// <summary>
+		/// The currently loaded URL, or <c>default(string)</c> in case no navigation has happened yet.
+		/// </summary>
+		string Url { get; }
+	}
+}

SafeExamBrowser.Browser.Contracts/Properties/AssemblyInfo.cs

@@ -0,0 +1,33 @@
+using System.Reflection;
+using System.Runtime.InteropServices;
+
+// General Information about an assembly is controlled through the following
+// set of attributes. Change these attribute values to modify the information
+// associated with an assembly.
+[assembly: AssemblyTitle("SafeExamBrowser.Browser.Contracts")]
+[assembly: AssemblyDescription("Safe Exam Browser")]
+[assembly: AssemblyCompany("ETH Zürich")]
+[assembly: AssemblyProduct("SafeExamBrowser.Browser.Contracts")]
+[assembly: AssemblyCopyright("Copyright © 2024 ETH Zürich, IT Services")]
+
+// Setting ComVisible to false makes the types in this assembly not visible
+// to COM components.  If you need to access a type in this assembly from
+// COM, set the ComVisible attribute to true on that type.
+[assembly: ComVisible(false)]
+
+// The following GUID is for the ID of the typelib if this project is exposed to COM
+[assembly: Guid("5fb5273d-277c-41dd-8593-a25ce1aff2e9")]
+
+// Version information for an assembly consists of the following four values:
+//
+//      Major Version
+//      Minor Version
+//      Build Number
+//      Revision
+//
+// You can specify all the values or you can default the Build and Revision Numbers
+// by using the '*' as shown below:
+// [assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyVersion("1.0.0.0")]
+[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyInformationalVersion("1.0.0.0")]

SafeExamBrowser.Browser.Contracts/SafeExamBrowser.Browser.Contracts.csproj

@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <ProjectGuid>{5FB5273D-277C-41DD-8593-A25CE1AFF2E9}</ProjectGuid>
+    <OutputType>Library</OutputType>
+    <AppDesignerFolder>Properties</AppDesignerFolder>
+    <RootNamespace>SafeExamBrowser.Browser.Contracts</RootNamespace>
+    <AssemblyName>SafeExamBrowser.Browser.Contracts</AssemblyName>
+    <TargetFrameworkVersion>v4.8</TargetFrameworkVersion>
+    <FileAlignment>512</FileAlignment>
+    <Deterministic>true</Deterministic>
+    <TargetFrameworkProfile />
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
+    <DebugSymbols>true</DebugSymbols>
+    <OutputPath>bin\x86\Debug\</OutputPath>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <DebugType>full</DebugType>
+    <PlatformTarget>x86</PlatformTarget>
+    <ErrorReport>prompt</ErrorReport>
+    <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x86'">
+    <OutputPath>bin\x86\Release\</OutputPath>
+    <DefineConstants>TRACE</DefineConstants>
+    <Optimize>true</Optimize>
+    <DebugType>pdbonly</DebugType>
+    <PlatformTarget>x86</PlatformTarget>
+    <ErrorReport>prompt</ErrorReport>
+    <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x64'">
+    <DebugSymbols>true</DebugSymbols>
+    <OutputPath>bin\x64\Debug\</OutputPath>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <DebugType>full</DebugType>
+    <PlatformTarget>x64</PlatformTarget>
+    <ErrorReport>prompt</ErrorReport>
+    <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x64'">
+    <OutputPath>bin\x64\Release\</OutputPath>
+    <DefineConstants>TRACE</DefineConstants>
+    <Optimize>true</Optimize>
+    <DebugType>pdbonly</DebugType>
+    <PlatformTarget>x64</PlatformTarget>
+    <ErrorReport>prompt</ErrorReport>
+    <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="System" />
+    <Reference Include="Microsoft.CSharp" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="Events\DownloadEventArgs.cs" />
+    <Compile Include="Events\DownloadFinishedCallback.cs" />
+    <Compile Include="Events\DownloadRequestedEventHandler.cs" />
+    <Compile Include="Events\TabPressedEventHandler.cs" />
+    <Compile Include="Events\LoseFocusRequestedEventHandler.cs" />
+    <Compile Include="Events\UserIdentifierDetectedEventHandler.cs" />
+    <Compile Include="Events\TerminationRequestedEventHandler.cs" />
+    <Compile Include="Filters\IRequestFilter.cs" />
+    <Compile Include="Filters\IRule.cs" />
+    <Compile Include="Filters\IRuleFactory.cs" />
+    <Compile Include="Filters\Request.cs" />
+    <Compile Include="IBrowserApplication.cs" />
+    <Compile Include="IBrowserWindow.cs" />
+    <Compile Include="Properties\AssemblyInfo.cs" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\SafeExamBrowser.Applications.Contracts\SafeExamBrowser.Applications.Contracts.csproj">
+      <Project>{ac77745d-3b41-43e2-8e84-d40e5a4ee77f}</Project>
+      <Name>SafeExamBrowser.Applications.Contracts</Name>
+    </ProjectReference>
+    <ProjectReference Include="..\SafeExamBrowser.Settings\SafeExamBrowser.Settings.csproj">
+      <Project>{30b2d907-5861-4f39-abad-c4abf1b3470e}</Project>
+      <Name>SafeExamBrowser.Settings</Name>
+    </ProjectReference>
+  </ItemGroup>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+</Project>