1
0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-31 09:43:46 +00:00

Compare commits

...

3 Commits

Author SHA1 Message Date
Robert
7f5bb589af Try to fix CI build 2024-07-22 14:52:30 +02:00
Robert
9001a12625 Workshop - Refactor InstalledEntry to not implement IEntryDetails
This turned out to be a hassle
2024-07-22 14:42:17 +02:00
Robert
a45d98c171 Workshop - Added indicator for official workshop entries 2024-07-22 11:01:50 +02:00
9 changed files with 236 additions and 198 deletions

View File

@ -14,6 +14,7 @@ public class EntryEntity
public int EntryType { get; set; }
public string Author { get; set; } = string.Empty;
public bool IsOfficial { get; set; }
public string Name { get; set; } = string.Empty;
public string Summary { get; set; } = string.Empty;
public long Downloads { get; set; }

View File

@ -11,8 +11,8 @@ using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
namespace Artemis.Storage.Migrations
{
[DbContext(typeof(ArtemisDbContext))]
[Migration("20240706131336_ExpandInstalledEntry")]
partial class ExpandInstalledEntry
[Migration("20240722084220_AutoUpdating")]
partial class AutoUpdating
{
/// <inheritdoc />
protected override void BuildTargetModel(ModelBuilder modelBuilder)
@ -264,6 +264,9 @@ namespace Artemis.Storage.Migrations
b.Property<DateTimeOffset>("InstalledAt")
.HasColumnType("TEXT");
b.Property<bool>("IsOfficial")
.HasColumnType("INTEGER");
b.Property<long?>("LatestReleaseId")
.HasColumnType("INTEGER");

View File

@ -6,7 +6,7 @@ using Microsoft.EntityFrameworkCore.Migrations;
namespace Artemis.Storage.Migrations
{
/// <inheritdoc />
public partial class ExpandInstalledEntry : Migration
public partial class AutoUpdating : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
@ -38,6 +38,13 @@ namespace Artemis.Storage.Migrations
nullable: false,
defaultValue: 0L);
migrationBuilder.AddColumn<bool>(
name: "IsOfficial",
table: "Entries",
type: "INTEGER",
nullable: false,
defaultValue: false);
migrationBuilder.AddColumn<long>(
name: "LatestReleaseId",
table: "Entries",
@ -50,7 +57,7 @@ namespace Artemis.Storage.Migrations
type: "TEXT",
nullable: false,
defaultValue: "");
// Enable auto-update on all entries that are not profiles
migrationBuilder.Sql("UPDATE Entries SET AutoUpdate = 1 WHERE EntryType != 2");
@ -87,6 +94,10 @@ namespace Artemis.Storage.Migrations
name: "Downloads",
table: "Entries");
migrationBuilder.DropColumn(
name: "IsOfficial",
table: "Entries");
migrationBuilder.DropColumn(
name: "LatestReleaseId",
table: "Entries");

View File

@ -261,6 +261,9 @@ namespace Artemis.Storage.Migrations
b.Property<DateTimeOffset>("InstalledAt")
.HasColumnType("TEXT");
b.Property<bool>("IsOfficial")
.HasColumnType("INTEGER");
b.Property<long?>("LatestReleaseId")
.HasColumnType("INTEGER");

View File

@ -39,7 +39,7 @@
<TextBlock Grid.Row="0" Margin="0 0 0 5" TextTrimming="CharacterEllipsis">
<Run Classes="h5" Text="{CompiledBinding Entry.Name, FallbackValue=Title}" />
<Run Classes="subtitle">by you</Run>
<Run Classes="subtitle" Text="{CompiledBinding Emoji}" />
<Run Text="{CompiledBinding Emoji}" />
</TextBlock>
<TextBlock Grid.Row="1"
Classes="subtitle"

View File

@ -11,7 +11,7 @@ namespace Artemis.UI.Screens.Workshop.Library.Tabs;
public class SubmissionsTabItemViewModel : ViewModelBase
{
private static readonly string[] Emojis = ["❤️", "🧡", "💛", "💚", "💙", "💜", "🤍", "💔", "❣️", "💕", "💞", "💓", "💗", "💖", "💘", "💝", "😍", "🥰"];
private static readonly string[] Emojis = ["❤️", "🧡", "💛", "💚", "💙", "💜", "💔", "❣️", "💕", "💞", "💓", "💗", "💖", "💘", "💝", "😍", "🥰"];
private readonly IRouter _router;
public SubmissionsTabItemViewModel(IGetSubmittedEntries_SubmittedEntries entry, IRouter router)

View File

@ -4,7 +4,6 @@ using System.Threading.Tasks;
using Artemis.Core;
using Artemis.Core.Services;
using Artemis.UI.Services.Interfaces;
using Artemis.UI.Shared.Services;
using Artemis.UI.Shared.Utilities;
using Artemis.WebClient.Workshop;
using Artemis.WebClient.Workshop.Handlers.InstallationHandlers;
@ -19,13 +18,11 @@ public class WorkshopUpdateService : IWorkshopUpdateService
{
private readonly ILogger _logger;
private readonly IWorkshopClient _client;
private readonly INotificationService _notificationService;
private readonly IWorkshopService _workshopService;
private readonly Lazy<IUpdateNotificationProvider> _updateNotificationProvider;
private readonly PluginSetting<bool> _showNotifications;
public WorkshopUpdateService(ILogger logger, IWorkshopClient client, IWorkshopService workshopService, ISettingsService settingsService,
Lazy<IUpdateNotificationProvider> updateNotificationProvider)
public WorkshopUpdateService(ILogger logger, IWorkshopClient client, IWorkshopService workshopService, ISettingsService settingsService, Lazy<IUpdateNotificationProvider> updateNotificationProvider)
{
_logger = logger;
_client = client;
@ -57,27 +54,41 @@ public class WorkshopUpdateService : IWorkshopUpdateService
_updateNotificationProvider.Value.ShowWorkshopNotification(updatedEntries);
}
public async Task<bool> AutoUpdateEntry(InstalledEntry entry)
public async Task<bool> AutoUpdateEntry(InstalledEntry installedEntry)
{
// Query the latest version
IOperationResult<IGetEntryLatestReleaseByIdResult> latestReleaseResult = await _client.GetEntryLatestReleaseById.ExecuteAsync(entry.Id);
IOperationResult<IGetEntryLatestReleaseByIdResult> latestReleaseResult = await _client.GetEntryLatestReleaseById.ExecuteAsync(installedEntry.Id);
IEntrySummary? entry = latestReleaseResult.Data?.Entry?.LatestRelease?.Entry;
if (entry == null)
return false;
if (latestReleaseResult.Data?.Entry?.LatestRelease is not IRelease latestRelease)
return false;
if (latestRelease.Id == entry.ReleaseId)
if (latestRelease.Id == installedEntry.ReleaseId)
return false;
_logger.Information("Auto-updating entry {Entry} to version {Version}", entry, latestRelease.Version);
EntryInstallResult updateResult = await _workshopService.InstallEntry(entry, latestRelease, new Progress<StreamProgress>(), CancellationToken.None);
try
{
EntryInstallResult updateResult = await _workshopService.InstallEntry(entry, latestRelease, new Progress<StreamProgress>(), CancellationToken.None);
// This happens during installation too but not on our reference of the entry
if (updateResult.IsSuccess)
entry.ApplyRelease(latestRelease);
// This happens during installation too but not on our reference of the entry
if (updateResult.IsSuccess)
installedEntry.ApplyRelease(latestRelease);
_logger.Information("Auto-update result: {Result}", updateResult);
if (updateResult.IsSuccess)
_logger.Information("Auto-update successful for entry {Entry}", entry);
else
_logger.Warning("Auto-update failed for entry {Entry}: {Message}", entry, updateResult.Message);
return updateResult.IsSuccess;
return updateResult.IsSuccess;
}
catch (Exception e)
{
_logger.Warning(e, "Auto-update failed for entry {Entry}", entry);
}
return false;
}
/// <inheritdoc />

View File

@ -6,22 +6,22 @@ using Artemis.Storage.Entities.Workshop;
namespace Artemis.WebClient.Workshop.Models;
public class InstalledEntry : CorePropertyChanged, IEntrySummary
public class InstalledEntry : CorePropertyChanged
{
private Dictionary<string, JsonNode> _metadata = new();
private long _id;
private string _author;
private bool _isOfficial;
private string _name;
private string _summary;
private EntryType _entryType;
private long _downloads;
private bool _autoUpdate;
private IReadOnlyList<InstalledEntryCategory> _categories;
private DateTimeOffset _createdAt;
private long _downloads;
private EntryType _entryType;
private long _id;
private bool _isOfficial;
private long? _latestReleaseId;
private IReadOnlyList<IGetDependantEntries_Entries_Items_Categories> _categories;
private Dictionary<string, JsonNode> _metadata = new();
private string _name;
private long _releaseId;
private string _releaseVersion = string.Empty;
private bool _autoUpdate;
private string _summary;
internal InstalledEntry(EntryEntity entity)
{
@ -40,7 +40,6 @@ public class InstalledEntry : CorePropertyChanged, IEntrySummary
AutoUpdate = true;
}
internal EntryEntity Entity { get; }
public DateTimeOffset InstalledAt { get; set; }
public long ReleaseId
@ -61,18 +60,177 @@ public class InstalledEntry : CorePropertyChanged, IEntrySummary
set => SetAndNotify(ref _autoUpdate, value);
}
public long Id
{
get => _id;
private set => SetAndNotify(ref _id, value);
}
public string Author
{
get => _author;
private set => SetAndNotify(ref _author, value);
}
public bool IsOfficial
{
get => _isOfficial;
private set => SetAndNotify(ref _isOfficial, value);
}
public string Name
{
get => _name;
private set => SetAndNotify(ref _name, value);
}
public string Summary
{
get => _summary;
private set => SetAndNotify(ref _summary, value);
}
public EntryType EntryType
{
get => _entryType;
private set => SetAndNotify(ref _entryType, value);
}
public long Downloads
{
get => _downloads;
private set => SetAndNotify(ref _downloads, value);
}
public DateTimeOffset CreatedAt
{
get => _createdAt;
private set => SetAndNotify(ref _createdAt, value);
}
public long? LatestReleaseId
{
get => _latestReleaseId;
private set => SetAndNotify(ref _latestReleaseId, value);
}
public IReadOnlyList<InstalledEntryCategory> Categories
{
get => _categories;
private set => SetAndNotify(ref _categories, value);
}
internal EntryEntity Entity { get; }
/// <summary>
/// Gets the metadata value associated with the specified key.
/// </summary>
/// <param name="key">The key of the value to get.</param>
/// <param name="value">
/// When this method returns, contains the value associated with the specified key, if the key is found and of type
/// <typeparamref name="T" />;
/// otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.
/// </param>
/// <typeparam name="T">The type of the value.</typeparam>
/// <returns>
/// <see langword="true" /> if the metadata contains an element with the specified key; otherwise,
/// <see langword="false" />.
/// </returns>
public bool TryGetMetadata<T>(string key, [NotNullWhen(true)] out T? value)
{
if (!_metadata.TryGetValue(key, out JsonNode? element))
{
value = default;
return false;
}
value = element.GetValue<T>();
return value != null;
}
/// <summary>
/// Sets metadata with the provided key to the provided value.
/// </summary>
/// <param name="key">The key of the value to set</param>
/// <param name="value">The value to set.</param>
public void SetMetadata(string key, object value)
{
_metadata[key] = JsonSerializer.SerializeToNode(value) ?? throw new InvalidOperationException();
}
/// <summary>
/// Removes metadata with the provided key.
/// </summary>
/// <param name="key">The key of the metadata to remove</param>
/// <returns><see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
public bool RemoveMetadata(string key)
{
return _metadata.Remove(key);
}
/// <summary>
/// Returns the directory info of the entry, where any files would be stored if applicable.
/// </summary>
/// <returns>The directory info of the directory.</returns>
public DirectoryInfo GetDirectory()
{
return new DirectoryInfo(Path.Combine(Constants.WorkshopFolder, $"{Id}-{StringUtilities.UrlFriendly(Name)}"));
}
/// <summary>
/// Returns the directory info of a release of this entry, where any files would be stored if applicable.
/// </summary>
/// <param name="release">The release to use, if none provided the current release is used.</param>
/// <returns>The directory info of the directory.</returns>
public DirectoryInfo GetReleaseDirectory(IRelease? release = null)
{
return new DirectoryInfo(Path.Combine(GetDirectory().FullName, StringUtilities.UrlFriendly(release?.Version ?? ReleaseVersion)));
}
/// <summary>
/// Applies the provided release to the installed entry.
/// </summary>
/// <param name="release">The release to apply.</param>
public void ApplyRelease(IRelease release)
{
ReleaseId = release.Id;
ReleaseVersion = release.Version;
InstalledAt = DateTimeOffset.UtcNow;
}
public void ApplyEntrySummary(IEntrySummary entry)
{
Id = entry.Id;
Author = entry.Author;
IsOfficial = entry.IsOfficial;
Name = entry.Name;
Summary = entry.Summary;
EntryType = entry.EntryType;
Downloads = entry.Downloads;
CreatedAt = entry.CreatedAt;
LatestReleaseId = entry.LatestReleaseId;
Categories = entry.Categories.Select(c => new InstalledEntryCategory(c.Name, c.Icon)).ToList();
}
public override string ToString()
{
return $"[{EntryType}] {Id} - {Name}";
}
internal void Load()
{
Id = Entity.EntryId;
Author = Entity.Author;
IsOfficial = Entity.IsOfficial;
Name = Entity.Name;
Summary = Entity.Summary;
EntryType = (EntryType) Entity.EntryType;
Downloads = Entity.Downloads;
CreatedAt = Entity.CreatedAt;
LatestReleaseId = Entity.LatestReleaseId;
Categories = Entity.Categories?.Select(c => new GetDependantEntries_Entries_Items_Categories_Category(c.Name, c.Icon)).ToList() ?? [];
Categories = Entity.Categories?.Select(c => new InstalledEntryCategory(c.Name, c.Icon)).ToList() ?? [];
ReleaseId = Entity.ReleaseId;
ReleaseVersion = Entity.ReleaseVersion;
InstalledAt = Entity.InstalledAt;
@ -87,6 +245,7 @@ public class InstalledEntry : CorePropertyChanged, IEntrySummary
Entity.EntryType = (int) EntryType;
Entity.Author = Author;
Entity.IsOfficial = IsOfficial;
Entity.Name = Name;
Entity.Summary = Summary;
Entity.Downloads = Downloads;
@ -98,171 +257,7 @@ public class InstalledEntry : CorePropertyChanged, IEntrySummary
Entity.ReleaseVersion = ReleaseVersion;
Entity.InstalledAt = InstalledAt;
Entity.AutoUpdate = AutoUpdate;
Entity.Metadata = new Dictionary<string, JsonNode>(_metadata);
}
/// <summary>
/// Gets the metadata value associated with the specified key.
/// </summary>
/// <param name="key">The key of the value to get.</param>
/// <param name="value">When this method returns, contains the value associated with the specified key, if the key is found and of type <typeparamref name="T"/>;
/// otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.</param>
/// <typeparam name="T">The type of the value.</typeparam>
/// <returns><see langword="true"/> if the metadata contains an element with the specified key; otherwise, <see langword="false"/>.</returns>
public bool TryGetMetadata<T>(string key, [NotNullWhen(true)] out T? value)
{
if (!_metadata.TryGetValue(key, out JsonNode? element))
{
value = default;
return false;
}
value = element.GetValue<T>();
return value != null;
}
/// <summary>
/// Sets metadata with the provided key to the provided value.
/// </summary>
/// <param name="key">The key of the value to set</param>
/// <param name="value">The value to set.</param>
public void SetMetadata(string key, object value)
{
_metadata[key] = JsonSerializer.SerializeToNode(value) ?? throw new InvalidOperationException();
}
/// <summary>
/// Removes metadata with the provided key.
/// </summary>
/// <param name="key">The key of the metadata to remove</param>
/// <returns><see langword="true"/> if the element is successfully found and removed; otherwise, <see langword="false"/>.</returns>
public bool RemoveMetadata(string key)
{
return _metadata.Remove(key);
}
/// <summary>
/// Returns the directory info of the entry, where any files would be stored if applicable.
/// </summary>
/// <returns>The directory info of the directory.</returns>
public DirectoryInfo GetDirectory()
{
return new DirectoryInfo(Path.Combine(Constants.WorkshopFolder, $"{Id}-{StringUtilities.UrlFriendly(Name)}"));
}
/// <summary>
/// Returns the directory info of a release of this entry, where any files would be stored if applicable.
/// </summary>
/// <param name="release">The release to use, if none provided the current release is used.</param>
/// <returns>The directory info of the directory.</returns>
public DirectoryInfo GetReleaseDirectory(IRelease? release = null)
{
return new DirectoryInfo(Path.Combine(GetDirectory().FullName, StringUtilities.UrlFriendly(release?.Version ?? ReleaseVersion)));
}
/// <summary>
/// Applies the provided release to the installed entry.
/// </summary>
/// <param name="release">The release to apply.</param>
public void ApplyRelease(IRelease release)
{
ReleaseId = release.Id;
ReleaseVersion = release.Version;
InstalledAt = DateTimeOffset.UtcNow;
}
public void ApplyEntrySummary(IEntrySummary entry)
{
Id = entry.Id;
Author = entry.Author;
IsOfficial = entry.IsOfficial;
Name = entry.Name;
Summary = entry.Summary;
EntryType = entry.EntryType;
Downloads = entry.Downloads;
CreatedAt = entry.CreatedAt;
LatestReleaseId = entry.LatestReleaseId;
Categories = entry.Categories;
}
#region Implementation of IEntrySummary
/// <inheritdoc />
public long Id
{
get => _id;
private set => SetAndNotify(ref _id, value);
}
/// <inheritdoc />
public string Author
{
get => _author;
private set => SetAndNotify(ref _author, value);
}
/// <inheritdoc />
public bool IsOfficial
{
get => _isOfficial;
private set => SetAndNotify(ref _isOfficial, value);
}
/// <inheritdoc />
public string Name
{
get => _name;
private set => SetAndNotify(ref _name, value);
}
/// <inheritdoc />
public string Summary
{
get => _summary;
private set => SetAndNotify(ref _summary, value);
}
/// <inheritdoc />
public EntryType EntryType
{
get => _entryType;
private set => SetAndNotify(ref _entryType, value);
}
/// <inheritdoc />
public long Downloads
{
get => _downloads;
private set => SetAndNotify(ref _downloads, value);
}
/// <inheritdoc />
public DateTimeOffset CreatedAt
{
get => _createdAt;
private set => SetAndNotify(ref _createdAt, value);
}
/// <inheritdoc />
public long? LatestReleaseId
{
get => _latestReleaseId;
private set => SetAndNotify(ref _latestReleaseId, value);
}
/// <inheritdoc />
public IReadOnlyList<IGetDependantEntries_Entries_Items_Categories> Categories
{
get => _categories;
private set => SetAndNotify(ref _categories, value);
}
#endregion
/// <inheritdoc />
public override string ToString()
{
return $"[{EntryType}] {Id} - {Name}";
}
}

View File

@ -0,0 +1,14 @@
namespace Artemis.WebClient.Workshop.Models;
public class InstalledEntryCategory
{
public InstalledEntryCategory(string name, string icon)
{
Name = name;
Icon = icon;
}
public string Name { get; }
public string Icon { get; }
}