DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-12 21:38:38 +00:00
Code Issues Releases Wiki Activity

Added artemis:// protocol support

Browse Source
This commit is contained in:
Robert 2023-09-24 20:10:21 +02:00
parent 9bf38f54a8
commit 0a5cc6955e
12 changed files with 162 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/docfx.yml vendored
View File

@ -33,4 +33,4 @@ jobs:
username: ${{ secrets.FTP_USER }}
password: ${{ secrets.FTP_PASSWORD }}
local-dir: docfx/docfx_project/_site/
server-dir: /httpdocs/docs/
server-dir: /docs/

21
src/Artemis.UI.Shared/Providers/IProtocolProvider.cs Normal file
View File

@ -0,0 +1,21 @@
using System.Threading.Tasks;
namespace Artemis.UI.Shared.Providers;
/// <summary>
/// Represents a provider associating with a custom protocol, e.g. artemis://
/// </summary>
public interface IProtocolProvider
{
/// <summary>
/// Associate Artemis with the provided custom protocol.
/// </summary>
/// <param name="protocol">The protocol to associate Artemis with.</param>
Task AssociateWithProtocol(string protocol);
/// <summary>
/// Disassociate Artemis with the provided custom protocol.
/// </summary>
/// <param name="protocol">The protocol to disassociate Artemis with.</param>
Task DisassociateWithProtocol(string protocol);
}

1
src/Artemis.UI.Shared/Routing/Router/Router.cs
View File

@ -72,6 +72,7 @@ internal class Router : CorePropertyChanged, IRouter, IDisposable
/// <inheritdoc />
public async Task Navigate(string path, RouterNavigationOptions? options = null)
{
path = path.ToLower().Trim(' ', '/', '\\');
options ??= new RouterNavigationOptions();
// Routing takes place on the UI thread with processing heavy tasks offloaded by the router itself

5
src/Artemis.UI.Windows/App.axaml.cs
View File

@ -74,6 +74,9 @@ public class App : Application
return false;
}
string? route = (ApplicationLifetime as IClassicDesktopStyleApplicationLifetime)?.Args?.FirstOrDefault(a => a.Contains("route"));
route = route?.Split("artemis://")[1];
string url = File.ReadAllText(Path.Combine(Constants.DataFolder, "webserver.txt"));
using HttpClient client = new();
try
@ -81,7 +84,7 @@ public class App : Application
CancellationTokenSource cts = new();
cts.CancelAfter(2000);
HttpResponseMessage httpResponseMessage = client.Send(new HttpRequestMessage(HttpMethod.Post, url + "remote/bring-to-foreground"), cts.Token);
HttpResponseMessage httpResponseMessage = client.Send(new HttpRequestMessage(HttpMethod.Post, url + "remote/bring-to-foreground") {Content = new StringContent(route ?? "")}, cts.Token);
httpResponseMessage.EnsureSuccessStatusCode();
return true;
}

1
src/Artemis.UI.Windows/DryIoc/ContainerExtensions.cs
View File

@ -24,5 +24,6 @@ public static class UIContainerExtensions
container.Register<IAutoRunProvider, AutoRunProvider>();
container.Register<InputProvider, WindowsInputProvider>(serviceKey: WindowsInputProvider.Id);
container.Register<IUpdateNotificationProvider, WindowsUpdateNotificationProvider>();
container.Register<IProtocolProvider, ProtocolProvider>();
}
}

34
src/Artemis.UI.Windows/Providers/ProtocolProvider.cs Normal file
View File

@ -0,0 +1,34 @@
using System;
using System.Threading.Tasks;
using Artemis.Core;
using Artemis.UI.Shared.Providers;
using Microsoft.Win32;
namespace Artemis.UI.Windows.Providers;
public class ProtocolProvider : IProtocolProvider
{
/// <inheritdoc />
public async Task AssociateWithProtocol(string protocol)
{
string key = $"HKEY_CURRENT_USER\\Software\\Classes\\{protocol}";
Registry.SetValue($"{key}", null, "URL:artemis protocol");
Registry.SetValue($"{key}", "URL Protocol", "");
Registry.SetValue($"{key}\\DefaultIcon", null, $"\"{Constants.ExecutablePath}\",1");
Registry.SetValue($"{key}\\shell\\open\\command", null, $"\"{Constants.ExecutablePath}\", \"--route=%1\"");
}
/// <inheritdoc />
public async Task DisassociateWithProtocol(string protocol)
{
try
{
string key = $"HKEY_CURRENT_USER\\Software\\Classes\\{protocol}";
Registry.CurrentUser.DeleteSubKeyTree(key);
}
catch (ArgumentException)
{
// Ignore errors (which means that the protocol wasn't associated before)
}
}
}

