mirror of
https://github.com/JustArchiNET/ArchiSteamFarm.git
synced 2026-01-14 07:30:39 +00:00
1202298e01
In bot controller, 3 endpoints:
POST {bot}
POST {bot}/GamesToRedeemInBackground
POST {bot}/Redeem
Now accept botNames (like all other endpoints), GenericResponse included in those responses now include Dictionary that maps previous single response to botName-response.
@JustArchiNET/asf-ui if you're not doing anything with the inner result of generic response, you don't need to do anything. If you do, please map your previous single inner result to dictionary of botName-single result. Functionality remains the same, thanks.
343 lines
17 KiB
C#
343 lines
17 KiB
C#
// _ _ _ ____ _ _____
|
|
// / \ _ __ ___ | |__ (_)/ ___| | |_ ___ __ _ _ __ ___ | ___|__ _ _ __ _ __ ___
|
|
// / _ \ | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_ / _` || '__|| '_ ` _ \
|
|
// / ___ \ | | | (__ | | | || | ___) || |_| __/| (_| || | | | | || _|| (_| || | | | | | | |
|
|
// /_/ \_\|_| \___||_| |_||_||____/ \__|\___| \__,_||_| |_| |_||_| \__,_||_| |_| |_| |_|
|
|
//
|
|
// Copyright 2015-2018 Ł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.Collections.Specialized;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Threading.Tasks;
|
|
using ArchiSteamFarm.IPC.Requests;
|
|
using ArchiSteamFarm.IPC.Responses;
|
|
using ArchiSteamFarm.Localization;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
|
|
namespace ArchiSteamFarm.IPC.Controllers.Api {
|
|
[Route("Api/Bot")]
|
|
public sealed class BotController : ArchiController {
|
|
/// <summary>
|
|
/// Deletes all files related to given bots.
|
|
/// </summary>
|
|
[HttpDelete("{botNames:required}")]
|
|
[ProducesResponseType(typeof(GenericResponse), 200)]
|
|
public async Task<ActionResult<GenericResponse>> BotDelete(string botNames) {
|
|
if (string.IsNullOrEmpty(botNames)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames));
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IList<bool> results = await Utilities.InParallel(bots.Select(bot => bot.DeleteAllRelatedFiles())).ConfigureAwait(false);
|
|
return Ok(new GenericResponse(results.All(result => result)));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Fetches common info related to given bots.
|
|
/// </summary>
|
|
[HttpGet("{botNames:required}")]
|
|
[ProducesResponseType(typeof(GenericResponse<IReadOnlyDictionary<string, Bot>>), 200)]
|
|
public ActionResult<GenericResponse<IReadOnlyDictionary<string, Bot>>> BotGet(string botNames) {
|
|
if (string.IsNullOrEmpty(botNames)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames));
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, Bot>>(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if (bots == null) {
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, Bot>>(false, string.Format(Strings.ErrorIsInvalid, nameof(bots))));
|
|
}
|
|
|
|
return Ok(new GenericResponse<IReadOnlyDictionary<string, Bot>>(bots.ToDictionary(bot => bot.BotName, bot => bot)));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Updates bot config of given bot.
|
|
/// </summary>
|
|
[Consumes("application/json")]
|
|
[HttpPost("{botNames:required}")]
|
|
[ProducesResponseType(typeof(GenericResponse<IReadOnlyDictionary<string, bool>>), 200)]
|
|
public async Task<ActionResult<GenericResponse<IReadOnlyDictionary<string, bool>>>> BotPost(string botNames, [FromBody] BotRequest request) {
|
|
if (string.IsNullOrEmpty(botNames) || (request == null)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames) + " || " + nameof(request));
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, bool>>(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames) + " || " + nameof(request))));
|
|
}
|
|
|
|
(bool valid, string errorMessage) = request.BotConfig.CheckValidation();
|
|
if (!valid) {
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, bool>>(false, errorMessage));
|
|
}
|
|
|
|
request.BotConfig.ShouldSerializeEverything = false;
|
|
request.BotConfig.ShouldSerializeHelperProperties = false;
|
|
|
|
string originalSteamLogin = request.BotConfig.SteamLogin;
|
|
string originalDecryptedSteamPassword = request.BotConfig.DecryptedSteamPassword;
|
|
string originalSteamParentalCode = request.BotConfig.SteamParentalCode;
|
|
|
|
HashSet<string> bots = botNames.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Where(botName => botName != SharedInfo.ASF).ToHashSet();
|
|
|
|
Dictionary<string, bool> result = new Dictionary<string, bool>(bots.Count);
|
|
|
|
foreach (string botName in bots) {
|
|
bool botExists = Bot.Bots.TryGetValue(botName, out Bot bot);
|
|
|
|
if (botExists) {
|
|
if (!request.BotConfig.IsSteamLoginSet && bot.BotConfig.IsSteamLoginSet) {
|
|
request.BotConfig.SteamLogin = bot.BotConfig.SteamLogin;
|
|
}
|
|
|
|
if (!request.BotConfig.IsSteamPasswordSet && bot.BotConfig.IsSteamPasswordSet) {
|
|
request.BotConfig.DecryptedSteamPassword = bot.BotConfig.DecryptedSteamPassword;
|
|
}
|
|
|
|
if (!request.BotConfig.IsSteamParentalCodeSet && bot.BotConfig.IsSteamParentalCodeSet) {
|
|
request.BotConfig.SteamParentalCode = bot.BotConfig.SteamParentalCode;
|
|
}
|
|
}
|
|
|
|
string filePath = Path.Combine(SharedInfo.ConfigDirectory, botName + SharedInfo.ConfigExtension);
|
|
result[botName] = await BotConfig.Write(filePath, request.BotConfig).ConfigureAwait(false);
|
|
|
|
if (botExists) {
|
|
request.BotConfig.SteamLogin = originalSteamLogin;
|
|
request.BotConfig.DecryptedSteamPassword = originalDecryptedSteamPassword;
|
|
request.BotConfig.SteamParentalCode = originalSteamParentalCode;
|
|
}
|
|
}
|
|
|
|
return Ok(new GenericResponse<IReadOnlyDictionary<string, bool>>(result.Values.All(value => value), result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Removes BGR output files of given bots.
|
|
/// </summary>
|
|
[HttpDelete("{botNames:required}/GamesToRedeemInBackground")]
|
|
[ProducesResponseType(typeof(GenericResponse), 200)]
|
|
public async Task<ActionResult<GenericResponse>> GamesToRedeemInBackgroundDelete(string botNames) {
|
|
if (string.IsNullOrEmpty(botNames)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames));
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IList<bool> results = await Utilities.InParallel(bots.Select(bot => Task.Run(bot.DeleteRedeemedKeysFiles))).ConfigureAwait(false);
|
|
return Ok(results.All(result => result) ? new GenericResponse(true) : new GenericResponse(false, Strings.WarningFailed));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Fetches BGR output files of given bots.
|
|
/// </summary>
|
|
[HttpGet("{botNames:required}/GamesToRedeemInBackground")]
|
|
[ProducesResponseType(typeof(GenericResponse<IReadOnlyDictionary<string, GamesToRedeemInBackgroundResponse>>), 200)]
|
|
public async Task<ActionResult<GenericResponse<IReadOnlyDictionary<string, GamesToRedeemInBackgroundResponse>>>> GamesToRedeemInBackgroundGet(string botNames) {
|
|
if (string.IsNullOrEmpty(botNames)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames));
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, GamesToRedeemInBackgroundResponse>>(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, GamesToRedeemInBackgroundResponse>>(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IList<(Dictionary<string, string> UnusedKeys, Dictionary<string, string> UsedKeys)> results = await Utilities.InParallel(bots.Select(bot => bot.GetUsedAndUnusedKeys())).ConfigureAwait(false);
|
|
|
|
Dictionary<string, GamesToRedeemInBackgroundResponse> result = new Dictionary<string, GamesToRedeemInBackgroundResponse>(bots.Count);
|
|
|
|
foreach (Bot bot in bots) {
|
|
(Dictionary<string, string> unusedKeys, Dictionary<string, string> usedKeys) = results[result.Count];
|
|
result[bot.BotName] = new GamesToRedeemInBackgroundResponse(unusedKeys, usedKeys);
|
|
}
|
|
|
|
return Ok(new GenericResponse<IReadOnlyDictionary<string, GamesToRedeemInBackgroundResponse>>(result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds keys to redeem using BGR to given bot.
|
|
/// </summary>
|
|
[Consumes("application/json")]
|
|
[HttpPost("{botNames:required}/GamesToRedeemInBackground")]
|
|
[ProducesResponseType(typeof(GenericResponse<IReadOnlyDictionary<string, IOrderedDictionary>>), 200)]
|
|
public async Task<ActionResult<GenericResponse<IReadOnlyDictionary<string, IOrderedDictionary>>>> GamesToRedeemInBackgroundPost(string botNames, [FromBody] BotGamesToRedeemInBackgroundRequest request) {
|
|
if (string.IsNullOrEmpty(botNames) || (request == null)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames) + " || " + nameof(request));
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, IOrderedDictionary>>(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames) + " || " + nameof(request))));
|
|
}
|
|
|
|
if (request.GamesToRedeemInBackground.Count == 0) {
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, IOrderedDictionary>>(false, string.Format(Strings.ErrorIsEmpty, nameof(request.GamesToRedeemInBackground))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, IOrderedDictionary>>(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IOrderedDictionary validGamesToRedeemInBackground = Bot.ValidateGamesToRedeemInBackground(request.GamesToRedeemInBackground);
|
|
if ((validGamesToRedeemInBackground == null) || (validGamesToRedeemInBackground.Count == 0)) {
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, IOrderedDictionary>>(false, string.Format(Strings.ErrorIsEmpty, nameof(validGamesToRedeemInBackground))));
|
|
}
|
|
|
|
await Utilities.InParallel(bots.Select(bot => bot.AddGamesToRedeemInBackground(validGamesToRedeemInBackground))).ConfigureAwait(false);
|
|
|
|
Dictionary<string, IOrderedDictionary> result = new Dictionary<string, IOrderedDictionary>(bots.Count);
|
|
|
|
foreach (Bot bot in bots) {
|
|
result[bot.BotName] = validGamesToRedeemInBackground;
|
|
}
|
|
|
|
return Ok(new GenericResponse<IReadOnlyDictionary<string, IOrderedDictionary>>(result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Pauses given bots.
|
|
/// </summary>
|
|
[Consumes("application/json")]
|
|
[HttpPost("{botNames:required}/Pause")]
|
|
[ProducesResponseType(typeof(GenericResponse), 200)]
|
|
public async Task<ActionResult<GenericResponse>> PausePost(string botNames, [FromBody] BotPauseRequest request) {
|
|
if (string.IsNullOrEmpty(botNames) || (request == null)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames) + " || " + nameof(request));
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames) + " || " + nameof(request))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IList<(bool Success, string Output)> results = await Utilities.InParallel(bots.Select(bot => bot.Actions.Pause(request.Permanent, request.ResumeInSeconds))).ConfigureAwait(false);
|
|
return Ok(new GenericResponse(results.All(result => result.Success), string.Join(Environment.NewLine, results.Select(result => result.Output))));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Redeems cd-keys on given bot.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Response contains a map that maps each provided cd-key to its redeem result.
|
|
/// Redeem result can be a null value, this means that ASF didn't even attempt to send a request (e.g. because of bot not being connected to Steam network).
|
|
/// </remarks>
|
|
[Consumes("application/json")]
|
|
[HttpPost("{botNames:required}/Redeem")]
|
|
[ProducesResponseType(typeof(GenericResponse<IReadOnlyDictionary<string, IReadOnlyDictionary<string, ArchiHandler.PurchaseResponseCallback>>>), 200)]
|
|
public async Task<ActionResult<GenericResponse<IReadOnlyDictionary<string, IReadOnlyDictionary<string, ArchiHandler.PurchaseResponseCallback>>>>> RedeemPost(string botNames, [FromBody] BotRedeemRequest request) {
|
|
if (string.IsNullOrEmpty(botNames) || (request == null)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames) + " || " + nameof(request));
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, IReadOnlyDictionary<string, ArchiHandler.PurchaseResponseCallback>>>(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames) + " || " + nameof(request))));
|
|
}
|
|
|
|
if (request.KeysToRedeem.Count == 0) {
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, IReadOnlyDictionary<string, ArchiHandler.PurchaseResponseCallback>>>(false, string.Format(Strings.ErrorIsEmpty, nameof(request.KeysToRedeem))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse<IReadOnlyDictionary<string, IReadOnlyDictionary<string, ArchiHandler.PurchaseResponseCallback>>>(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IList<ArchiHandler.PurchaseResponseCallback> results = await Utilities.InParallel(bots.Select(bot => request.KeysToRedeem.Select(key => bot.Actions.RedeemKey(key))).SelectMany(task => task)).ConfigureAwait(false);
|
|
|
|
Dictionary<string, IReadOnlyDictionary<string, ArchiHandler.PurchaseResponseCallback>> result = new Dictionary<string, IReadOnlyDictionary<string, ArchiHandler.PurchaseResponseCallback>>(bots.Count);
|
|
|
|
int count = 0;
|
|
|
|
foreach (Bot bot in bots) {
|
|
Dictionary<string, ArchiHandler.PurchaseResponseCallback> responses = new Dictionary<string, ArchiHandler.PurchaseResponseCallback>(request.KeysToRedeem.Count);
|
|
result[bot.BotName] = responses;
|
|
|
|
foreach (string key in request.KeysToRedeem) {
|
|
responses[key] = results[count++];
|
|
}
|
|
}
|
|
|
|
return Ok(new GenericResponse<IReadOnlyDictionary<string, IReadOnlyDictionary<string, ArchiHandler.PurchaseResponseCallback>>>(result.Values.SelectMany(responses => responses.Values).All(value => value != null), result));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Resumes given bots.
|
|
/// </summary>
|
|
[HttpPost("{botNames:required}/Resume")]
|
|
[ProducesResponseType(typeof(GenericResponse), 200)]
|
|
public async Task<ActionResult<GenericResponse>> ResumePost(string botNames) {
|
|
if (string.IsNullOrEmpty(botNames)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames));
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IList<(bool Success, string Output)> results = await Utilities.InParallel(bots.Select(bot => Task.Run(bot.Actions.Resume))).ConfigureAwait(false);
|
|
return Ok(new GenericResponse(results.All(result => result.Success), string.Join(Environment.NewLine, results.Select(result => result.Output))));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Starts given bots.
|
|
/// </summary>
|
|
[HttpPost("{botNames:required}/Start")]
|
|
[ProducesResponseType(typeof(GenericResponse), 200)]
|
|
public async Task<ActionResult<GenericResponse>> StartPost(string botNames) {
|
|
if (string.IsNullOrEmpty(botNames)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames));
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IList<(bool Success, string Output)> results = await Utilities.InParallel(bots.Select(bot => Task.Run(bot.Actions.Start))).ConfigureAwait(false);
|
|
return Ok(new GenericResponse(results.All(result => result.Success), string.Join(Environment.NewLine, results.Select(result => result.Output))));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Stops given bots.
|
|
/// </summary>
|
|
[HttpPost("{botNames:required}/Stop")]
|
|
[ProducesResponseType(typeof(GenericResponse), 200)]
|
|
public async Task<ActionResult<GenericResponse>> StopPost(string botNames) {
|
|
if (string.IsNullOrEmpty(botNames)) {
|
|
ASF.ArchiLogger.LogNullError(nameof(botNames));
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.ErrorIsEmpty, nameof(botNames))));
|
|
}
|
|
|
|
HashSet<Bot> bots = Bot.GetBots(botNames);
|
|
if ((bots == null) || (bots.Count == 0)) {
|
|
return BadRequest(new GenericResponse(false, string.Format(Strings.BotNotFound, botNames)));
|
|
}
|
|
|
|
IList<(bool Success, string Output)> results = await Utilities.InParallel(bots.Select(bot => Task.Run(bot.Actions.Stop))).ConfigureAwait(false);
|
|
return Ok(new GenericResponse(results.All(result => result.Success), string.Join(Environment.NewLine, results.Select(result => result.Output))));
|
|
}
|
|
}
|
|
}
|