/* * Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET) * * 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.Collections.Generic; using System.IO; using System.Linq; using SafeExamBrowser.Contracts.Configuration; using SafeExamBrowser.Contracts.Configuration.Settings; using SafeExamBrowser.Contracts.Logging; namespace SafeExamBrowser.Configuration { public class ConfigurationRepository : IConfigurationRepository { private const string BASE_ADDRESS = "net.pipe://localhost/safeexambrowser"; private readonly string executablePath; private readonly string programCopyright; private readonly string programTitle; private readonly string programVersion; private AppConfig appConfig; private IList dataFormats; private ILogger logger; private IList resourceLoaders; public ConfigurationRepository(ILogger logger, string executablePath, string programCopyright, string programTitle, string programVersion) { dataFormats = new List(); resourceLoaders = new List(); this.logger = logger; this.executablePath = executablePath ?? string.Empty; this.programCopyright = programCopyright ?? string.Empty; this.programTitle = programTitle ?? string.Empty; this.programVersion = programVersion ?? string.Empty; } public AppConfig InitializeAppConfig() { var appDataFolder = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), nameof(SafeExamBrowser)); var startTime = DateTime.Now; var logFolder = Path.Combine(appDataFolder, "Logs"); var logFilePrefix = startTime.ToString("yyyy-MM-dd\\_HH\\hmm\\mss\\s"); appConfig = new AppConfig(); appConfig.ApplicationStartTime = startTime; appConfig.AppDataFolder = appDataFolder; appConfig.BrowserCachePath = Path.Combine(appDataFolder, "Cache"); appConfig.BrowserLogFile = Path.Combine(logFolder, $"{logFilePrefix}_Browser.log"); appConfig.ClientId = Guid.NewGuid(); appConfig.ClientAddress = $"{BASE_ADDRESS}/client/{Guid.NewGuid()}"; appConfig.ClientExecutablePath = Path.Combine(Path.GetDirectoryName(executablePath), $"{nameof(SafeExamBrowser)}.Client.exe"); appConfig.ClientLogFile = Path.Combine(logFolder, $"{logFilePrefix}_Client.log"); appConfig.ConfigurationFileExtension = ".seb"; appConfig.DefaultSettingsFileName = "SebClientSettings.seb"; appConfig.DownloadDirectory = Path.Combine(appDataFolder, "Downloads"); appConfig.LogLevel = LogLevel.Debug; appConfig.ProgramCopyright = programCopyright; appConfig.ProgramDataFolder = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), nameof(SafeExamBrowser)); appConfig.ProgramTitle = programTitle; appConfig.ProgramVersion = programVersion; appConfig.RuntimeId = Guid.NewGuid(); appConfig.RuntimeAddress = $"{BASE_ADDRESS}/runtime/{Guid.NewGuid()}"; appConfig.RuntimeLogFile = Path.Combine(logFolder, $"{logFilePrefix}_Runtime.log"); appConfig.SebUriScheme = "seb"; appConfig.SebUriSchemeSecure = "sebs"; appConfig.ServiceAddress = $"{BASE_ADDRESS}/service"; return appConfig; } public ISessionConfiguration InitializeSessionConfiguration() { var configuration = new SessionConfiguration(); UpdateAppConfig(); configuration.AppConfig = appConfig.Clone(); configuration.Id = Guid.NewGuid(); configuration.StartupToken = Guid.NewGuid(); return configuration; } public Settings LoadDefaultSettings() { var settings = new Settings(); settings.KioskMode = KioskMode.None; settings.ServicePolicy = ServicePolicy.Optional; settings.Browser.StartUrl = "https://www.safeexambrowser.org/testing"; settings.Browser.AllowAddressBar = true; settings.Browser.AllowBackwardNavigation = true; settings.Browser.AllowConfigurationDownloads = true; settings.Browser.AllowDeveloperConsole = true; settings.Browser.AllowDownloads = true; settings.Browser.AllowForwardNavigation = true; settings.Browser.AllowReloading = true; settings.Taskbar.AllowApplicationLog = true; settings.Taskbar.AllowKeyboardLayout = true; settings.Taskbar.AllowWirelessNetwork = true; return settings; } public void Register(IDataFormat dataFormat) { dataFormats.Add(dataFormat); } public void Register(IResourceLoader resourceLoader) { resourceLoaders.Add(resourceLoader); } public LoadStatus TryLoadSettings(Uri resource, out Settings settings, string adminPassword = null, string settingsPassword = null) { settings = default(Settings); logger.Info($"Attempting to load '{resource}'..."); try { var status = TryLoadData(resource, out Stream data); using (data) { switch (status) { case LoadStatus.LoadWithBrowser: return HandleBrowserResource(resource, out settings); case LoadStatus.Success: return TryParseData(data, out settings, adminPassword, settingsPassword); } } return status; } catch (Exception e) { logger.Error($"Unexpected error while trying to load '{resource}'!", e); return LoadStatus.UnexpectedError; } } private LoadStatus TryLoadData(Uri resource, out Stream data) { var status = LoadStatus.NotSupported; var resourceLoader = resourceLoaders.FirstOrDefault(l => l.CanLoad(resource)); data = default(Stream); if (resourceLoader != null) { status = resourceLoader.TryLoad(resource, out data); logger.Info($"Tried to load data from '{resource}' using {resourceLoader.GetType().Name} -> Result: {status}."); } else { logger.Warn($"No resource loader found for '{resource}'!"); } return status; } private LoadStatus TryParseData(Stream data, out Settings settings, string adminPassword, string settingsPassword) { var status = LoadStatus.NotSupported; var dataFormat = dataFormats.FirstOrDefault(f => f.CanParse(data)); settings = default(Settings); if (dataFormat != null) { status = dataFormat.TryParse(data, out settings, adminPassword, settingsPassword); logger.Info($"Tried to parse data from '{data}' using {dataFormat.GetType().Name} -> Result: {status}."); } else { logger.Warn($"No data format found for '{data}'!"); } return status; } private LoadStatus HandleBrowserResource(Uri resource, out Settings settings) { settings = LoadDefaultSettings(); settings.Browser.StartUrl = resource.AbsoluteUri; logger.Info($"The resource needs authentication or is HTML data, loaded default settings with '{resource}' as startup URL."); return LoadStatus.Success; } private void UpdateAppConfig() { appConfig.ClientId = Guid.NewGuid(); appConfig.ClientAddress = $"{BASE_ADDRESS}/client/{Guid.NewGuid()}"; } } }