wabbajack/Wabbajack.Lib/Downloaders/NexusDownloader.cs

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Reactive;
using System.Reactive.Linq;
using System.Threading;
using System.Threading.Tasks;
using F23.StringSimilarity;
using Newtonsoft.Json;
using ReactiveUI;
using Wabbajack.Common;
using Wabbajack.Common.Serialization.Json;
using Wabbajack.Common.StatusFeed.Errors;
using Wabbajack.Lib.NexusApi;
using Wabbajack.Lib.Validation;
using Game = Wabbajack.Common.Game;

namespace Wabbajack.Lib.Downloaders
{
    public class NexusDownloader : IDownloader, INeedsLogin
    {
        private bool _prepared;
        private AsyncLock _lock = new AsyncLock();
        private UserStatus? _status;
        public INexusApi? Client;

        public IObservable<bool> IsLoggedIn => Utils.HaveEncryptedJsonObservable("nexusapikey");

        public string SiteName => "Nexus Mods";

        public IObservable<string> MetaInfo => Observable.Return("");

        public Uri SiteURL => new Uri("https://www.nexusmods.com");

        public Uri IconUri => new Uri("https://www.nexusmods.com/favicon.ico");

        public ReactiveCommand<Unit, Unit> TriggerLogin { get; }
        public ReactiveCommand<Unit, Unit> ClearLogin { get; }

        public NexusDownloader()
        {
            TriggerLogin = ReactiveCommand.CreateFromTask(
                execute: () => Utils.CatchAndLog(NexusApiClient.RequestAndCacheAPIKey), 
                canExecute: IsLoggedIn.Select(b => !b).ObserveOnGuiThread());
            ClearLogin = ReactiveCommand.CreateFromTask(
                execute: () => Utils.CatchAndLog(async () => await Utils.DeleteEncryptedJson("nexusapikey")),
                canExecute: IsLoggedIn.ObserveOnGuiThread());
        }

        public async Task<AbstractDownloadState?> GetDownloaderState(dynamic archiveINI, bool quickMode)
        {
            var general = archiveINI.General;

            if (general.modID != null && general.fileID != null && general.gameName != null)
            {
                var game = GameRegistry.GetByFuzzyName((string)general.gameName).Game;

                if (quickMode)
                {
                    return new State
                    {
                        Game = GameRegistry.GetByFuzzyName((string)general.gameName).Game,
                        ModID = long.Parse(general.modID),
                        FileID = long.Parse(general.fileID),
                    };
                }

                var client = DownloadDispatcher.GetInstance<NexusDownloader>().Client ?? await NexusApiClient.Get();
                ModInfo info;
                try
                {
                    info = await client.GetModInfo(game, long.Parse((string)general.modID));
                }
                catch (Exception)
                {
                    return new State
                    {
                        Game = GameRegistry.GetByFuzzyName((string)general.gameName).Game,
                        ModID = long.Parse(general.modID),
                        FileID = long.Parse(general.fileID),
                    };
                }

                try
                {
                    return new State
                    {
                        Name = NexusApiUtils.FixupSummary(info.name),
                        Author = NexusApiUtils.FixupSummary(info.author),
                        Version = general.version ?? "0.0.0.0",
                        ImageURL = info.picture_url,
                        IsNSFW = info.contains_adult_content,
                        Description = NexusApiUtils.FixupSummary(info.summary),
                        Game = GameRegistry.GetByFuzzyName((string)general.gameName).Game,
                        ModID = long.Parse(general.modID),
                        FileID = long.Parse(general.fileID)
                    };
                }
                catch (FormatException)
                {
                    Utils.Log(
                        $"Cannot parse ModID/FileID from {(string)general.gameName} {(string)general.modID} {(string)general.fileID}");
                    throw;
                }
            }

            return null;
        }

        public async Task Prepare()
        {
            if (!_prepared)
            {
                using var _ = await _lock.WaitAsync();
                // Could have become prepared while we waited for the lock
                if (!_prepared)
                {
                    if (CLIArguments.ApiKey != null)
                    {
                        await CLIArguments.ApiKey.ToEcryptedJson("nexusapikey");
                    }

                    Client = await NexusApiClient.Get();
                    _status = await Client.GetUserStatus();
                    if (!Client.IsAuthenticated)
                    {
                        Utils.ErrorThrow(new UnconvertedError(
                            $"Authenticating for the Nexus failed. A nexus account is required to automatically download mods."));
                        return;
                    }

                    
                    /* Disabled for better User experience
                    if (!await _client.IsPremium())
                    {
                        var result = await Utils.Log(new YesNoIntervention(
                            "Wabbajack can operate without a premium account, but downloads will be slower and the install process will require more user interactions (you will have to start each download by hand). Are you sure you wish to continue?",
                            "Continue without Premium?")).Task;
                        if (result == ConfirmationIntervention.Choice.Abort)
                        {
                            Utils.ErrorThrow(new UnconvertedError($"Aborting at the request of the user"));
                        }
                    }
                    */
                    _prepared = true;
                }
            }
        }

        public async Task<bool> HaveEnoughAPICalls(IEnumerable<Archive> archives)
        {
            if (await Client!.IsPremium())
                return true;
            
            var count = archives.Select(a => a.State).OfType<State>().Count();

            return count < Client!.RemainingAPICalls;
        }

