add API solution

This commit is contained in:
Stanley Dimant
2022-07-17 00:04:20 +02:00
parent 0542443fba
commit af8516d44a
15 changed files with 560 additions and 0 deletions

350
.gitignore vendored Normal file
View File

@@ -0,0 +1,350 @@
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Mono auto generated files
mono_crash.*
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# CodeRush personal settings
.cr/personal
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
# Local History for Visual Studio
.localhistory/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Ionide (cross platform F# VS Code tools) working folder
.ionide/

56
MareSynchronosAPI/API.cs Normal file
View File

@@ -0,0 +1,56 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace MareSynchronos.API
{
public class Api
{
public const int Version = 5;
public const string Path = "/mare";
public const string SendFileAbortUpload = "AbortUpload";
public const string InvokeFileSendFiles = "SendFiles";
public const string InvokeFileIsUploadFinished = "IsUploadFinished";
public const string SendFileUploadFileStreamAsync = "UploadFileStreamAsync";
public const string InvokeFileGetFileSize = "GetFileSize";
public const string StreamFileDownloadFileAsync = "StreamDownloadFileAsync";
public const string SendFileDeleteAllFiles = "DeleteAllFiles";
public const string InvokeHeartbeat = "Heartbeat";
public const string InvokeGetSystemInfo = "GetSystemInfo";
public const string OnUpdateSystemInfo = "OnUpdateSystemInfo";
public const string InvokeAdminGetOnlineUsers = "AdminGetOnlineUsers";
public const string InvokeAdminGetBannedUsers = "GetBannedUsers";
public const string SendAdminUpdateOrAddBannedUser = "UpdateOrAddBannedUser";
public const string SendAdminDeleteBannedUser = "DeleteBannedUser";
public const string InvokeAdminGetForbiddenFiles = "GetForbiddenFiles";
public const string SendAdminUpdateOrAddForbiddenFile = "UpdateOrAddForbiddenFile";
public const string SendAdminDeleteForbiddenFile = "DeleteForbiddenFile";
public const string SendAdminChangeModeratorStatus = "ChangeModeratorStatus";
public const string OnAdminForcedReconnect = "OnForcedReconnect";
public const string OnAdminUpdateOrAddBannedUser = "OnUpdateOrAddBannedUser";
public const string OnAdminDeleteBannedUser = "OnDeleteBannedUser";
public const string OnAdminUpdateOrAddForbiddenFile = "OnUpdateOrAddForbiddenFile";
public const string OnAdminDeleteForbiddenFile = "OnDeleteForbiddenFile";
public const string InvokeUserGetOnlineUsers = "GetOnlineUsers";
public const string InvokeUserRegister = "Register";
public const string InvokeUserPushCharacterDataToVisibleClients = "PushCharacterDataToVisibleClients";
public const string InvokeUserGetOnlineCharacters = "GetOnlineCharacters";
public const string SendUserPairedClientAddition = "SendPairedClientAddition";
public const string SendUserPairedClientRemoval = "SendPairedClientRemoval";
public const string SendUserPairedClientPauseChange = "SendPairedClientPauseChange";
public const string InvokeUserGetPairedClients = "GetPairedClients";
public const string SendUserDeleteAccount = "DeleteAccount";
public const string OnUserUpdateClientPairs = "UpdateClientPairs";
public const string OnUserReceiveCharacterData = "ReceiveCharacterData";
public const string OnUserRemoveOnlinePairedPlayer = "RemoveOnlinePairedPlayer";
public const string OnUserAddOnlinePairedPlayer = "AddOnlinePairedPlayer";
}
}

View File

@@ -0,0 +1,8 @@
namespace MareSynchronos.API
{
public record BannedUserDto
{
public string CharacterHash { get; set; }
public string Reason { get; set; }
}
}

View File

@@ -0,0 +1,12 @@
using System.Collections.Generic;
namespace MareSynchronos.API
{
public record CharacterCacheDto
{
public List<FileReplacementDto> FileReplacements { get; set; } = new();
public string GlamourerData { get; set; }
public string ManipulationData { get; set; }
public string Hash { get; set; }
}
}

View File

@@ -0,0 +1,12 @@
namespace MareSynchronos.API
{
public record ClientPairDto
{
public string OtherUID { get; set; }
public bool IsPaused { get; set; }
public bool IsSynced { get; set; }
public bool IsPausedFromOthers { get; set; }
public bool IsRemoved { get; set; }
public bool AllowReceiveMessages { get; set; }
}
}

View File

@@ -0,0 +1,10 @@
namespace MareSynchronos.API
{
public record ConnectionDto
{
public int ServerVersion { get; set; }
public bool IsAdmin { get; set; }
public bool IsModerator { get; set; }
public string UID { get; set; }
}
}

View File

@@ -0,0 +1,11 @@
namespace MareSynchronos.API
{
public record DownloadFileDto : ITransferFileDto
{
public bool FileExists { get; set; } = true;
public string Hash { get; set; } = string.Empty;
public long Size { get; set; } = 0;
public bool IsForbidden { get; set; } = false;
public string ForbiddenBy { get; set; } = string.Empty;
}
}

View File

@@ -0,0 +1,10 @@
using System;
namespace MareSynchronos.API
{
public record FileReplacementDto
{
public string[] GamePaths { get; set; } = Array.Empty<string>();
public string Hash { get; set; }
}
}

View File

@@ -0,0 +1,8 @@
namespace MareSynchronos.API
{
public record ForbiddenFileDto
{
public string Hash { get; set; }
public string ForbiddenBy { get; set; }
}
}

View File

@@ -0,0 +1,9 @@
namespace MareSynchronos.API
{
public interface ITransferFileDto
{
string Hash { get; set; }
bool IsForbidden { get; set; }
string ForbiddenBy { get; set; }
}
}

View File

@@ -0,0 +1,11 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net5.0</TargetFramework>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
</ItemGroup>
</Project>

View File

@@ -0,0 +1,25 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.2.32602.215
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MareSynchronos.API", "MareSynchronos.API.csproj", "{CD05EE19-802F-4490-AAD8-CAD4BF1D630D}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{CD05EE19-802F-4490-AAD8-CAD4BF1D630D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{CD05EE19-802F-4490-AAD8-CAD4BF1D630D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{CD05EE19-802F-4490-AAD8-CAD4BF1D630D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{CD05EE19-802F-4490-AAD8-CAD4BF1D630D}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {DFB70C71-AB27-468D-A08B-218CA79BF69D}
EndGlobalSection
EndGlobal

View File

@@ -0,0 +1,10 @@
namespace MareSynchronos.API
{
public record OnlineUserDto
{
public string UID { get; set; }
public string CharacterNameHash { get; set; }
public bool IsModerator { get; set; }
public bool IsAdmin { get; set; }
}
}

View File

@@ -0,0 +1,19 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace MareSynchronos.API
{
public record SystemInfoDto
{
public double CpuUsage { get; set; }
public long CacheUsage { get; set; }
public int UploadedFiles { get; set; }
public double NetworkIn { get; set; }
public double NetworkOut { get; set; }
public int OnlineUsers { get; set; }
public long RAMUsage { get; set; }
}
}

View File

@@ -0,0 +1,9 @@
namespace MareSynchronos.API
{
public record UploadFileDto : ITransferFileDto
{
public string Hash { get; set; } = string.Empty;
public bool IsForbidden { get; set; } = false;
public string ForbiddenBy { get; set; } = string.Empty;
}
}