16
src/Artemis.UI/Controllers/RemoteController.cs
View File

@ -1,6 +1,8 @@
using System;
using System.IO;
using Artemis.Core;
using Artemis.Core.Services;
using Artemis.UI.Shared.Routing;
using Artemis.UI.Shared.Services.MainWindow;
using Avalonia.Threading;
using EmbedIO;
@ -13,11 +15,13 @@ public class RemoteController : WebApiController
{
private readonly ICoreService _coreService;
private readonly IMainWindowService _mainWindowService;
private readonly IRouter _router;
public RemoteController(ICoreService coreService, IMainWindowService mainWindowService)
public RemoteController(ICoreService coreService, IMainWindowService mainWindowService, IRouter router)
{
_coreService = coreService;
_mainWindowService = mainWindowService;
_router = router;
}
[Route(HttpVerbs.Any, "/status")]
@ -29,7 +33,15 @@ public class RemoteController : WebApiController
[Route(HttpVerbs.Post, "/remote/bring-to-foreground")]
public void PostBringToForeground()
{
Dispatcher.UIThread.Post(() => _mainWindowService.OpenMainWindow());
using StreamReader reader = new(Request.InputStream);
string route = reader.ReadToEnd();
Dispatcher.UIThread.InvokeAsync(async () =>
{
if (!string.IsNullOrWhiteSpace(route))
await _router.Navigate(route);
_mainWindowService.OpenMainWindow();
});
}
[Route(HttpVerbs.Post, "/remote/restart")]

2
src/Artemis.UI/Screens/Root/RootViewModel.cs
View File

@ -14,6 +14,7 @@ using Artemis.UI.Shared.Routing;
using Artemis.UI.Shared.Services;
using Artemis.UI.Shared.Services.MainWindow;
using Avalonia;
using Avalonia.Controls;
using Avalonia.Controls.ApplicationLifetimes;
using Avalonia.Threading;
using ReactiveUI;
@ -181,6 +182,7 @@ public class RootViewModel : RoutableHostScreen<RoutableScreen>, IMainWindowProv
}
_lifeTime.MainWindow.Activate();
_lifeTime.MainWindow.WindowState = WindowState.Normal;
OnMainWindowOpened();
}

15
src/Artemis.UI/Screens/Settings/Tabs/GeneralTabView.axaml
View File

@ -45,6 +45,19 @@
</Grid>
<Border Classes="card-separator" />
<Grid RowDefinitions="*,*" ColumnDefinitions="*,Auto">
<StackPanel Grid.Column="0">
<TextBlock>Associate with Artemis links</TextBlock>
<TextBlock Classes="subtitle" TextWrapping="Wrap">
Open Artemis when navigating to artemis:// links, allows opening workshop entries from your browser.
</TextBlock>
</StackPanel>
<StackPanel Grid.Row="0" Grid.Column="1" VerticalAlignment="Center">
<ToggleSwitch IsChecked="{CompiledBinding UIUseProtocol.Value}" OnContent="Yes" OffContent="No" MinWidth="0" Margin="0 -10" />
</StackPanel>
</Grid>
<Border Classes="card-separator"/>
<Grid RowDefinitions="*,*" ColumnDefinitions="*,Auto" IsVisible="{CompiledBinding IsWindows11}">
<StackPanel Grid.Column="0">
<TextBlock>Enable Mica effect</TextBlock>
@ -57,7 +70,7 @@
</StackPanel>
</Grid>
<Border Classes="card-separator" IsVisible="{CompiledBinding IsWindows11}"/>
<Grid RowDefinitions="*,*" ColumnDefinitions="*,Auto">
<StackPanel Grid.Column="0">
<TextBlock>Startup delay</TextBlock>

