diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..b39ed35 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,27 @@ +name: .NET Build + +on: + push: + branches: [ "main", "dev/*" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Setup .NET + uses: actions/setup-dotnet@v4 + with: + dotnet-version: 8.0.x + + - name: Restore dependencies + run: dotnet restore + + - name: Build + run: dotnet build --no-restore + + - name: Test + run: dotnet test --no-build --verbosity normal diff --git a/ApiRequest/ApiRequest.cs b/ApiRequest/ApiRequest.cs deleted file mode 100644 index abaee12..0000000 --- a/ApiRequest/ApiRequest.cs +++ /dev/null @@ -1,370 +0,0 @@ -using FrenchyApps42.Web.ApiRequest.Helpers; -using FrenchyApps42.Web.ApiRequest.Interfaces; -using FrenchyApps42.Web.ApiRequest.Structs; -using Newtonsoft.Json; -using System.Net.Http.Headers; -using System.Text; - -namespace FrenchyApps42.Web.ApiRequest -{ - public class ApiRequest : IApiRequest - { - /// - /// The HTTP client used to send requests. - /// - private readonly HttpClient _httpClient = new(); - - /// - /// Settings for JSON serialization. - /// - private readonly JsonSerializerSettings _jsonSerializerSettings = new() - { - ContractResolver = new JsonPropAttrResolver(), - Formatting = Formatting.Indented - }; - - /// - /// Gets the URL to send the request to. - /// - public string URL { get; private set; } = string.Empty; - - /// - /// Gets the HTTP method to use for the request. - /// - public HttpMethod Method { get; private set; } = HttpMethod.Get; - - /// - /// Gets the request headers. - /// - public Dictionary RequestHeaders { get; private set; } = []; - - /// - /// Gets the content headers. - /// - public Dictionary ContentHeaders { get; private set; } = []; - - /// - /// Gets the query parameters. - /// - public Dictionary QueryParams { get; private set; } = []; - - /// - /// Gets the JSON body content of the request. - /// - public object Body { get; private set; } = null; - - /// - /// Gets the binary document content of the request. - /// - public byte[] DocumentBody { get; private set; } = null; - - /// - /// Gets the name of the binary document file. - /// - public string DocumentFileName { get; private set; } = null; - - /// - /// Gets the content type of the request. - /// - public string ContentType { get; private set; } = null; - - /// - /// Default constructor. - /// - public ApiRequest() - { - } - - /// - /// Initializes a new instance of the ApiRequest class with the specified URL. - /// - /// The URL to send the request to. - public ApiRequest(string url) - { - this.URL = url; - } - - /// - /// Initializes a new instance of the ApiRequest class with the specified URL and HTTP method. - /// - /// The URL to send the request to. - /// The HTTP method to use for the request. - public ApiRequest(string url, HttpMethod method) - { - this.URL = url; - this.Method = method; - } - - /// - /// Adds a header to the request. - /// - /// The header key. - /// The header value. - /// Instance - public ApiRequest AddHeader(string key, string value) - { - this.RequestHeaders.Add(key, value); - - return this; - } - - /// - /// Adds multiple headers from a dictionary of key-value pairs to the request. - /// - /// Headers in dictionary. - /// Instance - public ApiRequest AddHeaders(Dictionary headers) - { - foreach (KeyValuePair header in headers) - { - this.RequestHeaders.Add(header.Key, header.Value); - } - - return this; - } - - /// - /// Adds a content header to the request - /// - /// The content header key. - /// The content header value. - /// Instance - public ApiRequest AddContentHeader(string key, string value) - { - this.ContentHeaders.Add(key, value); - - return this; - } - - /// - /// Adds multiple content headers from a dictionary of key-value pairs to the request. - /// - /// Content headers in dictionary. - /// Instance - public ApiRequest AddContentHeaders(Dictionary headers) - { - foreach (KeyValuePair header in headers) - { - this.ContentHeaders.Add(header.Key, header.Value); - } - - return this; - } - - /// - /// Adds a query parameter to the request. - /// - /// The query parameter key. - /// The query parameter value. - /// Instance - public ApiRequest AddQueryParam(string key, string value) - { - this.QueryParams.Add(key, value); - - return this; - } - - /// - /// Adds multiple content headers from a dictionary of key-value pairs to the request. - /// - /// Query parameters in dictionary. - /// Instance - public ApiRequest AddQueryParams(Dictionary queryParams) - { - foreach (KeyValuePair query in queryParams) - { - this.QueryParams.Add(query.Key, query.Value); - } - - return this; - } - - /// - /// Adds an "Accept" header with the value "application/json" to the request. - /// - /// Instance - public ApiRequest AcceptJson() - { - this.RequestHeaders.Add("Accept", "application/json"); - - return this; - } - - /// - /// Adds a JSON body to the request content. - /// - /// The JSON body content. - /// Instance - public ApiRequest AddJsonBody(object body) - { - this.Body = body; - - return this; - } - - /// - /// Adds a binary document to the request content. - /// - /// The binary file content. - /// The name of the file. - /// Instance - public ApiRequest AddDocumentBody(byte[] document, string fileName) - { - this.DocumentBody = document; - this.DocumentFileName = fileName; - - return this; - } - - /// - /// Sets the content type of the request. - /// - /// The content type of the request. - /// Instance - public ApiRequest SetContentType(string contentType) - { - this.ContentType = contentType; - - return this; - } - - /// - /// Executes the HTTP request with the JSON body content included. - /// - /// The type of the response expected from the request. - /// A Result object containing the response. - public async Task> RunObject() - { - HttpRequestMessage request = this.BuildBaseRequest(); - - if (this.Body != null) - { - string json = JsonConvert.SerializeObject(this.Body, _jsonSerializerSettings); - request.Content = new StringContent(json, Encoding.UTF8, "application/json"); - request.Content.Headers.ContentType = new("application/json"); - } - - Result result = await this.ProcessRequest(request); - - return result; - } - - /// - /// Executes the HTTP request with the binary document content included. - /// - /// The type of the response expected from the request. - /// A Result object containing the response. - public async Task> RunDocument() - { - HttpRequestMessage request = this.BuildBaseRequest(); - - if (this.DocumentBody == null) - { - return new Result() - { - Error = "Document cannot be null", - StatusCode = 500, - }; - } - - MultipartFormDataContent content = new(); - ByteArrayContent fileContent = new(this.DocumentBody); - - fileContent.Headers.ContentDisposition = new ContentDispositionHeaderValue("binary") - { - Name = "file", - FileName = this.DocumentFileName - }; - - content.Add(fileContent); - - request.Content = content; - request.Content.Headers.ContentType = new(this.ContentType); - - Result result = await this.ProcessRequest(request); - - return result; - } - - /// - /// Constructs the URL for the request, including any query parameters if present. - /// - /// Request URL with added query parameters. - private string BuildUrl() - { - StringBuilder builder = new(this.URL); - string fullUrl = this.URL; - - if (fullUrl.EndsWith("/")) - builder.Remove(fullUrl.Length - 1, 1); - - if (this.QueryParams.Count() > 0) - { - builder.Append("?"); - - for (int i = 0; i < this.QueryParams.Count(); i++) - { - KeyValuePair query = this.QueryParams.ElementAt(i); - builder.Append($"{query.Key}={query.Value}"); - - if (!(i == this.QueryParams.Count() - 1)) - builder.Append("&"); - } - } - - return builder.ToString(); - } - - /// - /// Constructs the base HTTP request message by adding the specified headers. - /// - /// Base request message. - private HttpRequestMessage BuildBaseRequest() - { - HttpRequestMessage request = new(this.Method, this.BuildUrl()); - - for (int i = 0; i < this.RequestHeaders.Count(); i++) - { - KeyValuePair header = this.RequestHeaders.ElementAt(i); - request.Headers.Add(header.Key, header.Value); - } - - return request; - } - - /// - /// Executes the HTTP request and processes the response. - /// - /// The type of the response expected from the request. - /// The prepared HTTP request message. - /// A Result object containing the response. - private async Task> ProcessRequest(HttpRequestMessage request) - { - HttpResponseMessage response; - Result result = new(); - - try - { - response = await this._httpClient.SendAsync(request); - result.StatusCode = (int)response.StatusCode; - - if (response.IsSuccessStatusCode) - { - Stream ContentResponse = await response.Content?.ReadAsStreamAsync(); - result.Value = await System.Text.Json.JsonSerializer.DeserializeAsync(ContentResponse); - } - else - { - result.Error = await response.Content.ReadAsStringAsync(); - } - } - catch (Exception ex) - { - result.StatusCode = 500; - result.Error = ex.Message; - } - - return result; - } - } -} diff --git a/ApiRequest/ApiRequest.csproj b/ApiRequest/ApiRequest.csproj deleted file mode 100644 index bd357cc..0000000 --- a/ApiRequest/ApiRequest.csproj +++ /dev/null @@ -1,29 +0,0 @@ - - - - net8.0 - enable - enable - FrenchyApps42.Web.$(MSBuildProjectName.Replace(" ", "_")) - True - ApiRequest - AnthoDingo, Sikelio - FrenchyApps42 - README.md - https://github.com/FrApp42/Tools - git - https://github.com/FrApp42/Tools - - - - - - - - - True - \ - - - - diff --git a/ApiRequest/Helpers/JsonPropAttrResolver.cs b/ApiRequest/Helpers/JsonPropAttrResolver.cs deleted file mode 100644 index 2057cbb..0000000 --- a/ApiRequest/Helpers/JsonPropAttrResolver.cs +++ /dev/null @@ -1,36 +0,0 @@ -using Newtonsoft.Json; -using Newtonsoft.Json.Serialization; -using System.Reflection; -using System.Text.Json.Serialization; - -namespace FrenchyApps42.Web.ApiRequest.Helpers -{ - public class JsonPropAttrResolver : DefaultContractResolver - { - protected override IList CreateProperties(Type type, MemberSerialization memberSerialization) - { - IList props = base.CreateProperties(type, memberSerialization); - - foreach (JsonProperty prop in props) - { - if (prop.UnderlyingName == null) - continue; - - PropertyInfo? propInfo = type - .GetProperty(prop.UnderlyingName, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance); - - if (propInfo != null) - { - JsonPropertyNameAttribute? jsonPropertyName = propInfo.GetCustomAttribute(); - - if (jsonPropertyName != null) - { - prop.PropertyName = jsonPropertyName.Name; - } - } - } - - return props; - } - } -} diff --git a/ApiRequest/Interfaces/IApiRequest.cs b/ApiRequest/Interfaces/IApiRequest.cs deleted file mode 100644 index 833388d..0000000 --- a/ApiRequest/Interfaces/IApiRequest.cs +++ /dev/null @@ -1,17 +0,0 @@ -namespace FrenchyApps42.Web.ApiRequest.Interfaces -{ - public interface IApiRequest - { - string URL { get; } - HttpMethod Method { get; } - - Dictionary RequestHeaders { get; } - Dictionary ContentHeaders { get; } - Dictionary QueryParams { get; } - - object Body { get; } - byte[] DocumentBody { get; } - string DocumentFileName { get; } - string ContentType { get; } - } -} diff --git a/ApiRequest/README.md b/ApiRequest/README.md deleted file mode 100644 index 3aa203f..0000000 --- a/ApiRequest/README.md +++ /dev/null @@ -1,124 +0,0 @@ -# ApiRequest - -## About - -This classes helps you making call to APIs - -Authors: -* [AnthoDingo](https://github.com/AnthoDingo) - Initiator by taking inspiration from the dev community -* [Sikelio](https://github.com/Sikelio) - Contributor - -## Usage -### Simple request -```cs -using FrenchyApps42.Web.ApiRequest.Structs; -using FrenchyApps42.Web.ApiRequest; -using Program.Models; - -namespace Program -{ - public class Program - { - public static async Task Main() - { - string url = ""; // <-- Your API url - HttpMethod method = HttpMethod.Get; // <-- Your method. Default is Get - - ApiRequest request = new(url, method); - request - .AddContentHeader("", "") // <-- Any content header (optional) - .AddHeader("", "") // <-- Any header (optional) - .AddJsonBody("") // <-- Any json body (optional) - .AddQueryParam("", "") // <-- Any query parameter (optional) - .AcceptJson(); // <-- Adds "Accept", "application/json" in the headers (optional) - - Result result = await request.Run(); - - if (result.StatusCode == 200) // <-- Depends of the status code your waiting for - { - // If your request succeded - } - else - { - // Other cases - } - } - } -} -``` - -```cs -using System.Text.Json.Serialization; - -namespace Program.Models -{ - public class SomeModel - { - [JsonPropertyName("id")] - public int Id { get; set; } - - [JsonPropertyName("name")] - public string Name { get; set; } = string.Empty; - - [JsonPropertyName("email")] - public string Email { get; set; } = string.Empty; - } -} -``` - -## Advanced usage -### Sending binary file - -```cs -using FrenchyApps42.Web.ApiRequest.Structs; -using FrenchyApps42.Web.ApiRequest; -using Program.Models; - -namespace Program -{ - public class Program - { - public static async Task Main() - { - string url = ""; - string filePath = "path_to_your_file.ext"; - - if (File.Exists(filePath)) // <-- Check if your file exist at the specified path - { - try - { - byte[] fileBytes = File.ReadAllBytes(filePath); // <-- Convert your file into byte[] - - ApiRequest request = new(url, HttpMethod.Post); - request - .SetContentType("application/type") // <-- Set your content type - .AddDocumentBody(fileBytes, "your_file_name.ext"); // <-- Add your file in byte[] format with it's name - - Result result = await request.RunDocument(); - } - catch (Exception ex) - { - Console.WriteLine(ex.Message); - } - } - else - { - Console.WriteLine("File do not exist"); - } - } - } -} -``` - -```cs -using System.Text.Json.Serialization; - -namespace Program.Models -{ - public class FileModel - { - [JsonPropertyName("success")] - public bool Success { get; set; } - } -} -``` diff --git a/ApiRequest/Structs/Result.cs b/ApiRequest/Structs/Result.cs deleted file mode 100644 index 3c050eb..0000000 --- a/ApiRequest/Structs/Result.cs +++ /dev/null @@ -1,16 +0,0 @@ -namespace FrenchyApps42.Web.ApiRequest.Structs -{ - public struct Result - { - public int StatusCode; - public T? Value; - public string? Error; - - public Result(int statusCode, T value, string error = "") - { - this.StatusCode = statusCode; - this.Value = value; - this.Error = error; - } - } -} diff --git a/Shutdowner/LICENCE.md b/LICENCE.md similarity index 100% rename from Shutdowner/LICENCE.md rename to LICENCE.md diff --git a/README.md b/README.md index bcf07f9..2fe592c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,21 @@ -# Frenchy Apps 42 Tools +# Frenchy Apps 42 - Tools This repos contains tool classes in C# for multiple types of usage. -## Available classes +## Available tools -* [ApiRequest](https://github.com/FrApp42/Tools/tree/main/ApiRequest) -* [Shutdowner](https://github.com/FrApp42/Tools/tree/main/Shutdowner) - [GPLv3](https://github.com/FrApp42/Tools/blob/main/Shutdowner/LICENCE.md) -* [WakeOnLan](https://github.com/FrApp42/Tools/tree/main/WakeOnLan) - [GPLv3](https://github.com/FrApp42/Tools/blob/main/WakeOnLan/LICENCE.md) +* Request + * Makes API requests + * Namespace: `FrApps42.Web.API` + +* IsOnline + * Checks if a device is online + * Namespace: `FrApps42.System.Net` + +* Shutdown + * Shutdowns a device with SMB + * Namespace: `FrApps42.System.Computer.Shutdown` + +* WakeOnLan + * Waked up a device from it's MAC address + * Namespace: `FrApps42.System.Net` diff --git a/Shutdowner/Helpers/ShutdownArgs.cs b/Shutdowner/Helpers/ShutdownArgs.cs deleted file mode 100644 index 1f80bd9..0000000 --- a/Shutdowner/Helpers/ShutdownArgs.cs +++ /dev/null @@ -1,18 +0,0 @@ -namespace FrenchyApps42.System.Shutdowner.Helpers -{ - public class ShutdownArgs - { - public const string BaseCommand = "/c shutdown"; - public const string LogoutArg = "/l"; - public const string ShutdownArg = "/s"; - public const string ShutdownAndSignOnArg = "/sg"; - public const string RebootArg = "/r"; - public const string HibernateArg = "/h"; - public const string SoftArg = "/soft"; - public const string BootOptionsArg = "/o"; - public const string ForceArg = "/f"; - public const string MachineArg = "/m"; - public const string TimeoutArg = "/t"; - public const string CommentArg = "/c"; - } -} diff --git a/Shutdowner/Models/CommandResult.cs b/Shutdowner/Models/CommandResult.cs deleted file mode 100644 index ead549e..0000000 --- a/Shutdowner/Models/CommandResult.cs +++ /dev/null @@ -1,9 +0,0 @@ -namespace FrenchyApps42.System.Shutdowner.Models -{ - public class CommandResult - { - public int ExitCode { get; set; } - - public string? ErrorMessage { get; set; } - } -} diff --git a/Shutdowner/README.md b/Shutdowner/README.md deleted file mode 100644 index 33d5db8..0000000 --- a/Shutdowner/README.md +++ /dev/null @@ -1,178 +0,0 @@ -# Shutdowner - -## About - -Shutdowner is a class that sends a command to shutdown a computer with its hostname or perform various other shutdown-related operations. - -Authors: -* [Sikelio](https://github.com/Sikelio) - -## Features - -* Log off the current user -* Shutdown the computer -* Shutdown and sign on automatically -* Reboot after shutdown -* Hibernate the computer -* Perform a soft shutdown -* Open advanced boot options -* Force shutdown -* Specify target computer by hostname -* Set a timeout for the shutdown -* Add a custom reason for the shutdown -* Ping before running command - -## Usage - -```cs -using FrenchyApps42.System.Shutdowner; - -namespace Program -{ - public class Program - { - public static async Task Main() - { - string hostname = "your-computer-name"; // <-- the hostname of the machine you want to shutdown. - - Shutdowner shutdowner = new(); - shutdowner - .SetMachine(hostname) - .ShutdownComputer(); - - CommandResult result = await shutdowner.Run(); - - if (result.ExitCode == 0) - { - Console.WriteLine("Shutdown command executed successfully."); - } - else - { - Console.WriteLine($"Shutdown command failed with exit code {result.ExitCode}. Error: {result.ErrorMessage}"); - } - } - } -} -``` - -## Advanced Usage -### Ping before shutdown -```cs -using FrenchyApps42.System.Shutdowner; - -namespace Program -{ - public class Program - { - public static async Task Main() - { - Shutdowner shutdowner = new(); - shutdowner - .PingBefore(5); // <-- Timeout of the ping - - CommandResult result = await shutdowner.Run(); - - if (result.ExitCode == 0) - { - Console.WriteLine("Shutdown command executed successfully."); - } - else - { - Console.WriteLine($"Shutdown command failed with exit code {result.ExitCode}. Error: {result.ErrorMessage}"); - } - } - } -} -``` - -### Log off the current user -```cs -using FrenchyApps42.System.Shutdowner; - -namespace Program -{ - public class Program - { - public static async Task Main() - { - Shutdowner shutdowner = new(); - shutdowner - .LogoutUser(); - - CommandResult result = await shutdowner.Run(); - - if (result.ExitCode == 0) - { - Console.WriteLine("Shutdown command executed successfully."); - } - else - { - Console.WriteLine($"Shutdown command failed with exit code {result.ExitCode}. Error: {result.ErrorMessage}"); - } - } - } -} -``` - -### Shutdown and sign on automatically -```cs -using FrenchyApps42.System.Shutdowner; - -namespace Program -{ - public class Program - { - public static async Task Main() - { - Shutdowner shutdowner = new(); - shutdowner - .ShutdownAndSignOn(); - - CommandResult result = await shutdowner.Run(); - - if (result.ExitCode == 0) - { - Console.WriteLine("Shutdown command executed successfully."); - } - else - { - Console.WriteLine($"Shutdown command failed with exit code {result.ExitCode}. Error: {result.ErrorMessage}"); - } - } - } -} -``` - -### Set a timeout and add a custom reason for the shutdown -```cs -using FrenchyApps42.System.Shutdowner; - -namespace Program -{ - public class Program - { - public static async Task Main() - { - Shutdowner shutdowner = new(); - shutdowner - .SetTimeOut(60) // Set timeout to 60 seconds - .SetComment("Scheduled maintenance"); // Max 512 characters - - CommandResult result = await shutdowner.Run(); - - if (result.ExitCode == 0) - { - Console.WriteLine("Shutdown command executed successfully."); - } - else - { - Console.WriteLine($"Shutdown command failed with exit code {result.ExitCode}. Error: {result.ErrorMessage}"); - } - } - } -} -``` - -## License - -This project is licensed under the GPLv3 License - see the [LICENSE](./LICENCE.md) file for details. diff --git a/Shutdowner/Shutdowner.cs b/Shutdowner/Shutdowner.cs deleted file mode 100644 index e117c59..0000000 --- a/Shutdowner/Shutdowner.cs +++ /dev/null @@ -1,293 +0,0 @@ -using FrenchyApps42.System.Shutdowner.Helpers; -using FrenchyApps42.System.Shutdowner.Models; -using System.Diagnostics; -using System.Net.NetworkInformation; -using System.Text; - -namespace FrenchyApps42.System.Shutdowner -{ - public class Shutdowner - { - /// - /// StringBuilder instance used to build the shutdown command. - /// - private readonly StringBuilder _commandBuilder; - - /// - /// Machine hostname. - /// - private string Hostname = ""; - - /// - /// Will the machine be pinged before shutdowning it? - /// - private bool PingEnabled = false; - - /// - /// Timeout of machine ping. - /// - private int PingTimeout = 5; - - /// - /// Default constructor - /// - public Shutdowner() - { - this._commandBuilder = new StringBuilder(ShutdownArgs.BaseCommand); - } - - /// - /// Adds a shutdown argument to the command if it is not already present. - /// - /// The argument to add. - /// Optional value associated with the argument. - private void AddArgument(string arg, string value = "") - { - string currentCommand = this._commandBuilder.ToString(); - - // Prevent adding /l if /m or /t is already present - if (arg == ShutdownArgs.LogoutArg && (currentCommand.Contains(ShutdownArgs.MachineArg) || currentCommand.Contains(ShutdownArgs.TimeoutArg))) - return; - - // Prevent adding /m or /t if /l is already present - if ((arg == ShutdownArgs.MachineArg || arg == ShutdownArgs.TimeoutArg) && currentCommand.Contains(ShutdownArgs.LogoutArg)) - return; - - if (!this._commandBuilder.ToString().Contains(arg)) - { - if (string.IsNullOrEmpty(value)) - { - this._commandBuilder.Append($" {arg}"); - } - else - { - this._commandBuilder.Append($" {arg} {value}"); - } - } - } - - /// - /// Logs off the current user immediately, with no time-out period. - /// Can't be used with SetMachine and/or SetTimeOut options. - /// - /// Instance - public Shutdowner LogoutUser() - { - AddArgument(ShutdownArgs.LogoutArg); - return this; - } - - /// - /// Shuts down the computer. - /// - /// Instance - public Shutdowner ShutdownComputer() - { - this.AddArgument(ShutdownArgs.ShutdownArg); - return this; - } - - /// - /// Shuts down the computer. On the next boot, if Automatic Restart Sign-On is enabled, - /// the device automatically signs in and locks based on the last interactive user. - /// After sign in, it restarts any registered applications. - /// - /// Instance - public Shutdowner ShutdownAndSignOn() - { - this.AddArgument(ShutdownArgs.ShutdownAndSignOnArg); - return this; - } - - /// - /// Restarts the computer after shutdown. - /// - /// Instance - public Shutdowner RebootAfterShutdown() - { - this.AddArgument(ShutdownArgs.RebootArg); - return this; - } - - /// - /// Puts the local computer into hibernation, if hibernation is enabled. - /// The ForceShutdown option can be used with the Hibernate option. - /// - /// Instance - public Shutdowner Hibernate() - { - this.AddArgument(ShutdownArgs.HibernateArg); - return this; - } - - /// - /// Allows running processes and applications to gracefully close instead of forcibly terminating. - /// - /// Instance - public Shutdowner Soft() - { - this.AddArgument(ShutdownArgs.SoftArg); - return this; - } - - /// - /// Goes to the Advanced boot options menu and restarts the device. - /// This option must be used with the /r option. - /// - /// Instance - public Shutdowner OpenBootOptions() - { - this.AddArgument(ShutdownArgs.BootOptionsArg); - return this; - } - - /// - /// Forces running applications to close without warning users. - /// - /// - public Shutdowner ForceShutdown() - { - this.AddArgument(ShutdownArgs.ForceArg); - return this; - } - - /// - /// Specifies the target computer. - /// Can't be used with LogoutUser option. - /// - /// Machine hostname - /// Instance - public Shutdowner SetMachine(string machineName) - { - this.Hostname = machineName; - this.AddArgument(ShutdownArgs.MachineArg, machineName); - return this; - } - - /// - /// Sets the timeout period for the shutdown command. Min = 0, Max = 315360000 (10 years) - /// Can't be used with LogoutUser option. - /// - /// Timeout period in seconds - /// Instance - public Shutdowner SetTimeOut(int time) - { - if (time < 0) time = 0; - if (time > 315360000) time = 315360000; - - this.AddArgument(ShutdownArgs.TimeoutArg, time.ToString()); - return this; - } - - /// - /// Creates a custom reason for the system shutdown or restart, which must be enclosed. - /// You can use a maximum of 512 characters. If the comment is longer, it will be shortened to 512. - /// - /// Custom reason for shutdown, max 512 characters. - /// Instance - public Shutdowner SetComment(string comment) - { - if (comment.Length > 512) - comment = comment.Substring(0, 512); - - this.AddArgument(ShutdownArgs.CommentArg, $"\"{comment}\""); - return this; - } - - /// - /// Enables the ping before running the shutdown command. - /// - /// Timeout of ping to the machine - /// - public Shutdowner PingBefore(int timeout = 5) - { - if (timeout < 0) timeout = 0; - - this.PingEnabled = true; - this.PingTimeout = timeout; - - return this; - } - - /// - /// Runs the built shutdown command. - /// If ping is enabled, it will try to ping the machine. If the ping if unsuccesful it returns null. - /// - /// A tuple containing the exit code and an error message if an error occurred. - public async Task Run() - { - if (this.PingEnabled) - { - if (this.SendPing() == false) - return new CommandResult() - { - ErrorMessage = "Machine is unreachable.", - ExitCode = 1 - }; - } - - return await Task.Run(() => - { - ProcessStartInfo processStartInfo = new("cmd.exe", this._commandBuilder.ToString()) - { - UseShellExecute = false, - CreateNoWindow = true, - RedirectStandardError = true, - }; - - using (Process process = new() - { - StartInfo = processStartInfo - }) - { - process.Start(); - - string errorMessage = process.StandardError.ReadToEnd(); - - process.WaitForExit(); - - return new CommandResult() - { - ExitCode = process.ExitCode, - ErrorMessage = string.IsNullOrEmpty(errorMessage) ? null : errorMessage - }; - } - }); - } - - /// - /// Sends a ping to the machine. - /// - /// A bool depending of the success of the ping - private bool SendPing() - { - if (string.IsNullOrEmpty(this.Hostname)) - return false; - - Ping sender = new(); - PingOptions options = new() - { - DontFragment = true, - }; - - string data = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"; - byte[] buffer = Encoding.ASCII.GetBytes(data); - - PingReply reply = sender.Send(this.Hostname, this.PingTimeout, buffer, options); - - if (reply.Status == IPStatus.Success) - return true; - - return false; - } - - /// - /// Displays the command of the current command. - /// - /// Current built command - public string Display() - { - return this._commandBuilder.ToString(); - } - } -} diff --git a/Shutdowner/Shutdowner.csproj b/Shutdowner/Shutdowner.csproj deleted file mode 100644 index 6a32a12..0000000 --- a/Shutdowner/Shutdowner.csproj +++ /dev/null @@ -1,33 +0,0 @@ - - - - net8.0 - enable - enable - FrenchyApps42.System.$(MSBuildProjectName.Replace(" ", "_")) - True - Shutdowner - Sikelio - FrenchyApps42 - https://github.com/FrApp42/Tools/tree/main/Shutdowner - README.md - https://github.com/FrApp42/Tools - git - LICENCE.md - A class that sends a command to shutdown a computer with its hostname or perform various other shutdown-related operations. - shutdown; shutdowner; smb; admin tool - True - - - - - True - \ - - - True - \ - - - - diff --git a/System/Computer/Shutdown/Helpers/ShutdownArgs.cs b/System/Computer/Shutdown/Helpers/ShutdownArgs.cs index 8122ccc..ca7da2a 100644 --- a/System/Computer/Shutdown/Helpers/ShutdownArgs.cs +++ b/System/Computer/Shutdown/Helpers/ShutdownArgs.cs @@ -1,4 +1,4 @@ -namespace FrApps42.System.Computer.Shutdown.Helpers +namespace FrApp42.System.Computer.Shutdown.Helpers { internal sealed class ShutdownArgs { diff --git a/System/Computer/Shutdown/Models/ShutdownResult.cs b/System/Computer/Shutdown/Models/ShutdownResult.cs index 2ffea19..0215e77 100644 --- a/System/Computer/Shutdown/Models/ShutdownResult.cs +++ b/System/Computer/Shutdown/Models/ShutdownResult.cs @@ -1,4 +1,4 @@ -namespace FrApps42.System.Computer.Shutdown +namespace FrApp42.System.Computer.Shutdown { public class ShutdownResult { diff --git a/System/Computer/Shutdown/Shutdown.cs b/System/Computer/Shutdown/Shutdown.cs index 23a511c..b10ae06 100644 --- a/System/Computer/Shutdown/Shutdown.cs +++ b/System/Computer/Shutdown/Shutdown.cs @@ -1,10 +1,10 @@ -using FrApps42.System.Computer.Shutdown.Helpers; -using FrApps42.System.Net; +using FrApp42.System.Computer.Shutdown.Helpers; +using FrApp42.System.Net; using System.Diagnostics; using System.Net; using System.Text; -namespace FrApps42.System.Computer.Shutdown +namespace FrApp42.System.Computer.Shutdown { public partial class Shutdown { @@ -42,7 +42,6 @@ public Shutdown() /// public Shutdown(string hostname): this() { - SetMachine(hostname); } @@ -59,7 +58,7 @@ public Shutdown(IPAddress address) : this(address.ToString()) { } /// Optional value associated with the argument. private void AddArgument(string arg, string value = "") { - string currentCommand = this._commandBuilder.ToString(); + string currentCommand = _commandBuilder.ToString(); // Prevent adding /l if /m or /t is already present if (arg == ShutdownArgs.LogoutArg && (currentCommand.Contains(ShutdownArgs.MachineArg) || currentCommand.Contains(ShutdownArgs.TimeoutArg))) @@ -69,15 +68,15 @@ private void AddArgument(string arg, string value = "") if ((arg == ShutdownArgs.MachineArg || arg == ShutdownArgs.TimeoutArg) && currentCommand.Contains(ShutdownArgs.LogoutArg)) return; - if (!this._commandBuilder.ToString().Contains(arg)) + if (!_commandBuilder.ToString().Contains(arg)) { if (string.IsNullOrEmpty(value)) { - this._commandBuilder.Append($" {arg}"); + _commandBuilder.Append($" {arg}"); } else { - this._commandBuilder.Append($" {arg} {value}"); + _commandBuilder.Append($" {arg} {value}"); } } } @@ -88,7 +87,7 @@ private void AddArgument(string arg, string value = "") /// Current built command public string GetCommand() { - return this._commandBuilder.ToString(); + return _commandBuilder.ToString(); } /// @@ -108,7 +107,7 @@ public Shutdown LogoutUser() /// Instance public Shutdown ShutdownComputer() { - this.AddArgument(ShutdownArgs.ShutdownArg); + AddArgument(ShutdownArgs.ShutdownArg); return this; } @@ -120,7 +119,7 @@ public Shutdown ShutdownComputer() /// Instance public Shutdown ShutdownAndSignOn() { - this.AddArgument(ShutdownArgs.ShutdownAndSignOnArg); + AddArgument(ShutdownArgs.ShutdownAndSignOnArg); return this; } @@ -130,7 +129,7 @@ public Shutdown ShutdownAndSignOn() /// Instance public Shutdown Reboot() { - this.AddArgument(ShutdownArgs.RebootArg); + AddArgument(ShutdownArgs.RebootArg); return this; } @@ -141,7 +140,7 @@ public Shutdown Reboot() /// Instance public Shutdown Hibernate() { - this.AddArgument(ShutdownArgs.HibernateArg); + AddArgument(ShutdownArgs.HibernateArg); return this; } @@ -151,7 +150,7 @@ public Shutdown Hibernate() /// Instance public Shutdown Soft() { - this.AddArgument(ShutdownArgs.SoftArg); + AddArgument(ShutdownArgs.SoftArg); return this; } @@ -162,7 +161,7 @@ public Shutdown Soft() /// Instance public Shutdown OpenBootOptions() { - this.AddArgument(ShutdownArgs.BootOptionsArg); + AddArgument(ShutdownArgs.BootOptionsArg); return this; } @@ -172,7 +171,7 @@ public Shutdown OpenBootOptions() /// public Shutdown ForceShutdown() { - this.AddArgument(ShutdownArgs.ForceArg); + AddArgument(ShutdownArgs.ForceArg); return this; } @@ -200,7 +199,7 @@ public Shutdown SetTimeOut(int time) if (time < 0) time = 0; if (time > 315360000) time = 315360000; - this.AddArgument(ShutdownArgs.TimeoutArg, time.ToString()); + AddArgument(ShutdownArgs.TimeoutArg, time.ToString()); return this; } @@ -215,7 +214,7 @@ public Shutdown SetComment(string comment) if (comment.Length > 512) comment = comment.Substring(0, 512); - this.AddArgument(ShutdownArgs.CommentArg, $"\"{comment}\""); + AddArgument(ShutdownArgs.CommentArg, $"\"{comment}\""); return this; } diff --git a/System/Net/IsOnline.cs b/System/Net/IsOnline.cs index d7d92d8..4dc50b1 100644 --- a/System/Net/IsOnline.cs +++ b/System/Net/IsOnline.cs @@ -2,7 +2,7 @@ using System.Net.NetworkInformation; using System.Text; -namespace FrApps42.System.Net +namespace FrApp42.System.Net { public class IsOnline { @@ -51,6 +51,5 @@ public bool Check() return true; } - } } diff --git a/System/Net/WakeOnLan.cs b/System/Net/WakeOnLan.cs index a2f0ed5..af1ed4b 100644 --- a/System/Net/WakeOnLan.cs +++ b/System/Net/WakeOnLan.cs @@ -3,7 +3,7 @@ using System.Net; using System.Text.RegularExpressions; -namespace FrApps42.System.Net +namespace FrApp42.System.Net { public partial class WakeOnLan { @@ -13,7 +13,7 @@ public partial class WakeOnLan /// The MAC address of the device to wake up. public static async Task WakeUp(string macAddress) { - byte[] magicPacket = WakeOnLan.BuildMagicPacket(macAddress); + byte[] magicPacket = BuildMagicPacket(macAddress); IEnumerable networkInterfaces = NetworkInterface .GetAllNetworkInterfaces() @@ -36,7 +36,7 @@ public static async Task WakeUp(string macAddress) if (unicastIPAddressInformation != null) { - await WakeOnLan.SendWakeOnLan(unicastIPAddressInformation.Address, multicastIpAddress, magicPacket); + await SendWakeOnLan(unicastIPAddressInformation.Address, multicastIpAddress, magicPacket); } } else if (multicastIpAddress.ToString().Equals("224.0.0.1")) @@ -49,7 +49,7 @@ public static async Task WakeUp(string macAddress) if (unicastIPAddressInformation != null) { - await WakeOnLan.SendWakeOnLan(unicastIPAddressInformation.Address, multicastIpAddress, magicPacket); + await SendWakeOnLan(unicastIPAddressInformation.Address, multicastIpAddress, magicPacket); } } } diff --git a/System/README.md b/System/README.md new file mode 100644 index 0000000..d7126f1 --- /dev/null +++ b/System/README.md @@ -0,0 +1,54 @@ +# FrApp42.System + +FrApp42.System is collection of classes for system operations: +* IsOnline +* Shutdown +* WakeOnLan + +## How to Use this Library? + +```nuget +Install-Package FrApp42.System +``` + +## Examples + +### Check if device is online + +```csharp +using namespace FrApp42.System.Net; + +string address = "your-address"; +string timeout = 5; + +IsOnline online = new(address, timeout); + +bool isOnline = online.Check(); +``` + +### Shutdown through SMB (Windows Only) + +```csharp +using namespace FrApp42.System.Computer.Shutdown; + +string hostname = "your-hostname"; + +Shutdown shutdown = new(); +shutdown + .ShutdownComputer() + .Soft() + .SetTimeOut(5) + .SetComment("Custom reason"); + +ShutdownResult shutdownResult = await shutdown.Run(); +``` + +### Wake up a computer (WOL) + +```csharp +using namespace FrApp42.System.Net; + +string macAddress = "your-mac-address"; + +await WakeOnLan.WakeUp(macAddress); +``` diff --git a/System/System.csproj b/System/System.csproj index 03b77c6..ada257e 100644 --- a/System/System.csproj +++ b/System/System.csproj @@ -4,14 +4,34 @@ net8.0 enable enable - FrApps42.$(MSBuildProjectName) - FrApps42.$(MSBuildProjectName.Replace(" ", "_")) - FrApps42 System - FrApps42 + FrApp42.$(MSBuildProjectName) + FrApp42.$(MSBuildProjectName.Replace(" ", "_")) + FrApp42 System + FrApp42 GPLv3 https://github.com/FrApp42/Tools https://github.com/FrApp42/Tools.git git + True + A collection of classes for system operations + system;tools + LICENCE.md + True + README.md + + + True + \ + + + + + + True + \ + + + diff --git a/Tools.sln b/Tools.sln index cf4e7cc..d82f748 100644 --- a/Tools.sln +++ b/Tools.sln @@ -3,15 +3,9 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.9.34728.123 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WakeOnLan", "WakeOnLan\WakeOnLan.csproj", "{F158085E-AA44-450C-B628-8F51B84063D8}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System", "System\System.csproj", "{8083ADC6-AFB3-407B-A54C-50C8E8976142}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ApiRequest", "ApiRequest\ApiRequest.csproj", "{059E59CA-1E92-4268-9518-A3B16D08990D}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Shutdowner", "Shutdowner\Shutdowner.csproj", "{6A20A86C-2EF7-4399-AC17-4B97FD5939C5}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "System", "System\System.csproj", "{8083ADC6-AFB3-407B-A54C-50C8E8976142}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Web", "Web\Web.csproj", "{3872357E-B751-4C1B-AFD7-E4883E2FBB4C}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Web", "Web\Web.csproj", "{3872357E-B751-4C1B-AFD7-E4883E2FBB4C}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -19,18 +13,6 @@ Global Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {F158085E-AA44-450C-B628-8F51B84063D8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {F158085E-AA44-450C-B628-8F51B84063D8}.Debug|Any CPU.Build.0 = Debug|Any CPU - {F158085E-AA44-450C-B628-8F51B84063D8}.Release|Any CPU.ActiveCfg = Release|Any CPU - {F158085E-AA44-450C-B628-8F51B84063D8}.Release|Any CPU.Build.0 = Release|Any CPU - {059E59CA-1E92-4268-9518-A3B16D08990D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {059E59CA-1E92-4268-9518-A3B16D08990D}.Debug|Any CPU.Build.0 = Debug|Any CPU - {059E59CA-1E92-4268-9518-A3B16D08990D}.Release|Any CPU.ActiveCfg = Release|Any CPU - {059E59CA-1E92-4268-9518-A3B16D08990D}.Release|Any CPU.Build.0 = Release|Any CPU - {6A20A86C-2EF7-4399-AC17-4B97FD5939C5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {6A20A86C-2EF7-4399-AC17-4B97FD5939C5}.Debug|Any CPU.Build.0 = Debug|Any CPU - {6A20A86C-2EF7-4399-AC17-4B97FD5939C5}.Release|Any CPU.ActiveCfg = Release|Any CPU - {6A20A86C-2EF7-4399-AC17-4B97FD5939C5}.Release|Any CPU.Build.0 = Release|Any CPU {8083ADC6-AFB3-407B-A54C-50C8E8976142}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {8083ADC6-AFB3-407B-A54C-50C8E8976142}.Debug|Any CPU.Build.0 = Debug|Any CPU {8083ADC6-AFB3-407B-A54C-50C8E8976142}.Release|Any CPU.ActiveCfg = Release|Any CPU diff --git a/WakeOnLan/LICENCE.md b/WakeOnLan/LICENCE.md deleted file mode 100644 index f288702..0000000 --- a/WakeOnLan/LICENCE.md +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/WakeOnLan/README.md b/WakeOnLan/README.md deleted file mode 100644 index 5502691..0000000 --- a/WakeOnLan/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# WakeOnLan - -## About - -This class creates and send a magic packet for Wake On Lan. - -Source: [Link](https://stackoverflow.com/a/58043033) -Author: -* [Poul Bak](https://stackoverflow.com/users/5741643/poul-bak) - Original author -* [Sikelio](https://github.com/Sikelio) - Contributor: Edited the code to match the today's conventions - -## Usage - -```cs -using FrenchyApps42.System.WakeOnLan; - -namespace Program -{ - public class Program - { - public static async Task Main() - { - string macAddress = ""; // <-- your MAC address (eg: XX:XX:XX:XX:XX:XX or XX-XX-XX-XX-XX-XX) - - await WakeOnLan.WakeUp(macAddress); - } - } -} -``` - -## License - -This project is licensed under the GPLv3 License - see the [LICENSE](./LICENCE.md) file for details. diff --git a/WakeOnLan/WakeOnLan.cs b/WakeOnLan/WakeOnLan.cs deleted file mode 100644 index c88f36f..0000000 --- a/WakeOnLan/WakeOnLan.cs +++ /dev/null @@ -1,95 +0,0 @@ -using System.Net.NetworkInformation; -using System.Net.Sockets; -using System.Net; -using System.Text.RegularExpressions; - -namespace FrenchyApps42.System.WakeOnLan -{ - public partial class WakeOnLan - { - /// - /// Sends a Wake-on-LAN magic packet to a specified MAC address. - /// - /// The MAC address of the device to wake up. - public static async Task WakeUp(string macAddress) - { - byte[] magicPacket = WakeOnLan.BuildMagicPacket(macAddress); - - IEnumerable networkInterfaces = NetworkInterface - .GetAllNetworkInterfaces() - .Where((n) => n.NetworkInterfaceType != NetworkInterfaceType.Loopback && n.OperationalStatus == OperationalStatus.Up); - - foreach (NetworkInterface networkInterface in networkInterfaces) - { - IPInterfaceProperties iPInterfaceProperties = networkInterface.GetIPProperties(); - - foreach (MulticastIPAddressInformation multicastIPAddressInformation in iPInterfaceProperties.MulticastAddresses) - { - IPAddress multicastIpAddress = multicastIPAddressInformation.Address; - - if (multicastIpAddress.ToString().StartsWith("ff02::1%", StringComparison.OrdinalIgnoreCase)) - { - UnicastIPAddressInformation? unicastIPAddressInformation = iPInterfaceProperties - .UnicastAddresses - .Where((u) => u.Address.AddressFamily == AddressFamily.InterNetworkV6 && !u.Address.IsIPv6LinkLocal) - .FirstOrDefault(); - - if (unicastIPAddressInformation != null) - { - await WakeOnLan.SendWakeOnLan(unicastIPAddressInformation.Address, multicastIpAddress, magicPacket); - } - } - else if (multicastIpAddress.ToString().Equals("224.0.0.1")) - { - UnicastIPAddressInformation? unicastIPAddressInformation = iPInterfaceProperties - .UnicastAddresses - .Where((u) => u.Address.AddressFamily == AddressFamily.InterNetwork) - .Where((u) => !iPInterfaceProperties.GetIPv4Properties().IsAutomaticPrivateAddressingActive) - .FirstOrDefault(); - - if (unicastIPAddressInformation != null) - { - await WakeOnLan.SendWakeOnLan(unicastIPAddressInformation.Address, multicastIpAddress, magicPacket); - } - } - } - } - - } - - /// - /// Builds a Wake-on-LAN magic packet from a given MAC address. - /// - /// The MAC address to include in the magic packet. - /// A byte array representing the magic packet. - public static byte[] BuildMagicPacket(string macAddress) - { - macAddress = MacFormatter().Replace(macAddress, ""); - byte[] macBytes = Convert.FromHexString(macAddress); - - IEnumerable header = Enumerable.Repeat((byte)0xff, 6); - IEnumerable data = Enumerable.Repeat(macBytes, 16).SelectMany(m => m); - - return header.Concat(data).ToArray(); - } - - /// - /// Sends a Wake-on-LAN magic packet to a specified multicast IP address. - /// - /// The local IP address to use for sending the packet. - /// The multicast IP address to send the packet to. - /// The magic packet to send. - public static async Task SendWakeOnLan(IPAddress localIpAddress, IPAddress multicastIpAddress, byte[] magicPacket) - { - UdpClient client = new(new IPEndPoint(localIpAddress, 0)); - await client.SendAsync(magicPacket, magicPacket.Length, new IPEndPoint(multicastIpAddress, 9)); - } - - /// - /// Creates a regular expression to format MAC addresses by removing colons, hyphens, and spaces. - /// - /// A Regex object for formatting MAC addresses. - [GeneratedRegex("[: -]")] - private static partial Regex MacFormatter(); - } -} diff --git a/WakeOnLan/WakeOnLan.csproj b/WakeOnLan/WakeOnLan.csproj deleted file mode 100644 index 8d107f5..0000000 --- a/WakeOnLan/WakeOnLan.csproj +++ /dev/null @@ -1,33 +0,0 @@ - - - - net8.0 - enable - enable - FrenchyApps42.System.$(MSBuildProjectName.Replace(" ", "_")) - True - WakeOnLan - Sikelio - FrenchyApps42 - https://github.com/FrApp42/Tools/tree/main/WakeOnLan - README.md - https://github.com/FrApp42/Tools - git - LICENCE.md - A class that creates and send a magic packet for Wake On Lan. - wakeonlan; wol; wake on lan; admin tool - True - - - - - True - \ - - - True - \ - - - - diff --git a/Web/API/Helpers/JsonPropAttrResolver.cs b/Web/API/Helpers/JsonPropAttrResolver.cs index e8220cb..e187c6a 100644 --- a/Web/API/Helpers/JsonPropAttrResolver.cs +++ b/Web/API/Helpers/JsonPropAttrResolver.cs @@ -3,7 +3,7 @@ using System.Reflection; using System.Text.Json.Serialization; -namespace FrApps42.Web.API.Helpers +namespace FrApp42.Web.API.Helpers { internal sealed class JsonPropAttrResolver : DefaultContractResolver { diff --git a/Web/API/Request.cs b/Web/API/Request.cs index e5df395..6d57eb3 100644 --- a/Web/API/Request.cs +++ b/Web/API/Request.cs @@ -1,13 +1,12 @@ -using FrApps42.Web.API.Helpers; +using FrApp42.Web.API.Helpers; using Newtonsoft.Json; using System.Net.Http.Headers; using System.Text; -namespace FrApps42.Web.API +namespace FrApp42.Web.API { public class Request { - #region Variables /// /// The HTTP client used to send requests. diff --git a/Web/API/Structs/Result.cs b/Web/API/Structs/Result.cs index 7ec18a1..2957dd7 100644 --- a/Web/API/Structs/Result.cs +++ b/Web/API/Structs/Result.cs @@ -1,10 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; - -namespace FrApps42.Web.API +namespace FrApp42.Web.API { public struct Result { @@ -14,9 +8,9 @@ public struct Result public Result(int statusCode, T value, string error = "") { - this.StatusCode = statusCode; - this.Value = value; - this.Error = error; + StatusCode = statusCode; + Value = value; + Error = error; } } } diff --git a/Web/README.md b/Web/README.md new file mode 100644 index 0000000..549db80 --- /dev/null +++ b/Web/README.md @@ -0,0 +1,43 @@ +# FrApp42.System + +FrApp42.Web is collection of classes for web operations: +* Request + +## How to Use this Library? + +```nuget +Install-Package FrApp42.Net +``` + +## Examples + +### Make an API request + +```csharp +using namespace FrApp42.Web.API; +using System.Text.Json.Serialization; + +string url = "your-url"; + +Request request = new(url); +request + .AddHeader("key", "value") + .AcceptJson() + +Result result = await request.Run(); + +if (result.StatusCode == 200 && result.Value != null) +{ + Console.WriteLine(result.Value.Name); + Console.WriteLine(result.Value.Description); +} + +class MyModel +{ + [JsonPropertyName("name")] + public string Name { get; set; } + + [JsonPropertyName("description")] + public string Description { get; set; } +} +``` diff --git a/Web/Web.csproj b/Web/Web.csproj index 1babe63..f93f9a5 100644 --- a/Web/Web.csproj +++ b/Web/Web.csproj @@ -4,22 +4,38 @@ net8.0 enable enable - FrApps42.$(MSBuildProjectName) - FrApps42.$(MSBuildProjectName.Replace(" ", "_")) - FrApps42 Web + FrApp42.$(MSBuildProjectName) + FrApp42.$(MSBuildProjectName.Replace(" ", "_")) + FrApp42 Web FrApp42 GPLv3 https://github.com/FrApp42/Tools https://github.com/FrApp42/Tools.git git + True + A collection of classes for web operations + web;tools + LICENCE.md + True + README.md - + + True + \ + + + + \ + True + + +