Compare commits

..

No commits in common. "main" and "alpha-4" have entirely different histories.

73 changed files with 5589 additions and 5 deletions

30
.dockerignore Normal file
View File

@ -0,0 +1,30 @@
**/.classpath
**/.dockerignore
**/.env
**/.git
**/.gitignore
**/.project
**/.settings
**/.toolstarget
**/.vs
**/.vscode
**/*.*proj.user
**/*.dbmdl
**/*.jfm
**/azds.yaml
**/bin
**/charts
**/docker-compose*
**/Dockerfile*
**/node_modules
**/npm-debug.log
**/obj
**/secrets.dev.yaml
**/values.dev.yaml
LICENSE
README.md
!**/.gitignore
!.git/HEAD
!.git/config
!.git/packed-refs
!.git/refs/heads/**

138
.editorconfig Normal file
View File

@ -0,0 +1,138 @@
root = true
# top-most EditorConfig file
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
# 4 space indentation
indent_style = space
indent_size = 4
# disable redundant style warnings
# Microsoft .NET properties
csharp_indent_braces = false
csharp_new_line_before_catch = true
csharp_new_line_before_else = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = false
csharp_new_line_before_open_brace = all
csharp_preferred_modifier_order = public, private, protected, internal, new, abstract, virtual, sealed, override, static, readonly, extern, unsafe, volatile, async:suggestion
csharp_style_var_elsewhere = true:suggestion
csharp_style_var_for_built_in_types = true:suggestion
csharp_style_var_when_type_is_apparent = true:suggestion
dotnet_code_quality_unused_parameters = non_public
dotnet_naming_rule.event_rule.severity = warning
dotnet_naming_rule.event_rule.style = on_upper_camel_case_style
dotnet_naming_rule.event_rule.symbols = event_symbols
dotnet_naming_rule.private_constants_rule.severity = warning
dotnet_naming_rule.private_constants_rule.style = upper_camel_case_style
dotnet_naming_rule.private_constants_rule.symbols = private_constants_symbols
dotnet_naming_rule.private_instance_fields_rule.severity = warning
dotnet_naming_rule.private_instance_fields_rule.style = lower_camel_case_style
dotnet_naming_rule.private_instance_fields_rule.symbols = private_instance_fields_symbols
dotnet_naming_rule.private_static_fields_rule.severity = warning
dotnet_naming_rule.private_static_fields_rule.style = upper_camel_case_style
dotnet_naming_rule.private_static_fields_rule.symbols = private_static_fields_symbols
dotnet_naming_rule.private_static_readonly_rule.severity = warning
dotnet_naming_rule.private_static_readonly_rule.style = upper_camel_case_style
dotnet_naming_rule.private_static_readonly_rule.symbols = private_static_readonly_symbols
dotnet_naming_style.lower_camel_case_style.capitalization = camel_case
dotnet_naming_style.on_upper_camel_case_style.capitalization = pascal_case
dotnet_naming_style.on_upper_camel_case_style.required_prefix = On
dotnet_naming_style.upper_camel_case_style.capitalization = pascal_case
dotnet_naming_symbols.event_symbols.applicable_accessibilities = *
dotnet_naming_symbols.event_symbols.applicable_kinds = event
dotnet_naming_symbols.private_constants_symbols.applicable_accessibilities = private
dotnet_naming_symbols.private_constants_symbols.applicable_kinds = field
dotnet_naming_symbols.private_constants_symbols.required_modifiers = const
dotnet_naming_symbols.private_instance_fields_symbols.applicable_accessibilities = private
dotnet_naming_symbols.private_instance_fields_symbols.applicable_kinds = field
dotnet_naming_symbols.private_static_fields_symbols.applicable_accessibilities = private
dotnet_naming_symbols.private_static_fields_symbols.applicable_kinds = field
dotnet_naming_symbols.private_static_fields_symbols.required_modifiers = static
dotnet_naming_symbols.private_static_readonly_symbols.applicable_accessibilities = private
dotnet_naming_symbols.private_static_readonly_symbols.applicable_kinds = field
dotnet_naming_symbols.private_static_readonly_symbols.required_modifiers = static,readonly
dotnet_style_parentheses_in_arithmetic_binary_operators =always_for_clarity:suggestion
dotnet_style_parentheses_in_other_binary_operators =always_for_clarity:suggestion
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:suggestion
dotnet_style_predefined_type_for_member_access = true:suggestion
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
dotnet_style_parentheses_in_other_operators=always_for_clarity:silent
dotnet_style_object_initializer = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_empty_square_brackets = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_before_open_square_brackets = false
csharp_space_before_comma = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_after_comma = true
csharp_space_after_cast = false
csharp_space_around_binary_operators = before_and_after
csharp_space_between_method_declaration_name_and_open_parenthesis = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = none
csharp_space_between_square_brackets = false
# ReSharper properties
resharper_align_linq_query = true
resharper_align_multiline_argument = true
resharper_align_multiline_calls_chain = true
resharper_align_multiline_expression = true
resharper_align_multiline_extends_list = true
resharper_align_multiline_for_stmt = true
resharper_align_multline_type_parameter_constrains = true
resharper_align_multline_type_parameter_list = true
resharper_apply_on_completion = true
resharper_auto_property_can_be_made_get_only_global_highlighting = none
resharper_auto_property_can_be_made_get_only_local_highlighting = none
resharper_autodetect_indent_settings = true
resharper_braces_for_ifelse = required_for_multiline
resharper_can_use_global_alias = false
resharper_csharp_align_multiline_parameter = true
resharper_csharp_align_multiple_declaration = true
resharper_csharp_empty_block_style = together_same_line
resharper_csharp_int_align_comments = true
resharper_csharp_new_line_before_while = true
resharper_csharp_wrap_after_declaration_lpar = true
resharper_enforce_line_ending_style = true
resharper_member_can_be_private_global_highlighting = none
resharper_member_can_be_private_local_highlighting = none
resharper_new_line_before_finally = false
resharper_place_accessorholder_attribute_on_same_line = false
resharper_place_field_attribute_on_same_line = false
resharper_show_autodetect_configure_formatting_tip = false
resharper_use_indent_from_vs = false
# ReSharper inspection severities
resharper_arrange_missing_parentheses_highlighting = hint
resharper_arrange_redundant_parentheses_highlighting = hint
resharper_arrange_this_qualifier_highlighting = hint
resharper_arrange_type_member_modifiers_highlighting = hint
resharper_arrange_type_modifiers_highlighting = hint
resharper_built_in_type_reference_style_for_member_access_highlighting = hint
resharper_built_in_type_reference_style_highlighting = none
resharper_foreach_can_be_converted_to_query_using_another_get_enumerator_highlighting = none
resharper_foreach_can_be_partly_converted_to_query_using_another_get_enumerator_highlighting = none
resharper_invert_if_highlighting = none
resharper_loop_can_be_converted_to_query_highlighting = none
resharper_method_has_async_overload_highlighting = none
resharper_private_field_can_be_converted_to_local_variable_highlighting = none
resharper_redundant_base_qualifier_highlighting = none
resharper_suggest_var_or_type_built_in_types_highlighting = hint
resharper_suggest_var_or_type_elsewhere_highlighting = hint
resharper_suggest_var_or_type_simple_types_highlighting = hint
resharper_unused_auto_property_accessor_global_highlighting = none
csharp_style_deconstructed_variable_declaration=true:silent
[*.{appxmanifest,asax,ascx,aspx,axaml,axml,build,c,c++,cc,cginc,compute,config,cp,cpp,cs,cshtml,csproj,css,cu,cuh,cxx,dbml,discomap,dtd,h,hh,hlsl,hlsli,hlslinc,hpp,htm,html,hxx,inc,inl,ino,ipp,js,json,jsproj,jsx,lsproj,master,mpp,mq4,mq5,mqh,njsproj,nuspec,paml,proj,props,proto,razor,resjson,resw,resx,skin,StyleCop,targets,tasks,tpp,ts,tsx,usf,ush,vb,vbproj,xaml,xamlx,xml,xoml,xsd}]
indent_style = space
indent_size = 4
tab_width = 4
dotnet_style_parentheses_in_other_operators=always_for_clarity:silent

63
.gitattributes vendored Normal file
View File

@ -0,0 +1,63 @@
###############################################################################
# Set default behavior to automatically normalize line endings.
###############################################################################
* text=auto
###############################################################################
# Set default behavior for command prompt diff.
#
# This is need for earlier builds of msysgit that does not have it on by
# default for csharp files.
# Note: This is only used by command line
###############################################################################
#*.cs diff=csharp
###############################################################################
# Set the merge driver for project and solution files
#
# Merging from the command prompt will add diff markers to the files if there
# are conflicts (Merging from VS is not affected by the settings below, in VS
# the diff markers are never inserted). Diff markers may cause the following
# file extensions to fail to load in VS. An alternative would be to treat
# these files as binary and thus will always conflict and require user
# intervention with every merge. To do so, just uncomment the entries below
###############################################################################
#*.sln merge=binary
#*.csproj merge=binary
#*.vbproj merge=binary
#*.vcxproj merge=binary
#*.vcproj merge=binary
#*.dbproj merge=binary
#*.fsproj merge=binary
#*.lsproj merge=binary
#*.wixproj merge=binary
#*.modelproj merge=binary
#*.sqlproj merge=binary
#*.wwaproj merge=binary
###############################################################################
# behavior for image files
#
# image files are treated as binary by default.
###############################################################################
#*.jpg binary
#*.png binary
#*.gif binary
###############################################################################
# diff behavior for common document formats
#
# Convert binary document formats to text before diffing them. This feature
# is only available from the command line. Turn it on by uncommenting the
# entries below.
###############################################################################
#*.doc diff=astextplain
#*.DOC diff=astextplain
#*.docx diff=astextplain
#*.DOCX diff=astextplain
#*.dot diff=astextplain
#*.DOT diff=astextplain
#*.pdf diff=astextplain
#*.PDF diff=astextplain
#*.rtf diff=astextplain
#*.RTF diff=astextplain

400
.gitignore vendored Normal file
View File

@ -0,0 +1,400 @@
## 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/main/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/
[Ww][Ii][Nn]32/
[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/
# ASP.NET Scaffolding
ScaffoldingReadMe.txt
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
# but not Directory.Build.rsp, as it configures directory-level build defaults
!Directory.Build.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.tlog
*.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
# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info
# 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 6 auto-generated project file (contains which files were open etc.)
*.vbp
# Visual Studio 6 workspace and project file (working project files containing files to include in project)
*.dsw
*.dsp
# Visual Studio 6 technical files
*.ncb
*.aps
# 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/
# Visual Studio History (VSHistory) files
.vshistory/
# 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/
# Fody - auto-generated XML schema
FodyWeavers.xsd
# VS Code files for those working on multiple tools
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace
# Local History for Visual Studio Code
.history/
# Windows Installer files from build outputs
*.cab
*.msi
*.msix
*.msm
*.msp
# JetBrains Rider
*.sln.iml

0
Data/.gitkeep Normal file
View File

661
LICENSE.md Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are 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.
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.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
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 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 work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero 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 Affero 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 Affero 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 Affero 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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
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 AGPL, see
<https://www.gnu.org/licenses/>.

View File

@ -0,0 +1,27 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace QuestShare.Common.API
{
#pragma warning disable CS0618 // Type or member is obsolete
public sealed class AuthRequest : IAPIEndpoint<AuthRequest.Request, AuthRequest.Response>
#pragma warning restore CS0618 // Type or member is obsolete
{
[Obsolete("This constructor is for serialization only. Do not use it in code.")]
public class Request : IRequest
{
public Request() { }
public required string Version { get; set; }
public required string Token { get; set; }
}
public class Response : IResponse
{
public Response() { }
public Error Error { get; set; } = Error.None;
public bool Success { get; set; } = true;
}
}
}

View File

@ -0,0 +1,29 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace QuestShare.Common.API
{
public sealed class Authorize : IAPIEndpoint<Authorize.Request, Authorize.Response>
{
public class Request : IRequest
{
public Request() { }
public string Version { get; set; } = null!;
public string Token { get; set; } = null!;
public List<Objects.ShareCode> ShareCodes { get; set; } = [];
}
public class Response : IResponse
{
public Response() { }
public Error Error { get; set; } = Error.None;
public bool Success { get; set; }
public string Token { get; set; } = null!;
public List<Objects.Session> Sessions { get; set; } = [];
public Objects.OwnedSession? OwnedSession { get; set; }
}
}
}

View File

@ -0,0 +1,33 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace QuestShare.Common.API
{
public sealed class Cancel : IAPIEndpoint<Cancel.Request, Cancel.Response>
{
public class Request : IRequest
{
public Request() { }
public required string Version { get; set; }
public required string Token { get; set; }
public required string ShareCode { get; set; }
public required string OwnerCharacterId { get; set; }
}
public class Response : IResponse
{
public Response() { }
public Error Error { get; set; } = Error.None;
public required bool Success { get; set; }
}
public class CancelBroadcast
{
public CancelBroadcast() { }
public required string ShareCode { get; set; }
}
}
}

View File

@ -0,0 +1,33 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace QuestShare.Common.API
{
public sealed class GroupJoin : IAPIEndpoint<GroupJoin.Request, GroupJoin.Response>
{
public class Request : IRequest
{
public Request() { }
public required string Token { get; set; }
public required string Version { get; set; }
public required Objects.ShareCode SessionInfo { get; set; }
}
public class Response : IResponse
{
public Response() { }
public Error Error { get; set; } = Error.None;
public bool Success { get; set; } = false;
public Objects.Session? Session { get; set; }
}
public class GroupJoinBroadcast
{
public GroupJoinBroadcast() { }
public required Objects.Session Session { get; set; }
}
}
}

View File

@ -0,0 +1,32 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace QuestShare.Common.API
{
public sealed class GroupLeave : IAPIEndpoint<GroupLeave.Request, GroupLeave.Response>
{
public class Request : IRequest
{
public Request() { }
public string Version { get; set; } = null!;
public string Token { get; set; } = null!;
public required Objects.Session Session { get; set; }
}
public class Response : IResponse
{
public Response() { }
public Error Error { get; set; } = Error.None;
public bool Success { get; set; } = false;
public Objects.Session? Session { get; set; }
}
public class GroupLeaveBroadcast
{
public GroupLeaveBroadcast() { }
public required Objects.Session Session { get; set; }
}
}
}

View File

@ -0,0 +1,27 @@
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace QuestShare.Common.API
{
public sealed class Register : IAPIEndpoint<Register.Request, Register.Response>
{
public class Request : IRequest
{
public Request() { }
public required string Token { get; set; }
public required string Version { get; set; }
}
public class Response : IResponse
{
public Response() { }
public Error Error { get; set; } = Error.None;
public bool Success { get; set; } = false;
public required string ShareCode { get; set; }
}
}
}

View File

@ -0,0 +1,26 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace QuestShare.Common.API
{
public sealed class ServerMessage
{
public sealed class Broadcast
{
public Broadcast() { }
public ServerMessageType MessageType { get; set; }
public string Message { get; set; } = null!;
}
}
public enum ServerMessageType
{
ServerShutdown,
ServerRestart,
ServerUpdate,
UserNotInPartyViolation,
}
}

View File

@ -0,0 +1,34 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace QuestShare.Common.API
{
public sealed class Update : IAPIEndpoint<Update.Request, Update.Response>
{
public class Request : IRequest
{
public Request() { }
public required string Version { get; set; }
public required string Token { get; set; }
public required Objects.OwnedSession Session { get; set; }
public List<string> PartyMembers { get; set; } = [];
public bool IsQuestUpdate { get; set; } = false;
}
public class Response : IResponse
{
public Response() { }
public Error Error { get; set; } = Error.None;
public bool Success { get; set; } = false;
}
public class UpdateBroadcast
{
public UpdateBroadcast() { }
public required Objects.Session Session { get; set; }
}
}
}

View File

@ -0,0 +1,35 @@
using System.Text;
namespace QuestShare.Common
{
public class Constants
{
public static readonly string Version = "3";
}
public static class StringExtensions
{
public static string ToBase64(this string str)
{
return Convert.ToBase64String(Encoding.UTF8.GetBytes(str));
}
public static string FromBase64(this string str)
{
return Encoding.UTF8.GetString(Convert.FromBase64String(str));
}
public static string ToSHA256(this string str)
{
var bytes = Encoding.UTF8.GetBytes(str);
// 10 reps of SHA256
for (var i = 0; i < 10; i++)
bytes = System.Security.Cryptography.SHA256.HashData(bytes);
return BitConverter.ToString(bytes).Replace("-", "").ToLower();
}
public static string SaltedHash(this string str, string salt)
{
return (str + salt).ToSHA256();
}
}
}

View File

@ -0,0 +1,13 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
</ItemGroup>
</Project>

View File

@ -0,0 +1,116 @@
using Newtonsoft.Json;
using QuestShare.Services;
namespace QuestShare.Common;
public class ConfigurationManager
{
public class Configuration
{
public string Token { get; set; } = string.Empty;
public bool ConnectOnStartup { get; set; } = false;
public bool AutoShareMsq { get; set; } = false;
public bool AutoShareNewQuests { get; set; } = false;
public bool TrackMSQ { get; set; } = false;
public bool HideFutureStepsHost { get; set; } = true;
public bool HideFutureStepsMember { get; set; } = false;
public bool EnableHosting { get; set; } = false;
public Objects.OwnedSession? OwnedSession { get; set; }
public List<Objects.ShareCode> KnownShareCodes { get; set; } = [];
public int ActiveQuestId { get; set; } = 0;
public byte ActiveQuestStep { get; set; } = 0;
public Dictionary<long, string> KnownCharacters { get; set; } = [];
public ApiConfiguration[] ApiConfigurations { get; set; } = [new ApiConfiguration { DisplayName = "Primary Server - US East", Url = "https://api.nathanc.tech/Hub", Active = false }];
public string ApiUrl => ApiConfigurations.FirstOrDefault(x => x.Active)?.Url ?? "https://api.nathanc.tech/Hub";
public string ApiDisplayName => ApiConfigurations.FirstOrDefault(x => x.Active)?.DisplayName ?? "Primary Server - US East";
}
public class ApiConfiguration
{
public required string DisplayName;
public required string Url;
public bool Active = false;
}
public static Configuration Instance { get; private set; } = new Configuration();
private static ulong LocalContentId = 0;
public ConfigurationManager()
{
Log.Debug("ConfigurationManager constructor");
ClientState.Login += OnLogin;
ClientState.Logout += OnLogout;
if (ClientState.LocalContentId != 0)
{
LocalContentId = ClientState.LocalContentId;
Framework.Run(Load);
}
}
public void OnLogin()
{
LocalContentId = ClientState.LocalContentId;
Framework.Run(Load);
}
public void Dispose()
{
Save();
ClientState.Login -= OnLogin;
ClientState.Logout -= OnLogout;
}
public void OnLogout(int code, int state)
{
Framework.RunOnTick(Save);
}
public void Load()
{
if (File.Exists(Path.Join(PluginInterface.ConfigDirectory.FullName, $"{LocalContentId}.json")))
{
var config = File.ReadAllText(Path.Join(PluginInterface.ConfigDirectory.FullName, $"{LocalContentId}.json"));
if (config != null)
{
var deserialized = JsonConvert.DeserializeObject<Configuration>(config);
if (deserialized != null)
{
Instance = deserialized;
#if DEBUG
if (Instance.ApiConfigurations.All(x => x.DisplayName != "Local"))
Instance.ApiConfigurations.Append(new ApiConfiguration { DisplayName = "Local", Url = "http://localhost:8080/Hub", Active = true });
foreach (var item in Instance.ApiConfigurations)
{
if (item.DisplayName != "Local") item.Active = false;
}
#endif
}
else
{
Log.Error($"Failed to deserialize configuration for {LocalContentId}");
}
}
}
else
{
Instance = new Configuration();
Save();
}
}
public static void Save()
{
Log.Debug("Saving configuration");
File.WriteAllText(Path.Join(PluginInterface.ConfigDirectory.FullName, $"{LocalContentId}.json"), JsonConvert.SerializeObject(Instance));
Log.Debug($"Wrote config: {JsonConvert.SerializeObject(Instance)}");
}
}
public enum ShareMode
{
None,
Host,
Member
}

View File

@ -0,0 +1,264 @@
using Dalamud.Game.Text.SeStringHandling.Payloads;
using Dalamud.Plugin.Services;
using Dalamud.Utility;
using FFXIVClientStructs.FFXIV.Client.Game;
using FFXIVClientStructs.FFXIV.Client.Game.UI;
using FFXIVClientStructs.FFXIV.Client.UI.Agent;
using Lumina.Excel;
using Lumina.Excel.Sheets;
using Lumina.Extensions;
using Newtonsoft.Json;
using QuestShare.Services;
using System.Numerics;
namespace QuestShare.Common
{
internal static class GameQuestManager
{
public static List<GameQuest> GameQuests { get; private set; } = new List<GameQuest>();
public static List<GameQuest> SharedCache { get; private set; } = new List<GameQuest>();
private static byte LastStep = 0;
private static uint LastQuestId = 0;
public static void Initialize()
{
ClientState.Login += OnLogin;
ClientState.Logout += OnLogout;
if (GameQuests.Count == 0)
{
LoadQuests();
}
Framework.Update += OnFrameworkUpdate;
}
public static void Dispose()
{
ClientState.Login -= OnLogin;
ClientState.Logout -= OnLogout;
Framework.Update -= OnFrameworkUpdate;
}
public static void LoadQuests()
{
var activeQuest = GetActiveQuest();
GameQuests.Clear();
// iterate through all quests in the game to see which ones are currently active
foreach (var quest in SheetManager.QuestSheet)
{
if (quest.Id == "" || quest.RowId == 0)
{
continue;
}
if (QuestManager.GetQuestSequence(quest.RowId) > 0)
{
Log.Debug($"Adding quest {quest.RowId} to GameQuests - {quest.Name} - Progression {QuestManager.GetQuestSequence(quest.RowId)-1}");
GameQuests.Add(new GameQuest(quest.RowId));
}
}
if (activeQuest != null)
{
SetActiveFlag(activeQuest.QuestId);
}
else if (ConfigurationManager.Instance.OwnedSession != null)
{
var quest = GetQuestById((uint)ConfigurationManager.Instance.OwnedSession.ActiveQuestId);
SetActiveFlag(quest.QuestId);
}
}
private static void OnLogin()
{
LoadQuests();
}
private static void OnLogout(int code, int _)
{
GameQuests.Clear();
SharedCache.Clear();
}
public unsafe static bool TrackMsq()
{
var api = (ApiService)Plugin.GetService<ApiService>();
var share = (ShareService)Plugin.GetService<ShareService>();
if (ConfigurationManager.Instance.TrackMSQ)
{
var questId = (uint)AgentScenarioTree.Instance()->Data->CurrentScenarioQuest;
if (questId == 0) return false;
else questId += 0x10000U;
if (GetActiveQuest() != null && GetActiveQuest()?.QuestId == questId) return false;
if (SheetManager.QuestSheet.TryGetRow(questId, out var row))
{
if (row.RowId == 0) return false;
var quest = GetQuestById(questId);
if (GameQuests.Contains(quest) && GetActiveQuest()?.QuestId != questId)
{
SetActiveFlag(questId);
HostService.Update((int)questId, quest.CurrentStep);
}
else
{
GameQuests.Add(quest);
SetActiveFlag(questId);
HostService.Update((int)questId, quest.CurrentStep);
}
return true;
}
else
{
Log.Debug($"Quest {questId} not found in QuestSheet");
}
}
return false;
}
private static void OnFrameworkUpdate(IFramework framework)
{
if (ClientState.LocalContentId == 0) return;
TrackMsq();
var q = GetActiveQuest();
var api = (ApiService)Plugin.GetService<ApiService>();
if (q != null && q.QuestId == LastQuestId)
{
var step = QuestManager.GetQuestSequence(q.QuestId);
if (step != LastStep)
{
if (LastStep == 0xFF && step == 0)
{
// quest was completed
Log.Debug($"Quest {q.QuestId} was completed");
// check for next quest in the chain
if (q.QuestData.PreviousQuest.TryGetFirst(out var prevQuest))
{
if (prevQuest.RowId == 0 || !prevQuest.IsValid)
{
Log.Debug("No previous quest in chain");
GameQuests.Remove(q);
LoadQuests();
return;
}
Log.Debug($"Previous quest in chain was {prevQuest.RowId}");
var nextQuest = SheetManager.QuestSheet.FirstOrDefault(qu => prevQuest.Value.RowId == q.QuestId);
if (nextQuest.RowId != 0)
{
Log.Debug($"Next quest in chain is {nextQuest.RowId}");
GameQuests.Add(new GameQuest(nextQuest.RowId));
SetActiveFlag(nextQuest.RowId);
}
else
{
Log.Debug("No next quest in chain");
GameQuests.Remove(q);
LoadQuests();
}
}
HostService.Update((int)q.QuestId, q.CurrentStep);
}
else
{
LastStep = step;
Log.Debug($"Quest step changed to {step}");
HostService.Update((int)q.QuestId, q.CurrentStep);
}
}
}
else if (q != null)
{
LastQuestId = q.QuestId;
LastStep = QuestManager.GetQuestSequence(q.QuestId);
}
}
public static GameQuest? GetActiveQuest()
{
return GameQuests.FirstOrDefault(q => q.IsActive);
}
public static GameQuest GetQuestById(uint questId)
{
if (SharedCache.FirstOrDefault(q => q.QuestId == questId) is GameQuest quest)
{
return quest;
} else
{
var newQuest = new GameQuest(questId);
SharedCache.Add(newQuest);
return newQuest;
}
}
public static void SetActiveFlag(uint questId)
{
Log.Debug($"Setting active quest to {questId}");
var quest = GameQuests.FirstOrDefault(q => q.QuestId == questId);
if (quest != null)
{
quest.IsActive = true;
// set all other quests to inactive
foreach (var q in GameQuests)
{
if (q.QuestId != questId)
{
q.IsActive = false;
}
}
}
}
}
internal class GameQuest
{
public uint QuestId { get; init; }
[JsonIgnore]
public Lumina.Excel.Sheets.Quest QuestData { get; init; }
public string QuestName => QuestData.Name.ExtractText();
public byte CurrentStep => QuestManager.GetQuestSequence(QuestId);
public List<string> QuestSteps { get; private set; } = [];
public bool IsMainQuest => false; // TODO: Implement this
public bool IsActive { get; set; } = false;
public GameQuest(uint questId)
{
QuestId = questId;
if (SheetManager.QuestSheet.TryGetRow(questId, out var quest))
{
QuestData = quest;
}
var sheet = TextSheetForQuest(QuestData);
for(uint i = 0; i < sheet.Count; i++)
{
var row = sheet.GetRow(i);
if (row.Key.ExtractText().Contains("_TODO_") && row.Value.ExtractText() != "")
{
QuestSteps.Add(row.Value.ExtractText());
}
}
}
public Lumina.Excel.Sheets.Map GetMapLocation()
{
return QuestData.TodoParams.FirstOrDefault(param => param.ToDoCompleteSeq == CurrentStep)
.ToDoLocation.FirstOrDefault(location => location is not { RowId: 0 }).Value.Map.Value;
}
public MapLinkPayload GetMapLink(byte step)
{
var toDoData = QuestData.TodoParams.Select(t => t.ToDoLocation).ToList();
Log.Debug($"Step: {step}/{0xFF} - Total steps: {QuestSteps.Count} - ToDoParams Count: {toDoData.Count}");
var data = toDoData.ElementAt(step > QuestSteps.Count ? QuestSteps.Count-1 : step).FirstOrDefault();
if (!data.IsValid)
{
Log.Error("Invalid ToDoLocation data");
return new MapLinkPayload(0, 0, 0, 0);
}
var coords = MapUtil.WorldToMap(new Vector3(data.Value.X, data.Value.Y, data.Value.Z), data.Value.Map.Value.OffsetX, data.Value.Map.Value.OffsetY, 0, data.Value.Map.Value.SizeFactor);
var mapLink = new MapLinkPayload(data.Value.Territory.Value.RowId, data.Value.Map.Value.RowId, coords.X, coords.Y);
return mapLink;
}
internal static ExcelSheet<QuestDialogue> TextSheetForQuest(Lumina.Excel.Sheets.Quest q)
{
var qid = q.Id.ToString();
Log.Debug($"Getting text sheet for quest {q.Id} - RowID: {q.RowId}");
var dir = qid.Substring(qid.Length - 5, 3);
return DataManager.GetExcelSheet<QuestDialogue>(name: $"quest/{dir}/{qid}");
}
}
}

View File

@ -0,0 +1,19 @@
using Lumina.Excel;
using Lumina.Text.ReadOnly;
namespace QuestShare.Common
{
//ref: https://github.com/salanth357/NoTypeSay/blob/main/NoTypeSay/QuestDialogue.cs
[Sheet("QuestDialogue")]
public readonly struct QuestDialogue(RawRow row) : IExcelRow<QuestDialogue>
{
public uint RowId => row.RowId;
public ReadOnlySeString Key => row.ReadStringColumn(0);
public ReadOnlySeString Value => row.ReadStringColumn(1);
static QuestDialogue IExcelRow<QuestDialogue>.Create(ExcelPage page, uint offset, uint row) =>
new(new RawRow(page, offset, row));
}
}

View File

@ -0,0 +1,14 @@
using Dalamud.IoC;
using Lumina.Excel;
using Lumina.Excel.Sheets;
namespace QuestShare.Common
{
internal static class SheetManager
{
// All ExcelSheet<T> instances should be stored here
[PluginService] public static ExcelSheet<Quest> QuestSheet { get; } = DataManager.GetExcelSheet<Quest>();
[PluginService] public static ExcelSheet<Map> MapSheet { get; } = DataManager.GetExcelSheet<Map>();
[PluginService] public static ExcelSheet<PlaceName> PlaceNameSheet { get; } = DataManager.GetExcelSheet<PlaceName>();
}
}

View File

@ -0,0 +1,76 @@
global using static QuestShare.Service;
global using QuestShare.Common;
global using QuestShare.Common.API;
using Dalamud.Plugin;
using Dalamud.Plugin.Services;
using Serilog.Events;
using QuestShare.Services;
namespace QuestShare;
public sealed class Plugin : IDalamudPlugin
{
public static string Name => "Quest Share";
public static string Version => "1.0.0";
public static string PluginDataPath { get; private set; } = null!;
internal static ConfigurationManager Configuration { get; private set; } = null!;
private static List<IService> Services = [];
internal static StringWriter LogStream { get; private set; } = null!;
public Plugin(IDalamudPluginInterface pluginInterface)
{
pluginInterface.Create<Service>(pluginInterface);
// redirect console output to plugin log
Configuration = new ConfigurationManager();
Services =
[
new ApiService(),
new CommandService(),
new ShareService(),
new PartyService(),
new UiService(),
new HostService()
];
GameQuestManager.Initialize();
LogStream = new StringWriter();
Console.SetOut(LogStream);
Console.SetError(LogStream);
Framework.Update += OnFramework;
Log.Debug($"Token: {ConfigurationManager.Instance.Token}");
foreach (var service in Services)
{
Log.Debug($"Initializing {service.GetType().Name}");
service.Initialize();
}
}
public void Dispose()
{
LogStream.Dispose();
foreach (var service in Services)
{
service.Shutdown();
}
ConfigurationManager.Save();
ClientState.Login -= Configuration.OnLogin;
ClientState.Logout -= Configuration.OnLogout;
Framework.Update -= OnFramework;
Configuration.Dispose();
}
internal static IService GetService<T>() where T : IService
{
return Services.FirstOrDefault(s => s is T)!;
}
private void OnFramework(IFramework framework)
{
// check if there's logs to write
if (LogStream != null && LogStream.ToString() != "")
{
var toWrite = LogStream.ToString();
LogStream.GetStringBuilder().Clear();
Log.Write(LogEventLevel.Debug, null, toWrite);
}
}
}

View File

@ -0,0 +1,26 @@
<?xml version="1.0" encoding="utf-8"?>
<Project Sdk="Dalamud.NET.SDK/11.2.0">
<PropertyGroup>
<Version>0.0.0.1</Version>
<Description>A sample plugin.</Description>
<PackageProjectUrl>https://github.com/goatcorp/SamplePlugin</PackageProjectUrl>
<PackageLicenseExpression>AGPL-3.0-or-later</PackageLicenseExpression>
<IsPackable>false</IsPackable>
<ImplicitUsings>enable</ImplicitUsings>
<TargetFramework>net8.0-windows</TargetFramework>
</PropertyGroup>
<ItemGroup>
<Content Include="QuestShare.json" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\QuestShare.Common\QuestShare.Common.csproj" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="8.0.13" />
<PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.2" />
<PackageReference Include="Microsoft.Extensions.Logging.Console" Version="9.0.2" />
</ItemGroup>
<ItemGroup>
<Folder Include="Addons\" />
</ItemGroup>
</Project>

View File

@ -0,0 +1,14 @@
{
"Author": "Era",
"Name": "Quest Share",
"Punchline": "Share your quest progress with others.",
"Description": "blah",
"ApplicableVersion": "any",
"Tags": [
"utility",
"vendor",
"shop"
],
"RepoUrl": "",
"AcceptsFeedback": false
}

View File

@ -0,0 +1,21 @@
using Dalamud.IoC;
using Dalamud.Plugin.Services;
using Dalamud.Plugin;
namespace QuestShare
{
internal class Service
{
[PluginService] internal static IDalamudPluginInterface PluginInterface { get; private set; } = null!;
[PluginService] internal static ITextureProvider TextureProvider { get; private set; } = null!;
[PluginService] internal static ICommandManager CommandManager { get; private set; } = null!;
[PluginService] internal static IPluginLog Log { get; private set; } = null!;
[PluginService] internal static IDataManager DataManager { get; private set; } = null!;
[PluginService] internal static IGameGui GameGui { get; private set; } = null!;
[PluginService] internal static IClientState ClientState { get; private set; } = null!;
[PluginService] internal static IFramework Framework { get; private set; } = null!;
[PluginService] internal static IPartyList PartyList { get; private set; } = null!;
[PluginService] internal static IAddonLifecycle AddonLifecycle { get; private set; } = null!;
[PluginService] internal static IChatGui ChatGui { get; private set; } = null!;
}
}

View File

@ -0,0 +1,13 @@
namespace QuestShare.Services.API
{
internal class AuthRequest_Client
{
public static Task HandleResponse(AuthRequest.Response response)
{
var api = ((ApiService)Plugin.GetService<ApiService>());
ApiService.DispatchAuthorize();
return Task.CompletedTask;
}
}
}

View File

@ -0,0 +1,50 @@
namespace QuestShare.Services.API
{
internal class Authorize_Client
{
public static void HandleDispatch()
{
if (ClientState.LocalContentId == 0)
{
_ = ((ApiService)Plugin.GetService<ApiService>()).Disconnect();
return;
}
var knownCodes = ShareService.ShareCodes.Select(s => s).ToList();
if (HostService.ActiveSession != null)
{
knownCodes.Add(new Objects.ShareCode { CharacterId = HostService.ActiveSession.OwnerCharacterId, Code = HostService.ActiveSession.ShareCode });
}
var request = new Authorize.Request()
{
Token = ApiService.Token,
Version = Constants.Version,
ShareCodes = knownCodes,
};
((ApiService)Plugin.GetService<ApiService>()).Invoke(nameof(Authorize), request).ConfigureAwait(false);
}
public static Task HandleResponse(Authorize.Response response)
{
var share = (ShareService)Plugin.GetService<ShareService>();
if (response.Success)
{
ConfigurationManager.Instance.Token = response.Token;
foreach(var session in response.Sessions)
{
share.AddSession(session);
}
if (response.OwnedSession != null)
{
ConfigurationManager.Instance.OwnedSession = response.OwnedSession;
}
ConfigurationManager.Save();
}
else
{
Log.Error("Failed to authorize: {Error}", response.Error);
UiService.LastErrorMessage = $"Failed to authorize: {response.Error}";
_ = ((ApiService)Plugin.GetService<ApiService>()).Disconnect();
}
return Task.CompletedTask;
}
}
}

View File

@ -0,0 +1,41 @@
namespace QuestShare.Services.API
{
internal class Cancel_Client
{
public static void HandleDispatch()
{
var api = (ApiService)Plugin.GetService<ApiService>();
var party = (PartyService)Plugin.GetService<PartyService>();
var share = (ShareService)Plugin.GetService<ShareService>();
var request = new Cancel.Request
{
Token = ApiService.Token,
Version = Constants.Version,
ShareCode = HostService.ActiveSession!.ShareCode,
OwnerCharacterId = HostService.ActiveSession!.OwnerCharacterId
};
_ = api.Invoke(nameof(Cancel), request);
}
public static Task HandleResponse(Cancel.Response cancelResponse)
{
if (cancelResponse.Success)
{
var share = (ShareService)Plugin.GetService<ShareService>();
ConfigurationManager.Instance.OwnedSession = null;
}
else
{
UiService.LastErrorMessage = "Failed to cancel the party.";
}
return Task.CompletedTask;
}
public static Task HandleBroadcast(Cancel.CancelBroadcast cancelBroadcast)
{
var share = (ShareService)Plugin.GetService<ShareService>();
share.RemoveSession(cancelBroadcast.ShareCode);
return Task.CompletedTask;
}
}
}

View File

@ -0,0 +1,44 @@
namespace QuestShare.Services.API
{
internal class GroupJoin_Client
{
public static void HandleDispatch(Objects.ShareCode shareCode) {
var api = (ApiService)Plugin.GetService<ApiService>();
var request = new GroupJoin.Request()
{
Token = ApiService.Token,
Version = Constants.Version,
SessionInfo = shareCode
};
api.Invoke(nameof(GroupJoin), request).ConfigureAwait(false);
}
public static Task HandleResponse(GroupJoin.Response resp)
{
if (resp.Success && resp.Session != null)
{
var share = (ShareService)Plugin.GetService<ShareService>();
Log.Information("Successfully joined group.");
share.AddSession(resp.Session);
var api = (ApiService)Plugin.GetService<ApiService>();
api.OnGroupJoin(new ApiService.GroupJoinEventArgs { Session = resp.Session, IsSuccess = true });
}
else
{
Log.Error("Failed to join group: {Error}", resp.Error);
var api = (ApiService)Plugin.GetService<ApiService>();
api.OnGroupJoin(new ApiService.GroupJoinEventArgs { Session = null, IsSuccess = false });
UiService.LastErrorMessage = $"Failed to join group. {resp.Error}";
}
return Task.CompletedTask;
}
public static Task HandleBroadcast(GroupJoin.GroupJoinBroadcast broadcast)
{
var share = (ShareService)Plugin.GetService<ShareService>();
share.AddSession(broadcast.Session);
return Task.CompletedTask;
}
}
}

View File

@ -0,0 +1,36 @@
namespace QuestShare.Services.API
{
internal class GroupLeave_Client
{
public static void HandleDispatch(Objects.Session session)
{
var api = (ApiService)Plugin.GetService<ApiService>();
var request = new GroupLeave.Request
{
Token = ApiService.Token,
Version = Constants.Version,
Session = session
};
api.Invoke(nameof(GroupLeave), request).ConfigureAwait(false);
}
public static Task HandleResponse(GroupLeave.Response response)
{
if (response.Success && response.Session != null)
{
var share = (ShareService)Plugin.GetService<ShareService>();
share.RemoveSession(response.Session);
}
else
{
UiService.LastErrorMessage = "Failed to leave the party.";
}
return Task.CompletedTask;
}
public static void HandleBroadcast(GroupLeave.GroupLeaveBroadcast broadcast)
{
Log.Debug($"[GroupLeave] {broadcast.Session.OwnerCharacterId} left the party.");
}
}
}

View File

@ -0,0 +1,14 @@
namespace QuestShare.Services.API
{
internal interface IAPIHandler
{
string Method => GetType().Name;
void HandleDispatch();
void HandleDispatch(dynamic? data);
Task HandleResponse(IResponse response);
void InvokeHandler(IAPIHandler handler, IRequest request)
{
_ = ((ApiService)Plugin.GetService<ApiService>()).Invoke(Method, request);
}
}
}

View File

@ -0,0 +1,36 @@
using Newtonsoft.Json;
namespace QuestShare.Services.API
{
internal class Register_Client
{
public static void HandleDispatch()
{
var api = (ApiService)Plugin.GetService<ApiService>();
_ = api.Invoke(nameof(Register), new Common.API.Register.Request
{
Version = Constants.Version,
Token = ApiService.Token,
});
}
public void HandleDispatch(dynamic? data)
{
throw new NotImplementedException();
}
public static Task HandleResponse(Register.Response response)
{
if (response.Success)
{
var host = (HostService)Plugin.GetService<HostService>();
host.Start(response.ShareCode);
}
else
{
Log.Error("Failed to register as host: {0}", response.Error);
}
return Task.CompletedTask;
}
}
}

View File

@ -0,0 +1,43 @@
using Newtonsoft.Json;
namespace QuestShare.Services.API
{
internal class Update_Client
{
public static void HandleDispatch(Objects.OwnedSession session, List<string> partyMembers, bool broadcast = true)
{
var api = (ApiService)Plugin.GetService<ApiService>();
_ = api.Invoke(nameof(Update), new Update.Request
{
Token = ApiService.Token,
Version = Constants.Version,
Session = session,
PartyMembers = partyMembers,
IsQuestUpdate = broadcast
});
}
public static Task HandleResponse(Update.Response response)
{
if (response.Success)
{
Log.Debug("Successfully updated quest status.");
}
else
{
Log.Error("Failed to update quest status: {0}", response.Error);
UiService.LastErrorMessage = $"Failed to update quest status. {response.Error}";
}
return Task.CompletedTask;
}
}
internal class UpdateBroadcast_Client
{
public static Task HandleResponse(Update.UpdateBroadcast response)
{
((ShareService)Plugin.GetService<ShareService>()).UpdateSession(response.Session);
return Task.CompletedTask;
}
}
}

View File

@ -0,0 +1,162 @@
using Dalamud.Plugin.Services;
using Microsoft.AspNetCore.SignalR.Client;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using QuestShare.Services.API;
using System.Diagnostics;
namespace QuestShare.Services
{
internal class ApiService : IService
{
private readonly string socketUrl = ConfigurationManager.Instance.ApiUrl;
private HubConnection ApiConnection { get; set; } = null!;
internal bool IsConnected => ApiConnection.State == HubConnectionState.Connected;
internal HubConnectionState ConnectionState => ApiConnection.State;
internal bool IsAuthorized { get; private set; } = false;
private bool isDisposing = false;
internal static string Token => ConfigurationManager.Instance.Token;
private readonly List<IAPIHandler> apiHandlers = [];
public void Initialize()
{
var builder = new HubConnectionBuilder().WithUrl(socketUrl).ConfigureLogging(logging =>
{
logging.SetMinimumLevel(LogLevel.Information).AddConsole();
});
ApiConnection = builder.Build();
ApiConnection.Closed += async (error) =>
{
if (isDisposing) return;
Log.Warning($"Connection closed... {error}");
Log.Warning($"Connection closed, retrying... {error}");
await Task.Delay(new Random().Next(0, 5) * 1000);
await ApiConnection.StartAsync();
};
#pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
ApiConnection.Reconnected += async (error) =>
{
Log.Information("Connection reconnected");
};
#pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously
ApiConnection.On<AuthRequest.Response>(nameof(AuthRequest), AuthRequest_Client.HandleResponse);
ApiConnection.On<Authorize.Response>(nameof(Authorize), Authorize_Client.HandleResponse);
ApiConnection.On<Register.Response>(nameof(Register), Register_Client.HandleResponse);
ApiConnection.On<GroupJoin.Response>(nameof(GroupJoin), GroupJoin_Client.HandleResponse);
ApiConnection.On<GroupLeave.Response>(nameof(GroupLeave), GroupLeave_Client.HandleResponse);
ApiConnection.On<Cancel.Response>(nameof(Cancel), Cancel_Client.HandleResponse);
ApiConnection.On<Update.Response>(nameof(Update), Update_Client.HandleResponse);
ApiConnection.On<Update.UpdateBroadcast>(nameof(Update.UpdateBroadcast), UpdateBroadcast_Client.HandleResponse);
ApiConnection.On<Cancel.CancelBroadcast>(nameof(Cancel.CancelBroadcast), Cancel_Client.HandleBroadcast);
ApiConnection.On<GroupJoin.GroupJoinBroadcast>(nameof(GroupJoin.GroupJoinBroadcast), GroupJoin_Client.HandleBroadcast);
ApiConnection.On<GroupLeave.GroupLeaveBroadcast>(nameof(GroupLeave.GroupLeaveBroadcast), GroupLeave_Client.HandleBroadcast);
ApiConnection.On<SessionStart.Response>(nameof(SessionStart), SessionStart_Client.HandleResponse);
ClientState.Login += OnLogin;
ClientState.Logout += OnLogout;
Framework.Update += SavePersistedConfig;
}
public void Shutdown()
{
isDisposing = true;
if (IsConnected)
{
ApiConnection.StopAsync();
}
ApiConnection.DisposeAsync();
ClientState.Login -= OnLogin;
ClientState.Logout -= OnLogout;
Framework.Update -= SavePersistedConfig;
}
public void OnLogin()
{
if (Token != "" && ConfigurationManager.Instance.ConnectOnStartup)
{
Task.Run(Connect);
}
}
public void OnLogout(int code, int type)
{
ConfigurationManager.Save();
IsAuthorized = false;
ApiConnection.StopAsync().ConfigureAwait(false);
}
private void SavePersistedConfig(IFramework _)
{
ConfigurationManager.Instance.Token = Token;
}
public async Task Connect()
{
try
{
if (IsConnected) await ApiConnection.StopAsync();
isDisposing = false;
await ApiConnection.StartAsync().ContinueWith(task =>
{
if (task.IsFaulted)
{
Log.Error("Failed to connect to socket server");
}
else
{
Log.Information("Connected to socket server");
}
});
}
catch (Exception ex)
{
Log.Error(ex.Message);
}
}
public async Task Disconnect()
{
isDisposing = true;
await ApiConnection.StopAsync();
}
internal async Task Invoke(string methodName, object request)
{
if (!IsConnected) await Connect();
Log.Debug($"Invoking {methodName} with {JsonConvert.SerializeObject(request)}");
var s = new StackTrace();
Log.Debug(s.ToString());
await ApiConnection.InvokeAsync(methodName, request).ContinueWith(t =>
{
if (t.IsFaulted)
{
Log.Error($"Failed to invoke {methodName}: {t.Exception}");
}
});
}
public static void DispatchAuthorize() => Authorize_Client.HandleDispatch();
public static void DispatchRegister() => Register_Client.HandleDispatch();
public static void DispatchGroup(Objects.ShareCode shareCode) => GroupJoin_Client.HandleDispatch(shareCode);
public static void DispatchUngroup(Objects.Session session) => GroupLeave_Client.HandleDispatch(session);
public static void DispatchCancel() => Cancel_Client.HandleDispatch();
public static void DispatchUpdate(Objects.OwnedSession session, List<string> partyMembers) => Update_Client.HandleDispatch(session, partyMembers, true);
public static void DispatchConfigChange(Objects.OwnedSession session, List<string> partyMembers) => Update_Client.HandleDispatch(session, partyMembers, false);
public static void DispatchSessionStart(Objects.OwnedSession session) => SessionStart_Client.HandleDispatch(session);
public event EventHandler<GroupJoinEventArgs>? GroupJoined;
internal void OnGroupJoin(GroupJoinEventArgs e)
{
GroupJoined?.Invoke(this, e);
}
public class GroupJoinEventArgs : EventArgs
{
public bool IsSuccess { get; set; }
public Objects.Session? Session { get; set; }
}
}
}

View File

@ -0,0 +1,27 @@
using Dalamud.Game.Command;
namespace QuestShare.Services
{
internal class CommandService : IService
{
public void Initialize()
{
CommandManager.AddHandler("/questshare", new CommandInfo(OnCommand)
{
HelpMessage = "Open the Quest Share window."
});
}
public void Shutdown()
{
CommandManager.RemoveHandler("/questshare");
}
private static void OnCommand(string command, string args)
{
Log.Information($"Command received: {command} {args}");
if (command == "/questshare")
{
UiService.ToggleMainUI();
}
}
}
}

View File

@ -0,0 +1,8 @@
namespace QuestShare.Services
{
internal interface IService
{
void Initialize();
void Shutdown();
}
}

View File

@ -0,0 +1,66 @@
using Dalamud.Plugin.Services;
namespace QuestShare.Services
{
internal class PartyService : IService
{
public void Initialize()
{
Framework.Update += OnFramework;
}
public void Shutdown()
{
Framework.Update -= OnFramework;
}
public long PartyId { get; private set; }
private List<long> PartyMembers { get; set; } = [];
private void OnFramework(IFramework framework)
{
if (PartyList.Length > 0 && PartyId == 0)
{
PartyId = PartyList.PartyId;
Log.Debug($"Joined party {PartyId}");
PartyMembers.Clear();
foreach (var member in PartyList)
{
Log.Debug($"Party member {member.Name.TextValue} - {member.ContentId}");
PartyMembers.Add(member.ContentId);
}
}
else if (PartyList.Length == 0 && PartyId != 0)
{
PartyId = 0;
Log.Debug($"Left party");
PartyMembers.Clear();
}
else if (PartyList.Length != PartyMembers.Count)
{
var newMembers = PartyList.Where(x => !PartyMembers.Contains(x.ContentId)).ToList();
var leftMembers = PartyMembers.Where(x => !PartyList.Any(y => y.ContentId == x)).ToList();
foreach (var member in newMembers)
{
Log.Debug($"Party member {member.Name.TextValue} - {member.ContentId}");
PartyMembers.Add(member.ContentId);
}
foreach (var member in leftMembers)
{
Log.Debug($"Party member left {member}");
PartyMembers.Remove(member);
}
}
}
public List<string> GetPartyMembers(Objects.Session session)
{
var members = new List<string>();
foreach (var member in PartyList)
{
members.Add(member.ContentId.ToString().SaltedHash(session.ShareCode));
}
return members;
}
}
}

View File

@ -0,0 +1,131 @@
using Dalamud.Plugin.Services;
namespace QuestShare.Services
{
internal class ShareService : IService
{
internal static List<Objects.ShareCode> ShareCodes => ConfigurationManager.Instance.KnownShareCodes;
internal List<Objects.Session> Sessions { get; private set; } = [];
internal Dictionary<long, string> CharacterLookup { get; private set; } = [];
public void Initialize()
{
ClientState.Login += OnLogin;
ClientState.Logout += OnLogout;
Framework.Update += OnFrameworkUpdate;
}
public void Shutdown()
{
OnLogout(0, 0);
ClientState.Login -= OnLogin;
ClientState.Logout -= OnLogout;
Framework.Update -= OnFrameworkUpdate;
CharacterLookup.Clear();
Sessions.Clear();
}
private void OnLogin()
{
CharacterLookup.Clear();
CharacterLookup.Add((long)ClientState.LocalContentId, ClientState.LocalPlayer!.Name.TextValue);
foreach (var character in ConfigurationManager.Instance.KnownCharacters)
{
CharacterLookup.Add(character.Key, character.Value);
}
}
private void OnLogout(int code, int state)
{
ConfigurationManager.Save();
CharacterLookup.Clear();
Sessions.Clear();
}
private int pCount = 0;
private void OnFrameworkUpdate(IFramework framework)
{
if (PartyList.Count != pCount)
{
foreach (var partyMember in PartyList)
{
AddKnownCharacter(partyMember.ContentId, partyMember.Name.TextValue);
}
pCount = PartyList.Count;
}
}
public static void SetActiveQuest(uint questId, byte questStep)
{
Log.Debug($"Setting active quest to {questId} - {questStep}");
HostService.Update((int)questId, questStep);
}
public void AddSession(Objects.Session session)
{
if (Sessions.Any(s => s.ShareCode == session.ShareCode))
{
return;
}
Sessions.Add(session);
AddKnownShareCode(new Objects.ShareCode() { Code = session.ShareCode, CharacterId = ClientState.LocalContentId.ToString().SaltedHash(session.ShareCode) });
}
public void RemoveSession(Objects.Session session)
{
Sessions.Remove(session);
RemoveKnownShareCode(session.ShareCode);
}
public void RemoveSession(string shareCode)
{
var session = Sessions.FirstOrDefault(s => s.ShareCode == shareCode);
if (session != null)
{
RemoveSession(session);
}
}
public void UpdateSession(Objects.Session session)
{
var existing = Sessions.FirstOrDefault(s => s.ShareCode == session.ShareCode);
if (existing != null)
{
Sessions.Remove(existing);
}
Sessions.Add(session);
}
public static void AddKnownShareCode(Objects.ShareCode shareCode)
{
if (ConfigurationManager.Instance.KnownShareCodes.Any(sc => sc.Code == shareCode.Code))
{
return;
}
ConfigurationManager.Instance.KnownShareCodes.Add(shareCode);
}
public static void RemoveKnownShareCode(string shareCode)
{
ConfigurationManager.Instance.KnownShareCodes.RemoveAll(sc => sc.Code == shareCode);
}
public static void AddKnownCharacter(long contentId, string characterId)
{
if (ConfigurationManager.Instance.KnownCharacters.ContainsKey(contentId))
{
return;
}
ConfigurationManager.Instance.KnownCharacters.Add(contentId, characterId);
ConfigurationManager.Save();
}
public static void RemoveKnownCharacter(long contentId)
{
ConfigurationManager.Instance.KnownCharacters.Remove(contentId);
ConfigurationManager.Save();
}
}
}

View File

@ -0,0 +1,38 @@
using Dalamud.Interface.Windowing;
using QuestShare.Windows.MainWindow;
namespace QuestShare.Services
{
internal class UiService : IService
{
public static WindowSystem WindowSystem = new("QuestShare");
public static MainWindow MainWindow { get; private set; } = new();
public static string LastErrorMessage { get; set; } = string.Empty;
public void Initialize()
{
WindowSystem.AddWindow(MainWindow);
PluginInterface.UiBuilder.Draw += DrawUI;
// This adds a button to the plugin installer entry of this plugin which allows
// to toggle the display status of the configuration ui
PluginInterface.UiBuilder.OpenConfigUi += ToggleConfigUI;
// Adds another button that is doing the same but for the main ui of the plugin
PluginInterface.UiBuilder.OpenMainUi += ToggleMainUI;
}
public void Shutdown()
{
WindowSystem.RemoveAllWindows();
PluginInterface.UiBuilder.Draw -= DrawUI;
PluginInterface.UiBuilder.OpenConfigUi -= ToggleConfigUI;
PluginInterface.UiBuilder.OpenMainUi -= ToggleMainUI;
MainWindow.Dispose();
}
private static void DrawUI() => WindowSystem.Draw();
public static void ToggleConfigUI() => MainWindow.Toggle();
public static void ToggleMainUI() => MainWindow.Toggle();
}
}

View File

@ -0,0 +1,26 @@
using Dalamud.Interface.Utility;
using ImGuiNET;
using System.Numerics;
namespace QuestShare.Windows
{
/// <summary>
/// Contains utility functions for ImGui.
/// </summary>
internal static class ImGuiUtils
{
public static Vector2 WindowSize = ImGuiHelpers.ScaledVector2(700, 600);
public static Vector2 IconSize = ImGuiHelpers.ScaledVector2(40, 40);
public static Vector2 SmallIconSize = ImGuiHelpers.ScaledVector2(20, 20);
public static Vector2 LineIconSize = new(ImGui.GetFrameHeight(), 0);
public static Vector2 ItemSpacing = ImGui.GetStyle().ItemSpacing;
public static Vector2 FramePadding = ImGui.GetStyle().FramePadding;
public static Vector2 IconButtonSize = new(ImGui.GetFrameHeight(), 0);
public static float SelectorWidth = Math.Max(ImGui.GetWindowSize().X * 0.15f, 150 * Scale);
public static Vector2 HorizontalSpace = Vector2.Zero;
public static float TextHeight = ImGui.GetTextLineHeight();
public static float TextHeightSpacing = ImGui.GetTextLineHeightWithSpacing();
public static float Scale = ImGuiHelpers.GlobalScale;
public static float TextWidth(string text) => ImGui.CalcTextSize(text).X + ItemSpacing.X;
}
}

View File

@ -0,0 +1,411 @@
using System.Numerics;
using Dalamud.Interface;
using Dalamud.Interface.Colors;
using Dalamud.Interface.Components;
using Dalamud.Interface.Utility.Raii;
using Dalamud.Interface.Windowing;
using ImGuiNET;
using Microsoft.AspNetCore.SignalR.Client;
using QuestShare.Services;
using static QuestShare.Services.ApiService;
namespace QuestShare.Windows.MainWindow;
public class MainWindow : Window, IDisposable
{
public MainWindow()
: base(Plugin.Name + "###Main", ImGuiWindowFlags.NoScrollbar | ImGuiWindowFlags.NoScrollWithMouse)
{
SizeConstraints = new WindowSizeConstraints
{
MinimumSize = new Vector2(600, 650),
MaximumSize = new Vector2(float.MaxValue, float.MaxValue)
};
}
public override void OnOpen()
{
}
public void Dispose() { }
private ApiService ApiService => (ApiService)Plugin.GetService<ApiService>();
private ShareService ShareService => (ShareService)Plugin.GetService<ShareService>();
private PartyService PartyService => (PartyService)Plugin.GetService<PartyService>();
private HostService HostService => (HostService)Plugin.GetService<HostService>();
private GameQuest? selectedQuest = GameQuestManager.GetActiveQuest();
private enum ActiveTab
{
Host,
Join,
Settings
}
public override void Draw()
{
ImGui.TextUnformatted("Server Status: "); ImGui.SameLine();
DrawConnectionState();
ImGui.SameLine();
if (ApiService.IsConnected)
{
if (ImGuiComponents.IconButton(FontAwesomeIcon.Unlink, ImGuiColors.DPSRed))
{
_ = ApiService.Disconnect();
}
}
else
{
if (ImGuiComponents.IconButton(FontAwesomeIcon.Link, ImGuiColors.DPSRed))
{
_ = ApiService.Connect();
}
}
// ImGui.SameLine();
ImGui.Separator();
using (ImRaii.TabBar("MainTabBar", ImGuiTabBarFlags.NoCloseWithMiddleMouseButton))
{
ImGui.BeginDisabled(!ApiService.IsConnected);
if (ImGui.BeginTabItem("Host Group"))
{
DrawHostTab();
ImGui.EndTabItem();
}
if (ImGui.BeginTabItem("Join Group"))
{
DrawJoinTab();
ImGui.EndTabItem();
}
ImGui.EndDisabled();
if (ImGui.BeginTabItem("Settings"))
{
DrawSettingsTab();
ImGui.EndTabItem();
}
}
ImGui.Separator();
if (UiService.LastErrorMessage != null)
{
// ImGui.TextColored(ImGuiColors.DPSRed, UiService.LastErrorMessage);
}
}
private void DrawConnectionState()
{
switch (this.ApiService.ConnectionState)
{
case HubConnectionState.Connecting:
ImGui.TextColored(ImGuiColors.DalamudYellow, "Connecting...");
break;
case HubConnectionState.Connected:
ImGui.TextColored(ImGuiColors.HealerGreen, "Connected");
break;
case HubConnectionState.Disconnected:
ImGui.TextColored(ImGuiColors.DPSRed, "Disconnected");
break;
case HubConnectionState.Reconnecting:
ImGui.TextColored(ImGuiColors.DalamudYellow, "Reconnecting...");
break;
default:
break;
}
}
private bool generatePending = false;
private void DrawHostTab()
{
if (HostService.ActiveSession != null && HostService.ActiveSession.ShareCode != null) generatePending = false;
var isEnabled = ConfigurationManager.Instance.EnableHosting;
if (ImGuiComponents.ToggleButton(Namespace + "/Enable Hosting", ref isEnabled))
{
ConfigurationManager.Instance.EnableHosting = isEnabled;
ConfigurationManager.Save();
}
ImGui.SameLine();
ImGui.TextUnformatted("Enable Hosting");
ImGui.Separator();
if (isEnabled)
{
ImGui.TextUnformatted("Share Code:");
ImGui.SameLine();
if (HostService.ActiveSession != null)
{
ImGui.TextColored(ImGuiColors.HealerGreen, HostService.ActiveSession.ShareCode);
if (ImGui.IsItemClicked())
{
ImGui.SetClipboardText(HostService.ActiveSession.ShareCode);
}
if (ImGui.IsItemHovered())
{
ImGui.SetTooltip("Click to copy to clipboard.");
}
ImGui.SameLine();
if (ImGui.Button("Cancel"))
{
DispatchCancel();
}
if (ImGui.IsItemHovered())
{
ImGui.SetTooltip("Cancel the current session. This will permanently remove the share code and all connected clients.");
}
var allowJoins = HostService.AllowJoins;
var skipPartyCheck = HostService.SkipPartyCheck;
var sendUpdates = HostService.IsActive;
if (ImGui.Checkbox("Allow new Joins", ref allowJoins))
{
HostService.SetAllowJoins(allowJoins);
}
ImGui.SameLine();
if (ImGui.Checkbox("Skip Party Check", ref skipPartyCheck))
{
HostService.SetSkipPartyCheck(skipPartyCheck);
}
ImGui.SameLine();
if (ImGui.Checkbox("Send Updates", ref sendUpdates))
{
HostService.SetIsActive(sendUpdates);
}
var shareMsq = ConfigurationManager.Instance.TrackMSQ;
ImGui.BeginDisabled(shareMsq);
using (var combo = ImRaii.Combo("##Quests", GameQuestManager.GetActiveQuest()?.QuestName ?? "---SELECT---", ImGuiComboFlags.HeightRegular))
{
if (combo)
{
foreach (var quest in GameQuestManager.GameQuests.OrderBy(q => q.QuestName))
{
if (ImGui.Selectable(quest.QuestName))
{
selectedQuest = quest;
GameQuestManager.SetActiveFlag(quest.QuestId);
HostService.Update((int)quest.QuestId, quest.CurrentStep);
ConfigurationManager.Save();
}
}
}
}
ImGui.SameLine();
if (ImGui.Button("Refresh"))
{
GameQuestManager.LoadQuests();
}
ImGui.EndDisabled();
ImGui.SameLine();
var track = ConfigurationManager.Instance.TrackMSQ;
if (ImGui.Checkbox("Track MSQ", ref track))
{
ConfigurationManager.Instance.TrackMSQ = track;
ConfigurationManager.Save();
}
if (selectedQuest == null && GameQuestManager.GetActiveQuest() == null)
{
ImGui.TextUnformatted("No quest selected.");
return;
}
else if (GameQuestManager.GetActiveQuest() != null)
{
selectedQuest = GameQuestManager.GetActiveQuest();
}
ImGui.TextUnformatted("Active Quest:");
ImGui.SameLine();
ImGui.TextUnformatted(selectedQuest!.QuestName);
ImGui.TextUnformatted("Current Step:");
ImGui.SameLine();
ImGui.TextUnformatted(selectedQuest.CurrentStep.ToString());
ImGui.Separator();
ImGui.TextUnformatted("Quest Steps:");
ImGui.Separator();
var steps = selectedQuest.QuestSteps;
for (var i = 0; i < steps!.Count; i++)
{
if (i + 1 == selectedQuest.CurrentStep || (selectedQuest.CurrentStep == 0 && i == 0) || (selectedQuest.CurrentStep == 0xFF && i + 1 == steps.Count))
{
ImGui.TextColored(ImGuiColors.HealerGreen, steps[i]);
}
else if (i + 1 < selectedQuest.CurrentStep)
{
ImGui.TextColored(ImGuiColors.DalamudYellow, steps[i]);
}
else
{
ImGui.TextUnformatted("???");
}
}
} else {
ImGui.BeginDisabled(generatePending);
if (ImGui.Button("Generate New"))
{
ApiService.DispatchRegister();
}
ImGui.EndDisabled();
}
}
}
private string enteredShareCode = "";
private bool isJoining = false;
private bool isLeaving = false;
private void OnGroupJoin(object? sender, GroupJoinEventArgs args)
{
isJoining = false;
ApiService.GroupJoined -= OnGroupJoin;
}
private void DrawJoinTab()
{
ImGui.TextUnformatted("Enter Share Code:");
ImGui.SameLine();
ImGui.BeginDisabled(isJoining);
ImGui.InputText("##ShareCode", ref enteredShareCode, 8);
ImGui.SameLine();
var btn = "Join";
if (isJoining) btn = "Joining...";
if (ImGui.Button(btn))
{
var payload = new Objects.ShareCode { CharacterId = ClientState.LocalContentId.ToString().SaltedHash(enteredShareCode), Code = enteredShareCode };
isJoining = true;
ApiService.GroupJoined += OnGroupJoin;
ApiService.DispatchGroup(payload);
}
ImGui.EndDisabled();
ImGui.Separator();
ImGui.TextUnformatted("Currently Joined Groups");
if (ShareService.Sessions.Count == 0)
{
ImGui.TextUnformatted("No groups joined.");
}
else
{
foreach (var session in ShareService.Sessions)
{
using var tree = ImRaii.TreeNode($"Session: {session.ShareCode}");
if (tree)
{
DrawSessionDetails(session);
if (ImGui.Button("Leave Group"))
{
ApiService.DispatchUngroup(session);
isLeaving = true;
}
}
}
}
}
private void DrawSessionDetails(Objects.Session session)
{
ImGui.TextUnformatted($"Owner: {session.OwnerCharacterId}");
var activeQuest = session.ActiveQuestId;
var activeStep = session.ActiveQuestStep;
if (activeQuest != 0)
{
var questInfo = GameQuestManager.GetQuestById((uint)activeQuest);
var steps = questInfo.QuestSteps;
ImGui.TextUnformatted(questInfo.QuestData.Name.ExtractText());
ImGui.TextUnformatted("Current Step:");
ImGui.SameLine();
ImGui.TextUnformatted(activeStep.ToString());
ImGui.Separator();
ImGui.TextUnformatted("Quest Steps:");
ImGui.Separator();
for (var i = 0; i < steps.Count; i++)
{
if (i + 1 == activeStep || (i + 1 == steps.Count && activeStep == 0xFF))
{
ImGui.TextColored(ImGuiColors.HealerGreen, steps[i]);
}
else
{
ImGui.TextUnformatted(steps[i]);
}
}
if (ImGui.Button("Get Marker"))
{
var marker = questInfo.GetMapLink((byte)(activeStep - 1));
if (marker != null)
GameGui.OpenMapWithMapLink(marker);
else
Log.Error("No map link available for this quest.");
}
if (ImGui.IsItemHovered())
{
ImGui.SetTooltip("Generates a map marker for the current step's destination.");
}
// ImGui.SameLine();
/*if (ImGui.Button("Teleport"))
{
// attempt to generate a path to the next step
}
if (ImGui.IsItemHovered())
{
ImGui.SetTooltip("Teleports to nearest aetheryte of quest destination.");
}*/
} else
{
ImGui.TextUnformatted("No active quest or host is offline.");
}
}
private void DrawSettingsTab()
{
var selectedApiServer = ConfigurationManager.Instance.ApiDisplayName;
if (ImGui.BeginCombo("API Server", selectedApiServer))
{
foreach (var server in ConfigurationManager.Instance.ApiConfigurations)
{
var isSelected = selectedApiServer == server.DisplayName;
if (ImGui.Selectable(server.DisplayName, isSelected))
{
var index = Array.FindIndex(ConfigurationManager.Instance.ApiConfigurations, x => x.DisplayName == server.DisplayName);
ConfigurationManager.Instance.ApiConfigurations[index].Active = true;
foreach (var config in ConfigurationManager.Instance.ApiConfigurations)
{
if (config.DisplayName != server.DisplayName)
{
config.Active = false;
}
}
ConfigurationManager.Save();
}
if (isSelected)
{
ImGui.SetItemDefaultFocus();
}
}
ImGui.EndCombo();
}
ImGui.SameLine();
if (ImGui.Button("Add"))
{
// does nothing yet
}
var connectOnStartup = ConfigurationManager.Instance.ConnectOnStartup;
if (ImGui.Checkbox("Connect on Startup", ref connectOnStartup))
{
ConfigurationManager.Instance.ConnectOnStartup = connectOnStartup;
ConfigurationManager.Save();
}
var autoShareMsq = ConfigurationManager.Instance.AutoShareMsq;
if (ImGui.Checkbox("Auto Share MSQ", ref autoShareMsq))
{
ConfigurationManager.Instance.AutoShareMsq = autoShareMsq;
ConfigurationManager.Save();
}
var autoShareNewQuests = ConfigurationManager.Instance.AutoShareNewQuests;
if (ImGui.Checkbox("Auto Share New Quests", ref autoShareNewQuests))
{
ConfigurationManager.Instance.AutoShareNewQuests = autoShareNewQuests;
ConfigurationManager.Save();
}
}
}

