ArchiSteamFarm/ArchiSteamFarm/BotDatabase.cs

/*
    _                _      _  ____   _                           _____
   / \    _ __  ___ | |__  (_)/ ___| | |_  ___   __ _  _ __ ___  |  ___|__ _  _ __  _ __ ___
  / _ \  | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_  / _` || '__|| '_ ` _ \
 / ___ \ | |  | (__ | | | || | ___) || |_|  __/| (_| || | | | | ||  _|| (_| || |   | | | | | |
/_/   \_\|_|   \___||_| |_||_||____/  \__|\___| \__,_||_| |_| |_||_|   \__,_||_|   |_| |_| |_|

 Copyright 2015-2017 Łukasz "JustArchi" Domeradzki
 Contact: JustArchi@JustArchi.net

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0
					
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.

*/

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
using Newtonsoft.Json;

namespace ArchiSteamFarm {
	internal sealed class BotDatabase : IDisposable {
		[JsonProperty(Required = Required.DisallowNull)]
		private readonly ConcurrentHashSet<ulong> BlacklistedFromTradesSteamIDs = new ConcurrentHashSet<ulong>();

		private readonly SemaphoreSlim FileSemaphore = new SemaphoreSlim(1, 1);

		[JsonProperty(Required = Required.DisallowNull)]
		private readonly ConcurrentHashSet<uint> IdlingPriorityAppIDs = new ConcurrentHashSet<uint>();

		[JsonProperty(PropertyName = "_LoginKey")]
		internal string LoginKey { get; private set; }

		[JsonProperty(PropertyName = "_MobileAuthenticator")]
		internal MobileAuthenticator MobileAuthenticator { get; private set; }

		private string FilePath;

		// This constructor is used when creating new database
		private BotDatabase(string filePath) {
			if (string.IsNullOrEmpty(filePath)) {
				throw new ArgumentNullException(nameof(filePath));
			}

			FilePath = filePath;
			Save().Wait();
		}

		// This constructor is used only by deserializer
		[SuppressMessage("ReSharper", "UnusedMember.Local")]
		private BotDatabase() { }

		public void Dispose() {
			// Those are objects that are always being created if constructor doesn't throw exception
			FileSemaphore.Dispose();

			// Those are objects that might be null and the check should be in-place
			MobileAuthenticator?.Dispose();
		}

		internal async Task AddBlacklistedFromTradesSteamIDs(HashSet<ulong> steamIDs) {
			if ((steamIDs == null) || (steamIDs.Count == 0)) {
				ASF.ArchiLogger.LogNullError(nameof(steamIDs));
				return;
			}

			if (BlacklistedFromTradesSteamIDs.AddRange(steamIDs)) {
				await Save().ConfigureAwait(false);
			}
		}

		internal async Task AddIdlingPriorityAppIDs(HashSet<uint> appIDs) {
			if ((appIDs == null) || (appIDs.Count == 0)) {
				ASF.ArchiLogger.LogNullError(nameof(appIDs));
				return;
			}

			if (IdlingPriorityAppIDs.AddRange(appIDs)) {
				await Save().ConfigureAwait(false);
			}
		}

		internal async Task CorrectMobileAuthenticatorDeviceID(string deviceID) {
			if (string.IsNullOrEmpty(deviceID) || (MobileAuthenticator == null)) {
				ASF.ArchiLogger.LogNullError(nameof(deviceID) + " || " + nameof(MobileAuthenticator));
				return;
			}

			if (MobileAuthenticator.CorrectDeviceID(deviceID)) {
				await Save().ConfigureAwait(false);
			}
		}

		internal IEnumerable<ulong> GetBlacklistedFromTradesSteamIDs() => BlacklistedFromTradesSteamIDs;
		internal IEnumerable<uint> GetIdlingPriorityAppIDs() => IdlingPriorityAppIDs;

		internal bool IsBlacklistedFromTrades(ulong steamID) {
			if (steamID == 0) {
				ASF.ArchiLogger.LogNullError(nameof(steamID));
				return false;
			}

			bool result = BlacklistedFromTradesSteamIDs.Contains(steamID);
			return result;
		}

		internal bool IsPriorityIdling(uint appID) {
			if (appID == 0) {
				ASF.ArchiLogger.LogNullError(nameof(appID));
				return false;
			}

			bool result = IdlingPriorityAppIDs.Contains(appID);
			return result;
		}

		internal static BotDatabase Load(string filePath) {
			if (string.IsNullOrEmpty(filePath)) {
				ASF.ArchiLogger.LogNullError(nameof(filePath));
				return null;
			}

			if (!File.Exists(filePath)) {
				return new BotDatabase(filePath);
			}

			BotDatabase botDatabase;

			try {
				botDatabase = JsonConvert.DeserializeObject<BotDatabase>(File.ReadAllText(filePath));
			} catch (Exception e) {
				ASF.ArchiLogger.LogGenericException(e);
				return null;
			}

			if (botDatabase == null) {
				ASF.ArchiLogger.LogNullError(nameof(botDatabase));
				return null;
			}

			botDatabase.FilePath = filePath;
			return botDatabase;
		}

		internal async Task RemoveBlacklistedFromTradesSteamIDs(HashSet<ulong> steamIDs) {
			if ((steamIDs == null) || (steamIDs.Count == 0)) {
				ASF.ArchiLogger.LogNullError(nameof(steamIDs));
				return;
			}

			if (BlacklistedFromTradesSteamIDs.RemoveRange(steamIDs)) {
				await Save().ConfigureAwait(false);
			}
		}

		internal async Task RemoveIdlingPriorityAppIDs(HashSet<uint> appIDs) {
			if ((appIDs == null) || (appIDs.Count == 0)) {
				ASF.ArchiLogger.LogNullError(nameof(appIDs));
				return;
			}

			if (IdlingPriorityAppIDs.RemoveRange(appIDs)) {
				await Save().ConfigureAwait(false);
			}
		}

		internal async Task SetLoginKey(string value = null) {
			if (value == LoginKey) {
				return;
			}

			LoginKey = value;
			await Save().ConfigureAwait(false);
		}

		internal async Task SetMobileAuthenticator(MobileAuthenticator value = null) {
			if (value == MobileAuthenticator) {
				return;
			}

			MobileAuthenticator = value;
			await Save().ConfigureAwait(false);
		}

		private async Task Save() {
			string json = JsonConvert.SerializeObject(this);
			if (string.IsNullOrEmpty(json)) {
				ASF.ArchiLogger.LogNullError(nameof(json));
				return;
			}

			string newFilePath = FilePath + ".new";

			await FileSemaphore.WaitAsync().ConfigureAwait(false);

			try {
				await File.WriteAllTextAsync(newFilePath, json).ConfigureAwait(false);

				if (File.Exists(FilePath)) {
					File.Replace(newFilePath, FilePath, null);
				} else {
					File.Move(newFilePath, FilePath);
				}
			} catch (Exception e) {
				ASF.ArchiLogger.LogGenericException(e);
			} finally {
				FileSemaphore.Release();
			}
		}
	}
}