29
src/Artemis.UI/Screens/Settings/Tabs/GeneralTabViewModel.cs
View File

@ -29,6 +29,7 @@ namespace Artemis.UI.Screens.Settings;
public class GeneralTabViewModel : RoutableScreen
{
private readonly IAutoRunProvider? _autoRunProvider;
private readonly IProtocolProvider? _protocolProvider;
private readonly IDebugService _debugService;
private readonly PluginSetting<LayerBrushReference> _defaultLayerBrushDescriptor;
private readonly INotificationService _notificationService;
@ -52,6 +53,7 @@ public class GeneralTabViewModel : RoutableScreen
_updateService = updateService;
_notificationService = notificationService;
_autoRunProvider = container.Resolve<IAutoRunProvider>(IfUnresolved.ReturnDefault);
_protocolProvider = container.Resolve<IProtocolProvider>(IfUnresolved.ReturnDefault);
List<LayerBrushProvider> layerBrushProviders = pluginManagementService.GetFeaturesOfType<LayerBrushProvider>();
List<IGraphicsContextProvider> graphicsContextProviders = container.Resolve<List<IGraphicsContextProvider>>();
@ -74,13 +76,16 @@ public class GeneralTabViewModel : RoutableScreen
this.WhenActivated(d =>
{
UIAutoRun.SettingChanged += UIAutoRunOnSettingChanged;
UIUseProtocol.SettingChanged += UIUseProtocolOnSettingChanged;
UIAutoRunDelay.SettingChanged += UIAutoRunDelayOnSettingChanged;
EnableMica.SettingChanged += EnableMicaOnSettingChanged;
Dispatcher.UIThread.InvokeAsync(ApplyAutoRun);
Dispatcher.UIThread.Invoke(ApplyProtocolAssociation);
Disposable.Create(() =>
{
UIAutoRun.SettingChanged -= UIAutoRunOnSettingChanged;
UIUseProtocol.SettingChanged -= UIUseProtocolOnSettingChanged;
UIAutoRunDelay.SettingChanged -= UIAutoRunDelayOnSettingChanged;
EnableMica.SettingChanged -= EnableMicaOnSettingChanged;
@ -148,6 +153,7 @@ public class GeneralTabViewModel : RoutableScreen
}
public PluginSetting<bool> UIAutoRun => _settingsService.GetSetting("UI.AutoRun", false);
public PluginSetting<bool> UIUseProtocol => _settingsService.GetSetting("UI.UseProtocol", true);
public PluginSetting<int> UIAutoRunDelay => _settingsService.GetSetting("UI.AutoRunDelay", 15);
public PluginSetting<bool> UIShowOnStartup => _settingsService.GetSetting("UI.ShowOnStartup", true);
public PluginSetting<bool> EnableMica => _settingsService.GetSetting("UI.EnableMica", true);
@ -223,11 +229,34 @@ public class GeneralTabViewModel : RoutableScreen
_windowService.ShowExceptionDialog("Failed to apply auto-run", exception);
}
}
private void ApplyProtocolAssociation()
{
if (_protocolProvider == null)
return;
try
{
if (UIUseProtocol.Value)
_protocolProvider.AssociateWithProtocol("artemis");
else
_protocolProvider.DisassociateWithProtocol("artemis");
}
catch (Exception exception)
{
_windowService.ShowExceptionDialog("Failed to apply protocol association", exception);
}
}
private async void UIAutoRunOnSettingChanged(object? sender, EventArgs e)
{
await ApplyAutoRun();
}
private void UIUseProtocolOnSettingChanged(object? sender, EventArgs e)
{
ApplyProtocolAssociation();
}
private async void UIAutoRunDelayOnSettingChanged(object? sender, EventArgs e)
{

28
src/Artemis.UI/Screens/StartupWizard/StartupWizardViewModel.cs
View File

@ -20,6 +20,7 @@ namespace Artemis.UI.Screens.StartupWizard;
public class StartupWizardViewModel : DialogViewModelBase<bool>
{
private readonly IAutoRunProvider? _autoRunProvider;
private readonly IProtocolProvider? _protocolProvider;
private readonly IRgbService _rgbService;
private readonly ISettingsService _settingsService;
private readonly IWindowService _windowService;
@ -39,6 +40,7 @@ public class StartupWizardViewModel : DialogViewModelBase<bool>
_rgbService = rgbService;
_windowService = windowService;
_autoRunProvider = container.Resolve<IAutoRunProvider>(IfUnresolved.ReturnDefault);
_protocolProvider = container.Resolve<IProtocolProvider>(IfUnresolved.ReturnDefault);
Continue = ReactiveCommand.Create(ExecuteContinue);
GoBack = ReactiveCommand.Create(ExecuteGoBack);
@ -58,11 +60,13 @@ public class StartupWizardViewModel : DialogViewModelBase<bool>
this.WhenActivated(d =>
{
UIAutoRun.SettingChanged += UIAutoRunOnSettingChanged;
UIUseProtocol.SettingChanged += UIUseProtocolOnSettingChanged;
UIAutoRunDelay.SettingChanged += UIAutoRunDelayOnSettingChanged;
Disposable.Create(() =>
{
UIAutoRun.SettingChanged -= UIAutoRunOnSettingChanged;
UIUseProtocol.SettingChanged -= UIUseProtocolOnSettingChanged;
UIAutoRunDelay.SettingChanged -= UIAutoRunDelayOnSettingChanged;
_settingsService.SaveAllSettings();
@ -81,6 +85,7 @@ public class StartupWizardViewModel : DialogViewModelBase<bool>
public bool IsAutoRunSupported => _autoRunProvider != null;
public PluginSetting<bool> UIAutoRun => _settingsService.GetSetting("UI.AutoRun", false);
public PluginSetting<bool> UIUseProtocol => _settingsService.GetSetting("UI.UseProtocol", true);
public PluginSetting<int> UIAutoRunDelay => _settingsService.GetSetting("UI.AutoRunDelay", 15);
public PluginSetting<bool> UIShowOnStartup => _settingsService.GetSetting("UI.ShowOnStartup", true);
public PluginSetting<bool> UICheckForUpdates => _settingsService.GetSetting("UI.Updating.AutoCheck", true);
@ -177,11 +182,34 @@ public class StartupWizardViewModel : DialogViewModelBase<bool>
}
}
private void ApplyProtocolAssociation()
{
if (_protocolProvider == null)
return;
try
{
if (UIUseProtocol.Value)
_protocolProvider.AssociateWithProtocol("artemis");
else
_protocolProvider.DisassociateWithProtocol("artemis");
}
catch (Exception exception)
{
_windowService.ShowExceptionDialog("Failed to apply protocol association", exception);
}
}
private async void UIAutoRunOnSettingChanged(object? sender, EventArgs e)
{
await ApplyAutoRun();
}
private void UIUseProtocolOnSettingChanged(object? sender, EventArgs e)
{
ApplyProtocolAssociation();
}
private async void UIAutoRunDelayOnSettingChanged(object? sender, EventArgs e)
{
if (_autoRunProvider == null || !UIAutoRun.Value)

13
src/Artemis.UI/Screens/StartupWizard/Steps/SettingsStep.axaml
View File

@ -42,6 +42,19 @@
</StackPanel>
</Grid>
<Border Classes="card-separator" />
<Grid RowDefinitions="*,*" ColumnDefinitions="*,Auto">
<StackPanel Grid.Column="0">
<TextBlock>Associate with Artemis links</TextBlock>
<TextBlock Classes="subtitle" TextWrapping="Wrap">
Open Artemis when navigating to artemis:// links, allows opening workshop entries from your browser.
</TextBlock>
</StackPanel>
<StackPanel Grid.Row="0" Grid.Column="1" VerticalAlignment="Center">
<ToggleSwitch IsChecked="{CompiledBinding UIUseProtocol.Value}" OnContent="Yes" OffContent="No" MinWidth="0" Margin="0 -10" />
</StackPanel>
</Grid>
<Border Classes="card-separator"/>
<Grid RowDefinitions="*,*" ColumnDefinitions="*,Auto">
<StackPanel Grid.Column="0">