View File

@ -0,0 +1,243 @@
{
"version": 1,
"dependencies": {
"net8.0-windows7.0": {
"DalamudPackager": {
"type": "Direct",
"requested": "[11.0.0, )",
"resolved": "11.0.0",
"contentHash": "bjT7XUlhIJSmsE/O76b7weUX+evvGQctbQB8aKXt94o+oPWxHpCepxAGMs7Thow3AzCyqWs7cOpp9/2wcgRRQA=="
},
"DotNet.ReproducibleBuilds": {
"type": "Direct",
"requested": "[1.2.25, )",
"resolved": "1.2.25",
"contentHash": "xCXiw7BCxHJ8pF6wPepRUddlh2dlQlbr81gXA72hdk4FLHkKXas7EH/n+fk5UCA/YfMqG1Z6XaPiUjDbUNBUzg=="
},
"Microsoft.AspNetCore.SignalR.Client": {
"type": "Direct",
"requested": "[8.0.13, )",
"resolved": "8.0.13",
"contentHash": "DSOyT/ccsvAt3VFMgedaBWlo8G2A2BnY+zLWksED2onwYxk4JTla17GcLKQCDyPXnYKKuIRcgpUSSfqBP9VdEw==",
"dependencies": {
"Microsoft.AspNetCore.Http.Connections.Client": "8.0.13",
"Microsoft.AspNetCore.SignalR.Client.Core": "8.0.13"
}
},
"Microsoft.Extensions.Logging": {
"type": "Direct",
"requested": "[9.0.2, )",
"resolved": "9.0.2",
"contentHash": "loV/0UNpt2bD+6kCDzFALVE63CDtqzPeC0LAetkdhiEr/tTNbvOlQ7CBResH7BQBd3cikrwiBfaHdyHMFUlc2g==",
"dependencies": {
"Microsoft.Extensions.DependencyInjection": "9.0.2",
"Microsoft.Extensions.Logging.Abstractions": "9.0.2",
"Microsoft.Extensions.Options": "9.0.2"
}
},
"Microsoft.Extensions.Logging.Console": {
"type": "Direct",
"requested": "[9.0.2, )",
"resolved": "9.0.2",
"contentHash": "eoMjwiM0WpkVGSxzjo/f94ShreFLYhPMjfkOG04WOb8fq/TztpcWaU8XAkMMWZ+mYSbFYln+FBwUOEriXR4jtA==",
"dependencies": {
"Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.2",
"Microsoft.Extensions.Logging": "9.0.2",
"Microsoft.Extensions.Logging.Abstractions": "9.0.2",
"Microsoft.Extensions.Logging.Configuration": "9.0.2",
"Microsoft.Extensions.Options": "9.0.2",
"System.Text.Json": "9.0.2"
}
},
"Microsoft.AspNetCore.Connections.Abstractions": {
"type": "Transitive",
"resolved": "8.0.13",
"contentHash": "Ov8UviDb51fNXL7oQXaKPygQ3lSr0SflDGG5A2H63b98cLdfKNi7xSD0GtfCj4LIhctUZKBx7ViSVgDn3YFlTQ==",
"dependencies": {
"Microsoft.Extensions.Features": "8.0.13",
"System.IO.Pipelines": "8.0.0"
}
},
"Microsoft.AspNetCore.Http.Connections.Client": {
"type": "Transitive",
"resolved": "8.0.13",
"contentHash": "zqoaCWmXrsNT1LcnGtovN2+dYv4jNSxTuefff1MZKmVFcJVHBALS7FEwITwcxVYpaQrOoKW4X/UGDVqlnOwrQA==",
"dependencies": {
"Microsoft.AspNetCore.Http.Connections.Common": "8.0.13",
"Microsoft.Extensions.Logging.Abstractions": "8.0.3",
"Microsoft.Extensions.Options": "8.0.2"
}
},
"Microsoft.AspNetCore.Http.Connections.Common": {
"type": "Transitive",
"resolved": "8.0.13",
"contentHash": "MS968HjdhR8j3kt0mYs1BErGIx8rHHN1kzDfcdKv4GDph0TyHZrOZPrZDzZ70lPUkWoW1Xb7vQu09RuEpowa6w==",
"dependencies": {
"Microsoft.AspNetCore.Connections.Abstractions": "8.0.13"
}
},
"Microsoft.AspNetCore.SignalR.Client.Core": {
"type": "Transitive",
"resolved": "8.0.13",
"contentHash": "7kYdMlXT8Hn0Crsh699MikhEzS5O0AtLFMDsvxNMcJaD34agheBtnwbF703OI7ZuPkR0DL3/AfO2sV/oy+gpnA==",
"dependencies": {
"Microsoft.AspNetCore.SignalR.Common": "8.0.13",
"Microsoft.AspNetCore.SignalR.Protocols.Json": "8.0.13",
"Microsoft.Extensions.DependencyInjection": "8.0.1",
"Microsoft.Extensions.Logging": "8.0.1",
"System.Threading.Channels": "8.0.0"
}
},
"Microsoft.AspNetCore.SignalR.Common": {
"type": "Transitive",
"resolved": "8.0.13",
"contentHash": "PR7/EHwtXZPjR9MHnfqj5/pMs9Ja5YSyn6epXagjP4r8coOog9BtWaZfLF+XgezqDIDy9m1D4LK7pW6VjunR0Q==",
"dependencies": {
"Microsoft.AspNetCore.Connections.Abstractions": "8.0.13",
"Microsoft.Extensions.Options": "8.0.2"
}
},
"Microsoft.AspNetCore.SignalR.Protocols.Json": {
"type": "Transitive",
"resolved": "8.0.13",
"contentHash": "QfvhwlSyMxN/6xi+NEjLQgtizlYgsKouZF2O5ecp78vyEZJIEQKNuQsoegJBlqd5mWAoQE42Wse6MMBu/J4gUg==",
"dependencies": {
"Microsoft.AspNetCore.SignalR.Common": "8.0.13"
}
},
"Microsoft.Extensions.Configuration": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "EBZW+u96tApIvNtjymXEIS44tH0I/jNwABHo4c33AchWOiDWCq2rL3klpnIo+xGrxoVGJzPDISV6hZ+a9C9SzQ==",
"dependencies": {
"Microsoft.Extensions.Configuration.Abstractions": "9.0.2",
"Microsoft.Extensions.Primitives": "9.0.2"
}
},
"Microsoft.Extensions.Configuration.Abstractions": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "I0O/270E/lUNqbBxlRVjxKOMZyYjP88dpEgQTveml+h2lTzAP4vbawLVwjS9SC7lKaU893bwyyNz0IVJYsm9EA==",
"dependencies": {
"Microsoft.Extensions.Primitives": "9.0.2"
}
},
"Microsoft.Extensions.Configuration.Binder": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "krJ04xR0aPXrOf5dkNASg6aJjsdzexvsMRL6UNOUjiTzqBvRr95sJ1owoKEm89bSONQCfZNhHrAFV9ahDqIPIw==",
"dependencies": {
"Microsoft.Extensions.Configuration.Abstractions": "9.0.2"
}
},
"Microsoft.Extensions.DependencyInjection": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "ZffbJrskOZ40JTzcTyKwFHS5eACSWp2bUQBBApIgGV+es8RaTD4OxUG7XxFr3RIPLXtYQ1jQzF2DjKB5fZn7Qg==",
"dependencies": {
"Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.2"
}
},
"Microsoft.Extensions.DependencyInjection.Abstractions": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "MNe7GSTBf3jQx5vYrXF0NZvn6l7hUKF6J54ENfAgCO8y6xjN1XUmKKWG464LP2ye6QqDiA1dkaWEZBYnhoZzjg=="
},
"Microsoft.Extensions.Features": {
"type": "Transitive",
"resolved": "8.0.13",
"contentHash": "tsfmy1JfRhbKT/uYWxWcR1yhFQXgVAxtvQDou2NkY6UhqkFFxjO7fkd0CWc6YsX/qqbW3VxhabhDRnMKKA72lQ=="
},
"Microsoft.Extensions.Logging.Abstractions": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "dV9s2Lamc8jSaqhl2BQSPn/AryDIH2sSbQUyLitLXV0ROmsb+SROnn2cH939JFbsNrnf3mIM3GNRKT7P0ldwLg==",
"dependencies": {
"Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.2",
"System.Diagnostics.DiagnosticSource": "9.0.2"
}
},
"Microsoft.Extensions.Logging.Configuration": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "pnwYZE7U6d3Y6iMVqADOAUUMMBGYAQPsT3fMwVr/V1Wdpe5DuVGFcViZavUthSJ5724NmelIl1cYy+kRfKfRPQ==",
"dependencies": {
"Microsoft.Extensions.Configuration": "9.0.2",
"Microsoft.Extensions.Configuration.Abstractions": "9.0.2",
"Microsoft.Extensions.Configuration.Binder": "9.0.2",
"Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.2",
"Microsoft.Extensions.Logging": "9.0.2",
"Microsoft.Extensions.Logging.Abstractions": "9.0.2",
"Microsoft.Extensions.Options": "9.0.2",
"Microsoft.Extensions.Options.ConfigurationExtensions": "9.0.2"
}
},
"Microsoft.Extensions.Options": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "zr98z+AN8+isdmDmQRuEJ/DAKZGUTHmdv3t0ZzjHvNqvA44nAgkXE9kYtfoN6581iALChhVaSw2Owt+Z2lVbkQ==",
"dependencies": {
"Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.2",
"Microsoft.Extensions.Primitives": "9.0.2"
}
},
"Microsoft.Extensions.Options.ConfigurationExtensions": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "OPm1NXdMg4Kb4Kz+YHdbBQfekh7MqQZ7liZ5dYUd+IbJakinv9Fl7Ck6Strbgs0a6E76UGbP/jHR532K/7/feQ==",
"dependencies": {
"Microsoft.Extensions.Configuration.Abstractions": "9.0.2",
"Microsoft.Extensions.Configuration.Binder": "9.0.2",
"Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.2",
"Microsoft.Extensions.Options": "9.0.2",
"Microsoft.Extensions.Primitives": "9.0.2"
}
},
"Microsoft.Extensions.Primitives": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "puBMtKe/wLuYa7H6docBkLlfec+h8L35DXqsDKKJgW0WY5oCwJ3cBJKcDaZchv6knAyqOMfsl6VUbaR++E5LXA=="
},
"Newtonsoft.Json": {
"type": "Transitive",
"resolved": "13.0.3",
"contentHash": "HrC5BXdl00IP9zeV+0Z848QWPAoCr9P3bDEZguI+gkLcBKAOxix/tLEAAHC+UvDNPv4a2d18lOReHMOagPa+zQ=="
},
"System.Diagnostics.DiagnosticSource": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "z5CMQNLzk8UKnTEHRKb4nq03CCDWBMEF2gfP3oPKZn4F8wip6LFZCP5rF90DREHqdNddScIGAfszXJSjh4drSw=="
},
"System.IO.Pipelines": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "UIBaK7c/A3FyQxmX/747xw4rCUkm1BhNiVU617U5jweNJssNjLJkPUGhBsrlDG0BpKWCYKsncD+Kqpy4KmvZZQ=="
},
"System.Text.Encodings.Web": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "/kCGdrXg0PXrvkHYyHubXJHcmCAvJrxTZ7g4XS6UCxY1JW79aMjtUW6UYNECHJmiyFZsZ/vUuWOM4CtNpiNt8Q=="
},
"System.Text.Json": {
"type": "Transitive",
"resolved": "9.0.2",
"contentHash": "4TY2Yokh5Xp8XHFhsY9y84yokS7B0rhkaZCXuRiKppIiKwPVH4lVSFD9EEFzRpXdBM5ZeZXD43tc2vB6njEwwQ==",
"dependencies": {
"System.IO.Pipelines": "9.0.2",
"System.Text.Encodings.Web": "9.0.2"
}
},
"System.Threading.Channels": {
"type": "Transitive",
"resolved": "8.0.0",
"contentHash": "CMaFr7v+57RW7uZfZkPExsPB6ljwzhjACWW1gfU35Y56rk72B/Wu+sTqxVmGSk4SFUlPc3cjeKND0zktziyjBA=="
},
"questshare.common": {
"type": "Project",
"dependencies": {
"Newtonsoft.Json": "[13.0.3, )"
}
}
}
}
}

