osu/osu.Desktop/Updater/SquirrelUpdateManager.cs

222 lines
7.7 KiB
C#
Raw Normal View History

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
2018-04-13 09:19:50 +00:00
using System;
2018-07-06 07:39:27 +00:00
using System.Threading.Tasks;
2018-04-13 09:19:50 +00:00
using osu.Framework.Allocation;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Colour;
using osu.Framework.Graphics.Shapes;
using osu.Framework.Graphics.Sprites;
2018-04-13 09:19:50 +00:00
using osu.Framework.Logging;
using osu.Game;
using osu.Game.Graphics;
using osu.Game.Overlays;
using osu.Game.Overlays.Notifications;
2018-11-20 07:51:59 +00:00
using osuTK;
using osuTK.Graphics;
2018-04-13 09:19:50 +00:00
using Squirrel;
using LogLevel = Splat.LogLevel;
2018-04-13 09:19:50 +00:00
2018-07-06 07:39:27 +00:00
namespace osu.Desktop.Updater
2018-04-13 09:19:50 +00:00
{
public class SquirrelUpdateManager : osu.Game.Updater.UpdateManager
2018-04-13 09:19:50 +00:00
{
private UpdateManager updateManager;
private NotificationOverlay notificationOverlay;
2019-06-28 12:26:31 +00:00
public Task PrepareUpdateAsync() => UpdateManager.RestartAppWhenExited();
2018-04-13 09:19:50 +00:00
private static readonly Logger logger = Logger.GetLogger("updater");
/// <summary>
/// Whether an update has been downloaded but not yet applied.
/// </summary>
private bool updatePending;
2018-04-13 09:19:50 +00:00
[BackgroundDependencyLoader]
private void load(NotificationOverlay notification)
2018-04-13 09:19:50 +00:00
{
notificationOverlay = notification;
Splat.Locator.CurrentMutable.Register(() => new SquirrelLogger(), typeof(Splat.ILogger));
2018-04-13 09:19:50 +00:00
}
protected override async Task<bool> PerformUpdateCheck() => await checkForUpdateAsync().ConfigureAwait(false);
2020-05-07 06:07:22 +00:00
private async Task<bool> checkForUpdateAsync(bool useDeltaPatching = true, UpdateProgressNotification notification = null)
2018-04-13 09:19:50 +00:00
{
2020-05-05 01:31:11 +00:00
// should we schedule a retry on completion of this check?
bool scheduleRecheck = true;
2018-04-13 09:19:50 +00:00
try
{
updateManager ??= await UpdateManager.GitHubUpdateManager(@"https://github.com/ppy/osu", @"osulazer", null, null, true).ConfigureAwait(false);
2018-04-13 09:19:50 +00:00
var info = await updateManager.CheckForUpdate(!useDeltaPatching).ConfigureAwait(false);
2018-04-13 09:19:50 +00:00
if (info.ReleasesToApply.Count == 0)
{
if (updatePending)
{
// the user may have dismissed the completion notice, so show it again.
notificationOverlay.Post(new UpdateCompleteNotification(this));
return true;
}
2020-05-05 01:31:11 +00:00
// no updates available. bail and retry later.
return false;
}
2018-04-13 09:19:50 +00:00
scheduleRecheck = false;
2018-04-13 09:19:50 +00:00
if (notification == null)
{
notification = new UpdateProgressNotification(this) { State = ProgressNotificationState.Active };
Schedule(() => notificationOverlay.Post(notification));
}
notification.Progress = 0;
notification.Text = @"Downloading update...";
try
{
await updateManager.DownloadReleases(info.ReleasesToApply, p => notification.Progress = p / 100f).ConfigureAwait(false);
2018-04-13 09:19:50 +00:00
notification.Progress = 0;
notification.Text = @"Installing update...";
await updateManager.ApplyReleases(info, p => notification.Progress = p / 100f).ConfigureAwait(false);
2018-04-13 09:19:50 +00:00
notification.State = ProgressNotificationState.Completed;
updatePending = true;
2018-04-13 09:19:50 +00:00
}
catch (Exception e)
{
if (useDeltaPatching)
{
logger.Add(@"delta patching failed; will attempt full download!");
2018-04-13 09:19:50 +00:00
2020-05-05 01:31:11 +00:00
// could fail if deltas are unavailable for full update path (https://github.com/Squirrel/Squirrel.Windows/issues/959)
// try again without deltas.
await checkForUpdateAsync(false, notification).ConfigureAwait(false);
2018-04-13 09:19:50 +00:00
}
else
{
// In the case of an error, a separate notification will be displayed.
2019-06-28 12:26:31 +00:00
notification.State = ProgressNotificationState.Cancelled;
notification.Close();
2018-04-13 09:19:50 +00:00
Logger.Error(e, @"update failed!");
}
}
}
catch (Exception)
{
// we'll ignore this and retry later. can be triggered by no internet connection or thread abortion.
scheduleRecheck = true;
2018-04-13 09:19:50 +00:00
}
finally
{
if (scheduleRecheck)
2018-04-13 09:19:50 +00:00
{
2020-05-05 01:31:11 +00:00
// check again in 30 minutes.
Scheduler.AddDelayed(() => Task.Run(async () => await checkForUpdateAsync().ConfigureAwait(false)), 60000 * 30);
2018-04-13 09:19:50 +00:00
}
}
return true;
2018-04-13 09:19:50 +00:00
}
protected override void Dispose(bool isDisposing)
{
base.Dispose(isDisposing);
updateManager?.Dispose();
}
private class UpdateCompleteNotification : ProgressCompletionNotification
{
[Resolved]
private OsuGame game { get; set; }
public UpdateCompleteNotification(SquirrelUpdateManager updateManager)
{
Text = @"Update ready to install. Click to restart!";
Activated = () =>
{
updateManager.PrepareUpdateAsync()
.ContinueWith(_ => updateManager.Schedule(() => game?.GracefullyExit()));
return true;
};
}
}
2018-04-13 09:19:50 +00:00
private class UpdateProgressNotification : ProgressNotification
{
private readonly SquirrelUpdateManager updateManager;
public UpdateProgressNotification(SquirrelUpdateManager updateManager)
{
this.updateManager = updateManager;
}
protected override Notification CreateCompletionNotification()
{
return new UpdateCompleteNotification(updateManager);
2018-04-13 09:19:50 +00:00
}
[BackgroundDependencyLoader]
private void load(OsuColour colours)
2018-04-13 09:19:50 +00:00
{
IconContent.AddRange(new Drawable[]
{
new Box
{
RelativeSizeAxes = Axes.Both,
Colour = ColourInfo.GradientVertical(colours.YellowDark, colours.Yellow)
},
new SpriteIcon
{
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
2019-04-02 10:55:24 +00:00
Icon = FontAwesome.Solid.Upload,
2018-04-13 09:19:50 +00:00
Colour = Color4.White,
Size = new Vector2(20),
}
});
}
public override void Close()
{
// cancelling updates is not currently supported by the underlying updater.
// only allow dismissing for now.
switch (State)
{
case ProgressNotificationState.Cancelled:
base.Close();
break;
}
}
2018-04-13 09:19:50 +00:00
}
private class SquirrelLogger : Splat.ILogger, IDisposable
{
public LogLevel Level { get; set; } = LogLevel.Info;
public void Write(string message, LogLevel logLevel)
{
if (logLevel < Level)
return;
2019-05-15 05:12:59 +00:00
logger.Add(message);
}
public void Dispose()
{
}
}
2018-04-13 09:19:50 +00:00
}
}