mirror of
https://github.com/jie65535/gc-opencommand-plugin.git
synced 2025-12-15 19:31:35 +08:00
Compare commits
60 Commits
v1.0.0
...
v1.5.2-for
| Author | SHA1 | Date | |
|---|---|---|---|
| d64238a9e9 | |||
| c3667a8206 | |||
| c62d777037 | |||
| 5019b6548a | |||
| 1c8d448a7b | |||
| 99f914b952 | |||
| 82477321d1 | |||
| f19c4b8e77 | |||
| 3f1ecfe8a6 | |||
|
|
79564ff41c | ||
| ded44804d4 | |||
| 4b8eb490f5 | |||
| 70261df520 | |||
| 5c2be0e776 | |||
| 72948121d6 | |||
| 42c748ad2e | |||
| 1d03d3e476 | |||
| ef885af137 | |||
| b70b73667d | |||
| 623856ca99 | |||
|
|
b3bc0f051a | ||
|
|
1439139404 | ||
|
|
2799a06312 | ||
| 9fe473d6cc | |||
| d2499bad5f | |||
|
|
6db7c89196 | ||
|
|
dc5cbcc981 | ||
|
|
3ed8e233bc | ||
|
|
4712e2cd73 | ||
|
|
6aa19ce860 | ||
|
|
4d08acd084 | ||
|
|
37dcd0f1a7 | ||
|
|
a4048d4fd1 | ||
|
|
e62b1d4967 | ||
|
|
8030ef8034 | ||
|
|
67f3eb180d | ||
|
|
3bc9b0ab14 | ||
|
|
8b91e50d02 | ||
|
|
684ab421bd | ||
| 12740c64e3 | |||
| a1ef41f373 | |||
| 1ec9e3f09a | |||
| 1a3b2e4904 | |||
| 957098a2cf | |||
|
|
910842c460 | ||
| 8b05c9aa10 | |||
| d5c29b61ff | |||
| f719ba97ad | |||
| 9a15414f3c | |||
| 95f688e970 | |||
| d291d2a8d8 | |||
| ff04a5f107 | |||
| d9b09e48ce | |||
| d190576c33 | |||
| 1df94e613e | |||
| e5a6aa22aa | |||
| b119bb9fad | |||
| 062187d1c1 | |||
| 8e30c6ad52 | |||
| 8cdfcf3dc3 |
50
.github/workflows/build.yml
vendored
Normal file
50
.github/workflows/build.yml
vendored
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
name: "Build"
|
||||||
|
on:
|
||||||
|
workflow_dispatch: ~
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- "**.java"
|
||||||
|
branches:
|
||||||
|
- "for-unstable"
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- "**.java"
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
- synchronize
|
||||||
|
- reopened
|
||||||
|
jobs:
|
||||||
|
Build-Jar:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
- name: Setup Java
|
||||||
|
uses: actions/setup-java@v3
|
||||||
|
with:
|
||||||
|
distribution: temurin
|
||||||
|
java-version: '17'
|
||||||
|
- name: Cache gradle files
|
||||||
|
uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
./.gradle/loom-cache
|
||||||
|
key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle', 'gradle.properties', '**/*.accesswidener') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-gradle-
|
||||||
|
- name: Download latest grasscutter jar
|
||||||
|
run: wget https://nightly.link/Grasscutters/Grasscutter/workflows/build/unstable/Grasscutter.zip && mkdir lib && unzip Grasscutter.zip -d lib
|
||||||
|
|
||||||
|
- name: Change permission
|
||||||
|
run: chmod +x gradlew
|
||||||
|
|
||||||
|
- name: Run Gradle
|
||||||
|
run: ./gradlew jar
|
||||||
|
|
||||||
|
- name: Upload build
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: opencommand
|
||||||
|
path: opencommand*.jar
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -23,3 +23,6 @@
|
|||||||
hs_err_pid*
|
hs_err_pid*
|
||||||
|
|
||||||
/lib/
|
/lib/
|
||||||
|
.gradle
|
||||||
|
.idea
|
||||||
|
/build
|
||||||
798
LICENSE
798
LICENSE
@@ -1,201 +1,661 @@
|
|||||||
Apache License
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
Version 2.0, January 2004
|
Version 3, 19 November 2007
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
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.
|
||||||
|
|
||||||
1. Definitions.
|
Preamble
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
The licenses for most software and other practical works are designed
|
||||||
the copyright owner that is granting the License.
|
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.
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
When we speak of free software, we are referring to freedom, not
|
||||||
other entities that control, are controlled by, or are under common
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
control with that entity. For the purposes of this definition,
|
have the freedom to distribute copies of free software (and charge for
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
them if you wish), that you receive source code or can get it if you
|
||||||
direction or management of such entity, whether by contract or
|
want it, that you can change the software or use pieces of it in new
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
free programs, and that you know you can do these things.
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
Developers that use our General Public Licenses protect your rights
|
||||||
exercising permissions granted by this License.
|
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.
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
A secondary benefit of defending all users' freedom is that
|
||||||
including but not limited to software source code, documentation
|
improvements made in alternate versions of the program, if they
|
||||||
source, and configuration files.
|
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.
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
The GNU Affero General Public License is designed specifically to
|
||||||
transformation or translation of a Source form, including but
|
ensure that, in such cases, the modified source code becomes available
|
||||||
not limited to compiled object code, generated documentation,
|
to the community. It requires the operator of a network server to
|
||||||
and conversions to other media types.
|
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.
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
An older license, called the Affero General Public License and
|
||||||
Object form, made available under the License, as indicated by a
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
copyright notice that is included in or attached to the work
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
(an example is provided in the Appendix below).
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
The precise terms and conditions for copying, distribution and
|
||||||
form, that is based on (or derived from) the Work and for which the
|
modification follow.
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
TERMS AND CONDITIONS
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
0. Definitions.
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
works, such as semiconductor masks.
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
modifications, and in Source or Object form, provided that You
|
"recipients" may be individuals or organizations.
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
Derivative Works a copy of this License; and
|
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.
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
A "covered work" means either the unmodified Program or a work based
|
||||||
stating that You changed the files; and
|
on the Program.
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
To "propagate" a work means to do anything with it that, without
|
||||||
that You distribute, all copyright, patent, trademark, and
|
permission, would make you directly or secondarily liable for
|
||||||
attribution notices from the Source form of the Work,
|
infringement under applicable copyright law, except executing it on a
|
||||||
excluding those notices that do not pertain to any part of
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
the Derivative Works; and
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
To "convey" a work means any kind of propagation that enables other
|
||||||
distribution, then any Derivative Works that You distribute must
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
include a readable copy of the attribution notices contained
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
may provide additional or different license terms and conditions
|
to the extent that it includes a convenient and prominently visible
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
tells the user that there is no warranty for the work (except to the
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
extent that warranties are provided), that licensees may convey the
|
||||||
the conditions stated in this License.
|
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.
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
1. Source Code.
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
The "source code" for a work means the preferred form of the work
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
for making modifications to it. "Object code" means any non-source
|
||||||
except as required for reasonable and customary use in describing the
|
form of a work.
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
A "Standard Interface" means an interface that either is an official
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
standard defined by a recognized standards body, or, in the case of
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
interfaces specified for a particular programming language, one that
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
is widely used among developers working in that language.
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
The "System Libraries" of an executable work include anything, other
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
unless required by applicable law (such as deliberate and grossly
|
packaging a Major Component, but which is not part of that Major
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
Component, and (b) serves only to enable use of the work with that
|
||||||
liable to You for damages, including any direct, indirect, special,
|
Major Component, or to implement a Standard Interface for which an
|
||||||
incidental, or consequential damages of any character arising as a
|
implementation is available to the public in source code form. A
|
||||||
result of this License or out of the use or inability to use the
|
"Major Component", in this context, means a major essential component
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
(kernel, window system, and so on) of the specific operating system
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
other commercial damages or losses), even if such Contributor
|
produce the work, or an object code interpreter used to run it.
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
The "Corresponding Source" for a work in object code form means all
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
the source code needed to generate, install, and (for an executable
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
work) run the object code and to modify the work, including scripts to
|
||||||
or other liability obligations and/or rights consistent with this
|
control those activities. However, it does not include the work's
|
||||||
License. However, in accepting such obligations, You may act only
|
System Libraries, or general-purpose tools or generally available free
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
programs which are used unmodified in performing those activities but
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
which are not part of the work. For example, Corresponding Source
|
||||||
defend, and hold each Contributor harmless for any liability
|
includes interface definition files associated with source files for
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
the work, and the source code for shared libraries and dynamically
|
||||||
of your accepting any such warranty or additional liability.
|
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.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
2. Basic Permissions.
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
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.
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
You may make, run and propagate covered works that you do not
|
||||||
you may not use this file except in compliance with the License.
|
convey, without conditions so long as your license otherwise remains
|
||||||
You may obtain a copy of the License at
|
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.
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
No covered work shall be deemed part of an effective technological
|
||||||
See the License for the specific language governing permissions and
|
measure under any applicable law fulfilling obligations under article
|
||||||
limitations under the License.
|
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/>.
|
||||||
|
|||||||
281
README.md
281
README.md
@@ -1,24 +1,70 @@
|
|||||||
# gc-opencommand-plugin
|
# gc-opencommand-plugin
|
||||||
|
|
||||||
|
中文 | [English](README_en-US.md)
|
||||||
|
|
||||||
一个为第三方客户端开放GC命令执行接口的插件
|
一个为第三方客户端开放GC命令执行接口的插件
|
||||||
|
|
||||||
# 服务端安装
|
## 分支说明
|
||||||
|
|
||||||
|
本分支目的在于兼容 GC 的 `unstable` 分支
|
||||||
|
|
||||||
|
## 使用本插件的应用
|
||||||
|
- [GrasscutterTools](https://github.com/jie65535/GrasscutterCommandGenerator) —— Windows 客户端工具
|
||||||
|
- [JGrasscutterCommand](https://github.com/jie65535/JGrasscutterCommand) —— [Mirai](https://github.com/mamoe/mirai) 插件,在QQ里执行命令
|
||||||
|
- [Yunzai-GrasscutterCommand](https://github.com/Zyy-boop/Yunzai-GrasscutterCommand) —— Yunzai-bot插件,在QQ里执行命令
|
||||||
|
- 待补充
|
||||||
|
|
||||||
|
## 服务端安装
|
||||||
|
|
||||||
1. 在 [Release](https://github.com/jie65535/gc-opencommand-plugin/releases) 下载 `jar`
|
1. 在 [Release](https://github.com/jie65535/gc-opencommand-plugin/releases) 下载 `jar`
|
||||||
2. 放入 `plugins` 文件夹即可
|
2. 放入 `plugins` 文件夹即可
|
||||||
|
|
||||||
# 构建说明
|
> 注意,如果出现以下错误:
|
||||||
|
> ```log
|
||||||
|
> INFO:PluginManager Enabling plugin: opencommand-plugin
|
||||||
|
> Exception in thread "main" java.lang.NoSuchMethodError: 'void emu.grasscutter.server.event.EventHandler.register(emu.grasscutter.plugin.Plugin)'
|
||||||
|
> at com.github.jie65535.opencommand.OpenCommandPlugin.onEnable(OpenCommandPlugin.java:49)
|
||||||
|
> at emu.grasscutter.plugin.PluginManager.lambda$enablePlugins$3(PluginManager.java:131)
|
||||||
|
> ```
|
||||||
|
> 请使用v1.2.1版本插件,因为该报错表示你的服务端是旧版!
|
||||||
|
|
||||||
|
## 控制台连接
|
||||||
|
|
||||||
|
1. 首次启动时,会在 `plugins` 目录下生成一个 `opencommand-plugin` 目录,打开并编辑 `config.json`
|
||||||
|
2. 设置 `consoleToken` 的值为你的连接秘钥,建议使用至少32字符的长随机字符串。
|
||||||
|
3. 重新启动服务端即可生效配置
|
||||||
|
4. 在客户端中选择控制台身份,并填写你的 `consoleToken` 即可以控制台身份运行指令
|
||||||
|
|
||||||
|
## 多服务器
|
||||||
|
### 主服务器 (Dispatch)
|
||||||
|
1. 在 `opencommand-plugin` 目录下打开 `config.json`
|
||||||
|
2. 修改 `socketPort` 值为一个未被使用的端口
|
||||||
|
3. 设置 `socketToken` 多服务器通信密钥,建议使用至少32字符的长随机字符串。
|
||||||
|
4. 重新启动服务端即可生效配置
|
||||||
|
|
||||||
|
### 子服务器 (Game)
|
||||||
|
1. 在 `opencommand-plugin` 目录下打开 `config.json`
|
||||||
|
2. 修改 `socketHost` 和 `socketPort` 值为主服务器的地址和端口
|
||||||
|
3. 设置 `socketToken` 和主服务器相同的值
|
||||||
|
4. 设置 `socketDisplayName` 值为你的服务器名称 (用途请见[下方](https://github.com/jie65535/gc-opencommand-plugin#%E8%8E%B7%E5%8F%96%E5%A4%9A%E6%9C%8D%E5%8A%A1%E5%99%A8%E5%88%97%E8%A1%A8))
|
||||||
|
5. 重新启动服务端即可生效配置
|
||||||
|
|
||||||
|
## 构建说明
|
||||||
|
|
||||||
1. 克隆仓库
|
1. 克隆仓库
|
||||||
2. 在目录下新建 `lib` 目录
|
2. 在目录下新建 `lib` 目录
|
||||||
3. 将 `grasscutter-1.1.x-dev.jar` 放入 `lib` 目录
|
3. 将 `grasscutter-1.1.x-dev.jar` 放入 `lib` 目录
|
||||||
4. `gradle build`
|
4. `gradle build`
|
||||||
|
|
||||||
# 玩家使用流程
|
## 玩家使用流程
|
||||||
|
|
||||||
1. 在客户端中填写服务地址,确认是否支持
|
1. 在客户端中填写服务地址,确认是否支持
|
||||||
2. 填写UID,发送验证码
|
2. 填写UID,发送验证码
|
||||||
3. 将游戏内收到的**4位整数验证码**填入客户端校验
|
3. 将游戏内收到的**4位整数验证码**填入客户端校验
|
||||||
4. 享受便利!
|
4. 享受便利!
|
||||||
|
|
||||||
# 客户端请求流程
|
## 客户端请求流程
|
||||||
|
|
||||||
1. `ping` 确认是否支持 `opencommand` 插件
|
1. `ping` 确认是否支持 `opencommand` 插件
|
||||||
2. `sendCode` 向指定玩家发送验证码(1分钟内不允许重发),保存返回的 `token`
|
2. `sendCode` 向指定玩家发送验证码(1分钟内不允许重发),保存返回的 `token`
|
||||||
3. 使用 `token` 和**4位整数验证码**发送 `verify` 校验
|
3. 使用 `token` 和**4位整数验证码**发送 `verify` 校验
|
||||||
@@ -26,51 +72,228 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# API `/opencommand/api`
|
## `config.json`
|
||||||
|
|
||||||
|
```json5
|
||||||
|
{
|
||||||
|
// 控制台连接令牌
|
||||||
|
"consoleToken": "",
|
||||||
|
// 验证码过期时间(秒)
|
||||||
|
"codeExpirationTime_S": 60,
|
||||||
|
// 临时令牌过期时间(秒)
|
||||||
|
"tempTokenExpirationTime_S": 300,
|
||||||
|
// 授权令牌最后使用过期时间(小时)
|
||||||
|
"tokenLastUseExpirationTime_H": 48,
|
||||||
|
// 多服务器通信端口
|
||||||
|
"socketPort": 5746,
|
||||||
|
// 多服务器通信密钥
|
||||||
|
"socketToken": "",
|
||||||
|
// 多服务器Dispatch服务器地址
|
||||||
|
"socketHost": "127.0.0.1",
|
||||||
|
// 多服务器显示名称
|
||||||
|
"socketDisplayName": ""
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## API `/opencommand/api`
|
||||||
|
|
||||||
示例
|
示例
|
||||||
|
|
||||||
```
|
```
|
||||||
https://127.0.0.1/opencommand/api
|
https://127.0.0.1/opencommand/api
|
||||||
```
|
```
|
||||||
|
|
||||||
# Request 请求
|
### Request 请求
|
||||||
|
|
||||||
```java
|
```java
|
||||||
public final class JsonRequest {
|
public final class JsonRequest {
|
||||||
public String token = "";
|
public String token = "";
|
||||||
public String action = "";
|
public String action = "";
|
||||||
|
public String server = "";
|
||||||
public Object data = null;
|
public Object data = null;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
# Response 响应
|
### Response 响应
|
||||||
|
|
||||||
```java
|
```java
|
||||||
public final class JsonResponse {
|
public final class JsonResponse {
|
||||||
public int retcode = 200;
|
public int retcode = 200;
|
||||||
public String message = "success";
|
public String message = "Success";
|
||||||
public Object data;
|
public Object data;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
# Actions 动作
|
### Actions 动作
|
||||||
## `ping`
|
|
||||||
data = null
|
|
||||||
|
|
||||||
## `sendCode`
|
#### `测试连接`
|
||||||
### Request
|
|
||||||
data = uid (int)
|
|
||||||
### Response
|
|
||||||
data = token (string)
|
|
||||||
|
|
||||||
## `verify` 要求 `token`
|
##### Request
|
||||||
### Request
|
|
||||||
data = code (int)
|
|
||||||
### Response
|
|
||||||
#### Success:
|
|
||||||
code = 200
|
|
||||||
#### Verification failed:
|
|
||||||
code = 400
|
|
||||||
|
|
||||||
## `command` 要求 `token`
|
| 请求参数 | 请求数据 | 类型 |
|
||||||
### Request
|
|--------|--------|----------|
|
||||||
data = command (string)
|
| action | `ping` | `String` |
|
||||||
### Response
|
|
||||||
data = message (string)
|
##### Response
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|-----------|----------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `null` | `null` |
|
||||||
|
|
||||||
|
#### `获取在线玩家`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| 请求参数 | 请求数据 | 类型 |
|
||||||
|
|--------|----------|----------|
|
||||||
|
| action | `online` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|---------------------------------|--------------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `{"count": 0, playerList": []}` | `JsonObject` |
|
||||||
|
|
||||||
|
#### `发送验证码`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| 请求参数 | 请求数据 | 类型 |
|
||||||
|
|--------|------------|----------|
|
||||||
|
| action | `sendCode` | `String` |
|
||||||
|
| data | `uid` | `Int` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|-----------|----------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `token` | `String` |
|
||||||
|
|
||||||
|
#### `验证验证码`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| 请求参数 | 请求数据 | 类型 |
|
||||||
|
|--------|----------|----------|
|
||||||
|
| action | `verify` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
| data | `code` | `Int` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
成功
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|-----------|----------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `null` | `null` |
|
||||||
|
|
||||||
|
失败
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|-----------------------|----------|
|
||||||
|
| retcode | `400` | `Int` |
|
||||||
|
| message | `Verification failed` | `String` |
|
||||||
|
| data | `null` | `null` |
|
||||||
|
|
||||||
|
#### `执行命令`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| 请求参数 | 请求数据 | 类型 |
|
||||||
|
|--------|-----------|----------|
|
||||||
|
| action | `command` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
| data | `command` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
成功
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|------------------|----------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `Command return` | `String` |
|
||||||
|
|
||||||
|
### 执行控制台命令
|
||||||
|
|
||||||
|
#### `获取运行模式`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| 请求参数 | 请求数据 | 类型 |
|
||||||
|
|--------|-----------|----------|
|
||||||
|
| action | `runmode` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
成功
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|-----------------------|----------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `1 (多服务器) / 0 (单服务器)` | `Int` |
|
||||||
|
|
||||||
|
#### `获取多服务器列表`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| 请求参数 | 请求数据 | 类型 |
|
||||||
|
|--------|----------|----------|
|
||||||
|
| action | `server` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
成功
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|-----------|--------------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `{}` | `JsonObject` |
|
||||||
|
|
||||||
|
```json5
|
||||||
|
{
|
||||||
|
"retcode": 200,
|
||||||
|
"message": "success",
|
||||||
|
"data": {
|
||||||
|
// 服务器 UUID
|
||||||
|
"13d82d0d-c7d9-47dd-830c-76588006ef6e": "2.8.0 服务器",
|
||||||
|
"e6b83224-a761-4023-be57-e054c5bb823a": "2.8.0 开发服务器"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `执行命令`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
> 如果为单服务器则无需填写服务器 UUID
|
||||||
|
|
||||||
|
| 请求参数 | 请求数据 | 类型 |
|
||||||
|
|--------|-----------|----------|
|
||||||
|
| action | `command` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
| server | `UUID` | `String` |
|
||||||
|
| data | `command` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
成功
|
||||||
|
|
||||||
|
| 返回参数 | 返回数据 | 类型 |
|
||||||
|
|---------|------------------|----------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `Command return` | `String` |
|
||||||
|
|||||||
284
README_en-US.md
Normal file
284
README_en-US.md
Normal file
@@ -0,0 +1,284 @@
|
|||||||
|
# gc-opencommand-plugin
|
||||||
|
|
||||||
|
[中文](README.md) | English
|
||||||
|
|
||||||
|
A plugin that opens the GC command execution interface for third-party clients
|
||||||
|
|
||||||
|
## Branch Description
|
||||||
|
|
||||||
|
The purpose of this branch is to be compatible with the 'unstable' branch of GC
|
||||||
|
|
||||||
|
## Applications using this plug-in
|
||||||
|
- [GrasscutterTools](https://github.com/jie65535/GrasscutterCommandGenerator) —— Windows Client Tools
|
||||||
|
- [JGrasscutterCommand](https://github.com/jie65535/JGrasscutterCommand) —— [Mirai](https://github.com/mamoe/mirai) Plugin, run commands in QQ
|
||||||
|
- TODO
|
||||||
|
|
||||||
|
## Server installation
|
||||||
|
|
||||||
|
1. Download the `jar` in [Release](https://github.com/jie65535/gc-opencommand-plugin/releases)
|
||||||
|
2. Put it in the `plugins` folder
|
||||||
|
|
||||||
|
## Console connection
|
||||||
|
|
||||||
|
1. When starting for the first time, a `opencommand-plugin` directory will be generated under the `plugins` directory,
|
||||||
|
open and edit `config.json`
|
||||||
|
2. Set the value of `consoleToken` to your connection key. It is recommended to use a long random string of at least 32
|
||||||
|
characters.
|
||||||
|
3. Restart the server to take effect
|
||||||
|
4. Select the console identity in the client, and fill in your `consoleToken` to run the command as the console identity
|
||||||
|
|
||||||
|
## Multi server
|
||||||
|
### Master server (Dispatch)
|
||||||
|
1. Open `config.json` in the `opencommand-plugin` directory
|
||||||
|
2. Modify the `socketPort` value to an unused port
|
||||||
|
3. Set `sockettoken` multi server communication key. It is recommended to use a long random string of at least 32 characters.
|
||||||
|
4. Restart the server to make the configuration effective
|
||||||
|
|
||||||
|
### Sub server (Game)
|
||||||
|
1. Open `config.json` in the `opencommand-plugin` directory
|
||||||
|
2. Modify the `sockethost` and `socketport` values to the address and port of the primary server
|
||||||
|
3. Set the same value of `sockettoken` and the primary server
|
||||||
|
4. Set the `socketDisplayName` value to your server name (See below for usage [Jump](https://github.com/jie65535/gc-opencommand-plugin/blob/master/README_en-US.md#get-mulit-server-list))
|
||||||
|
5. Restart the server to make the configuration effective
|
||||||
|
|
||||||
|
## Build
|
||||||
|
|
||||||
|
1. `git clone https://github.com/jie65535/gc-opencommand-plugin`
|
||||||
|
2. `cd gc-opencommand-plugin`
|
||||||
|
3. `mkdir lib`
|
||||||
|
4. `mv path/to/grasscutter-1.x.x-dev.jar ./lib`
|
||||||
|
5. `gradle build`
|
||||||
|
|
||||||
|
## Player
|
||||||
|
|
||||||
|
1. Fill in the service address in the client to confirm whether it supports
|
||||||
|
2. Fill in the UID and send the verification code
|
||||||
|
3. Fill in the **4-digit integer verification code** received in the game into the client verification
|
||||||
|
4. Enjoy the convenience!
|
||||||
|
|
||||||
|
## Client request
|
||||||
|
|
||||||
|
1. `ping` to confirm whether the `opencommand` plugin is supported
|
||||||
|
2. `sendCode` sends a verification code to the specified player (re-send is not allowed within 1 minute), and save the
|
||||||
|
returned `token`
|
||||||
|
3. Send `verify` check using `token` and **4-digit integer verification code**
|
||||||
|
4. If the verification is passed, you can use the `token` to execute the `command` action
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## `config.json`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"consoleToken": "",
|
||||||
|
"codeExpirationTime_S": 60,
|
||||||
|
"tempTokenExpirationTime_S": 300,
|
||||||
|
"tokenLastUseExpirationTime_H": 48,
|
||||||
|
"socketPort": 5746,
|
||||||
|
"socketToken": "",
|
||||||
|
"socketHost": "127.0.0.1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## API `/opencommand/api`
|
||||||
|
|
||||||
|
Example
|
||||||
|
|
||||||
|
```
|
||||||
|
https://127.0.0.1/opencommand/api
|
||||||
|
```
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
```java
|
||||||
|
public final class JsonRequest {
|
||||||
|
public String token = "";
|
||||||
|
public String action = "";
|
||||||
|
public Seting server = "";
|
||||||
|
public Object data = null;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Response
|
||||||
|
|
||||||
|
```java
|
||||||
|
public final class JsonResponse {
|
||||||
|
public int retcode = 200;
|
||||||
|
public String message = "Success";
|
||||||
|
public Object data;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Actions
|
||||||
|
|
||||||
|
#### `Test connect`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| Request | Request data | type |
|
||||||
|
|---------|--------------|----------|
|
||||||
|
| action | `ping` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
| Response | Response data | type |
|
||||||
|
|----------|---------------|----------|
|
||||||
|
| retcode | `200` | `String` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `null` | `null` |
|
||||||
|
|
||||||
|
#### `Get online players`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| Request | Request data | type |
|
||||||
|
|---------|--------------|----------|
|
||||||
|
| action | `online` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
| Response | Response data | type |
|
||||||
|
|----------|---------------------------------|--------------|
|
||||||
|
| retcode | `200` | `String` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `{"count": 0, playerList": []}` | `JsonObject` |
|
||||||
|
|
||||||
|
#### `Send code`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| Request | Request data | type |
|
||||||
|
|---------|--------------|----------|
|
||||||
|
| action | `sendCode` | `String` |
|
||||||
|
| data | `uid` | `Int` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
| Response | Response data | type |
|
||||||
|
|----------|---------------|----------|
|
||||||
|
| retcode | `200` | `String` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `token` | `String` |
|
||||||
|
|
||||||
|
#### `Verify code`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| Request | Request data | type |
|
||||||
|
|---------|--------------|----------|
|
||||||
|
| action | `verify` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
| data | `code` | `Int` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
Success
|
||||||
|
|
||||||
|
| Response | Response data | type |
|
||||||
|
|----------|---------------|----------|
|
||||||
|
| retcode | `200` | `String` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `null` | `null` |
|
||||||
|
|
||||||
|
Failed
|
||||||
|
|
||||||
|
| Response | Response data | type |
|
||||||
|
|----------|-----------------------|----------|
|
||||||
|
| retcode | `400` | `String` |
|
||||||
|
| message | `Verification failed` | `String` |
|
||||||
|
| data | `null` | `null` |
|
||||||
|
|
||||||
|
#### `Run command`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| Request | Request data | type |
|
||||||
|
|---------|--------------|----------|
|
||||||
|
| action | `command` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
| data | `command` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
Success
|
||||||
|
|
||||||
|
| Response | Response data | type |
|
||||||
|
|----------|------------------|----------|
|
||||||
|
| retcode | `200` | `String` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `Command return` | `String` |
|
||||||
|
|
||||||
|
### Run console command
|
||||||
|
|
||||||
|
#### `Get run mode`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| Request | Request data | Type |
|
||||||
|
|---------|--------------|----------|
|
||||||
|
| action | `runmode` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
Success
|
||||||
|
|
||||||
|
| Request | Response data | Type |
|
||||||
|
|---------|----------------------------------------|----------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `1 (Multi server) / 0 (Single server)` | `Int` |
|
||||||
|
|
||||||
|
#### `Get mulit server list`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
| Request | Request data | Type |
|
||||||
|
|---------|--------------|----------|
|
||||||
|
| action | `server` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
Success
|
||||||
|
|
||||||
|
| Request | Response data | Type |
|
||||||
|
|---------|---------------|--------------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `{}` | `JsonObject` |
|
||||||
|
|
||||||
|
```json5
|
||||||
|
{
|
||||||
|
"retcode": 200,
|
||||||
|
"message": "success",
|
||||||
|
"data": {
|
||||||
|
// Server UUID
|
||||||
|
"13d82d0d-c7d9-47dd-830c-76588006ef6e": "2.8.0 Server",
|
||||||
|
"e6b83224-a761-4023-be57-e054c5bb823a": "2.8.0 Dev server"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `Run command`
|
||||||
|
|
||||||
|
##### Request
|
||||||
|
|
||||||
|
> If it is a single server, there is no need to fill in server UUID.
|
||||||
|
|
||||||
|
| Request | Request data | Type |
|
||||||
|
|---------|--------------|----------|
|
||||||
|
| action | `command` | `String` |
|
||||||
|
| token | `token` | `String` |
|
||||||
|
| server | `UUID` | `String` |
|
||||||
|
| data | `command` | `String` |
|
||||||
|
|
||||||
|
##### Response
|
||||||
|
|
||||||
|
Success
|
||||||
|
|
||||||
|
| Request | Response data | Type |
|
||||||
|
|---------|------------------|----------|
|
||||||
|
| retcode | `200` | `Int` |
|
||||||
|
| message | `Success` | `String` |
|
||||||
|
| data | `Command return` | `String` |
|
||||||
@@ -4,7 +4,7 @@ plugins {
|
|||||||
}
|
}
|
||||||
|
|
||||||
group 'com.github.jie65535.opencommand'
|
group 'com.github.jie65535.opencommand'
|
||||||
version 'dev-1.0.0'
|
version '1.5.2'
|
||||||
|
|
||||||
sourceCompatibility = 17
|
sourceCompatibility = 17
|
||||||
targetCompatibility = 17
|
targetCompatibility = 17
|
||||||
@@ -18,7 +18,7 @@ dependencies {
|
|||||||
}
|
}
|
||||||
|
|
||||||
jar {
|
jar {
|
||||||
jar.baseName = 'opencommand'
|
jar.baseName = 'opencommand-for-unstable'
|
||||||
|
|
||||||
destinationDir = file(".")
|
destinationDir = file(".")
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,121 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.socket.SocketClient;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.player.PlayerList;
|
||||||
|
import emu.grasscutter.Grasscutter;
|
||||||
|
import emu.grasscutter.game.player.Player;
|
||||||
|
import emu.grasscutter.server.event.game.ReceiveCommandFeedbackEvent;
|
||||||
|
import emu.grasscutter.server.event.player.PlayerJoinEvent;
|
||||||
|
import emu.grasscutter.server.event.player.PlayerQuitEvent;
|
||||||
|
import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
|
||||||
|
import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
|
||||||
|
public final class EventListeners {
|
||||||
|
|
||||||
|
private static StringBuilder consoleMessageHandler;
|
||||||
|
private static final Int2ObjectMap<StringBuilder> playerMessageHandlers = new Int2ObjectOpenHashMap<>();
|
||||||
|
|
||||||
|
public static void setConsoleMessageHandler(StringBuilder handler) {
|
||||||
|
consoleMessageHandler = handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取新的玩家消息处理类
|
||||||
|
* 获取时将创建或清空消息处理器并返回实例,**在执行命令前获取!**
|
||||||
|
* @param uid 玩家uid
|
||||||
|
* @return 新的玩家消息处理类
|
||||||
|
*/
|
||||||
|
public static StringBuilder getPlayerNewMessageHandler(int uid) {
|
||||||
|
var handler = playerMessageHandlers.get(uid);
|
||||||
|
if (handler == null) {
|
||||||
|
handler = new StringBuilder();
|
||||||
|
playerMessageHandlers.put(uid, handler);
|
||||||
|
} else {
|
||||||
|
handler.setLength(0);
|
||||||
|
}
|
||||||
|
return handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 命令执行反馈事件处理
|
||||||
|
*/
|
||||||
|
public static void onCommandResponse(ReceiveCommandFeedbackEvent event) {
|
||||||
|
StringBuilder handler;
|
||||||
|
if (event.getPlayer() == null) {
|
||||||
|
handler = consoleMessageHandler;
|
||||||
|
} else {
|
||||||
|
handler = playerMessageHandlers.get(event.getPlayer().getUid());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (handler != null) {
|
||||||
|
if (!handler.isEmpty()) {
|
||||||
|
// New line
|
||||||
|
handler.append(System.lineSeparator());
|
||||||
|
}
|
||||||
|
handler.append(event.getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void onPlayerJoin(PlayerJoinEvent playerJoinEvent) {
|
||||||
|
PlayerList playerList = new PlayerList();
|
||||||
|
playerList.player = Grasscutter.getGameServer().getPlayers().size();
|
||||||
|
ArrayList<String> playerNames = new ArrayList<>();
|
||||||
|
playerNames.add(playerJoinEvent.getPlayer().getNickname());
|
||||||
|
playerList.playerMap.put(playerJoinEvent.getPlayer().getUid(), playerJoinEvent.getPlayer().getNickname());
|
||||||
|
for (Player player : Grasscutter.getGameServer().getPlayers().values()) {
|
||||||
|
playerNames.add(player.getNickname());
|
||||||
|
playerList.playerMap.put(player.getUid(), player.getNickname());
|
||||||
|
}
|
||||||
|
playerList.playerList = playerNames;
|
||||||
|
|
||||||
|
SocketClient.sendPacket(playerList);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 仅游戏模式下玩家离开事件处理方法
|
||||||
|
* 用于更新玩家列表
|
||||||
|
*/
|
||||||
|
public static void onPlayerQuit(PlayerQuitEvent playerQuitEvent) {
|
||||||
|
PlayerList playerList = new PlayerList();
|
||||||
|
playerList.player = Grasscutter.getGameServer().getPlayers().size();
|
||||||
|
ArrayList<String> playerNames = new ArrayList<>();
|
||||||
|
for (Player player : Grasscutter.getGameServer().getPlayers().values()) {
|
||||||
|
playerNames.add(player.getNickname());
|
||||||
|
playerList.playerMap.put(player.getUid(), player.getNickname());
|
||||||
|
}
|
||||||
|
playerList.playerMap.remove(playerQuitEvent.getPlayer().getUid());
|
||||||
|
playerNames.remove(playerQuitEvent.getPlayer().getNickname());
|
||||||
|
playerList.playerList = playerNames;
|
||||||
|
SocketClient.sendPacket(playerList);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 玩家离开事件处理 2
|
||||||
|
* 用于清理内存
|
||||||
|
*/
|
||||||
|
public static void onPlayerQuit2(PlayerQuitEvent playerQuitEvent) {
|
||||||
|
var uid = playerQuitEvent.getPlayer().getUid();
|
||||||
|
if (playerMessageHandlers.containsKey(uid)) {
|
||||||
|
playerMessageHandlers.remove(uid);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand;
|
||||||
|
|
||||||
|
public class OpenCommandConfig {
|
||||||
|
/**
|
||||||
|
* 控制台 Token
|
||||||
|
*/
|
||||||
|
public String consoleToken = "";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 验证码过期时间(单位秒)
|
||||||
|
*/
|
||||||
|
public int codeExpirationTime_S = 60;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 临时Token过期时间(单位秒)
|
||||||
|
*/
|
||||||
|
public int tempTokenExpirationTime_S = 300;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Token 最后使用过期时间(单位小时)
|
||||||
|
*/
|
||||||
|
public int tokenLastUseExpirationTime_H = 48;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Socket 端口
|
||||||
|
*/
|
||||||
|
public int socketPort = 5746;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Socket Token
|
||||||
|
*/
|
||||||
|
public String socketToken = "";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Socket 主机地址
|
||||||
|
*/
|
||||||
|
public String socketHost = "127.0.0.1";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Socket 显示名称
|
||||||
|
*/
|
||||||
|
public String socketDisplayName = "";
|
||||||
|
}
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
package com.github.jie65535.opencommand;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.model.Client;
|
||||||
|
|
||||||
|
import java.util.Date;
|
||||||
|
import java.util.Vector;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 插件持久化数据
|
||||||
|
*/
|
||||||
|
public class OpenCommandData {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 连接的客户端列表
|
||||||
|
*/
|
||||||
|
public Vector<Client> clients = new Vector<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 通过令牌获取客户端
|
||||||
|
* @param token 令牌
|
||||||
|
* @return 客户端对象,若未找到返回null
|
||||||
|
*/
|
||||||
|
public Client getClientByToken(String token) {
|
||||||
|
for (var c : clients) {
|
||||||
|
if (c.token.equals(token))
|
||||||
|
return c;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 移除所有过期的客户端
|
||||||
|
*/
|
||||||
|
public void removeExpiredClients() {
|
||||||
|
var now = new Date();
|
||||||
|
clients.removeIf(client -> client.tokenExpireTime.before(now));
|
||||||
|
}
|
||||||
|
|
||||||
|
public void addClient(Client client) {
|
||||||
|
clients.add(client);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,113 +1,182 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
package com.github.jie65535.opencommand;
|
package com.github.jie65535.opencommand;
|
||||||
|
|
||||||
import com.github.jie65535.opencommand.json.JsonRequest;
|
import com.github.jie65535.opencommand.json.JsonRequest;
|
||||||
import com.github.jie65535.opencommand.json.JsonResponse;
|
import com.github.jie65535.opencommand.json.JsonResponse;
|
||||||
import emu.grasscutter.Grasscutter;
|
import com.github.jie65535.opencommand.model.Client;
|
||||||
|
import com.github.jie65535.opencommand.socket.SocketData;
|
||||||
import emu.grasscutter.command.CommandMap;
|
import emu.grasscutter.command.CommandMap;
|
||||||
|
import emu.grasscutter.server.http.Router;
|
||||||
import emu.grasscutter.utils.Crypto;
|
import emu.grasscutter.utils.Crypto;
|
||||||
import emu.grasscutter.utils.MessageHandler;
|
|
||||||
import emu.grasscutter.utils.Utils;
|
import emu.grasscutter.utils.Utils;
|
||||||
import express.http.HttpContextHandler;
|
import io.javalin.Javalin;
|
||||||
import express.http.Request;
|
import io.javalin.http.Context;
|
||||||
import express.http.Response;
|
|
||||||
import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
|
import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
|
||||||
import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
|
import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.util.ArrayList;
|
||||||
import java.util.Date;
|
import java.util.Date;
|
||||||
import java.util.HashMap;
|
import java.util.HashMap;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
|
|
||||||
public final class OpenCommandHandler implements HttpContextHandler {
|
public final class OpenCommandHandler implements Router {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void applyRoutes(Javalin javalin) {
|
||||||
|
javalin.post("/opencommand/api", OpenCommandHandler::handle);
|
||||||
|
}
|
||||||
|
|
||||||
private static final Map<String, Integer> clients = new HashMap<>();
|
|
||||||
private static final Map<String, Date> tokenExpireTime = new HashMap<>();
|
|
||||||
private static final Map<String, Integer> codes = new HashMap<>();
|
private static final Map<String, Integer> codes = new HashMap<>();
|
||||||
private static final Int2ObjectMap<Date> codeExpireTime = new Int2ObjectOpenHashMap<>();
|
private static final Int2ObjectMap<Date> codeExpireTime = new Int2ObjectOpenHashMap<>();
|
||||||
|
|
||||||
@Override
|
|
||||||
public void handle(Request request, Response response) throws IOException {
|
|
||||||
// Trigger cleanup action
|
|
||||||
cleanupExpiredData();
|
|
||||||
var now = new Date();
|
|
||||||
|
|
||||||
var req = request.body(JsonRequest.class);
|
public static void handle(Context context) {
|
||||||
response.type("application/json");
|
var plugin = OpenCommandPlugin.getInstance();
|
||||||
if (req.action.equals("sendCode")) {
|
try {
|
||||||
int playerId = (int) req.data;
|
var config = plugin.getConfig();
|
||||||
var player = Grasscutter.getGameServer().getPlayerByUid(playerId);
|
var data = plugin.getData();
|
||||||
if (player == null) {
|
var now = new Date();
|
||||||
response.json(new JsonResponse(404, "Player Not Found."));
|
// Trigger cleanup action
|
||||||
|
cleanupExpiredCodes();
|
||||||
|
data.removeExpiredClients();
|
||||||
|
|
||||||
|
var req = context.bodyAsClass(JsonRequest.class);
|
||||||
|
if (req.action.equals("sendCode")) {
|
||||||
|
int playerId = (int) req.data;
|
||||||
|
var player = plugin.getServer().getPlayerByUid(playerId);
|
||||||
|
if (player == null) {
|
||||||
|
context.json(new JsonResponse(404, "Player Not Found."));
|
||||||
|
} else {
|
||||||
|
if (codeExpireTime.containsKey(playerId)) {
|
||||||
|
var expireTime = codeExpireTime.get(playerId);
|
||||||
|
if (now.before(expireTime)) {
|
||||||
|
context.json(new JsonResponse(403, "Requests are too frequent"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
String token = req.token;
|
||||||
|
if (token == null || token.isEmpty())
|
||||||
|
token = Utils.bytesToHex(Crypto.createSessionKey(32));
|
||||||
|
int code = Utils.randomRange(1000, 9999);
|
||||||
|
codeExpireTime.put(playerId, new Date(now.getTime() + config.codeExpirationTime_S * 1000L));
|
||||||
|
codes.put(token, code);
|
||||||
|
data.addClient(new Client(token, playerId, new Date(now.getTime() + config.tempTokenExpirationTime_S * 1000L)));
|
||||||
|
player.dropMessage("[Open Command] Verification code: " + code);
|
||||||
|
context.json(new JsonResponse(token));
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("ping")) {
|
||||||
|
context.json(new JsonResponse());
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("online")) {
|
||||||
|
var p = new ArrayList<String>();
|
||||||
|
plugin.getServer().getPlayers().forEach((uid, player) -> p.add(player.getNickname()));
|
||||||
|
context.json(new JsonResponse(200, "Success", new SocketData.OnlinePlayer(p)));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// token is required
|
||||||
|
if (req.token == null || req.token.isEmpty()) {
|
||||||
|
context.json(new JsonResponse(401, "Unauthorized"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
var isConsole = req.token.equals(config.consoleToken);
|
||||||
|
var client = data.getClientByToken(req.token);
|
||||||
|
if (!isConsole && client == null) {
|
||||||
|
context.json(new JsonResponse(401, "Unauthorized"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isConsole) {
|
||||||
|
if (req.action.equals("verify")) {
|
||||||
|
context.json(new JsonResponse());
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("command")) {
|
||||||
|
//noinspection SynchronizationOnLocalVariableOrMethodParameter
|
||||||
|
synchronized (plugin) {
|
||||||
|
try {
|
||||||
|
plugin.getLogger().info(String.format("IP: %s run command in console > %s", context.ip(), req.data));
|
||||||
|
var resultCollector = new StringBuilder();
|
||||||
|
EventListeners.setConsoleMessageHandler(resultCollector);
|
||||||
|
CommandMap.getInstance().invoke(null, null, req.data.toString());
|
||||||
|
context.json(new JsonResponse(resultCollector.toString()));
|
||||||
|
} catch (Exception e) {
|
||||||
|
plugin.getLogger().warn("Run command failed.", e);
|
||||||
|
EventListeners.setConsoleMessageHandler(null);
|
||||||
|
context.json(new JsonResponse(500, "error", e.getLocalizedMessage()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("runmode")) {
|
||||||
|
context.json(new JsonResponse(200, "Success", 0));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
} else if (codes.containsKey(req.token)) {
|
||||||
|
if (req.action.equals("verify")) {
|
||||||
|
if (codes.get(req.token).equals(req.data)) {
|
||||||
|
codes.remove(req.token);
|
||||||
|
// update token expire time
|
||||||
|
client.tokenExpireTime = new Date(now.getTime() + config.tokenLastUseExpirationTime_H * 60L * 60L * 1000L);
|
||||||
|
context.json(new JsonResponse());
|
||||||
|
plugin.getLogger().info(String.format("Player %d has passed the verification, ip: %s", client.playerId, context.ip()));
|
||||||
|
plugin.saveData();
|
||||||
|
} else {
|
||||||
|
context.json(new JsonResponse(400, "Verification failed"));
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
if (codeExpireTime.containsKey(playerId)) {
|
if (req.action.equals("command")) {
|
||||||
var expireTime = codeExpireTime.get(playerId);
|
// update token expire time
|
||||||
if (now.before(expireTime)) {
|
client.tokenExpireTime = new Date(now.getTime() + config.tokenLastUseExpirationTime_H * 60L * 60L * 1000L);
|
||||||
response.json(new JsonResponse(403, "Requests are too frequent"));
|
var player = plugin.getServer().getPlayerByUid(client.playerId);
|
||||||
|
var command = req.data.toString();
|
||||||
|
if (player == null) {
|
||||||
|
context.json(new JsonResponse(404, "Player not found"));
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
//noinspection SynchronizationOnLocalVariableOrMethodParameter
|
||||||
|
synchronized (player) {
|
||||||
|
// Player MessageHandler do not support concurrency
|
||||||
|
var handler = EventListeners.getPlayerNewMessageHandler(player.getUid());
|
||||||
|
try {
|
||||||
|
CommandMap.getInstance().invoke(player, player, command);
|
||||||
|
context.json(new JsonResponse(handler.toString()));
|
||||||
|
} catch (Exception e) {
|
||||||
|
plugin.getLogger().warn("Run command failed.", e);
|
||||||
|
context.json(new JsonResponse(500, "error", e.getLocalizedMessage()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
String token = req.token;
|
|
||||||
if (token == null || token.isEmpty())
|
|
||||||
token = Utils.bytesToHex(Crypto.createSessionKey(32));
|
|
||||||
int code = Utils.randomRange(1000, 9999);
|
|
||||||
codeExpireTime.put(playerId, new Date(now.getTime() + 60 * 1000));
|
|
||||||
tokenExpireTime.put(token, new Date(now.getTime() + 5 * 60 * 1000));
|
|
||||||
codes.put(token, code);
|
|
||||||
clients.put(token, playerId);
|
|
||||||
player.dropMessage("[Open Command] Verification code: {code}".replace("{code}", Integer.toString(code)));
|
|
||||||
|
|
||||||
response.json(new JsonResponse(token));
|
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
} else if (req.action.equals("ping")) {
|
context.json(new JsonResponse(403, "forbidden"));
|
||||||
response.json(new JsonResponse());
|
} catch (Throwable ex) {
|
||||||
return;
|
plugin.getLogger().error("[OpenCommand] handler error.", ex);
|
||||||
}
|
}
|
||||||
|
|
||||||
// token is required
|
|
||||||
if (!clients.containsKey(req.token)) {
|
|
||||||
response.json(new JsonResponse(401, "Unauthorized"));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (codes.containsKey(req.token)) {
|
|
||||||
if (req.action.equals("verify")) {
|
|
||||||
if (codes.get(req.token).equals(req.data)) {
|
|
||||||
codes.remove(req.token);
|
|
||||||
// update token expire time
|
|
||||||
tokenExpireTime.put(req.token, new Date(now.getTime() + 60 * 60 * 1000));
|
|
||||||
response.json(new JsonResponse());
|
|
||||||
} else {
|
|
||||||
response.json(new JsonResponse(400, "Verification failed"));
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if (req.action.equals("command")) {
|
|
||||||
// update token expire time
|
|
||||||
tokenExpireTime.put(req.token, new Date(now.getTime() + 60 * 60 * 1000));
|
|
||||||
var playerId = clients.get(req.token);
|
|
||||||
var player = Grasscutter.getGameServer().getPlayerByUid(playerId);
|
|
||||||
var command = req.data.toString();
|
|
||||||
try {
|
|
||||||
var resultCollector = new MessageHandler();
|
|
||||||
player.setMessageHandler(resultCollector);
|
|
||||||
CommandMap.getInstance().invoke(player, player, command);
|
|
||||||
response.json(new JsonResponse(resultCollector.getMessage()));
|
|
||||||
} catch (Exception e) {
|
|
||||||
response.json(new JsonResponse(500, "error", e.getLocalizedMessage()));
|
|
||||||
} finally {
|
|
||||||
player.setMessageHandler(null);
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
response.json(new JsonResponse(403, "forbidden"));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private void cleanupExpiredData() {
|
private static void cleanupExpiredCodes() {
|
||||||
var now = new Date();
|
var now = new Date();
|
||||||
codeExpireTime.int2ObjectEntrySet().removeIf(entry -> entry.getValue().before(now));
|
codeExpireTime.int2ObjectEntrySet().removeIf(entry -> entry.getValue().before(now));
|
||||||
tokenExpireTime.entrySet().removeIf(entry -> entry.getValue().before(now));
|
if (codeExpireTime.isEmpty())
|
||||||
|
codes.clear();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,215 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.json.JsonRequest;
|
||||||
|
import com.github.jie65535.opencommand.json.JsonResponse;
|
||||||
|
import com.github.jie65535.opencommand.model.Client;
|
||||||
|
import com.github.jie65535.opencommand.socket.SocketData;
|
||||||
|
import com.github.jie65535.opencommand.socket.SocketDataWait;
|
||||||
|
import com.github.jie65535.opencommand.socket.SocketServer;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.HttpPacket;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.RunConsoleCommand;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.player.Player;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.player.PlayerEnum;
|
||||||
|
import emu.grasscutter.server.http.Router;
|
||||||
|
import emu.grasscutter.utils.Crypto;
|
||||||
|
import emu.grasscutter.utils.Utils;
|
||||||
|
import io.javalin.Javalin;
|
||||||
|
import io.javalin.http.Context;
|
||||||
|
import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
|
||||||
|
import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
|
||||||
|
|
||||||
|
import java.util.Date;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
public final class OpenCommandOnlyHttpHandler implements Router {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void applyRoutes(Javalin javalin) {
|
||||||
|
javalin.post("/opencommand/api", OpenCommandOnlyHttpHandler::handle);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static final Map<String, Integer> codes = new HashMap<>();
|
||||||
|
private static final Int2ObjectMap<Date> codeExpireTime = new Int2ObjectOpenHashMap<>();
|
||||||
|
|
||||||
|
public static void handle(Context context) {
|
||||||
|
var plugin = OpenCommandPlugin.getInstance();
|
||||||
|
try {
|
||||||
|
var config = plugin.getConfig();
|
||||||
|
var data = plugin.getData();
|
||||||
|
var now = new Date();
|
||||||
|
// Trigger cleanup action
|
||||||
|
cleanupExpiredCodes();
|
||||||
|
data.removeExpiredClients();
|
||||||
|
|
||||||
|
var req = context.bodyAsClass(JsonRequest.class);
|
||||||
|
if (req.action.equals("sendCode")) {
|
||||||
|
int playerId = (int) req.data;
|
||||||
|
var player = SocketData.getPlayer(playerId);
|
||||||
|
if (player == null) {
|
||||||
|
context.json(new JsonResponse(404, "Player Not Found."));
|
||||||
|
} else {
|
||||||
|
if (codeExpireTime.containsKey(playerId)) {
|
||||||
|
var expireTime = codeExpireTime.get(playerId);
|
||||||
|
if (now.before(expireTime)) {
|
||||||
|
context.json(new JsonResponse(403, "Requests are too frequent"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
String token = req.token;
|
||||||
|
if (token == null || token.isEmpty())
|
||||||
|
token = Utils.bytesToHex(Crypto.createSessionKey(32));
|
||||||
|
int code = Utils.randomRange(1000, 9999);
|
||||||
|
codeExpireTime.put(playerId, new Date(now.getTime() + config.codeExpirationTime_S * 1000L));
|
||||||
|
codes.put(token, code);
|
||||||
|
data.addClient(new Client(token, playerId, new Date(now.getTime() + config.tempTokenExpirationTime_S * 1000L)));
|
||||||
|
Player.dropMessage(playerId, "[Open Command] Verification code: " + code);
|
||||||
|
context.json(new JsonResponse(token));
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("ping")) {
|
||||||
|
context.json(new JsonResponse());
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("online")) {
|
||||||
|
context.json(new JsonResponse(200, "Success", SocketData.getOnlinePlayer()));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// token is required
|
||||||
|
if (req.token == null || req.token.isEmpty()) {
|
||||||
|
context.json(new JsonResponse(401, "Unauthorized"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
var isConsole = req.token.equals(config.consoleToken);
|
||||||
|
var client = data.getClientByToken(req.token);
|
||||||
|
if (!isConsole && client == null) {
|
||||||
|
context.json(new JsonResponse(401, "Unauthorized"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isConsole) {
|
||||||
|
if (req.action.equals("verify")) {
|
||||||
|
context.json(new JsonResponse());
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("command")) {
|
||||||
|
var server = SocketServer.getClientInfoByUuid(req.server);
|
||||||
|
if (server == null) {
|
||||||
|
context.json(new JsonResponse(404, "Server Not Found."));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
plugin.getLogger().info(String.format("IP: %s run command in console > %s", context.ip(), req.data));
|
||||||
|
var wait = new SocketDataWait<HttpPacket>(2000L) {
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public HttpPacket initData(HttpPacket data) {
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void timeout() {
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
SocketServer.sendPacketAndWait(server.ip, new RunConsoleCommand(req.data.toString()), wait);
|
||||||
|
var packet = wait.getData();
|
||||||
|
if (packet == null) {
|
||||||
|
context.json(new JsonResponse(408, "Timeout"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
context.json(new JsonResponse(packet.code, packet.message, packet.data));
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("server")) {
|
||||||
|
context.json(new JsonResponse(200, "Success", SocketServer.getOnlineClient()));
|
||||||
|
return;
|
||||||
|
} else if (req.action.equals("runmode")) {
|
||||||
|
context.json(new JsonResponse(200, "Success", 1));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
} else if (codes.containsKey(req.token)) {
|
||||||
|
if (req.action.equals("verify")) {
|
||||||
|
if (codes.get(req.token).equals(req.data)) {
|
||||||
|
codes.remove(req.token);
|
||||||
|
// update token expire time
|
||||||
|
client.tokenExpireTime = new Date(now.getTime() + config.tokenLastUseExpirationTime_H * 60L * 60L * 1000L);
|
||||||
|
context.json(new JsonResponse());
|
||||||
|
plugin.getLogger().info(String.format("Player %d has passed the verification, ip: %s", client.playerId, context.ip()));
|
||||||
|
plugin.saveData();
|
||||||
|
} else {
|
||||||
|
context.json(new JsonResponse(400, "Verification failed"));
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (req.action.equals("command")) {
|
||||||
|
SocketDataWait<HttpPacket> socketDataWait = new SocketDataWait<>(1000L * 10L) {
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public HttpPacket initData(HttpPacket data) {
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void timeout() {
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// update token expire time
|
||||||
|
client.tokenExpireTime = new Date(now.getTime() + config.tokenLastUseExpirationTime_H * 60L * 60L * 1000L);
|
||||||
|
var command = req.data.toString();
|
||||||
|
var player = new Player();
|
||||||
|
player.uid = client.playerId;
|
||||||
|
player.type = PlayerEnum.RunCommand;
|
||||||
|
player.data = command;
|
||||||
|
|
||||||
|
if (!SocketServer.sendUidPacketAndWait(client.playerId, player, socketDataWait)) {
|
||||||
|
context.json(new JsonResponse(404, "Player Not Found."));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
HttpPacket httpPacket = socketDataWait.getData();
|
||||||
|
if (httpPacket == null) {
|
||||||
|
context.json(new JsonResponse(500, "error", "Wait timeout"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
context.json(new JsonResponse(httpPacket.code, httpPacket.message));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
context.json(new JsonResponse(403, "forbidden"));
|
||||||
|
} catch (Exception ex) {
|
||||||
|
plugin.getLogger().error("[OpenCommand] handler error.", ex);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void cleanupExpiredCodes() {
|
||||||
|
var now = new Date();
|
||||||
|
codeExpireTime.int2ObjectEntrySet().removeIf(entry -> entry.getValue().before(now));
|
||||||
|
if (codeExpireTime.isEmpty())
|
||||||
|
codes.clear();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,26 +1,174 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
package com.github.jie65535.opencommand;
|
package com.github.jie65535.opencommand;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.socket.SocketClient;
|
||||||
|
import com.github.jie65535.opencommand.socket.SocketServer;
|
||||||
import emu.grasscutter.Grasscutter;
|
import emu.grasscutter.Grasscutter;
|
||||||
import emu.grasscutter.plugin.Plugin;
|
import emu.grasscutter.plugin.Plugin;
|
||||||
|
import emu.grasscutter.server.event.EventHandler;
|
||||||
|
import emu.grasscutter.server.event.HandlerPriority;
|
||||||
|
import emu.grasscutter.server.event.game.ReceiveCommandFeedbackEvent;
|
||||||
|
import emu.grasscutter.server.event.player.PlayerJoinEvent;
|
||||||
|
import emu.grasscutter.server.event.player.PlayerQuitEvent;
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
|
||||||
public class OpenCommandPlugin extends Plugin {
|
import java.io.*;
|
||||||
private OpenCommandHandler handler;
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
|
||||||
|
public final class OpenCommandPlugin extends Plugin {
|
||||||
|
|
||||||
|
private static OpenCommandPlugin instance;
|
||||||
|
|
||||||
|
public static OpenCommandPlugin getInstance() {
|
||||||
|
return instance;
|
||||||
|
}
|
||||||
|
|
||||||
|
private OpenCommandConfig config;
|
||||||
|
|
||||||
|
private OpenCommandData data;
|
||||||
|
|
||||||
|
private Grasscutter.ServerRunMode runMode = Grasscutter.ServerRunMode.HYBRID;
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void onLoad() {
|
public void onLoad() {
|
||||||
handler = new OpenCommandHandler();
|
instance = this;
|
||||||
|
// 加载配置
|
||||||
|
loadConfig();
|
||||||
|
// 加载数据
|
||||||
|
loadData();
|
||||||
|
// 启动Socket
|
||||||
|
startSocket();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void onEnable() {
|
public void onEnable() {
|
||||||
var app = Grasscutter.getDispatchServer().getServer();
|
// 监听命令执行反馈
|
||||||
app.post("/opencommand/api", handler);
|
new EventHandler<>(ReceiveCommandFeedbackEvent.class)
|
||||||
Grasscutter.getLogger().info("Open command enabled");
|
.priority(HandlerPriority.HIGH)
|
||||||
|
.listener(EventListeners::onCommandResponse)
|
||||||
|
.register(this);
|
||||||
|
// 监听玩家离开事件
|
||||||
|
new EventHandler<>(PlayerQuitEvent.class)
|
||||||
|
.priority(HandlerPriority.NORMAL)
|
||||||
|
.listener(EventListeners::onPlayerQuit2)
|
||||||
|
.register(this);
|
||||||
|
if (runMode == Grasscutter.ServerRunMode.GAME_ONLY) {
|
||||||
|
// 仅运行游戏服务器时注册玩家加入和离开事件
|
||||||
|
new EventHandler<>(PlayerJoinEvent.class)
|
||||||
|
.priority(HandlerPriority.HIGH)
|
||||||
|
.listener(EventListeners::onPlayerJoin)
|
||||||
|
.register(this);
|
||||||
|
new EventHandler<>(PlayerQuitEvent.class)
|
||||||
|
.priority(HandlerPriority.HIGH)
|
||||||
|
.listener(EventListeners::onPlayerQuit)
|
||||||
|
.register(this);
|
||||||
|
} else if (runMode == Grasscutter.ServerRunMode.DISPATCH_ONLY) {
|
||||||
|
getHandle().addRouter(OpenCommandOnlyHttpHandler.class);
|
||||||
|
} else {
|
||||||
|
getHandle().addRouter(OpenCommandHandler.class);
|
||||||
|
}
|
||||||
|
getLogger().info("[OpenCommand] Enabled. https://github.com/jie65535/gc-opencommand-plugin");
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void onDisable() {
|
public void onDisable() {
|
||||||
|
saveData();
|
||||||
|
getLogger().info("[OpenCommand] Disabled");
|
||||||
|
}
|
||||||
|
|
||||||
|
public OpenCommandConfig getConfig() {
|
||||||
|
return config;
|
||||||
|
}
|
||||||
|
|
||||||
|
public OpenCommandData getData() {
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void loadConfig() {
|
||||||
|
var configFile = new File(getDataFolder(), "config.json");
|
||||||
|
if (!configFile.exists()) {
|
||||||
|
config = new OpenCommandConfig();
|
||||||
|
try (var file = new FileWriter(configFile)) {
|
||||||
|
file.write(JsonUtils.encode(config));
|
||||||
|
} catch (IOException e) {
|
||||||
|
getLogger().error("[OpenCommand] Unable to write to config file.");
|
||||||
|
} catch (Exception e) {
|
||||||
|
getLogger().error("[OpenCommand] Unable to save config file.");
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
try {
|
||||||
|
config = JsonUtils.decode(Files.readString(configFile.toPath(), StandardCharsets.UTF_8),
|
||||||
|
OpenCommandConfig.class);
|
||||||
|
} catch (Exception exception) {
|
||||||
|
getLogger().error("[OpenCommand] There was an error while trying to load the configuration from config.json. Please make sure that there are no syntax errors. If you want to start with a default configuration, delete your existing config.json.");
|
||||||
|
}
|
||||||
|
if (config == null) {
|
||||||
|
config = new OpenCommandConfig();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
runMode = Grasscutter.getConfig().server.runMode;
|
||||||
|
} catch (Exception ex) {
|
||||||
|
getLogger().warn("[OpenCommand] Failed to load server configuration, default HYBRID mode is being used.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void loadData() {
|
||||||
|
var dataFile = new File(getDataFolder(), "data.json");
|
||||||
|
if (!dataFile.exists()) {
|
||||||
|
data = new OpenCommandData();
|
||||||
|
saveData();
|
||||||
|
} else {
|
||||||
|
try {
|
||||||
|
data = JsonUtils.decode(Files.readString(dataFile.toPath(), StandardCharsets.UTF_8),
|
||||||
|
OpenCommandData.class);
|
||||||
|
} catch (Exception exception) {
|
||||||
|
getLogger().error("[OpenCommand] There was an error while trying to load the data from data.json. Please make sure that there are no syntax errors. If you want to start with a default data, delete your existing data.json.");
|
||||||
|
}
|
||||||
|
if (data == null) {
|
||||||
|
data = new OpenCommandData();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public void saveData() {
|
||||||
|
try (var file = new FileWriter(new File(getDataFolder(), "data.json"))) {
|
||||||
|
file.write(JsonUtils.encode(data));
|
||||||
|
} catch (IOException e) {
|
||||||
|
getLogger().error("[OpenCommand] Unable to write to data file.");
|
||||||
|
} catch (Exception e) {
|
||||||
|
getLogger().error("[OpenCommand] Unable to save data file.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void startSocket() {
|
||||||
|
if (runMode == Grasscutter.ServerRunMode.GAME_ONLY) {
|
||||||
|
getLogger().info("[OpenCommand] Starting socket client...");
|
||||||
|
SocketClient.connectServer();
|
||||||
|
} else if (runMode == Grasscutter.ServerRunMode.DISPATCH_ONLY) {
|
||||||
|
getLogger().info("[OpenCommand] Starting socket server...");
|
||||||
|
try {
|
||||||
|
SocketServer.startServer();
|
||||||
|
} catch (IOException e) {
|
||||||
|
getLogger().error("[OpenCommand] Unable to start socket server.", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,25 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
package com.github.jie65535.opencommand.json;
|
package com.github.jie65535.opencommand.json;
|
||||||
|
|
||||||
public final class JsonRequest {
|
public final class JsonRequest {
|
||||||
public String token = "";
|
public String token = "";
|
||||||
public String action = "";
|
public String action = "";
|
||||||
|
public String server = "";
|
||||||
public Object data = null;
|
public Object data = null;
|
||||||
}
|
}
|
||||||
@@ -1,8 +1,25 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
package com.github.jie65535.opencommand.json;
|
package com.github.jie65535.opencommand.json;
|
||||||
|
|
||||||
public final class JsonResponse {
|
public final class JsonResponse {
|
||||||
public int retcode = 200;
|
public int retcode = 200;
|
||||||
public String message = "success";
|
public String message = "Success";
|
||||||
public Object data;
|
public Object data;
|
||||||
|
|
||||||
public JsonResponse() {
|
public JsonResponse() {
|
||||||
|
|||||||
@@ -0,0 +1,16 @@
|
|||||||
|
package com.github.jie65535.opencommand.model;
|
||||||
|
|
||||||
|
import java.util.Date;
|
||||||
|
|
||||||
|
public final class Client {
|
||||||
|
|
||||||
|
public String token;
|
||||||
|
public Integer playerId;
|
||||||
|
public Date tokenExpireTime;
|
||||||
|
|
||||||
|
public Client(String token, Integer playerId, Date tokenExpireTime) {
|
||||||
|
this.token = token;
|
||||||
|
this.playerId = playerId;
|
||||||
|
this.tokenExpireTime = tokenExpireTime;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket;
|
||||||
|
|
||||||
|
public class ClientInfo {
|
||||||
|
|
||||||
|
public final String uuid;
|
||||||
|
public final SocketServer.ClientThread clientThread;
|
||||||
|
public final String ip;
|
||||||
|
|
||||||
|
public ClientInfo(String uuid, String ip, SocketServer.ClientThread clientThread) {
|
||||||
|
this.uuid = uuid;
|
||||||
|
this.clientThread = clientThread;
|
||||||
|
this.ip = ip;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,259 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.EventListeners;
|
||||||
|
import com.github.jie65535.opencommand.OpenCommandConfig;
|
||||||
|
import com.github.jie65535.opencommand.OpenCommandPlugin;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.*;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.player.Player;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.player.PlayerList;
|
||||||
|
import emu.grasscutter.Grasscutter;
|
||||||
|
import emu.grasscutter.command.CommandMap;
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.OutputStream;
|
||||||
|
import java.net.Socket;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Timer;
|
||||||
|
import java.util.TimerTask;
|
||||||
|
|
||||||
|
// Socket 客户端
|
||||||
|
public class SocketClient {
|
||||||
|
public static ClientThread clientThread;
|
||||||
|
|
||||||
|
public static Logger mLogger;
|
||||||
|
|
||||||
|
public static Timer timer;
|
||||||
|
|
||||||
|
public static boolean connect = false;
|
||||||
|
|
||||||
|
public static ReceiveThread receiveThread;
|
||||||
|
|
||||||
|
// 连接服务器
|
||||||
|
public static void connectServer() {
|
||||||
|
if (connect) return;
|
||||||
|
if (clientThread != null) {
|
||||||
|
mLogger.warn("[OpenCommand] Retry connecting to the server after 15 seconds");
|
||||||
|
try {
|
||||||
|
Thread.sleep(15000);
|
||||||
|
} catch (InterruptedException ex) {
|
||||||
|
throw new RuntimeException(ex);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
OpenCommandConfig config = OpenCommandPlugin.getInstance().getConfig();
|
||||||
|
mLogger = OpenCommandPlugin.getInstance().getLogger();
|
||||||
|
clientThread = new ClientThread(config.socketHost, config.socketPort);
|
||||||
|
|
||||||
|
if (timer != null) {
|
||||||
|
timer.cancel();
|
||||||
|
}
|
||||||
|
timer = new Timer();
|
||||||
|
timer.schedule(new SendHeartBeatPacket(), 500);
|
||||||
|
timer.schedule(new SendPlayerListPacket(), 1000);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 发送数据包
|
||||||
|
public static boolean sendPacket(BasePacket packet) {
|
||||||
|
var p = SocketUtils.getPacket(packet);
|
||||||
|
if (!clientThread.sendPacket(p)) {
|
||||||
|
mLogger.warn("[OpenCommand] Send packet to server failed");
|
||||||
|
mLogger.info("[OpenCommand] Reconnect to server");
|
||||||
|
connect = false;
|
||||||
|
connectServer();
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 发送数据包带数据包ID
|
||||||
|
public static boolean sendPacket(BasePacket packet, String packetID) {
|
||||||
|
if (!clientThread.sendPacket(SocketUtils.getPacketAndPackID(packet, packetID))) {
|
||||||
|
mLogger.warn("[OpenCommand] Send packet to server failed");
|
||||||
|
mLogger.info("[OpenCommand] Reconnect to server");
|
||||||
|
connect = false;
|
||||||
|
connectServer();
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 心跳包发送
|
||||||
|
private static class SendHeartBeatPacket extends TimerTask {
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
if (connect) {
|
||||||
|
sendPacket(new HeartBeat("Pong"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static class SendPlayerListPacket extends TimerTask {
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
if (connect) {
|
||||||
|
PlayerList playerList = new PlayerList();
|
||||||
|
playerList.player = Grasscutter.getGameServer().getPlayers().size();
|
||||||
|
ArrayList<String> playerNames = new ArrayList<>();
|
||||||
|
for (emu.grasscutter.game.player.Player player : Grasscutter.getGameServer().getPlayers().values()) {
|
||||||
|
playerNames.add(player.getNickname());
|
||||||
|
playerList.playerMap.put(player.getUid(), player.getNickname());
|
||||||
|
}
|
||||||
|
playerList.playerList = playerNames;
|
||||||
|
sendPacket(playerList);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 数据包接收
|
||||||
|
private static class ReceiveThread extends Thread {
|
||||||
|
private InputStream is;
|
||||||
|
private boolean exit = false;
|
||||||
|
|
||||||
|
public ReceiveThread(Socket socket) {
|
||||||
|
try {
|
||||||
|
is = socket.getInputStream();
|
||||||
|
} catch (IOException e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
start();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
while (true) {
|
||||||
|
try {
|
||||||
|
if (exit) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
String data = SocketUtils.readString(is);
|
||||||
|
Packet packet = JsonUtils.decode(data, Packet.class);
|
||||||
|
switch (packet.type) {
|
||||||
|
// 玩家类
|
||||||
|
case Player:
|
||||||
|
var player = JsonUtils.decode(packet.data, Player.class);
|
||||||
|
switch (player.type) {
|
||||||
|
// 运行命令
|
||||||
|
case RunCommand -> {
|
||||||
|
var command = player.data;
|
||||||
|
var playerData = OpenCommandPlugin.getInstance().getServer().getPlayerByUid(player.uid);
|
||||||
|
if (playerData == null) {
|
||||||
|
sendPacket(new HttpPacket(404, "Player not found."), packet.packetID);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
//noinspection SynchronizationOnLocalVariableOrMethodParameter
|
||||||
|
synchronized (playerData) {
|
||||||
|
// Player MessageHandler do not support concurrency
|
||||||
|
var handler = EventListeners.getPlayerNewMessageHandler(playerData.getUid());
|
||||||
|
try {
|
||||||
|
CommandMap.getInstance().invoke(playerData, playerData, command);
|
||||||
|
sendPacket(new HttpPacket(200, handler.toString()), packet.packetID);
|
||||||
|
} catch (Exception e) {
|
||||||
|
OpenCommandPlugin.getInstance().getLogger().warn("[OpenCommand] Run command failed.", e);
|
||||||
|
sendPacket(new HttpPacket(500, "error", e.getLocalizedMessage()), packet.packetID);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// 发送信息
|
||||||
|
case DropMessage -> {
|
||||||
|
var playerData = OpenCommandPlugin.getInstance().getServer().getPlayerByUid(player.uid);
|
||||||
|
if (playerData == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
playerData.dropMessage(player.data);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case RunConsoleCommand:
|
||||||
|
var consoleCommand = JsonUtils.decode(packet.data, RunConsoleCommand.class);
|
||||||
|
var plugin = OpenCommandPlugin.getInstance();
|
||||||
|
//noinspection SynchronizationOnLocalVariableOrMethodParameter
|
||||||
|
synchronized (plugin) {
|
||||||
|
try {
|
||||||
|
var resultCollector = new StringBuilder();
|
||||||
|
EventListeners.setConsoleMessageHandler(resultCollector);
|
||||||
|
CommandMap.getInstance().invoke(null, null, consoleCommand.command);
|
||||||
|
sendPacket(new HttpPacket(resultCollector.toString()), packet.packetID);
|
||||||
|
} catch (Exception e) {
|
||||||
|
mLogger.warn("[OpenCommand] Run command failed.", e);
|
||||||
|
EventListeners.setConsoleMessageHandler(null);
|
||||||
|
sendPacket(new HttpPacket(500, "error", e.getLocalizedMessage()), packet.packetID);
|
||||||
|
} finally {
|
||||||
|
EventListeners.setConsoleMessageHandler(null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (Throwable e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
if (!sendPacket(new HeartBeat("Pong"))) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public void exit() {
|
||||||
|
exit = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 客户端连接线程
|
||||||
|
private static class ClientThread extends Thread {
|
||||||
|
private final String ip;
|
||||||
|
private final int port;
|
||||||
|
private Socket socket;
|
||||||
|
private OutputStream os;
|
||||||
|
|
||||||
|
public ClientThread(String ip, int port) {
|
||||||
|
this.ip = ip;
|
||||||
|
this.port = port;
|
||||||
|
start();
|
||||||
|
}
|
||||||
|
|
||||||
|
public Socket getSocket() {
|
||||||
|
return socket;
|
||||||
|
}
|
||||||
|
|
||||||
|
public boolean sendPacket(String string) {
|
||||||
|
return SocketUtils.writeString(os, string);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
try {
|
||||||
|
connect = true;
|
||||||
|
if (receiveThread != null) {
|
||||||
|
receiveThread.exit();
|
||||||
|
}
|
||||||
|
|
||||||
|
socket = new Socket(ip, port);
|
||||||
|
os = socket.getOutputStream();
|
||||||
|
mLogger.info("[OpenCommand] Connect to server: " + ip + ":" + port);
|
||||||
|
SocketClient.sendPacket(new AuthPacket(OpenCommandPlugin.getInstance().getConfig().socketToken, OpenCommandPlugin.getInstance().getConfig().socketDisplayName));
|
||||||
|
receiveThread = new ReceiveThread(socket);
|
||||||
|
} catch (IOException e) {
|
||||||
|
connect = false;
|
||||||
|
mLogger.warn("[OpenCommand] Connect to server failed: " + ip + ":" + port);
|
||||||
|
connectServer();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.player.PlayerList;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.concurrent.atomic.AtomicReference;
|
||||||
|
|
||||||
|
// Socket 数据保存
|
||||||
|
public class SocketData {
|
||||||
|
public static HashMap<String, PlayerList> playerList = new HashMap<>();
|
||||||
|
|
||||||
|
public static String getPlayer(int uid) {
|
||||||
|
for (PlayerList player : playerList.values()) {
|
||||||
|
if (player.playerMap.get(uid) != null) {
|
||||||
|
return player.playerMap.get(uid);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static String getPlayerInServer(int uid) {
|
||||||
|
AtomicReference<String> ret = new AtomicReference<>();
|
||||||
|
playerList.forEach((key, value) -> {
|
||||||
|
if (value.playerMap.get(uid) != null) {
|
||||||
|
ret.set(key);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return ret.get();
|
||||||
|
}
|
||||||
|
|
||||||
|
public static OnlinePlayer getOnlinePlayer() {
|
||||||
|
ArrayList<String> player = new ArrayList<>();
|
||||||
|
playerList.forEach((address, playerMap) -> playerMap.playerMap.forEach((uid, name) -> player.add(name)));
|
||||||
|
return new OnlinePlayer(player);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static class OnlinePlayer {
|
||||||
|
public int count;
|
||||||
|
public ArrayList<String> playerList;
|
||||||
|
|
||||||
|
public OnlinePlayer(ArrayList<String> playerList) {
|
||||||
|
this.playerList = playerList;
|
||||||
|
this.count = playerList.size();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket;
|
||||||
|
|
||||||
|
// 异步等待数据返回
|
||||||
|
public abstract class SocketDataWait<T> extends Thread {
|
||||||
|
public T data;
|
||||||
|
public long timeout;
|
||||||
|
public long time;
|
||||||
|
public String uid;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 异步等待数据返回
|
||||||
|
* @param timeout 超时时间
|
||||||
|
*/
|
||||||
|
public SocketDataWait(long timeout) {
|
||||||
|
this.timeout = timeout;
|
||||||
|
start();
|
||||||
|
}
|
||||||
|
|
||||||
|
public abstract void run();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 数据处理
|
||||||
|
* @param data 数据
|
||||||
|
* @return 处理后的数据
|
||||||
|
*/
|
||||||
|
public abstract T initData(T data);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 超时回调
|
||||||
|
*/
|
||||||
|
public abstract void timeout();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 异步设置数据
|
||||||
|
* @param data 数据
|
||||||
|
*/
|
||||||
|
public void setData(Object data) {
|
||||||
|
this.data = initData((T) data);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取异步数据(此操作会一直堵塞直到获取到数据)
|
||||||
|
* @return 数据
|
||||||
|
*/
|
||||||
|
public T getData() {
|
||||||
|
while (data == null) {
|
||||||
|
try {
|
||||||
|
time += 100;
|
||||||
|
Thread.sleep(100);
|
||||||
|
} catch (InterruptedException e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
if (time > timeout) {
|
||||||
|
timeout();
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,294 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.OpenCommandPlugin;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.*;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.player.PlayerList;
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.OutputStream;
|
||||||
|
import java.net.ServerSocket;
|
||||||
|
import java.net.Socket;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Timer;
|
||||||
|
import java.util.TimerTask;
|
||||||
|
import java.util.UUID;
|
||||||
|
|
||||||
|
// Socket 服务器
|
||||||
|
public class SocketServer {
|
||||||
|
// 客户端超时时间
|
||||||
|
private static final int TIMEOUT = 5000;
|
||||||
|
private static final HashMap<String, ClientInfo> clientList = new HashMap<>();
|
||||||
|
|
||||||
|
private static final HashMap<String, Integer> clientTimeout = new HashMap<>();
|
||||||
|
private static Logger mLogger;
|
||||||
|
|
||||||
|
public static HashMap<String, String> getOnlineClient() {
|
||||||
|
HashMap<String, String> onlineClient = new HashMap<>();
|
||||||
|
for (var key : clientList.entrySet()) {
|
||||||
|
onlineClient.put(key.getValue().uuid, key.getValue().clientThread.getDisplayName());
|
||||||
|
}
|
||||||
|
return onlineClient;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static ClientInfo getClientInfoByUuid(String uuid) {
|
||||||
|
for (var key : clientList.entrySet()) {
|
||||||
|
if (key.getValue().uuid.equals(uuid)) {
|
||||||
|
return key.getValue();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void startServer() throws IOException {
|
||||||
|
int port = OpenCommandPlugin.getInstance().getConfig().socketPort;
|
||||||
|
mLogger = OpenCommandPlugin.getInstance().getLogger();
|
||||||
|
new Timer().schedule(new SocketClientCheck(), 500);
|
||||||
|
new WaitClientConnect(port);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 向全部客户端发送数据
|
||||||
|
public static boolean sendAllPacket(BasePacket packet) {
|
||||||
|
var p = SocketUtils.getPacket(packet);
|
||||||
|
HashMap<String, ClientInfo> old = (HashMap<String, ClientInfo>) clientList.clone();
|
||||||
|
for (var client : old.entrySet()) {
|
||||||
|
if (!client.getValue().clientThread.sendPacket(p)) {
|
||||||
|
mLogger.warn("[OpenCommand] Send packet to client {} failed", client.getKey());
|
||||||
|
clientList.remove(client.getKey());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 根据地址发送到相应的客户端
|
||||||
|
public static boolean sendPacket(String address, BasePacket packet) {
|
||||||
|
var p = SocketUtils.getPacket(packet);
|
||||||
|
var client = clientList.get(address);
|
||||||
|
if (client != null) {
|
||||||
|
if (client.clientThread.sendPacket(p)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
mLogger.warn("[OpenCommand] Send packet to client {} failed", address);
|
||||||
|
clientList.remove(address);
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static boolean sendPacketAndWait(String address, BasePacket packet, SocketDataWait<?> wait) {
|
||||||
|
var p = SocketUtils.getPacketAndPackID(packet);
|
||||||
|
var client = clientList.get(address);
|
||||||
|
if (client != null) {
|
||||||
|
wait.uid = p.get(0);
|
||||||
|
if (client.clientThread.sendPacket(p.get(1), wait)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
mLogger.warn("[OpenCommand] Send packet to client {} failed", address);
|
||||||
|
clientList.remove(address);
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static boolean sendUidPacket(Integer playerId, BasePacket player) {
|
||||||
|
var p = SocketUtils.getPacket(player);
|
||||||
|
var clientID = SocketData.getPlayerInServer(playerId);
|
||||||
|
if (clientID == null) return false;
|
||||||
|
var client = clientList.get(clientID);
|
||||||
|
if (client != null) {
|
||||||
|
if (!client.clientThread.sendPacket(p)) {
|
||||||
|
mLogger.warn("[OpenCommand] Send packet to client {} failed", clientID);
|
||||||
|
clientList.remove(clientID);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 根据Uid发送到相应的客户端异步返回数据
|
||||||
|
public static boolean sendUidPacketAndWait(Integer playerId, BasePacket player, SocketDataWait<?> socketDataWait) {
|
||||||
|
var p = SocketUtils.getPacketAndPackID(player);
|
||||||
|
var clientID = SocketData.getPlayerInServer(playerId);
|
||||||
|
if (clientID == null) return false;
|
||||||
|
var client = clientList.get(clientID);
|
||||||
|
if (client != null) {
|
||||||
|
socketDataWait.uid = p.get(0);
|
||||||
|
if (!client.clientThread.sendPacket(p.get(1), socketDataWait)) {
|
||||||
|
mLogger.warn("[OpenCommand] Send packet to client {} failed", clientID);
|
||||||
|
clientList.remove(clientID);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 客户端超时检测
|
||||||
|
private static class SocketClientCheck extends TimerTask {
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
HashMap<String, Integer> old = (HashMap<String, Integer>) clientTimeout.clone();
|
||||||
|
for (var client : old.entrySet()) {
|
||||||
|
var clientID = client.getKey();
|
||||||
|
var clientTime = client.getValue();
|
||||||
|
if (clientTime > TIMEOUT) {
|
||||||
|
mLogger.info("[OpenCommand] Client {} timeout, disconnect.", clientID);
|
||||||
|
clientList.remove(clientID);
|
||||||
|
clientTimeout.remove(clientID);
|
||||||
|
SocketData.playerList.remove(clientID);
|
||||||
|
} else {
|
||||||
|
clientTimeout.put(clientID, clientTime + 500);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 客户端数据包处理
|
||||||
|
static class ClientThread extends Thread {
|
||||||
|
private final Socket socket;
|
||||||
|
private InputStream is;
|
||||||
|
private OutputStream os;
|
||||||
|
private final String address;
|
||||||
|
private final String token;
|
||||||
|
private boolean auth = false;
|
||||||
|
private String displayName = "";
|
||||||
|
|
||||||
|
private final HashMap<String, SocketDataWait<?>> socketDataWaitList = new HashMap<>();
|
||||||
|
|
||||||
|
public ClientThread(Socket accept) {
|
||||||
|
socket = accept;
|
||||||
|
address = socket.getInetAddress() + ":" + socket.getPort();
|
||||||
|
token = OpenCommandPlugin.getInstance().getConfig().socketToken;
|
||||||
|
try {
|
||||||
|
is = accept.getInputStream();
|
||||||
|
os = accept.getOutputStream();
|
||||||
|
} catch (IOException e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
start();
|
||||||
|
}
|
||||||
|
|
||||||
|
public Socket getSocket() {
|
||||||
|
return socket;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 发送数据包
|
||||||
|
public boolean sendPacket(String packet) {
|
||||||
|
return SocketUtils.writeString(os, packet);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 发送异步数据包
|
||||||
|
public boolean sendPacket(String packet, SocketDataWait<?> socketDataWait) {
|
||||||
|
if (SocketUtils.writeString(os, packet)) {
|
||||||
|
socketDataWaitList.put(socketDataWait.uid, socketDataWait);
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
while (true) {
|
||||||
|
try {
|
||||||
|
String data = SocketUtils.readString(is);
|
||||||
|
Packet packet = JsonUtils.decode(data, Packet.class);
|
||||||
|
if (packet.type == PacketEnum.AuthPacket) {
|
||||||
|
AuthPacket authPacket = JsonUtils.decode(packet.data, AuthPacket.class);
|
||||||
|
if (authPacket.token.equals(token)) {
|
||||||
|
auth = true;
|
||||||
|
displayName = authPacket.displayName;
|
||||||
|
mLogger.info("[OpenCommand] Client {} auth success, name: {}", address, displayName);
|
||||||
|
clientList.put(address, new ClientInfo(UUID.randomUUID().toString(), address, this));
|
||||||
|
clientTimeout.put(address, 0);
|
||||||
|
} else {
|
||||||
|
mLogger.warn("[OpenCommand] Client {} auth failed", address);
|
||||||
|
socket.close();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!auth) {
|
||||||
|
mLogger.warn("[OpenCommand] Client {} auth failed", address);
|
||||||
|
socket.close();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
switch (packet.type) {
|
||||||
|
// 缓存玩家列表
|
||||||
|
case PlayerList -> {
|
||||||
|
PlayerList playerList = JsonUtils.decode(packet.data, PlayerList.class);
|
||||||
|
SocketData.playerList.put(address, playerList);
|
||||||
|
}
|
||||||
|
// Http信息返回
|
||||||
|
case HttpPacket -> {
|
||||||
|
HttpPacket httpPacket = JsonUtils.decode(packet.data, HttpPacket.class);
|
||||||
|
var socketWait = socketDataWaitList.get(packet.packetID);
|
||||||
|
if (socketWait == null) {
|
||||||
|
mLogger.error("[OpenCommand] HttpPacket: " + packet.packetID + " not found");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
socketWait.setData(httpPacket);
|
||||||
|
socketDataWaitList.remove(packet.packetID);
|
||||||
|
}
|
||||||
|
// 心跳包
|
||||||
|
case HeartBeat -> clientTimeout.put(address, 0);
|
||||||
|
}
|
||||||
|
} catch (Throwable e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
mLogger.error("[OpenCommand] Client {} disconnect.", address);
|
||||||
|
clientList.remove(address);
|
||||||
|
clientTimeout.remove(address);
|
||||||
|
SocketData.playerList.remove(address);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getDisplayName() {
|
||||||
|
return displayName;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 等待客户端连接
|
||||||
|
private static class WaitClientConnect extends Thread {
|
||||||
|
ServerSocket socketServer;
|
||||||
|
|
||||||
|
public WaitClientConnect(int port) throws IOException {
|
||||||
|
socketServer = new ServerSocket(port);
|
||||||
|
start();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void run() {
|
||||||
|
mLogger.info("[OpenCommand] Start socket server on port " + socketServer.getLocalPort());
|
||||||
|
// noinspection InfiniteLoopStatement
|
||||||
|
while (true) {
|
||||||
|
try {
|
||||||
|
Socket accept = socketServer.accept();
|
||||||
|
String address = accept.getInetAddress() + ":" + accept.getPort();
|
||||||
|
mLogger.info("[OpenCommand] Client connect: " + address);
|
||||||
|
new ClientThread(accept);
|
||||||
|
} catch (IOException e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,158 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.BasePacket;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.Packet;
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.OutputStream;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.UUID;
|
||||||
|
|
||||||
|
// Socket 工具类
|
||||||
|
public class SocketUtils {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取打包后的数据包
|
||||||
|
*
|
||||||
|
* @param bPacket 数据包
|
||||||
|
* @return 打包后的数据包
|
||||||
|
*/
|
||||||
|
public static String getPacket(BasePacket bPacket) {
|
||||||
|
Packet packet = new Packet();
|
||||||
|
packet.type = bPacket.getType();
|
||||||
|
packet.data = bPacket.getPacket();
|
||||||
|
packet.packetID = UUID.randomUUID().toString();
|
||||||
|
return JsonUtils.encode(packet);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取打包后的数据包
|
||||||
|
*
|
||||||
|
* @param bPacket BasePacket
|
||||||
|
* @return list[0] 是包ID, list[1] 是数据包
|
||||||
|
*/
|
||||||
|
public static List<String> getPacketAndPackID(BasePacket bPacket) {
|
||||||
|
Packet packet = new Packet();
|
||||||
|
packet.type = bPacket.getType();
|
||||||
|
packet.data = bPacket.getPacket();
|
||||||
|
packet.packetID = UUID.randomUUID().toString();
|
||||||
|
|
||||||
|
List<String> list = new ArrayList<>();
|
||||||
|
list.add(packet.packetID);
|
||||||
|
list.add(JsonUtils.encode(packet));
|
||||||
|
return list;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取打包后的数据包
|
||||||
|
*
|
||||||
|
* @param bPacket 数据包
|
||||||
|
* @param packetID 数据包ID
|
||||||
|
* @return 打包后的数据包
|
||||||
|
*/
|
||||||
|
public static String getPacketAndPackID(BasePacket bPacket, String packetID) {
|
||||||
|
Packet packet = new Packet();
|
||||||
|
packet.type = bPacket.getType();
|
||||||
|
packet.data = bPacket.getPacket();
|
||||||
|
packet.packetID = packetID;
|
||||||
|
return JsonUtils.encode(packet);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 读整数
|
||||||
|
*
|
||||||
|
* @param is 输入流
|
||||||
|
* @return 整数
|
||||||
|
*/
|
||||||
|
public static int readInt(InputStream is) {
|
||||||
|
int[] values = new int[4];
|
||||||
|
try {
|
||||||
|
for (int i = 0; i < 4; i++) {
|
||||||
|
values[i] = is.read();
|
||||||
|
}
|
||||||
|
} catch (IOException e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
|
||||||
|
return values[0] << 24 | values[1] << 16 | values[2] << 8 | values[3];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 写整数
|
||||||
|
*
|
||||||
|
* @param os 输出流
|
||||||
|
* @param value 整数
|
||||||
|
*/
|
||||||
|
public static void writeInt(OutputStream os, int value) {
|
||||||
|
int[] values = new int[4];
|
||||||
|
values[0] = (value >> 24) & 0xFF;
|
||||||
|
values[1] = (value >> 16) & 0xFF;
|
||||||
|
values[2] = (value >> 8) & 0xFF;
|
||||||
|
values[3] = (value) & 0xFF;
|
||||||
|
|
||||||
|
try {
|
||||||
|
for (int i = 0; i < 4; i++) {
|
||||||
|
os.write(values[i]);
|
||||||
|
}
|
||||||
|
} catch (IOException e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 读字符串
|
||||||
|
*
|
||||||
|
* @param is 输入流
|
||||||
|
* @return 字符串
|
||||||
|
*/
|
||||||
|
public static String readString(InputStream is) {
|
||||||
|
int len = readInt(is);
|
||||||
|
byte[] sByte = new byte[len];
|
||||||
|
try {
|
||||||
|
is.read(sByte);
|
||||||
|
} catch (IOException e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
return new String(sByte);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 写字符串
|
||||||
|
*
|
||||||
|
* @param os 输出流
|
||||||
|
* @param s 字符串
|
||||||
|
* @return 是否成功
|
||||||
|
*/
|
||||||
|
public static boolean writeString(OutputStream os, String s) {
|
||||||
|
try {
|
||||||
|
byte[] bytes = s.getBytes();
|
||||||
|
int len = bytes.length;
|
||||||
|
writeInt(os, len);
|
||||||
|
os.write(bytes);
|
||||||
|
return true;
|
||||||
|
} catch (IOException e) {
|
||||||
|
e.printStackTrace();
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet;
|
||||||
|
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
|
||||||
|
public class AuthPacket extends BasePacket {
|
||||||
|
public String token;
|
||||||
|
public String displayName;
|
||||||
|
|
||||||
|
public AuthPacket(String token, String displayName) {
|
||||||
|
this.displayName = displayName;
|
||||||
|
this.token = token;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getPacket() {
|
||||||
|
return JsonUtils.encode(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public PacketEnum getType() {
|
||||||
|
return PacketEnum.AuthPacket;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return "AuthPacket [token=" + token + ", displayName=" + displayName + "]";
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet;
|
||||||
|
|
||||||
|
// 基本数据包
|
||||||
|
public abstract class BasePacket {
|
||||||
|
public abstract String getPacket();
|
||||||
|
|
||||||
|
public abstract PacketEnum getType();
|
||||||
|
}
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet;
|
||||||
|
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
|
||||||
|
// 心跳包
|
||||||
|
public class HeartBeat extends BasePacket {
|
||||||
|
public String ping;
|
||||||
|
|
||||||
|
public HeartBeat(String ping) {
|
||||||
|
this.ping = ping;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getPacket() {
|
||||||
|
return JsonUtils.encode(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public PacketEnum getType() {
|
||||||
|
return PacketEnum.HeartBeat;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet;
|
||||||
|
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
|
||||||
|
// http返回数据
|
||||||
|
public class HttpPacket extends BasePacket {
|
||||||
|
public int code = 200;
|
||||||
|
public String message = "Success";
|
||||||
|
public String data;
|
||||||
|
|
||||||
|
public HttpPacket(int code, String message, String data) {
|
||||||
|
this.code = code;
|
||||||
|
this.message = message;
|
||||||
|
this.data = data;
|
||||||
|
}
|
||||||
|
|
||||||
|
public HttpPacket(int code, String message) {
|
||||||
|
this.code = code;
|
||||||
|
this.message = message;
|
||||||
|
}
|
||||||
|
public HttpPacket(String data) {
|
||||||
|
this.data = data;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getPacket() {
|
||||||
|
return JsonUtils.encode(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public PacketEnum getType() {
|
||||||
|
return PacketEnum.HttpPacket;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return "HttpPacket [code=" + code + ", message=" + message + ", data=" + data + "]";
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet;
|
||||||
|
|
||||||
|
// 数据包结构
|
||||||
|
public class Packet {
|
||||||
|
public PacketEnum type;
|
||||||
|
public String data;
|
||||||
|
public String packetID;
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return "Packet [type=" + type + ", data=" + data + ", packetID=" + packetID + "]";
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet;
|
||||||
|
|
||||||
|
// 数据包类型列表
|
||||||
|
public enum PacketEnum {
|
||||||
|
PlayerList,
|
||||||
|
Player,
|
||||||
|
HttpPacket,
|
||||||
|
AuthPacket,
|
||||||
|
RunConsoleCommand,
|
||||||
|
HeartBeat
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet;
|
||||||
|
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
|
||||||
|
public class RunConsoleCommand extends BasePacket {
|
||||||
|
public String command;
|
||||||
|
|
||||||
|
public RunConsoleCommand(String command) {
|
||||||
|
this.command = command;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getPacket() {
|
||||||
|
return JsonUtils.encode(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public PacketEnum getType() {
|
||||||
|
return PacketEnum.RunConsoleCommand;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet.player;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.socket.SocketServer;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.BasePacket;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.PacketEnum;
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
|
||||||
|
// 玩家操作类
|
||||||
|
public class Player extends BasePacket {
|
||||||
|
public PlayerEnum type;
|
||||||
|
public int uid;
|
||||||
|
public String data;
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getPacket() {
|
||||||
|
return JsonUtils.encode(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public PacketEnum getType() {
|
||||||
|
return PacketEnum.Player;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void dropMessage(int uid, String str) {
|
||||||
|
Player p = new Player();
|
||||||
|
p.type = PlayerEnum.DropMessage;
|
||||||
|
p.uid = uid;
|
||||||
|
p.data = str;
|
||||||
|
SocketServer.sendUidPacket(uid, p);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet.player;
|
||||||
|
|
||||||
|
// 玩家操作列表
|
||||||
|
public enum PlayerEnum {
|
||||||
|
DropMessage,
|
||||||
|
RunCommand
|
||||||
|
}
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/*
|
||||||
|
* gc-opencommand
|
||||||
|
* Copyright (C) 2022 jie65535
|
||||||
|
*
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
package com.github.jie65535.opencommand.socket.packet.player;
|
||||||
|
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.BasePacket;
|
||||||
|
import com.github.jie65535.opencommand.socket.packet.PacketEnum;
|
||||||
|
import emu.grasscutter.utils.JsonUtils;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
// 玩家列表信息
|
||||||
|
public class PlayerList extends BasePacket {
|
||||||
|
public int player = -1;
|
||||||
|
public List<String> playerList = new ArrayList<>();
|
||||||
|
public Map<Integer, String> playerMap = new HashMap<>();
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getPacket() {
|
||||||
|
return JsonUtils.encode(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public PacketEnum getType() {
|
||||||
|
return PacketEnum.PlayerList;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "opencommand-plugin",
|
"name": "opencommand-plugin",
|
||||||
"description": "Open command interface for third-party clients",
|
"description": "Open command interface for third-party clients",
|
||||||
"version": "dev-1.0.0",
|
"version": "dev-1.5.2",
|
||||||
"mainClass": "com.github.jie65535.opencommand.OpenCommandPlugin",
|
"mainClass": "com.github.jie65535.opencommand.OpenCommandPlugin",
|
||||||
"authors": ["jie65535"]
|
"authors": ["jie65535", "方块君"]
|
||||||
}
|
}
|
||||||
Reference in New Issue
Block a user