View File

@ -0,0 +1,30 @@
# See https://aka.ms/customizecontainer to learn how to customize your debug container and how Visual Studio uses this Dockerfile to build your images for faster debugging.
# This stage is used when running from VS in fast mode (Default for Debug configuration)
FROM mcr.microsoft.com/dotnet/aspnet:9.0 AS base
USER $APP_UID
WORKDIR /app
EXPOSE 8080
EXPOSE 8081
# This stage is used to build the service project
FROM mcr.microsoft.com/dotnet/sdk:9.0 AS build
ARG BUILD_CONFIGURATION=Release
WORKDIR /src
COPY ["QuestShare.Server/QuestShare.Server.csproj", "QuestShare.Server/"]
RUN dotnet restore "./QuestShare.Server/QuestShare.Server.csproj"
COPY . .
WORKDIR "/src/QuestShare.Server"
RUN dotnet build "./QuestShare.Server.csproj" -c $BUILD_CONFIGURATION -o /app/build
# This stage is used to publish the service project to be copied to the final stage
FROM build AS publish
ARG BUILD_CONFIGURATION=Release
RUN dotnet publish "./QuestShare.Server.csproj" -c $BUILD_CONFIGURATION -o /app/publish /p:UseAppHost=false
# This stage is used in production or when running from VS in regular mode (Default when not using the Debug configuration)
FROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .
ENTRYPOINT ["dotnet", "QuestShare.Server.dll"]

