mirror of
https://github.com/JustArchiNET/ArchiSteamFarm.git
synced 2026-01-01 06:00:46 +00:00
Closes #1191
This commit is contained in:
43
ArchiSteamFarm.CustomPlugins.ExamplePlugin/CatController.cs
Normal file
43
ArchiSteamFarm.CustomPlugins.ExamplePlugin/CatController.cs
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
// _ _ _ ____ _ _____
|
||||||
|
// / \ _ __ ___ | |__ (_)/ ___| | |_ ___ __ _ _ __ ___ | ___|__ _ _ __ _ __ ___
|
||||||
|
// / _ \ | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_ / _` || '__|| '_ ` _ \
|
||||||
|
// / ___ \ | | | (__ | | | || | ___) || |_| __/| (_| || | | | | || _|| (_| || | | | | | | |
|
||||||
|
// /_/ \_\|_| \___||_| |_||_||____/ \__|\___| \__,_||_| |_| |_||_| \__,_||_| |_| |_| |_|
|
||||||
|
// |
|
||||||
|
// Copyright 2015-2019 Ł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.Net;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using ArchiSteamFarm.IPC.Controllers.Api;
|
||||||
|
using ArchiSteamFarm.IPC.Responses;
|
||||||
|
using Microsoft.AspNetCore.Mvc;
|
||||||
|
|
||||||
|
namespace ArchiSteamFarm.CustomPlugins.ExamplePlugin {
|
||||||
|
// This is an example class which shows you how you can extend ASF's API with your own custom API routes and controllers
|
||||||
|
// You're free to decide whether you want to integrate with existing ASF concepts (such as ArchiController/GenericResponse), or roll out your own
|
||||||
|
// All API controllers will be discovered during our Kestrel initialization using attributes mapping, you're also getting usual ASF goodies such as swagger documentation out of the box
|
||||||
|
[Route("/Api/Cat")]
|
||||||
|
public sealed class CatController : ArchiController {
|
||||||
|
[HttpGet]
|
||||||
|
[ProducesResponseType(typeof(GenericResponse<string>), (int) HttpStatusCode.OK)]
|
||||||
|
[ProducesResponseType(typeof(GenericResponse), (int) HttpStatusCode.ServiceUnavailable)]
|
||||||
|
public async Task<ActionResult<GenericResponse<string>>> ASFGet() {
|
||||||
|
string link = await CatAPI.GetRandomCatURL(ASF.WebBrowser).ConfigureAwait(false);
|
||||||
|
|
||||||
|
return !string.IsNullOrEmpty(link) ? Ok(new GenericResponse<string>(link)) : StatusCode((int) HttpStatusCode.ServiceUnavailable, new GenericResponse(false));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -34,10 +34,10 @@ namespace ArchiSteamFarm.IPC.Responses {
|
|||||||
[JsonProperty]
|
[JsonProperty]
|
||||||
public readonly T Result;
|
public readonly T Result;
|
||||||
|
|
||||||
internal GenericResponse(T result) : base(result != null) => Result = result;
|
public GenericResponse(T result) : base(result != null) => Result = result;
|
||||||
internal GenericResponse(bool success, string message) : base(success, message) { }
|
public GenericResponse(bool success, string message) : base(success, message) { }
|
||||||
internal GenericResponse(bool success, T result) : base(success) => Result = result;
|
public GenericResponse(bool success, T result) : base(success) => Result = result;
|
||||||
internal GenericResponse(bool success, string message, T result) : base(success, message) => Result = result;
|
public GenericResponse(bool success, string message, T result) : base(success, message) => Result = result;
|
||||||
}
|
}
|
||||||
|
|
||||||
public class GenericResponse {
|
public class GenericResponse {
|
||||||
@@ -57,7 +57,7 @@ namespace ArchiSteamFarm.IPC.Responses {
|
|||||||
[Required]
|
[Required]
|
||||||
public readonly bool Success;
|
public readonly bool Success;
|
||||||
|
|
||||||
internal GenericResponse(bool success, string message = null) {
|
public GenericResponse(bool success, string message = null) {
|
||||||
Success = success;
|
Success = success;
|
||||||
|
|
||||||
if (!string.IsNullOrEmpty(message)) {
|
if (!string.IsNullOrEmpty(message)) {
|
||||||
|
|||||||
@@ -20,8 +20,11 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
|
|
||||||
using System;
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
using System.IO;
|
using System.IO;
|
||||||
|
using System.Reflection;
|
||||||
using ArchiSteamFarm.IPC.Integration;
|
using ArchiSteamFarm.IPC.Integration;
|
||||||
|
using ArchiSteamFarm.Plugins;
|
||||||
using JetBrains.Annotations;
|
using JetBrains.Annotations;
|
||||||
using Microsoft.AspNetCore.Builder;
|
using Microsoft.AspNetCore.Builder;
|
||||||
using Microsoft.AspNetCore.Hosting;
|
using Microsoft.AspNetCore.Hosting;
|
||||||
@@ -159,6 +162,15 @@ namespace ArchiSteamFarm.IPC {
|
|||||||
// We need MVC for /Api, but we're going to use only a small subset of all available features
|
// We need MVC for /Api, but we're going to use only a small subset of all available features
|
||||||
IMvcCoreBuilder mvc = services.AddMvcCore();
|
IMvcCoreBuilder mvc = services.AddMvcCore();
|
||||||
|
|
||||||
|
// Add support for controllers declared in custom plugins
|
||||||
|
HashSet<Assembly> assemblies = Core.LoadAssemblies();
|
||||||
|
|
||||||
|
if (assemblies != null) {
|
||||||
|
foreach (Assembly assembly in assemblies) {
|
||||||
|
mvc.AddApplicationPart(assembly);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Add API explorer for swagger
|
// Add API explorer for swagger
|
||||||
mvc.AddApiExplorer();
|
mvc.AddApiExplorer();
|
||||||
|
|
||||||
|
|||||||
@@ -86,29 +86,9 @@ namespace ArchiSteamFarm.Plugins {
|
|||||||
}
|
}
|
||||||
|
|
||||||
internal static bool InitPlugins() {
|
internal static bool InitPlugins() {
|
||||||
HashSet<Assembly> assemblies = new HashSet<Assembly>();
|
HashSet<Assembly> assemblies = LoadAssemblies();
|
||||||
|
|
||||||
string pluginsPath = Path.Combine(SharedInfo.HomeDirectory, SharedInfo.PluginsDirectory);
|
if ((assemblies == null) || (assemblies.Count == 0)) {
|
||||||
|
|
||||||
if (Directory.Exists(pluginsPath)) {
|
|
||||||
HashSet<Assembly> loadedAssemblies = LoadAssembliesFrom(pluginsPath);
|
|
||||||
|
|
||||||
if ((loadedAssemblies != null) && (loadedAssemblies.Count > 0)) {
|
|
||||||
assemblies.UnionWith(loadedAssemblies);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
string customPluginsPath = Path.Combine(Directory.GetCurrentDirectory(), SharedInfo.PluginsDirectory);
|
|
||||||
|
|
||||||
if (Directory.Exists(customPluginsPath)) {
|
|
||||||
HashSet<Assembly> loadedAssemblies = LoadAssembliesFrom(customPluginsPath);
|
|
||||||
|
|
||||||
if ((loadedAssemblies != null) && (loadedAssemblies.Count > 0)) {
|
|
||||||
assemblies.UnionWith(loadedAssemblies);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (assemblies.Count == 0) {
|
|
||||||
ASF.ArchiLogger.LogGenericTrace(Strings.NothingFound);
|
ASF.ArchiLogger.LogGenericTrace(Strings.NothingFound);
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
@@ -166,6 +146,36 @@ namespace ArchiSteamFarm.Plugins {
|
|||||||
return invalidPlugins.Count == 0;
|
return invalidPlugins.Count == 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
internal static HashSet<Assembly> LoadAssemblies() {
|
||||||
|
HashSet<Assembly> assemblies = null;
|
||||||
|
|
||||||
|
string pluginsPath = Path.Combine(SharedInfo.HomeDirectory, SharedInfo.PluginsDirectory);
|
||||||
|
|
||||||
|
if (Directory.Exists(pluginsPath)) {
|
||||||
|
HashSet<Assembly> loadedAssemblies = LoadAssembliesFrom(pluginsPath);
|
||||||
|
|
||||||
|
if ((loadedAssemblies != null) && (loadedAssemblies.Count > 0)) {
|
||||||
|
assemblies = loadedAssemblies;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
string customPluginsPath = Path.Combine(Directory.GetCurrentDirectory(), SharedInfo.PluginsDirectory);
|
||||||
|
|
||||||
|
if (Directory.Exists(customPluginsPath)) {
|
||||||
|
HashSet<Assembly> loadedAssemblies = LoadAssembliesFrom(customPluginsPath);
|
||||||
|
|
||||||
|
if ((loadedAssemblies != null) && (loadedAssemblies.Count > 0)) {
|
||||||
|
if ((assemblies != null) && (assemblies.Count > 0)) {
|
||||||
|
assemblies.UnionWith(loadedAssemblies);
|
||||||
|
} else {
|
||||||
|
assemblies = loadedAssemblies;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return assemblies;
|
||||||
|
}
|
||||||
|
|
||||||
internal static async Task OnASFInitModules(IReadOnlyDictionary<string, JToken> additionalConfigProperties = null) {
|
internal static async Task OnASFInitModules(IReadOnlyDictionary<string, JToken> additionalConfigProperties = null) {
|
||||||
if ((ActivePlugins == null) || (ActivePlugins.Count == 0)) {
|
if ((ActivePlugins == null) || (ActivePlugins.Count == 0)) {
|
||||||
return;
|
return;
|
||||||
|
|||||||
Reference in New Issue
Block a user