        [JsonName("NexusDownloader")]
        public class State : AbstractDownloadState, IMetaState, IUpgradingState
        {
            [JsonIgnore]
            public Uri URL => new Uri($"http://nexusmods.com/{Game.MetaData().NexusName}/mods/{ModID}");

            public string? Name { get; set; }

            public string? Author { get; set; }

            public string? Version { get; set; }
            
            public Uri? ImageURL { get; set; }
            
            public bool IsNSFW { get; set; }

            public string? Description { get; set; }

            [JsonProperty("GameName")]
            [JsonConverter(typeof(Utils.GameConverter))]
            public Game Game { get; set; }
            
            public long ModID { get; set; }
            public long FileID { get; set; }
            
            public async Task<bool> LoadMetaData()
            {
                return true;
            }
            
            [JsonIgnore]
            public override object[] PrimaryKey { get => new object[]{Game, ModID, FileID};}

            public override bool IsWhitelisted(ServerWhitelist whitelist)
            {
                // Nexus files are always whitelisted
                return true;
            }

            public override async Task<bool> Download(Archive a, AbsolutePath destination)
            {
                string url;
                try
                {
                    url = await DownloadDispatcher.GetInstance<NexusDownloader>().Client!.GetNexusDownloadLink(this);
                }
                catch (NexusAPIQuotaExceeded ex)
                {
                    Utils.Log(ex.ExtendedDescription);
                    throw;
                }
                catch (Exception)
                {
                    return false;
                }

                return await new HTTPDownloader.State(url).Download(a, destination);
            }

            public override async Task<bool> Verify(Archive a, CancellationToken? token = null)
            {
                try
                {
                    var nclient = DownloadDispatcher.GetInstance<NexusDownloader>();
                    await nclient.Prepare();
                    var client = nclient.Client!;
                    var file = await client.GetModFile(Game, ModID, FileID);
                    return file?.category_name != null;
                }
                catch (Exception ex)
                {
                    Utils.Log($"{Name} - {Game} - {ModID} - {FileID} - Error getting Nexus download URL - {ex}");
                    return false;
                }

            }

            public override IDownloader GetDownloader()
            {
                return DownloadDispatcher.GetInstance<NexusDownloader>();
            }

            public override string GetManifestURL(Archive a)
            {
                return $"https://www.nexusmods.com/{Game.MetaData().NexusName}/mods/{ModID}/?tab=files&file_id={FileID}";
            }

            public override string[] GetMetaIni()
            {
                return new[] {"[General]", $"gameName={Game.MetaData().MO2ArchiveName}", $"modID={ModID}", $"fileID={FileID}"};
            }

            public override async Task<(Archive? Archive, TempFile NewFile)> FindUpgrade(Archive a, Func<Archive, Task<AbsolutePath>> downloadResolver)
            {
                var client = DownloadDispatcher.GetInstance<NexusDownloader>().Client ?? await NexusApiClient.Get();
                await client.IsPremium();
                
                if (client.RemainingAPICalls <= 0)
                    throw new NexusAPIQuotaExceeded();

                var mod = await client.GetModInfo(Game, ModID);
                if (!mod.available) 
                    return default;
                
                var files = await client.GetModFiles(Game, ModID);
                var oldFile = files.files.FirstOrDefault(f => f.file_id == FileID);
                var nl = new Levenshtein();
                var newFile = files.files.Where(f => f.category_name != null)
                    .OrderBy(f => nl.Distance(oldFile!.name.ToLowerInvariant(), f.name.ToLowerInvariant())).FirstOrDefault();

                if (!mod.available || oldFile == default || newFile == default)
                {
                    return default;
                }
                // Size is in KB
                if (oldFile.size > 4_500_000 || newFile.size > 4_500_000 || oldFile.file_id == newFile.file_id)
                {
                    return default;
                }
                
                var newArchive = new Archive(new State {Game = Game, ModID = ModID, FileID = newFile.file_id})
                {
                    Name = newFile.file_name,
                };

                var fastPath = await downloadResolver(newArchive);
                if (fastPath != default)
                {
                    newArchive.Size = fastPath.Size;
                    var hash = await fastPath.FileHashAsync();
                    if (hash == null) return default;
                    newArchive.Hash = hash.Value;
                    return (newArchive, new TempFile());
                }

                Utils.Log($"Downloading possible upgrade {newArchive.State.PrimaryKeyString}");
                var tempFile = new TempFile();
                 
                await newArchive.State.Download(newArchive, tempFile.Path);

                newArchive.Size = tempFile.Path.Size;
                var newArchiveHash = await tempFile.Path.FileHashAsync();
                if (newArchiveHash == null) return default;
                newArchive.Hash = newArchiveHash.Value;

                Utils.Log($"Possible upgrade {newArchive.State.PrimaryKeyString} downloaded");

                return (newArchive, tempFile);
            }

            public override async Task<bool> ValidateUpgrade(Hash srcHash, AbstractDownloadState newArchiveState)
            {
                var state = (State)newArchiveState;
                return Game == state.Game && ModID == state.ModID;
            }
        }
    }
}