View File

@ -0,0 +1,99 @@
using Microsoft.AspNetCore.SignalR;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using QuestShare.Common;
using QuestShare.Server.Managers;
namespace QuestShare.Server.Hubs
{
public partial class ShareHub : Hub
{
[HubMethodName(nameof(Authorize))]
public async Task Server_Authorize(Authorize.Request request)
{
if (BanManager.IsBanned(Context))
{
Log.Error($"[AUTHORIZE] Client {Context.ConnectionId} is banned.");
Context.Abort();
return;
}
var error = Error.None;
Log.Debug($"[AUTHORIZE] Client {Context.ConnectionId} attempting to authorize. {JsonConvert.SerializeObject(request)}");
if (request.Version != Common.Constants.Version) error = Error.InvalidVersion;
if (error != Error.None)
{
Log.Warning($"[AUTHORIZE] Client {Context.ConnectionId} failed authorization with error {error}.");
await Clients.Caller.SendAsync(nameof(Authorize), new Authorize.Response
{
Success = false,
Error = error,
});
Context.Abort();
return;
}
var client = await ClientManager.GetClient(Context.ConnectionId, request.Token);
if (client == null)
{
// create new client
client = await ClientManager.AddClient(Context.ConnectionId);
Context.Items.Add("Token", client.Token);
Log.Information($"[AUTHORIZE] Client {Context.ConnectionId} authorized with token {client.Token}.");
}
else
{
Log.Information($"[AUTHORIZE] Client {Context.ConnectionId} reauthorized with token {client.Token}.");
Context.Items.Add("Token", client.Token);
await ClientManager.ChangeClientConnectionId(client.ConnectionId, Context.ConnectionId);
}
var sessions = new List<Objects.Session>();
Objects.OwnedSession? ownedSession = null;
foreach(var share in request.ShareCodes)
{
var session = await SessionManager.GetSession(share.Code);
if (session != null)
{
var members = await ClientManager.GetClientsInSession(session);
if (members.Any(m => m.Client.ClientId == client.ClientId))
{
if (session.OwnerCharacterId == share.CharacterId && client.ClientId == session.Owner.ClientId && ownedSession == null)
{
ownedSession = new Objects.OwnedSession
{
Session = new Objects.Session {
OwnerCharacterId = session.OwnerCharacterId,
ShareCode = session.ShareCode,
ActiveQuestId = session.SharedQuestId,
ActiveQuestStep = session.SharedQuestStep
},
SkipPartyCheck = session.SkipPartyCheck,
IsActive = session.IsActive,
AllowJoins = session.AllowJoins,
};
}
else
{
sessions.Add(new Objects.Session
{
OwnerCharacterId = session.OwnerCharacterId,
ActiveQuestId = session.SharedQuestId,
ActiveQuestStep = session.SharedQuestStep,
ShareCode = share.Code,
});
}
await Groups.AddToGroupAsync(Context.ConnectionId, session.ShareCode);
}
}
}
await Clients.Caller.SendAsync(nameof(Authorize), new Authorize.Response
{
Success = true,
Error = Error.None,
Token = client.Token,
Sessions = sessions,
OwnedSession = ownedSession,
});
}
}
}

View File

@ -0,0 +1,67 @@
using Microsoft.AspNetCore.SignalR;
using QuestShare.Common;
using QuestShare.Server.Managers;
namespace QuestShare.Server.Hubs
{
public partial class ShareHub : Hub
{
[HubMethodName(nameof(Cancel))]
public async Task Server_Cancel(Cancel.Request request)
{
if (BanManager.IsBanned(Context))
{
Context.Abort();
return;
}
var client = await ClientManager.GetClient(Context.ConnectionId);
if (client == null)
{
await Clients.Caller.SendAsync(nameof(Cancel), new Cancel.Response
{
Success = false,
Error = Error.Unauthorized,
});
return;
}
var error = Error.None;
if (request.Token == "") error = Error.InvalidToken;
else if (request.Version != Common.Constants.Version) error = Error.InvalidVersion;
var session = await SessionManager.GetSession(request.ShareCode);
if (session == null) error = Error.Unauthorized;
if (session != null && session.OwnerCharacterId != request.OwnerCharacterId) error = Error.InvalidSession;
if (session != null && session.Owner.ClientId != client.ClientId) error = Error.Unauthorized;
if (error != Error.None)
{
await Clients.Caller.SendAsync(nameof(Cancel), new Cancel.Response
{
Success = false,
Error = error,
});
return;
}
await Groups.RemoveFromGroupAsync(Context.ConnectionId, session!.ShareCode.ToString());
if (session.PartyMembers.Count > 0)
{
// broadcast to party
await Clients.GroupExcept(session.SessionId.ToString(), Context.ConnectionId).SendAsync(nameof(Cancel.CancelBroadcast), new Cancel.CancelBroadcast
{
ShareCode = request.ShareCode
});
var members = await ClientManager.GetClientsInSession(session);
foreach (var member in members)
{
await Groups.RemoveFromGroupAsync(member.Client.ConnectionId, session.ShareCode.ToString());
await ClientManager.RemoveClientSession(member.Client);
}
}
await SessionManager.RemoveSession(session!.ShareCode);
await Clients.Caller.SendAsync(nameof(Cancel), new Cancel.Response
{
Success = true,
});
}
}
}

View File

@ -0,0 +1,62 @@
using Microsoft.AspNetCore.SignalR;
using Newtonsoft.Json;
using QuestShare.Common;
using QuestShare.Server.Managers;
using QuestShare.Server.Models;
namespace QuestShare.Server.Hubs
{
public partial class ShareHub : Hub
{
[HubMethodName(nameof(GroupJoin))]
public async Task Server_GroupJoin(GroupJoin.Request request)
{
var error = Error.None;
if (request.Token == "") error = Error.InvalidToken;
if (request.Version != Common.Constants.Version) error = Error.InvalidVersion;
var client = await ClientManager.GetClient(Context.ConnectionId, request.Token);
if (client == null) error = Error.Unauthorized;
if (error != Error.None)
{
await Clients.Caller.SendAsync(nameof(GroupJoin), new GroupJoin.Response
{
Success = false,
Error = error,
});
return;
}
var session = await SessionManager.GetSession(request.SessionInfo.Code);
if (session == null)
{
Log.Warning($"[GroupJoin] Session {request.SessionInfo.Code} not found.");
await Clients.Caller.SendAsync(nameof(GroupJoin), new GroupJoin.Response
{
Success = false,
Error = Error.InvalidParty,
});
return;
}
await ClientManager.AddClientSession(client!.ClientId, session.SessionId);
await Groups.AddToGroupAsync(Context.ConnectionId, session.ShareCode.ToString());
await ClientManager.AddKnownShareCode(client!, session.ShareCode);
await Clients.Caller.SendAsync(nameof(GroupJoin), new GroupJoin.Response
{
Success = true,
Session = new Objects.Session
{
OwnerCharacterId = session.OwnerCharacterId,
ShareCode = session.ShareCode,
},
});
await Clients.GroupExcept(Context.ConnectionId, session.ShareCode.ToString()).SendAsync(nameof(GroupJoin.GroupJoinBroadcast), new GroupJoin.GroupJoinBroadcast
{
Session = new Objects.Session
{
OwnerCharacterId = session.OwnerCharacterId,
ShareCode = session.ShareCode,
},
});
Log.Debug($"[GroupJoin] {client} joined session {request.SessionInfo.Code}");
}
}
}

View File

@ -0,0 +1,76 @@
using Microsoft.AspNetCore.RateLimiting;
using Microsoft.AspNetCore.SignalR;
using QuestShare.Common;
using QuestShare.Server.Managers;
namespace QuestShare.Server.Hubs
{
public partial class ShareHub : Hub
{
[HubMethodName(nameof(GroupLeave))]
[EnableRateLimiting("ClientPolicy")]
public async Task Server_GroupLeave(GroupLeave.Request request)
{
if (BanManager.IsBanned(Context))
{
Context.Abort();
return;
}
var error = Error.None;
if (request.Token == "") error = Error.InvalidToken;
else if (request.Version != Common.Constants.Version) error = Error.InvalidVersion;
var client = await ClientManager.GetClient(Context.ConnectionId);
if (client == null) error = Error.Unauthorized;
if (error != Error.None)
{
await Clients.Caller.SendAsync(nameof(GroupLeave), new GroupLeave.Response
{
Success = false,
Error = error,
});
return;
}
var session = await SessionManager.GetSession(request.Session.ShareCode);
if (session == null)
{
await Clients.Caller.SendAsync(nameof(GroupLeave), new GroupLeave.Response
{
Success = false,
Error = Error.InvalidSession,
});
return;
}
var smember = await SessionManager.GetMembersInSession(session);
if (!smember.Any(s => s.Client.ClientId == client!.ClientId))
{
await Clients.Caller.SendAsync(nameof(GroupLeave), new GroupLeave.Response
{
Success = false,
Error = Error.InvalidMember,
});
return;
}
await SessionManager.RemoveMemberFromSession(session, client!);
await Groups.RemoveFromGroupAsync(Context.ConnectionId, session.ShareCode.ToString());
await ClientManager.RemoveKnownShareCode(client!, session.ShareCode);
await Clients.Caller.SendAsync(nameof(GroupLeave), new GroupLeave.Response
{
Success = true,
Session = new Objects.Session
{
ShareCode = session.ShareCode,
OwnerCharacterId = session.OwnerCharacterId,
}
});
// broadcast to party
await Clients.GroupExcept(session.SessionId.ToString(), Context.ConnectionId).SendAsync(nameof(GroupLeave.GroupLeaveBroadcast), new GroupLeave.GroupLeaveBroadcast
{
Session = new Objects.Session
{
ShareCode = session.ShareCode,
OwnerCharacterId = session.OwnerCharacterId,
}
});
}
}
}

View File

@ -0,0 +1,43 @@
using Microsoft.AspNetCore.RateLimiting;
using Microsoft.AspNetCore.SignalR;
using Newtonsoft.Json;
using QuestShare.Common;
using QuestShare.Server.Hubs;
using QuestShare.Server.Managers;
using QuestShare.Server.Models;
namespace QuestShare.Server.Hubs
{
public partial class ShareHub : Hub
{
[EnableRateLimiting("ClientPolicy")]
[HubMethodName(nameof(Register))]
public async Task Server_Register(Register.Request request)
{
if (BanManager.IsBanned(Context))
{
Log.Warning($"[REGISTER] Client {Context.ConnectionId} is banned.");
Context.Abort();
return;
}
var error = Error.None;
if (request.Version != Constants.Version) error = Error.InvalidVersion;
var client = await ClientManager.GetClient(Context.ConnectionId, request.Token);
if (client == null) error = Error.InvalidToken;
if (client != null)
{
var existingSession = await SessionManager.GetSession(client);
if (existingSession != null) error = Error.AlreadyRegistered;
}
if (error != Error.None)
{
Log.Warning($"[REGISTER] Client {Context.ConnectionId} failed to register: {error}");
await Clients.Caller.SendAsync(nameof(Register), new Register.Response { Error = error, Success = false, ShareCode = "" });
return;
}
var session = await SessionManager.GenerateSession(Context.ConnectionId, client!);
await Clients.Caller.SendAsync(nameof(Register), new Register.Response { Error = Error.None, Success = true, ShareCode = session });
Log.Information($"[REGISTER] Client {Context.ConnectionId} generated share code {session}.");
}
}
}

View File

@ -0,0 +1,53 @@
using Microsoft.AspNetCore.RateLimiting;
using Microsoft.AspNetCore.SignalR;
using Newtonsoft.Json;
using QuestShare.Common;
using QuestShare.Server.Managers;
using QuestShare.Server.Models;
namespace QuestShare.Server.Hubs
{
public partial class ShareHub : Hub
{
[HubMethodName(nameof(Update))]
[EnableRateLimiting("ClientPolicy")]
public async Task Server_Update(Update.Request request)
{
Log.Debug($"[UPDATE] Client {Context.ConnectionId} requested update.");
if (BanManager.IsBanned(Context))
{
Context.Abort();
return;
}
var client = await ClientManager.GetClient(Context.ConnectionId);
var error = Error.None;
if (request.Token == "" || request.Token != client!.Token) error = Error.InvalidToken;
if (client == null) error = Error.Unauthorized;
else if (request.Version != Common.Constants.Version) error = Error.InvalidVersion;
var session = await SessionManager.GetSession(request.Session.ShareCode);
if (session == null) error = Error.InvalidSession;
if (error != Error.None)
{
Log.Warning($"[UPDATE] Client {Context.ConnectionId} failed update with error {error}.");
await Clients.Caller.SendAsync(nameof(Update), new Update.Response
{
Success = false,
Error = error,
});
return;
}
await SessionManager.UpdateActiveQuest(request.Session.ShareCode, request.Session.ActiveQuestId, request.Session.ActiveQuestStep);
await SessionManager.SetPartyMembers(session!.ShareCode, [.. request.PartyMembers]);
await Clients.Caller.SendAsync(nameof(Update), new Update.Response
{
Success = true,
Error = Error.None,
});
// Broadcast to party
await Clients.GroupExcept(session.ShareCode.ToString(), Context.ConnectionId).SendAsync(nameof(Update.UpdateBroadcast), new Update.UpdateBroadcast
{
Session = request.Session.Session,
});
}
}
}

View File

@ -0,0 +1,34 @@
using Microsoft.AspNetCore.RateLimiting;
using Microsoft.AspNetCore.SignalR;
using QuestShare.Server.Managers;
using Microsoft.AspNetCore.Http.Features;
using QuestShare.Server.Models;
namespace QuestShare.Server.Hubs
{
public partial class ShareHub : Hub
{
public override Task OnConnectedAsync()
{
Log.Information($"Client connected: {Context.ConnectionId}");
if (BanManager.IsBanned(Context))
{
Log.Warning($"Client {Context.ConnectionId} is banned.");
Context.Abort();
}
Clients.Caller.SendAsync(nameof(AuthRequest), new AuthRequest.Response
{
});
return base.OnConnectedAsync();
}
public override Task OnDisconnectedAsync(Exception? exception)
{
Log.Information($"Client {Context.ConnectionId} disconnected.");
if (exception != null)
{
Log.Error(exception, "Exception occurred on disconnect.");
}
return base.OnDisconnectedAsync(exception);
}
}
}

View File

@ -0,0 +1,69 @@
using Microsoft.AspNetCore.Http.Features;
using Microsoft.AspNetCore.SignalR;
using QuestShare.Server.Models;
using System.Net;
namespace QuestShare.Server.Managers
{
public static class BanManager
{
public static void Ban(HubCallerContext context, string reason, ulong characterId = 0)
{
using var db = new QuestShareContext();
var ip = GetIp(context)!;
db.Bans.Add(new Ban
{
BanIp = ip,
BanCharacterId = characterId,
BanReason = reason,
BanIssuer = "Server",
BanDate = DateTime.UtcNow,
BanExpiry = DateTime.UtcNow.AddHours(1)
});
Console.WriteLine($"Banned {ip} for {reason}");
}
public static bool IsBanned(HubCallerContext context, ulong characterId = 0)
{
using var db = new QuestShareContext();
var ip = GetIp(context)!;
return db.Bans.Any(b => (b.BanIp == ip || b.BanCharacterId == characterId) && b.BanExpiry > DateTime.UtcNow);
}
public static IPAddress? GetIp(HubCallerContext context)
{
var feature = context.Features.Get<IHttpConnectionFeature>();
var httpContext = context.GetHttpContext();
if (httpContext == null) return feature!.RemoteIpAddress!;
if (httpContext.Request.Headers.TryGetValue("X-Forwarded-For", out var value))
{
return IPAddress.Parse(value!);
}
else if (httpContext.Request.Headers.TryGetValue("X-Real-IP", out value))
{
return IPAddress.Parse(value!);
}
else if (httpContext.Request.Headers.TryGetValue("CF-Connecting-IP", out value))
{
return IPAddress.Parse(value!);
}
else
{
return feature!.RemoteIpAddress;
}
}
public static bool CheckBadRequests(HubCallerContext context, string requestType)
{
var requests = context.Items.TryGetValue(requestType, out var value) ? (int)value! : 0;
if (requests > 5)
{
Ban(context, $"Excessive bad {requestType} requests.");
return true;
} else
{
context.Items[requestType] = requests + 1;
return false;
}
}
}
}

View File

@ -0,0 +1,31 @@
using QuestShare.Server.Models;
namespace QuestShare.Server.Managers
{
public class CleanupManager
{
// Cleans up old database entries
private static int CleanupTimeMinutes = 60;
private static Timer Timer = null!;
public void Initialize()
{
// Set up a timer to run every hour
Timer = new Timer(new TimerCallback(CleanupTask), dueTime: 1000, period: CleanupTimeMinutes*60*1000, state: null);
}
public void Dispose()
{
Timer.Dispose();
}
private static void CleanupTask(object? timerState)
{
using var shareContext = new QuestShareContext();
var toDelete = shareContext.Sessions.Where(s => s.LastUpdated < DateTime.Now.AddMinutes(-CleanupTimeMinutes)).ToList();
Console.WriteLine($"Deleting {toDelete.Count} old shares.");
shareContext.Sessions.RemoveRange(toDelete);
shareContext.SaveChanges();
}
}
}

View File

@ -0,0 +1,136 @@
using Microsoft.EntityFrameworkCore;
using QuestShare.Server.Models;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.Security.Cryptography;
namespace QuestShare.Server.Managers
{
public static class ClientManager
{
public static async Task<Client> AddClient(string connectionId)
{
using var context = new QuestShareContext();
var token = GenerateToken();
var c = context.Clients.Add(new Client
{
ConnectionId = connectionId,
Token = token
});
await context.SaveChangesAsync();
return c.Entity;
}
public static async Task RemoveClient(string connectionId)
{
using var context = new QuestShareContext();
var client = context.Clients.FirstOrDefault(c => c.ConnectionId == connectionId);
if (client != null)
{
context.Clients.Remove(client);
}
await context.SaveChangesAsync();
}
public static async Task<Client?> GetClient(string connectionId, string token = "")
{
using var context = new QuestShareContext();
var client = await context.Clients.Where(c => c.ConnectionId == connectionId || c.Token == token).FirstOrDefaultAsync();
if (client != null)
{
if (token != "" && client.Token != token)
{
Log.Warning($"[ClientManager] Found a client, but tokens did not match. {token} != {client.Token}");
return null;
}
if (client.ConnectionId != connectionId)
{
Log.Information($"[ClientManager] Changing connection ID from {connectionId} to {client.ConnectionId} for token {token}");
await ChangeClientConnectionId(client.ConnectionId, connectionId);
}
return client;
} else
{
Log.Warning($"[ClientManager] Unable to find client for {connectionId} or token {token}");
return null;
}
}
public static async Task<List<SessionMember>> GetClientsInSession(Session session)
{
using var context = new QuestShareContext();
var clients = await context.SessionMembers.Where(c => c.Session == session).Include(s => s.Session).Include(sm => sm.Client).ToListAsync();
return clients;
}
public static async Task RemoveClientSession(Client client)
{
using var context = new QuestShareContext();
var cs = await context.SessionMembers.Where(cs => cs.Client.ClientId == client.ClientId).FirstOrDefaultAsync();
if (cs == null)
{
Log.Warning($"[ClientManager] Unable to find client session for {client.ClientId}");
return;
}
context.SessionMembers.Remove(cs);
Log.Debug($"[ClientManager] Removing client {client.ClientId} from session");
await context.SaveChangesAsync();
}
public static async Task AddClientSession(Guid ClientId, Guid SessionId)
{
using var context = new QuestShareContext();
var client = await context.Clients.Where(c => c.ClientId == ClientId).FirstOrDefaultAsync();
var session = await context.Sessions.Where(s => s.SessionId == SessionId).FirstOrDefaultAsync();
if (client == null || session == null)
{
Log.Warning($"[ClientManager] Unable to find client {ClientId} or session {SessionId}");
return;
}
await context.SessionMembers.AddAsync(new SessionMember
{
Client = client,
Session = session
});
Log.Debug($"[ClientManager] Adding client {client.ClientId} to session {session.SessionId}");
await context.SaveChangesAsync();
}
public static async Task ChangeClientConnectionId(string oldConnectionId, string newConnectionId)
{
using var context = new QuestShareContext();
var client = await context.Clients.Where(c => c.ConnectionId == oldConnectionId).FirstOrDefaultAsync();
if (client != null)
{
client.ConnectionId = newConnectionId;
await context.SaveChangesAsync();
}
}
public static async Task AddKnownShareCode(Client client, string shareCode)
{
using var context = new QuestShareContext();
var c = await context.Clients.Where(c => c.ClientId == client.ClientId).FirstOrDefaultAsync();
if (c != null)
{
c.KnownShareCodes.Add(shareCode);
await context.SaveChangesAsync();
}
}
public static async Task RemoveKnownShareCode(Client client, string shareCode)
{
using var context = new QuestShareContext();
var c = await context.Clients.Where(c => c.ClientId == client.ClientId).FirstOrDefaultAsync();
if (c != null)
{
c.KnownShareCodes.Remove(shareCode);
await context.SaveChangesAsync();
}
}
public static string GenerateToken()
{
var random = RandomNumberGenerator.GetHexString(32, true);
return random;
}
}
}

View File

@ -0,0 +1,115 @@
using Microsoft.EntityFrameworkCore;
using QuestShare.Common;
using QuestShare.Server.Models;
namespace QuestShare.Server.Managers
{
public class SessionManager
{
public static async Task<Session?> GetSession(Client client)
{
using var context = new QuestShareContext();
return await context.Sessions.Where(s => s.Owner.ClientId == client.ClientId).FirstOrDefaultAsync();
}
public static async Task<Session?> GetSession(string ShareCode)
{
using var context = new QuestShareContext();
var session = await context.Sessions.Where(s => s.ShareCode == ShareCode).FirstOrDefaultAsync();
return session;
}
public static async Task<string> GenerateSession(string connectionId, Client client)
{
using var context = new QuestShareContext();
var token = ClientManager.GenerateToken();
var c = await context.Clients.Where(c => c.ClientId == client.ClientId).FirstOrDefaultAsync();
var s = context.Sessions.Add(new Session
{
ShareCode = token[..8].ToUpperInvariant(),
ReservedConnectionId = connectionId,
Owner = c!,
});
await context.SaveChangesAsync();
return token[..8].ToUpperInvariant();
}
public static async Task<Session?> CreateSession(Client owner, string connectionId, Objects.OwnedSession session)
{
using var context = new QuestShareContext();
var s = await context.Sessions.Where(s => s.ShareCode == session.Session.ShareCode && s.ReservedConnectionId == connectionId).FirstOrDefaultAsync();
if (s == null)
{
Log.Error($"[SessionManager] Failed to create session for {session.Session.OwnerCharacterId} with share code {session.Session.ShareCode}");
return null;
}
s.OwnerCharacterId = session.Session.OwnerCharacterId;
s.IsActive = session.IsActive;
s.AllowJoins = session.AllowJoins;
s.SkipPartyCheck = session.SkipPartyCheck;
await context.SaveChangesAsync();
return s;
}
public static async Task RemoveSession(string shareCode)
{
using var context = new QuestShareContext();
var session = await context.Sessions.Where(s => s.ShareCode == shareCode).FirstOrDefaultAsync();
if (session != null)
{
context.Sessions.Remove(session);
await context.SaveChangesAsync();
}
}
public static async Task SetPartyMembers(string shareCode, List<string> partyMembers)
{
using var context = new QuestShareContext();
var s = await context.Sessions.Where(s => s.ShareCode == shareCode).FirstOrDefaultAsync();
if (s != null)
{
s.PartyMembers = partyMembers;
await context.SaveChangesAsync();
}
}
public static async Task AddMemberToSession(Session session, string member)
{
using var context = new QuestShareContext();
var s = await context.Sessions.Where(s => s.SessionId == session.SessionId).FirstOrDefaultAsync();
if (s != null)
{
s.AddMember(member);
await context.SaveChangesAsync();
}
}
public static async Task RemoveMemberFromSession(Session session, Client client)
{
using var context = new QuestShareContext();
await context.SessionMembers.Where(s => s.Session.SessionId == session.SessionId && s.Client.ClientId == client.ClientId).ExecuteDeleteAsync();
}
public static async Task<List<SessionMember>> GetMembersInSession(Session session)
{
using var context = new QuestShareContext();
var s = await context.SessionMembers.Where(s => s.Session.SessionId == session.SessionId).Include("Sessions").Include("Clients").ToListAsync();
return s;
}
public static async Task UpdateActiveQuest(string shareCode, int questId, byte questStep)
{
using var context = new QuestShareContext();
var session = await context.Sessions.Where(s => s.ShareCode == shareCode).FirstOrDefaultAsync();
if (session == null)
{
// log error
Console.Error.WriteLine($"Failed to update quests for session {shareCode}");
return;
}
session.SharedQuestStep = questStep;
session.SharedQuestId = questId;
var records = await context.SaveChangesAsync();
Log.Debug($"[UPDATE] Updated {records} quests for session {shareCode}");
}
}
}

View File

@ -0,0 +1,196 @@
// <auto-generated />
using System;
using System.Net;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
using QuestShare.Server.Models;
#nullable disable
namespace QuestShare.Server.Migrations
{
[DbContext(typeof(QuestShareContext))]
[Migration("20250217022911_InitialCreate")]
partial class InitialCreate
{
/// <inheritdoc />
protected override void BuildTargetModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder
.HasAnnotation("ProductVersion", "9.0.2")
.HasAnnotation("Relational:MaxIdentifierLength", 63);
NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
modelBuilder.Entity("QuestShare.Server.Models.Ban", b =>
{
b.Property<string>("BanId")
.HasColumnType("text");
b.Property<decimal>("BanCharacterId")
.HasColumnType("numeric(20,0)");
b.Property<DateTime>("BanDate")
.HasColumnType("timestamp with time zone");
b.Property<DateTime>("BanExpiry")
.HasColumnType("timestamp with time zone");
b.Property<IPAddress>("BanIp")
.IsRequired()
.HasColumnType("inet");
b.Property<string>("BanIssuer")
.IsRequired()
.HasColumnType("text");
b.Property<string>("BanReason")
.IsRequired()
.HasColumnType("text");
b.HasKey("BanId");
b.ToTable("Bans", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Client", b =>
{
b.Property<Guid>("ClientId")
.ValueGeneratedOnAdd()
.HasColumnType("uuid");
b.Property<decimal>("CharacterId")
.HasColumnType("numeric(20,0)");
b.Property<string>("ConnectedShareCode")
.IsRequired()
.HasColumnType("text");
b.Property<string>("ConnectionId")
.IsRequired()
.HasColumnType("text");
b.Property<DateTime>("Created")
.ValueGeneratedOnAdd()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<DateTime>("LastUpdated")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<string>("Token")
.IsRequired()
.HasColumnType("text");
b.HasKey("ClientId");
b.ToTable("Clients", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Quest", b =>
{
b.Property<int>("QuestObjId")
.ValueGeneratedOnAdd()
.HasColumnType("integer");
NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("QuestObjId"));
b.Property<byte>("CurrentStep")
.HasColumnType("smallint");
b.Property<bool>("IsActive")
.HasColumnType("boolean");
b.Property<long>("QuestId")
.HasColumnType("bigint");
b.Property<Guid>("ShareId")
.HasColumnType("uuid");
b.Property<Guid>("ShareId1")
.HasColumnType("uuid");
b.HasKey("QuestObjId");
b.HasIndex("ShareId");
b.HasIndex("ShareId1");
b.ToTable("Quests", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Share", b =>
{
b.Property<Guid>("ShareId")
.ValueGeneratedOnAdd()
.HasColumnType("uuid");
b.Property<bool>("BroadcastParty")
.HasColumnType("boolean");
b.Property<DateTime>("Created")
.ValueGeneratedOnAdd()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<DateTime>("LastUpdated")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<string>("ShareCode")
.IsRequired()
.HasColumnType("text");
b.Property<Guid>("ShareHostClientId")
.HasColumnType("uuid");
b.HasKey("ShareId");
b.HasIndex("ShareHostClientId");
b.ToTable("QuestShares", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Quest", b =>
{
b.HasOne("QuestShare.Server.Models.Share", null)
.WithMany("Quests")
.HasForeignKey("ShareId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.HasOne("QuestShare.Server.Models.Share", "Share")
.WithMany()
.HasForeignKey("ShareId1")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.Navigation("Share");
});
modelBuilder.Entity("QuestShare.Server.Models.Share", b =>
{
b.HasOne("QuestShare.Server.Models.Client", "ShareHost")
.WithMany()
.HasForeignKey("ShareHostClientId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.Navigation("ShareHost");
});
modelBuilder.Entity("QuestShare.Server.Models.Share", b =>
{
b.Navigation("Quests");
});
#pragma warning restore 612, 618
}
}
}

View File

@ -0,0 +1,133 @@
using System;
using System.Net;
using Microsoft.EntityFrameworkCore.Migrations;
using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
#nullable disable
namespace QuestShare.Server.Migrations
{
/// <inheritdoc />
public partial class InitialCreate : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.CreateTable(
name: "Bans",
columns: table => new
{
BanId = table.Column<string>(type: "text", nullable: false),
BanIp = table.Column<IPAddress>(type: "inet", nullable: false),
BanCharacterId = table.Column<decimal>(type: "numeric(20,0)", nullable: false),
BanReason = table.Column<string>(type: "text", nullable: false),
BanIssuer = table.Column<string>(type: "text", nullable: false),
BanDate = table.Column<DateTime>(type: "timestamp with time zone", nullable: false),
BanExpiry = table.Column<DateTime>(type: "timestamp with time zone", nullable: false)
},
constraints: table =>
{
table.PrimaryKey("PK_Bans", x => x.BanId);
});
migrationBuilder.CreateTable(
name: "Clients",
columns: table => new
{
ClientId = table.Column<Guid>(type: "uuid", nullable: false),
CharacterId = table.Column<decimal>(type: "numeric(20,0)", nullable: false),
ConnectionId = table.Column<string>(type: "text", nullable: false),
Token = table.Column<string>(type: "text", nullable: false),
ConnectedShareCode = table.Column<string>(type: "text", nullable: false),
Created = table.Column<DateTime>(type: "timestamp with time zone", nullable: false, defaultValueSql: "current_timestamp"),
LastUpdated = table.Column<DateTime>(type: "timestamp with time zone", nullable: false, defaultValueSql: "current_timestamp")
},
constraints: table =>
{
table.PrimaryKey("PK_Clients", x => x.ClientId);
});
migrationBuilder.CreateTable(
name: "QuestShares",
columns: table => new
{
ShareId = table.Column<Guid>(type: "uuid", nullable: false),
ShareHostClientId = table.Column<Guid>(type: "uuid", nullable: false),
ShareCode = table.Column<string>(type: "text", nullable: false),
BroadcastParty = table.Column<bool>(type: "boolean", nullable: false),
Created = table.Column<DateTime>(type: "timestamp with time zone", nullable: false, defaultValueSql: "current_timestamp"),
LastUpdated = table.Column<DateTime>(type: "timestamp with time zone", nullable: false, defaultValueSql: "current_timestamp")
},
constraints: table =>
{
table.PrimaryKey("PK_QuestShares", x => x.ShareId);
table.ForeignKey(
name: "FK_QuestShares_Clients_ShareHostClientId",
column: x => x.ShareHostClientId,
principalTable: "Clients",
principalColumn: "ClientId",
onDelete: ReferentialAction.Cascade);
});
migrationBuilder.CreateTable(
name: "Quests",
columns: table => new
{
QuestObjId = table.Column<int>(type: "integer", nullable: false)
.Annotation("Npgsql:ValueGenerationStrategy", NpgsqlValueGenerationStrategy.IdentityByDefaultColumn),
QuestId = table.Column<long>(type: "bigint", nullable: false),
CurrentStep = table.Column<byte>(type: "smallint", nullable: false),
IsActive = table.Column<bool>(type: "boolean", nullable: false),
ShareId1 = table.Column<Guid>(type: "uuid", nullable: false),
ShareId = table.Column<Guid>(type: "uuid", nullable: false)
},
constraints: table =>
{
table.PrimaryKey("PK_Quests", x => x.QuestObjId);
table.ForeignKey(
name: "FK_Quests_QuestShares_ShareId",
column: x => x.ShareId,
principalTable: "QuestShares",
principalColumn: "ShareId",
onDelete: ReferentialAction.Cascade);
table.ForeignKey(
name: "FK_Quests_QuestShares_ShareId1",
column: x => x.ShareId1,
principalTable: "QuestShares",
principalColumn: "ShareId",
onDelete: ReferentialAction.Cascade);
});
migrationBuilder.CreateIndex(
name: "IX_Quests_ShareId",
table: "Quests",
column: "ShareId");
migrationBuilder.CreateIndex(
name: "IX_Quests_ShareId1",
table: "Quests",
column: "ShareId1");
migrationBuilder.CreateIndex(
name: "IX_QuestShares_ShareHostClientId",
table: "QuestShares",
column: "ShareHostClientId");
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropTable(
name: "Bans");
migrationBuilder.DropTable(
name: "Quests");
migrationBuilder.DropTable(
name: "QuestShares");
migrationBuilder.DropTable(
name: "Clients");
}
}
}

View File

@ -0,0 +1,148 @@
// <auto-generated />
using System;
using System.Net;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
using QuestShare.Server.Models;
#nullable disable
namespace QuestShare.Server.Migrations
{
[DbContext(typeof(QuestShareContext))]
[Migration("20250217033300_RefactorQuests")]
partial class RefactorQuests
{
/// <inheritdoc />
protected override void BuildTargetModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder
.HasAnnotation("ProductVersion", "9.0.2")
.HasAnnotation("Relational:MaxIdentifierLength", 63);
NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
modelBuilder.Entity("QuestShare.Server.Models.Ban", b =>
{
b.Property<string>("BanId")
.HasColumnType("text");
b.Property<decimal>("BanCharacterId")
.HasColumnType("numeric(20,0)");
b.Property<DateTime>("BanDate")
.HasColumnType("timestamp with time zone");
b.Property<DateTime>("BanExpiry")
.HasColumnType("timestamp with time zone");
b.Property<IPAddress>("BanIp")
.IsRequired()
.HasColumnType("inet");
b.Property<string>("BanIssuer")
.IsRequired()
.HasColumnType("text");
b.Property<string>("BanReason")
.IsRequired()
.HasColumnType("text");
b.HasKey("BanId");
b.ToTable("Bans", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Client", b =>
{
b.Property<Guid>("ClientId")
.ValueGeneratedOnAdd()
.HasColumnType("uuid");
b.Property<decimal>("CharacterId")
.HasColumnType("numeric(20,0)");
b.Property<string>("ConnectedShareCode")
.IsRequired()
.HasColumnType("text");
b.Property<string>("ConnectionId")
.IsRequired()
.HasColumnType("text");
b.Property<DateTime>("Created")
.ValueGeneratedOnAdd()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<DateTime>("LastUpdated")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<string>("Token")
.IsRequired()
.HasColumnType("text");
b.HasKey("ClientId");
b.ToTable("Clients", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Share", b =>
{
b.Property<Guid>("ShareId")
.ValueGeneratedOnAdd()
.HasColumnType("uuid");
b.Property<bool>("BroadcastParty")
.HasColumnType("boolean");
b.Property<DateTime>("Created")
.ValueGeneratedOnAdd()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<DateTime>("LastUpdated")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<string>("ShareCode")
.IsRequired()
.HasColumnType("text");
b.Property<Guid>("ShareHostClientId")
.HasColumnType("uuid");
b.Property<long>("SharedQuestId")
.HasColumnType("bigint");
b.Property<byte>("SharedQuestStep")
.HasColumnType("smallint");
b.HasKey("ShareId");
b.HasIndex("ShareHostClientId");
b.ToTable("QuestShares", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Share", b =>
{
b.HasOne("QuestShare.Server.Models.Client", "ShareHost")
.WithMany()
.HasForeignKey("ShareHostClientId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.Navigation("ShareHost");
});
#pragma warning restore 612, 618
}
}
}

View File

@ -0,0 +1,84 @@
using System;
using Microsoft.EntityFrameworkCore.Migrations;
using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
#nullable disable
namespace QuestShare.Server.Migrations
{
/// <inheritdoc />
public partial class RefactorQuests : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropTable(
name: "Quests");
migrationBuilder.AddColumn<long>(
name: "SharedQuestId",
table: "QuestShares",
type: "bigint",
nullable: false,
defaultValue: 0L);
migrationBuilder.AddColumn<byte>(
name: "SharedQuestStep",
table: "QuestShares",
type: "smallint",
nullable: false,
defaultValue: (byte)0);
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropColumn(
name: "SharedQuestId",
table: "QuestShares");
migrationBuilder.DropColumn(
name: "SharedQuestStep",
table: "QuestShares");
migrationBuilder.CreateTable(
name: "Quests",
columns: table => new
{
QuestObjId = table.Column<int>(type: "integer", nullable: false)
.Annotation("Npgsql:ValueGenerationStrategy", NpgsqlValueGenerationStrategy.IdentityByDefaultColumn),
ShareId1 = table.Column<Guid>(type: "uuid", nullable: false),
CurrentStep = table.Column<byte>(type: "smallint", nullable: false),
IsActive = table.Column<bool>(type: "boolean", nullable: false),
QuestId = table.Column<long>(type: "bigint", nullable: false),
ShareId = table.Column<Guid>(type: "uuid", nullable: false)
},
constraints: table =>
{
table.PrimaryKey("PK_Quests", x => x.QuestObjId);
table.ForeignKey(
name: "FK_Quests_QuestShares_ShareId",
column: x => x.ShareId,
principalTable: "QuestShares",
principalColumn: "ShareId",
onDelete: ReferentialAction.Cascade);
table.ForeignKey(
name: "FK_Quests_QuestShares_ShareId1",
column: x => x.ShareId1,
principalTable: "QuestShares",
principalColumn: "ShareId",
onDelete: ReferentialAction.Cascade);
});
migrationBuilder.CreateIndex(
name: "IX_Quests_ShareId",
table: "Quests",
column: "ShareId");
migrationBuilder.CreateIndex(
name: "IX_Quests_ShareId1",
table: "Quests",
column: "ShareId1");
}
}
}

View File

@ -0,0 +1,231 @@
// <auto-generated />
using System;
using System.Net;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
using QuestShare.Server.Models;
#nullable disable
namespace QuestShare.Server.Migrations
{
[DbContext(typeof(QuestShareContext))]
partial class QuestShareContextModelSnapshot : ModelSnapshot
{
protected override void BuildModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder
.HasAnnotation("ProductVersion", "9.0.2")
.HasAnnotation("Relational:MaxIdentifierLength", 63);
NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
modelBuilder.Entity("QuestShare.Server.Models.Ban", b =>
{
b.Property<string>("BanId")
.HasColumnType("text");
b.Property<decimal>("BanCharacterId")
.HasColumnType("numeric(20,0)");
b.Property<DateTime>("BanDate")
.HasColumnType("timestamp with time zone");
b.Property<DateTime>("BanExpiry")
.HasColumnType("timestamp with time zone");
b.Property<IPAddress>("BanIp")
.IsRequired()
.HasColumnType("inet");
b.Property<string>("BanIssuer")
.IsRequired()
.HasColumnType("text");
b.Property<string>("BanReason")
.IsRequired()
.HasColumnType("text");
b.HasKey("BanId");
b.ToTable("Bans", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Client", b =>
{
b.Property<Guid>("ClientId")
.ValueGeneratedOnAdd()
.HasColumnType("uuid");
b.Property<string>("ConnectionId")
.IsRequired()
.HasColumnType("text");
b.Property<DateTime>("Created")
.ValueGeneratedOnAdd()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<string>("KnownShareCodes")
.IsRequired()
.HasColumnType("text");
b.Property<DateTime>("LastUpdated")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<Guid?>("SessionMemberClientSessionId")
.HasColumnType("uuid");
b.Property<string>("Token")
.IsRequired()
.HasColumnType("text");
b.HasKey("ClientId");
b.HasIndex("SessionMemberClientSessionId");
b.ToTable("Clients", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Session", b =>
{
b.Property<Guid>("SessionId")
.ValueGeneratedOnAdd()
.HasColumnType("uuid");
b.Property<bool>("AllowJoins")
.HasColumnType("boolean");
b.Property<DateTime>("Created")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<bool>("IsActive")
.HasColumnType("boolean");
b.Property<DateTime>("LastUpdated")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<string>("OwnerCharacterId")
.IsRequired()
.HasColumnType("text");
b.Property<Guid>("OwnerClientId")
.HasColumnType("uuid");
b.Property<string>("PartyMembers")
.IsRequired()
.HasColumnType("text");
b.Property<string>("ReservedConnectionId")
.IsRequired()
.HasColumnType("text");
b.Property<Guid?>("SessionMemberClientSessionId")
.HasColumnType("uuid");
b.Property<string>("ShareCode")
.IsRequired()
.HasColumnType("text");
b.Property<int>("SharedQuestId")
.HasColumnType("integer");
b.Property<byte>("SharedQuestStep")
.HasColumnType("smallint");
b.Property<bool>("SkipPartyCheck")
.HasColumnType("boolean");
b.HasKey("SessionId");
b.HasIndex("OwnerClientId");
b.HasIndex("SessionMemberClientSessionId");
b.ToTable("Sessions", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.SessionMember", b =>
{
b.Property<Guid>("ClientSessionId")
.ValueGeneratedOnAdd()
.HasColumnType("uuid");
b.Property<Guid>("ClientId")
.HasColumnType("uuid");
b.Property<DateTime>("Created")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<DateTime>("LastUpdated")
.ValueGeneratedOnAddOrUpdate()
.HasColumnType("timestamp with time zone")
.HasDefaultValueSql("current_timestamp");
b.Property<Guid>("SessionId")
.HasColumnType("uuid");
b.HasKey("ClientSessionId");
b.HasIndex("ClientId");
b.HasIndex("SessionId");
b.ToTable("SessionMembers", (string)null);
});
modelBuilder.Entity("QuestShare.Server.Models.Client", b =>
{
b.HasOne("QuestShare.Server.Models.SessionMember", null)
.WithMany()
.HasForeignKey("SessionMemberClientSessionId");
});
modelBuilder.Entity("QuestShare.Server.Models.Session", b =>
{
b.HasOne("QuestShare.Server.Models.Client", "Owner")
.WithMany()
.HasForeignKey("OwnerClientId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.HasOne("QuestShare.Server.Models.SessionMember", null)
.WithMany()
.HasForeignKey("SessionMemberClientSessionId");
b.Navigation("Owner");
});
modelBuilder.Entity("QuestShare.Server.Models.SessionMember", b =>
{
b.HasOne("QuestShare.Server.Models.Client", "Client")
.WithMany()
.HasForeignKey("ClientId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.HasOne("QuestShare.Server.Models.Session", "Session")
.WithMany()
.HasForeignKey("SessionId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.Navigation("Client");
b.Navigation("Session");
});
#pragma warning restore 612, 618
}
}
}

View File

@ -0,0 +1,15 @@
using System.Net;
namespace QuestShare.Server.Models
{
public class Ban
{
public string BanId { get; set; } = null!;
public IPAddress BanIp { get; set; } = null!;
public ulong BanCharacterId { get; set; } = 0;
public string BanReason { get; set; } = null!;
public string BanIssuer { get; set; } = null!;
public DateTime BanDate { get; set; }
public DateTime BanExpiry { get; set; }
}
}

View File

@ -0,0 +1,21 @@
using System.ComponentModel.DataAnnotations.Schema;
using System.ComponentModel.DataAnnotations;
namespace QuestShare.Server.Models
{
public class Client
{
[Key]
public Guid ClientId { get; set; }
public required string ConnectionId { get; set; } = null!;
public required string Token { get; set; } = null!;
public List<string> KnownShareCodes { get; set; } = [];
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public DateTime Created { get; set; }
[DatabaseGenerated(DatabaseGeneratedOption.Computed)]
public DateTime LastUpdated { get; set; }
}
}

View File

@ -0,0 +1,42 @@
using Microsoft.EntityFrameworkCore;
using QuestShare.Common.API;
using Serilog.Events;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Diagnostics.CodeAnalysis;
namespace QuestShare.Server.Models
{
public class QuestShareContext : DbContext
{
public QuestShareContext()
{
// Database.EnsureCreated();
}
public DbSet<Session> Sessions { get; set; } = null!;
public DbSet<Client> Clients { get; set; } = null!;
public DbSet<Ban> Bans { get; set; } = null!;
public DbSet<SessionMember> SessionMembers { get; set; } = null!;
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
optionsBuilder.UseNpgsql(Environment.GetEnvironmentVariable("QUESTSHARE_DATABASE"));
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Client>().ToTable("Clients");
modelBuilder.Entity<Client>().Property(a => a.Created).HasDefaultValueSql("current_timestamp");
modelBuilder.Entity<Client>().Property(a => a.LastUpdated).HasDefaultValueSql("current_timestamp").ValueGeneratedOnAddOrUpdate();
modelBuilder.Entity<Client>().Property(a => a.KnownShareCodes).HasConversion(
v => string.Join(',', v),
v => v.Split(',', StringSplitOptions.RemoveEmptyEntries).ToList()
);
new SessionsConfiguration().Configure(modelBuilder.Entity<Session>());
new ClientSessionConfiguration().Configure(modelBuilder.Entity<SessionMember>());
modelBuilder.Entity<Ban>().ToTable("Bans");
}
}
}

View File

@ -0,0 +1,56 @@
using System.ComponentModel.DataAnnotations.Schema;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
using Newtonsoft.Json;
using QuestShare.Common;
namespace QuestShare.Server.Models
{
public class Session
{
[Key]
public Guid SessionId { get; set; }
public string OwnerCharacterId { get; set; } = "";
public required Client Owner { get; set; }
public required string ShareCode { get; set; }
public required string ReservedConnectionId { get; set; }
public int SharedQuestId { get; set; } = 0;
public byte SharedQuestStep { get; set; } = 0;
public List<string> PartyMembers { get; set; } = [];
public bool IsActive { get; set; } = true;
public bool SkipPartyCheck { get; set; } = false;
public bool AllowJoins { get; set; } = true;
public DateTime Created { get; set; }
public DateTime LastUpdated { get; set; }
public bool IsMember(string characterId)
{
return PartyMembers.Contains(characterId);
}
public void AddMember(string characterId)
{
PartyMembers.Add(characterId);
}
public void RemoveMember(string characterId)
{
PartyMembers.Remove(characterId);
}
}
public class SessionsConfiguration : IEntityTypeConfiguration<Session>
{
public void Configure(EntityTypeBuilder<Session> builder)
{
builder.ToTable("Sessions");
builder.Property(s => s.Created).HasDefaultValueSql("current_timestamp").ValueGeneratedOnAddOrUpdate(); ;
builder.Property(s => s.LastUpdated).HasDefaultValueSql("current_timestamp").ValueGeneratedOnAddOrUpdate();
builder.Property(s => s.PartyMembers).HasConversion(
v => JsonConvert.SerializeObject(v),
v => JsonConvert.DeserializeObject<List<string>>(v ?? "")!
);
}
}
}

View File

@ -0,0 +1,75 @@
global using QuestShare.Common.API;
global using Serilog;
using Microsoft.AspNetCore.RateLimiting;
using Microsoft.AspNetCore.Server.Kestrel.Https;
using Microsoft.EntityFrameworkCore;
using QuestShare.Common;
using QuestShare.Server.Models;
using System.Diagnostics;
using System.Net;
namespace QuestShare.Server
{
public class Program
{
public static async Task Main(string[] args)
{
var log = new LoggerConfiguration()
.WriteTo.Console()
.MinimumLevel.Debug()
.CreateLogger();
Log.Logger = log;
var builder = new HostBuilder()
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.ConfigureKestrel(serverOptions =>
{
serverOptions.Listen(IPAddress.Any, 8080);
serverOptions.ConfigureHttpsDefaults(httpsOptions =>
{
httpsOptions.ServerCertificate = null;
httpsOptions.ClientCertificateMode = ClientCertificateMode.NoCertificate;
});
});
webBuilder.UseStartup<Startup>();
}).ConfigureServices(services =>
{
services.AddRateLimiter(_ => _.AddFixedWindowLimiter(policyName: "ClientPolicy", options =>
{
options.PermitLimit = 5;
options.Window = TimeSpan.FromSeconds(15);
}));
services.AddRateLimiter(_ => _.AddSlidingWindowLimiter(policyName: "UpdatePolicy", options =>
{
options.PermitLimit = 5;
options.Window = TimeSpan.FromSeconds(5);
}));
services.AddRateLimiter(_ => _.AddSlidingWindowLimiter(policyName: "PartyCheckPolicy", options =>
{
options.PermitLimit = 1;
options.Window = TimeSpan.FromSeconds(30);
}));
}).ConfigureLogging(logging =>
{
logging.AddConsole();
logging.AddDebug();
logging.AddFilter("Microsoft.AspNetCore.SignalR", LogLevel.Information);
logging.AddFilter("Microsoft.AspNetCore.Http.Connections", LogLevel.Information);
}).UseSerilog();
var database = Environment.GetEnvironmentVariable("QUESTSHARE_DATABASE");
if (string.IsNullOrEmpty(database))
{
Console.WriteLine("Please set the QUESTSHARE_DATABASE environment variable.");
Environment.Exit(-1);
}
var app = builder.Build();
Log.Information($"Starting QuestShare Server - API Version {Constants.Version}");
using (var scope = app.Services.CreateScope())
{
var context = scope.ServiceProvider.GetRequiredService<QuestShareContext>();
await context.Database.MigrateAsync();
}
app.Run();
}
}
}

View File

@ -0,0 +1,31 @@
{
"profiles": {
"http": {
"commandName": "Project",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
},
"dotnetRunMessages": true,
"applicationUrl": "http://localhost:5087"
},
"https": {
"commandName": "Project",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
},
"dotnetRunMessages": true,
"applicationUrl": "https://localhost:7041;http://localhost:5087"
},
"Container (Dockerfile)": {
"commandName": "Docker",
"launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}",
"environmentVariables": {
"ASPNETCORE_HTTPS_PORTS": "8081",
"ASPNETCORE_HTTP_PORTS": "8080"
},
"publishAllPorts": true,
"useSSL": true
}
},
"$schema": "https://json.schemastore.org/launchsettings.json"
}

View File

@ -0,0 +1,41 @@
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<UserSecretsId>f9f09687-a48d-4dd0-84e9-ff93099838ff</UserSecretsId>
<DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="EntityFrameworkCore.Exceptions.PostgreSQL" Version="8.1.3" />
<PackageReference Include="Microsoft.AspNetCore.SignalR.Protocols.NewtonsoftJson" Version="9.0.2" />
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="9.0.2" />
<PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="9.0.2" />
<PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.21.2" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.3" />
<PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL.Design" Version="1.1.0" />
<PackageReference Include="Serilog" Version="4.2.0" />
<PackageReference Include="Serilog.Extensions.Hosting" Version="9.0.0" />
<PackageReference Include="Serilog.Extensions.Logging" Version="9.0.0" />
<PackageReference Include="Serilog.Sinks.Console" Version="6.0.0" />
<PackageReference Include="Serilog.Sinks.Debug" Version="3.0.0" />
<PackageReference Include="System.Net.Http" Version="4.3.4" />
<PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\QuestShare.Common\QuestShare.Common.csproj" />
</ItemGroup>
<ItemGroup>
<Folder Include="Migrations\" />
</ItemGroup>
</Project>

View File

@ -0,0 +1,6 @@
@QuestShare.Server_HostAddress = http://localhost:5087
GET {{QuestShare.Server_HostAddress}}/weatherforecast/
Accept: application/json
###

Binary file not shown.

View File

@ -0,0 +1,34 @@
using Microsoft.AspNetCore.Http.Connections;
using Microsoft.AspNetCore.SignalR;
using QuestShare.Server.Hubs;
using QuestShare.Server.Managers;
namespace QuestShare.Server
{
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddSignalR(options =>
{
options.EnableDetailedErrors = true;
}).AddJsonProtocol(options =>
{
options.PayloadSerializerOptions.PropertyNamingPolicy = null;
});
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseRouting();
app.UseWebSockets();
app.UseDeveloperExceptionPage();
app.UseEndpoints(endpoints =>
{
endpoints.MapHub<ShareHub>("/Hub", options =>
{
options.Transports = HttpTransportType.WebSockets | HttpTransportType.ServerSentEvents | HttpTransportType.LongPolling;
});
});
}
}
}

View File

@ -0,0 +1,8 @@
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
}
}

View File

@ -0,0 +1,11 @@
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*",
"Microsoft.AspNetCore.SignalR": "Debug",
"Microsoft.AspNetCore.Http.Connections": "Debug"
}

41
QuestShare.sln Normal file
View File

@ -0,0 +1,41 @@
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.12.35506.116
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QuestShare", "QuestShare.Dalamud\QuestShare.csproj", "{13C812E9-0D42-4B95-8646-40EEBF30636F}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QuestShare.Server", "QuestShare.Server\QuestShare.Server.csproj", "{D8B65C09-BCAC-4B75-9A65-46E3BD1DAA25}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QuestShare.Common", "QuestShare.Common\QuestShare.Common.csproj", "{7A4BDE00-BF8F-4A09-8363-6434609B6865}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{EE8C4212-4861-444C-9E4E-36DA4CC86458}"
ProjectSection(SolutionItems) = preProject
plogonmaster.json = plogonmaster.json
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|x64 = Debug|x64
Release|x64 = Release|x64
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{13C812E9-0D42-4B95-8646-40EEBF30636F}.Debug|x64.ActiveCfg = Debug|x64
{13C812E9-0D42-4B95-8646-40EEBF30636F}.Debug|x64.Build.0 = Debug|x64
{13C812E9-0D42-4B95-8646-40EEBF30636F}.Release|x64.ActiveCfg = Release|x64
{13C812E9-0D42-4B95-8646-40EEBF30636F}.Release|x64.Build.0 = Release|x64
{D8B65C09-BCAC-4B75-9A65-46E3BD1DAA25}.Debug|x64.ActiveCfg = Debug|Any CPU
{D8B65C09-BCAC-4B75-9A65-46E3BD1DAA25}.Debug|x64.Build.0 = Debug|Any CPU
{D8B65C09-BCAC-4B75-9A65-46E3BD1DAA25}.Release|x64.ActiveCfg = Release|Any CPU
{D8B65C09-BCAC-4B75-9A65-46E3BD1DAA25}.Release|x64.Build.0 = Release|Any CPU
{7A4BDE00-BF8F-4A09-8363-6434609B6865}.Debug|x64.ActiveCfg = Debug|Any CPU
{7A4BDE00-BF8F-4A09-8363-6434609B6865}.Debug|x64.Build.0 = Debug|Any CPU
{7A4BDE00-BF8F-4A09-8363-6434609B6865}.Release|x64.ActiveCfg = Release|Any CPU
{7A4BDE00-BF8F-4A09-8363-6434609B6865}.Release|x64.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {B17E85B1-5F60-4440-9F9A-3DDE877E8CDF}
EndGlobalSection
EndGlobal

View File

@ -0,0 +1,76 @@
> ⚠️ **Don't click Fork!**
>
> This is a GitHub Template repo. If you want to use this for a plugin, just [use this template][new-repo] to make a new repo!
>
> ![image](https://github.com/goatcorp/SamplePlugin/assets/16760685/d9732094-e1ed-4769-a70b-58ed2b92580c)
# SamplePlugin
[![Use This Template badge](https://img.shields.io/badge/Use%20This%20Template-0?logo=github&labelColor=grey)][new-repo]
Simple example plugin for Dalamud.
This is not designed to be the simplest possible example, but it is also not designed to cover everything you might want to do. For more detailed questions, come ask in [the Discord](https://discord.gg/holdshift).
## Main Points
* Simple functional plugin
* Slash command
* Main UI
* Settings UI
* Image loading
* Plugin json
* Simple, slightly-improved plugin configuration handling
* Project organization
* Copies all necessary plugin files to the output directory
* Does not copy dependencies that are provided by dalamud
* Output directory can be zipped directly and have exactly what is required
* Hides data files from visual studio to reduce clutter
* Also allows having data files in different paths than VS would usually allow if done in the IDE directly
The intention is less that any of this is used directly in other projects, and more to show how similar things can be done.
## How To Use
### Getting Started
To begin, [clone this template repository][new-repo] to your own GitHub account. This will automatically bring in everything you need to get a jumpstart on development. You do not need to fork this repository unless you intend to contribute modifications to it.
Be sure to also check out the [Dalamud Developer Docs][dalamud-docs] for helpful information about building your own plugin. The Developer Docs includes helpful information about all sorts of things, including [how to submit][submit] your newly-created plugin to the official repository. Assuming you use this template repository, the provided project build configuration and license are already chosen to make everything a breeze.
[new-repo]: https://github.com/new?template_name=SamplePlugin&template_owner=goatcorp
[dalamud-docs]: https://dalamud.dev
[submit]: https://dalamud.dev/plugin-development/plugin-submission
### Prerequisites
SamplePlugin assumes all the following prerequisites are met:
* XIVLauncher, FINAL FANTASY XIV, and Dalamud have all been installed and the game has been run with Dalamud at least once.
* XIVLauncher is installed to its default directories and configurations.
* If a custom path is required for Dalamud's dev directory, it must be set with the `DALAMUD_HOME` environment variable.
* A .NET Core 8 SDK has been installed and configured, or is otherwise available. (In most cases, the IDE will take care of this.)
### Building
1. Open up `SamplePlugin.sln` in your C# editor of choice (likely [Visual Studio 2022](https://visualstudio.microsoft.com) or [JetBrains Rider](https://www.jetbrains.com/rider/)).
2. Build the solution. By default, this will build a `Debug` build, but you can switch to `Release` in your IDE.
3. The resulting plugin can be found at `SamplePlugin/bin/x64/Debug/SamplePlugin.dll` (or `Release` if appropriate.)
### Activating in-game
1. Launch the game and use `/xlsettings` in chat or `xlsettings` in the Dalamud Console to open up the Dalamud settings.
* In here, go to `Experimental`, and add the full path to the `SamplePlugin.dll` to the list of Dev Plugin Locations.
2. Next, use `/xlplugins` (chat) or `xlplugins` (console) to open up the Plugin Installer.
* In here, go to `Dev Tools > Installed Dev Plugins`, and the `SamplePlugin` should be visible. Enable it.
3. You should now be able to use `/pmycommand` (chat) or `pmycommand` (console)!
Note that you only need to add it to the Dev Plugin Locations once (Step 1); it is preserved afterwards. You can disable, enable, or load your plugin on startup through the Plugin Installer.
### Reconfiguring for your own uses
Basically, just replace all references to `SamplePlugin` in all of the files and filenames with your desired name, then start building the plugin of your dreams. You'll figure it out 😁
Dalamud will load the JSON file (by default, `SamplePlugin/SamplePlugin.json`) next to your DLL and use it for metadata, including the description for your plugin in the Plugin Installer. Make sure to update this with information relevant to _your_ plugin!

View File

@ -12,17 +12,17 @@
],
"RepoUrl": "https://git.nathanc.tech/nate/QuestShare/",
"AcceptsFeedback": false,
"DownloadLinkInstall": "https://git.nathanc.tech/nate/QuestShare/releases/download/alpha-6/latest.zip",
"DownloadLinkTesting": "https://git.nathanc.tech/nate/QuestShare/releases/download/alpha-6/latest.zip",
"DownloadLinkUpdate": "https://git.nathanc.tech/nate/QuestShare/releases/download/alpha-6/latest.zip",
"DownloadLinkInstall": "https://git.nathanc.tech/nate/QuestShare/releases/download/alpha-4/latest.zip",
"DownloadLinkTesting": "https://git.nathanc.tech/nate/QuestShare/releases/download/alpha-4/latest.zip",
"DownloadLinkUpdate": "https://git.nathanc.tech/nate/QuestShare/releases/download/alpha-4/latest.zip",
"DownloadCount": 1,
"LastUpdate": "180000000",
"LastUpdate": "1739859999",
"IsHide": false,
"IsTestingExclusive": false,
"IconUrl": "",
"DalamudApiLevel": 11,
"InternalName": "QuestShare",
"AssemblyVersion": "1.0.3.0"
"AssemblyVersion": "1.0.1.0"
}
]