forked from StarOpenSource/Engine
Initial commit
This commit is contained in:
commit
f47dd66d88
GPG key ID:
E366BAEF67E4704D
91 changed files with 6744 additions and 0 deletions
43
.gitignore
vendored
Normal file
43
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
### Gradle ###
|
||||||
|
.gradle
|
||||||
|
build/
|
||||||
|
!gradle/wrapper/gradle-wrapper.jar
|
||||||
|
!**/src/main/**/build/
|
||||||
|
!**/src/test/**/build/
|
||||||
|
|
||||||
|
### IntelliJ IDEA ###
|
||||||
|
.idea/modules.xml
|
||||||
|
.idea/jarRepositories.xml
|
||||||
|
.idea/compiler.xml
|
||||||
|
.idea/libraries/
|
||||||
|
*.iws
|
||||||
|
*.iml
|
||||||
|
*.ipr
|
||||||
|
out/
|
||||||
|
!**/src/main/**/out/
|
||||||
|
!**/src/test/**/out/
|
||||||
|
|
||||||
|
### Eclipse ###
|
||||||
|
.apt_generated
|
||||||
|
.classpath
|
||||||
|
.factorypath
|
||||||
|
.project
|
||||||
|
.settings
|
||||||
|
.springBeans
|
||||||
|
.sts4-cache
|
||||||
|
bin/
|
||||||
|
!**/src/main/**/bin/
|
||||||
|
!**/src/test/**/bin/
|
||||||
|
|
||||||
|
### NetBeans ###
|
||||||
|
/nbproject/private/
|
||||||
|
/nbbuild/
|
||||||
|
/dist/
|
||||||
|
/nbdist/
|
||||||
|
/.nb-gradle/
|
||||||
|
|
||||||
|
### VS Code ###
|
||||||
|
.vscode/
|
||||||
|
|
||||||
|
### Mac OS ###
|
||||||
|
.DS_Store
|
||||||
105
.idea/workspace.xml
Normal file
105
.idea/workspace.xml
Normal file
|
|
@ -0,0 +1,105 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="RunManager">
|
||||||
|
<configuration name="Build test application" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="shadowJar" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="Clean" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="clean" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="Generate Javadoc" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="javadoc" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="Run test application" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="shadowJar" />
|
||||||
|
<option value="testapp:run" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<list>
|
||||||
|
<item itemvalue="Gradle.Run test application" />
|
||||||
|
<item itemvalue="Gradle.Build test application" />
|
||||||
|
<item itemvalue="Gradle.Generate Javadoc" />
|
||||||
|
<item itemvalue="Gradle.Clean" />
|
||||||
|
</list>
|
||||||
|
<recent_temporary>
|
||||||
|
<list>
|
||||||
|
<item itemvalue="Gradle.Generate Javadoc" />
|
||||||
|
</list>
|
||||||
|
</recent_temporary>
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
|
|
@ -0,0 +1,661 @@
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
51
README.md
Normal file
51
README.md
Normal file
|
|
@ -0,0 +1,51 @@
|
||||||
|
# StarOpenSource Engine
|
||||||
|
The StarOpenSource engine (or sos!engine for short) is a modular, extensible and easy to use Java game and application engine.
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [About](#about)
|
||||||
|
- [About the engine](#about-the-engine)
|
||||||
|
- [About the repository](#about-the-repository)
|
||||||
|
- [Priorities](#priorities)
|
||||||
|
- [Documentation](#documentation)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [Requirements](#requirements)
|
||||||
|
- [What IDE to use?](#what-ide-to-use)
|
||||||
|
- [Code style](#code-style)
|
||||||
|
- [Read this before creating a pull request](#read-this-before-creating-a-pull-request)
|
||||||
|
- [Making your first contribution](#making-your-first-contribution)
|
||||||
|
|
||||||
|
## About
|
||||||
|
### About the engine
|
||||||
|
The sos!engine is a modular and extensible framework for building applications and games, written in the Java programming language.
|
||||||
|
The engine consists of various subsystems, each separate and responsible for only one thing. The engine also houses various useful utilities and classes making development fun, while being lightweight.
|
||||||
|
### About the repository
|
||||||
|
The sos!engine repository is a monorepo, consisting of the core engine, official subsystems and their documentation.
|
||||||
|
### Priorities
|
||||||
|
- modular
|
||||||
|
- small & lightweight
|
||||||
|
- fast
|
||||||
|
- [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy) (subsystems)
|
||||||
|
- have as few dependencies as possible
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
The official documentation for the StarOpenSource Engine is not yet available and won't be until we hit v1-rc0.
|
||||||
|
You can however [visit the Javadocs](https://jd.engine.staropensource.de).
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
### Requirements
|
||||||
|
You need the following things to be able to contribute to the StarOpenSource Engine:
|
||||||
|
- knowledge of Java
|
||||||
|
- (basic) knowledge of the engine
|
||||||
|
### What IDE to use?
|
||||||
|
We use and recommend using [IntelliJ IDEA Community Edition](https://github.com/JetBrains/intellij-community) for development because it is flexible, extendable, customizable, provides good completions and error detection. It's also open source.
|
||||||
|
### Code style
|
||||||
|
We recommend looking at existing classes.
|
||||||
|
### Read this before creating a pull request
|
||||||
|
Before creating a pull request, make sure you've
|
||||||
|
- created tests for the functionality you added, changed or removed (if applicable),
|
||||||
|
- tested your changes,
|
||||||
|
- made sure that everything works,
|
||||||
|
- is compatible with other code in the monorepo, and
|
||||||
|
- is compatible with other applications. If not, tell us in your pull request description.
|
||||||
|
### Making your first contribution
|
||||||
|
TODO (probably) until v1-rc0
|
||||||
33
base/build.gradle
Normal file
33
base/build.gradle
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
plugins {
|
||||||
|
id 'java'
|
||||||
|
id "io.freefair.lombok" version "${pluginLombok}"
|
||||||
|
}
|
||||||
|
|
||||||
|
group = project.group
|
||||||
|
version = project.versioningVersion + "-" + project.versioningType + project.versioningTyperelease + project.versioningFork
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
// Lombok
|
||||||
|
compileOnly 'org.projectlombok:lombok:' + project.dependencyLombok
|
||||||
|
annotationProcessor 'org.projectlombok:lombok:' + project.dependencyLombok
|
||||||
|
|
||||||
|
// JetBrains annotations
|
||||||
|
compileOnly 'org.jetbrains:annotations:' + project.dependencyJetbrainsAnnotations
|
||||||
|
|
||||||
|
// ANSI support
|
||||||
|
implementation 'org.fusesource.jansi:jansi:' + project.dependencyJansi
|
||||||
|
}
|
||||||
|
|
||||||
|
javadoc.options {
|
||||||
|
setMemberLevel(JavadocMemberLevel.PUBLIC)
|
||||||
|
setOverview("src/main/javadoc/overview.html")
|
||||||
|
setLocale("en_US");
|
||||||
|
setJFlags([
|
||||||
|
// Force Javadoc to use English translations
|
||||||
|
"-Duser.language=en_US"
|
||||||
|
])
|
||||||
|
}
|
||||||
1
base/gradle
Symbolic link
1
base/gradle
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradle
|
||||||
1
base/gradlew
vendored
Symbolic link
1
base/gradlew
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradlew
|
||||||
1
base/gradlew.bat
vendored
Symbolic link
1
base/gradlew.bat
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradlew.bat
|
||||||
162
base/src/main/java/de/staropensource/sosengine/base/Engine.java
Normal file
162
base/src/main/java/de/staropensource/sosengine/base/Engine.java
Normal file
|
|
@ -0,0 +1,162 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.logging.CrashHandler;
|
||||||
|
import de.staropensource.sosengine.base.logging.LoggerInstance;
|
||||||
|
import de.staropensource.sosengine.base.types.CodePart;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import de.staropensource.sosengine.base.utility.*;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.util.LinkedHashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sos!engine management object.<br/>
|
||||||
|
* It is responsible for the base engine initialization.
|
||||||
|
*
|
||||||
|
* @see EngineConfiguration
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
public class Engine {
|
||||||
|
/**
|
||||||
|
* Instance.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@link Engine} instance.
|
||||||
|
*
|
||||||
|
* @return {@link Engine} instance unless uninitialized
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
@Getter
|
||||||
|
private static Engine instance = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logger instance.
|
||||||
|
*
|
||||||
|
* @see LoggerInstance
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LoggerInstance logger;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor, initializes the StarOpenSource Engine.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public Engine() {
|
||||||
|
// Check if sos!engine is already loaded
|
||||||
|
if (instance == null)
|
||||||
|
instance = this;
|
||||||
|
else {
|
||||||
|
instance.logger.crash("sos!engine tried to initialize twice");
|
||||||
|
//noinspection DataFlowIssue
|
||||||
|
logger = null;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Startup time measurement
|
||||||
|
long initTime = System.currentTimeMillis();
|
||||||
|
|
||||||
|
// Initialize EngineConfiguration and load it
|
||||||
|
new EngineConfiguration();
|
||||||
|
EngineConfiguration.getInstance().loadConfiguration();
|
||||||
|
|
||||||
|
// Initialize classes
|
||||||
|
// Sorted in rough order of dependence
|
||||||
|
new BuildInfo();
|
||||||
|
new PlaceholderEngine();
|
||||||
|
new ShortcodeConverter();
|
||||||
|
|
||||||
|
// Populate crash content
|
||||||
|
populateCrashContent();
|
||||||
|
|
||||||
|
// Initialize variables
|
||||||
|
logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE));
|
||||||
|
|
||||||
|
// Startup time measurement
|
||||||
|
initTime = System.currentTimeMillis() - initTime;
|
||||||
|
|
||||||
|
// Print finish message
|
||||||
|
logger.info("Initialized sos!engine v%engine_version% in " + initTime + "ms");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method populates the Crash Handler's content with the default set of content.
|
||||||
|
*
|
||||||
|
* @see CrashHandler#getCrashContent()
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings("ExtractMethodRecommender")
|
||||||
|
private void populateCrashContent() {
|
||||||
|
// Issuer
|
||||||
|
Map<String, String> crashContentIssuer = new LinkedHashMap<>();
|
||||||
|
crashContentIssuer.put("Code part", "%issuer_code_part%");
|
||||||
|
crashContentIssuer.put("Classpath", "%issuer_path%");
|
||||||
|
crashContentIssuer.put("Additional information", "%issuer_info%");
|
||||||
|
crashContentIssuer.put("Message", "%issuer_message%");
|
||||||
|
|
||||||
|
// Engine -> Dependencies
|
||||||
|
Map<String, String> crashContentEngineDependencies = new LinkedHashMap<>();
|
||||||
|
crashContentEngineDependencies.put("Lombok", "%engine_dependency_lombok%");
|
||||||
|
crashContentEngineDependencies.put("Jetbrains Annotations", "%engine_dependency_jetbrains_annotations%");
|
||||||
|
crashContentEngineDependencies.put("Jansi", "%engine_dependency_jansi%");
|
||||||
|
// Engine -> Plugins
|
||||||
|
Map<String, String> crashContentEnginePlugins = new LinkedHashMap<>();
|
||||||
|
crashContentEnginePlugins.put("Shadow", "%engine_plugin_shadow%");
|
||||||
|
crashContentEnginePlugins.put("Lombok", "%engine_plugin_lombok%");
|
||||||
|
// Engine -> *
|
||||||
|
Map<String, Object> crashContentEngine = new LinkedHashMap<>();
|
||||||
|
crashContentEngine.put("Version", "%engine_version%");
|
||||||
|
crashContentEngine.put("Dependencies", crashContentEngineDependencies);
|
||||||
|
crashContentEngine.put("Plugins", crashContentEnginePlugins);
|
||||||
|
|
||||||
|
// JVM -> Implementation
|
||||||
|
Map<String, String> crashContentJvmImplementation = new LinkedHashMap<>();
|
||||||
|
crashContentJvmImplementation.put("Name", "%jvm_implementation_name%");
|
||||||
|
crashContentJvmImplementation.put("Version", "%jvm_implementation_version%");
|
||||||
|
crashContentJvmImplementation.put("Vendor", "%jvm_implementation_vendor%");
|
||||||
|
// JVM -> *
|
||||||
|
Map<String, Object> crashContentJvm = new LinkedHashMap<>();
|
||||||
|
crashContentJvm.put("Java Version", "%jvm_java%");
|
||||||
|
crashContentJvm.put("Implementation", crashContentJvmImplementation);
|
||||||
|
crashContentJvm.put("Arguments", "%jvm_arguments%");
|
||||||
|
|
||||||
|
// Operating system
|
||||||
|
Map<String, String> crashContentOS = new LinkedHashMap<>();
|
||||||
|
crashContentOS.put("Time", "%time_hour%:%time_minute%:%time_second% (%time_zone%, UNIX Epoch: %time_epoch%)");
|
||||||
|
crashContentOS.put("Date", "%date_day%.%date_month%.%date_year%");
|
||||||
|
|
||||||
|
// Add to crash handler
|
||||||
|
CrashHandler.getCrashContent().put("Issuer", crashContentIssuer);
|
||||||
|
CrashHandler.getCrashContent().put("Engine", crashContentEngine);
|
||||||
|
CrashHandler.getCrashContent().put("Java Virtual Machine", crashContentJvm);
|
||||||
|
CrashHandler.getCrashContent().put("Operating system", crashContentOS);
|
||||||
|
CrashHandler.getCrashContent().put("Stacktrace", "%stacktrace%");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,268 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.logging.Logger;
|
||||||
|
import de.staropensource.sosengine.base.types.CodePart;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import de.staropensource.sosengine.base.types.LogLevel;
|
||||||
|
import de.staropensource.sosengine.base.utility.PropertyParser;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
import java.util.Properties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the engine configuration for all classes in a centralized place.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
@Getter
|
||||||
|
public class EngineConfiguration {
|
||||||
|
/**
|
||||||
|
* Instance.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@link EngineConfiguration} instance.
|
||||||
|
*
|
||||||
|
* @return {@link EngineConfiguration} instance
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static EngineConfiguration instance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defines the group every property must start with to be recognized as an engine configuration setting.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the group every property must start with to be recognized as an engine configuration setting.
|
||||||
|
*
|
||||||
|
* @return the property group
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static final String group = "sosengine.base.";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If enabled, allows for unintentional behaviour and excess logging.<br/>
|
||||||
|
* Unless you want to debug or work on a sensitive part of the engine, don't enable this!
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Gets the value for {@code debug}.
|
||||||
|
*
|
||||||
|
* @return variable value
|
||||||
|
* @see EngineConfiguration#debug
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean debug;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If enabled, very verbose messages about the {@link de.staropensource.sosengine.base.utility.ShortcodeConverter}'s internals will be printed.<br/>
|
||||||
|
* Don't enable unless you have knowledge about the {@link de.staropensource.sosengine.base.utility.ShortcodeConverter} and want to work on it.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.utility.ShortcodeConverter
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Gets the value for {@code debugShortcodeConverter}.
|
||||||
|
*
|
||||||
|
* @return variable value
|
||||||
|
* @see EngineConfiguration#debugShortcodeConverter
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean debugShortcodeConverter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If enabled, invalid shortcodes will be logged in {@link de.staropensource.sosengine.base.utility.ShortcodeConverter}.
|
||||||
|
* The message will be printed as a silent warning.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.utility.ShortcodeConverter
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Gets the value for {@code errorShortcodeConverter}.
|
||||||
|
*
|
||||||
|
* @return variable value
|
||||||
|
* @see EngineConfiguration#errorShortcodeConverter
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean errorShortcodeConverter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines which logger levels are allowed.
|
||||||
|
*
|
||||||
|
* @see Logger
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Gets the value for {@code loggerLevel}.
|
||||||
|
*
|
||||||
|
* @return variable value
|
||||||
|
* @see EngineConfiguration#loggerLevel
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private LogLevel loggerLevel;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the logging template.
|
||||||
|
*
|
||||||
|
* @see Logger
|
||||||
|
* @see de.staropensource.sosengine.base.data.placeholders Global placeholder list
|
||||||
|
* @see de.staropensource.sosengine.base.logging.placeholders.logger Logger placeholder list
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Gets the value for {@code loggerTemplate}
|
||||||
|
*
|
||||||
|
* @return variable value
|
||||||
|
* @see EngineConfiguration#loggerTemplate
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private String loggerTemplate;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If enabled, the JVM will immediately shutdown. This will prevent shutdown hooks from executing.<br/>
|
||||||
|
* Note: This will also prevent Jansi from removing temporary native libraries at shutdown.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.logging.CrashHandler
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Gets the value for {@code loggerImmediateShutdown}.
|
||||||
|
*
|
||||||
|
* @return variable value
|
||||||
|
* @see EngineConfiguration#loggerImmediateShutdown
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean loggerImmediateShutdown;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If enabled, will force the {@link Logger} and {@link de.staropensource.sosengine.base.logging.CrashHandler} to use the standard output.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Gets the value for {@code loggerForceStandardOutput}.
|
||||||
|
*
|
||||||
|
* @return variable value
|
||||||
|
* @see EngineConfiguration#loggerForceStandardOutput
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private boolean loggerForceStandardOutput;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @see Engine
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineConfiguration() {
|
||||||
|
// Only allow one instance
|
||||||
|
if (instance == null)
|
||||||
|
instance = this;
|
||||||
|
else
|
||||||
|
Logger.crash(new LogIssuer(getClass(), CodePart.ENGINE), "Tried reinitializing " + getClass().getName() + " twice");
|
||||||
|
|
||||||
|
loadDefaultConfiguration();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Loads the engine configuration from the specified {@link java.util.Properties}.<br/>
|
||||||
|
* Unless you want to allow configuration overriding, resetting the configuration using {@code loadDefaultConfiguration()} is advised.
|
||||||
|
*
|
||||||
|
* @param properties the {@link Properties} object
|
||||||
|
* @see EngineConfiguration#loadDefaultConfiguration()
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void loadConfiguration(Properties properties) {
|
||||||
|
// Define variables
|
||||||
|
PropertyParser parser = new PropertyParser(properties);
|
||||||
|
|
||||||
|
for (String property : properties.stringPropertyNames()) {
|
||||||
|
// Check if property name starts with "de.staropensource.sosengine.base."
|
||||||
|
if (!property.startsWith(group)) continue;
|
||||||
|
|
||||||
|
// Skip to important stuff
|
||||||
|
property = property.substring(group.length());
|
||||||
|
|
||||||
|
// Match settings
|
||||||
|
try {
|
||||||
|
switch (property) {
|
||||||
|
case "debug" -> debug = parser.getBoolean(group + property);
|
||||||
|
case "debugShortcodeConverter" -> debugShortcodeConverter = parser.getBoolean(group + property);
|
||||||
|
|
||||||
|
case "errorShortcodeConverter" -> errorShortcodeConverter = parser.getBoolean(group + property);
|
||||||
|
|
||||||
|
case "loggerLevel" -> {
|
||||||
|
try {
|
||||||
|
loggerLevel = LogLevel.valueOf(parser.getString(group + property).toUpperCase());
|
||||||
|
} catch (IllegalArgumentException ignored) {
|
||||||
|
System.out.println("Logger level " + parser.getString(group + property) + " is not valid");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case "loggerTemplate" -> loggerTemplate = parser.getString(group + property);
|
||||||
|
case "loggerImmediateShutdown" -> loggerImmediateShutdown = parser.getBoolean(group + property);
|
||||||
|
case "loggerForceStandardOutput" -> loggerForceStandardOutput = parser.getBoolean(group + property);
|
||||||
|
}
|
||||||
|
} catch (NullPointerException ignored) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Disable all debug options if 'debug' is disabled
|
||||||
|
if (!debug) {
|
||||||
|
debugShortcodeConverter = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Loads the engine configuration from the system properties.
|
||||||
|
*
|
||||||
|
* @see EngineConfiguration#loadConfiguration(Properties)
|
||||||
|
* @see System#getProperties()
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void loadConfiguration() {
|
||||||
|
loadConfiguration(System.getProperties());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Loads the default engine configuration.
|
||||||
|
*
|
||||||
|
* @see EngineConfiguration#loadConfiguration()
|
||||||
|
* @see EngineConfiguration#loadConfiguration(Properties)
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void loadDefaultConfiguration() {
|
||||||
|
debug = false;
|
||||||
|
debugShortcodeConverter = false;
|
||||||
|
|
||||||
|
errorShortcodeConverter = true;
|
||||||
|
|
||||||
|
loggerLevel = LogLevel.INFORMATIONAL;
|
||||||
|
loggerTemplate = "%log_color_primary%[%time_hour%:%time_minute%:%time_second%] [%log_level% %log_path%%log_info%] %log_color_secondary%%log_message%<reset>";
|
||||||
|
loggerImmediateShutdown = false;
|
||||||
|
loggerForceStandardOutput = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.classes;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import de.staropensource.sosengine.base.types.LogLevel;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for implementing custom logger implementations, called by {@link de.staropensource.sosengine.base.logging.Logger}.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.logging.Logger
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public interface LoggerImpl {
|
||||||
|
/**
|
||||||
|
* Run before placeholders are replaced.
|
||||||
|
*
|
||||||
|
* @param level log level
|
||||||
|
* @param logIssuer log issuer
|
||||||
|
* @param message log message
|
||||||
|
* @return new log message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
String prePlaceholder(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run after placeholders are replaced.
|
||||||
|
*
|
||||||
|
* @param level log level
|
||||||
|
* @param logIssuer log issuer
|
||||||
|
* @param message log message
|
||||||
|
* @return new log message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
String postPlaceholder(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Responsible for printing the finalized log message.
|
||||||
|
*
|
||||||
|
* @param level log level
|
||||||
|
* @param logIssuer log issuer
|
||||||
|
* @param message finalized log message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
void print(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,51 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.classes;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.utility.PlaceholderEngine;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for implementing placeholders.
|
||||||
|
*
|
||||||
|
* @see PlaceholderEngine
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public interface Placeholder {
|
||||||
|
/**
|
||||||
|
* Returns the placeholder's name.
|
||||||
|
*
|
||||||
|
* @return the placeholder name
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
String getName();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Replaces the placeholder with it's appropriate content.
|
||||||
|
*
|
||||||
|
* @param text the text to process
|
||||||
|
* @return the processed text
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
String replace(@NotNull String text);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains various interfaces.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.classes;
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains various packages with tiny classes that provide or process information.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.data;
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Calendar;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code date_day} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class DateDay implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public DateDay() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "date_day";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.DAY_OF_MONTH), 2));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Calendar;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code date_month} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class DateMonth implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public DateMonth() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "date_month";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.MONTH), 2));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Calendar;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code date_year} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class DateYear implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public DateYear() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "date_year";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.YEAR), 4));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_dependency_jansi} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EngineDependencyJansi implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineDependencyJansi() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_dependency_jansi";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", BuildInfo.getInstance().getDependencyJansi());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_dependency_jetbrains_annotations} placeholder.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
* @see Placeholder
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EngineDependencyJetbrainsAnnotations implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineDependencyJetbrainsAnnotations() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_dependency_jetbrains_annotations";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", BuildInfo.getInstance().getDependencyJetbrainsAnnotations());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_dependency_lombok} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EngineDependencyLombok implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineDependencyLombok() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_dependency_lombok";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", BuildInfo.getInstance().getDependencyLombok());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_plugin_lombok} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EnginePluginLombok implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EnginePluginLombok() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_plugin_lombok";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", BuildInfo.getInstance().getPluginLombok());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_plugin_shadow} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EnginePluginShadow implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EnginePluginShadow() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_plugin_shadow";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", BuildInfo.getInstance().getPluginShadow());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_version} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EngineVersion implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineVersion() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_version";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", "%engine_version_version%-%engine_version_type%%engine_version_typerelease%%engine_version_fork%");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_version_fork} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EngineVersionFork implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineVersionFork() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_version_fork";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", BuildInfo.getInstance().getVersioningFork());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_version_type} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EngineVersionType implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineVersionType() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_version_type";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", BuildInfo.getInstance().getVersioningType().name().toLowerCase());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_version_typerelease} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EngineVersionTyperelease implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineVersionTyperelease() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_version_typerelease";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", String.valueOf(BuildInfo.getInstance().getVersioningTyperelease()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code engine_version_version} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class EngineVersionVersion implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public EngineVersionVersion() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "engine_version_version";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", String.valueOf(BuildInfo.getInstance().getVersioningVersion()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,68 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.JvmInformation;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code jvm_arguments} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class JvmArguments implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public JvmArguments() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "jvm_arguments";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
StringBuilder arguments = new StringBuilder();
|
||||||
|
|
||||||
|
for (String argument : JvmInformation.getArguments()) {
|
||||||
|
if (!arguments.isEmpty()) arguments.append(" ");
|
||||||
|
|
||||||
|
arguments
|
||||||
|
.append("\"")
|
||||||
|
.append(
|
||||||
|
argument
|
||||||
|
.replace("\\", "\\\\")
|
||||||
|
.replace("\n", "\\n")
|
||||||
|
.replace("\"", "\\\"")
|
||||||
|
)
|
||||||
|
.append("\"");
|
||||||
|
}
|
||||||
|
|
||||||
|
return text.replace("%" + getName() + "%", arguments.toString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.JvmInformation;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code jvm_implementation_name} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class JvmImplementationName implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public JvmImplementationName() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "jvm_implementation_name";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", JvmInformation.getImplementationName());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.JvmInformation;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code jvm_implementation_vendor} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class JvmImplementationVendor implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public JvmImplementationVendor() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "jvm_implementation_vendor";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", JvmInformation.getImplementationVendor());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.JvmInformation;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code jvm_implementation_version} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class JvmImplementationVersion implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public JvmImplementationVersion() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "jvm_implementation_version";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", JvmInformation.getImplementationVersion());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.JvmInformation;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code jvm_uptime} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class JvmUptime implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public JvmUptime() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "jvm_uptime";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", String.valueOf(JvmInformation.getUptime()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.JvmInformation;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code jvm_java} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class JvmVersion implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public JvmVersion() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "jvm_java";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", String.valueOf(JvmInformation.getJavaVersion()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code time_epoch} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class TimeEpoch implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public TimeEpoch() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "time_epoch";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(System.currentTimeMillis(), String.valueOf(Long.MAX_VALUE).length()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Calendar;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code time_hour} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class TimeHour implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public TimeHour() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "time_hour";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.HOUR_OF_DAY), 2));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Calendar;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code time_minute} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class TimeMinute implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public TimeMinute() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "time_minute";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.MINUTE), 2));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Calendar;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code time_second} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class TimeSecond implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public TimeSecond() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "time_second";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", Miscellaneous.padNumbers(Calendar.getInstance().get(Calendar.SECOND), 2));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Locale;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code time_zone} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class TimeZone implements Placeholder {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public TimeZone() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
public String getName() {
|
||||||
|
return "time_zone";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@NotNull
|
||||||
|
@Override
|
||||||
|
public String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", java.util.TimeZone.getDefault().getDisplayName(false, java.util.TimeZone.SHORT, Locale.US));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all built-in placeholders used in {@link de.staropensource.sosengine.base.utility.PlaceholderEngine}.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.utility.PlaceholderEngine
|
||||||
|
* @see de.staropensource.sosengine.base.classes.Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.data.placeholders;
|
||||||
|
|
@ -0,0 +1,216 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.logging.placeholders.crashhandler.*;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import de.staropensource.sosengine.base.types.LogLevel;
|
||||||
|
import de.staropensource.sosengine.base.utility.PlaceholderEngine;
|
||||||
|
import lombok.Getter;
|
||||||
|
import lombok.Setter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
import java.util.*;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles engine and application crashes.
|
||||||
|
*
|
||||||
|
* @see Logger
|
||||||
|
* @see LoggerInstance
|
||||||
|
* @see LogIssuer
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
public class CrashHandler {
|
||||||
|
/**
|
||||||
|
* Hopefully {@code false} :)
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Hopefully {@code false} :)
|
||||||
|
*
|
||||||
|
* @return if the engine is in a crashed state
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private static boolean crashed = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the template used to print a crash report.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Gets the template used to print a crash report.
|
||||||
|
*
|
||||||
|
* @return crash report template
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- SETTER --
|
||||||
|
* Sets the template used to print a crash report.
|
||||||
|
*
|
||||||
|
* @param crashTemplate new crash template
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
@Setter
|
||||||
|
private static String crashTemplate = """
|
||||||
|
<fg:red><bold>
|
||||||
|
------------------------
|
||||||
|
sos!engine crash
|
||||||
|
------------------------
|
||||||
|
%content%
|
||||||
|
|
||||||
|
------------------------
|
||||||
|
sos!engine crash
|
||||||
|
------------------------
|
||||||
|
""";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains nested {@link LinkedHashMap}s that contain the content printed at the time of a crash.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the nested {@link LinkedHashMap}s that contain the content printed at the time of a crash.
|
||||||
|
*
|
||||||
|
* @return crash content
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static final LinkedHashMap<Object, Object> crashContent = new LinkedHashMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public CrashHandler() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles a crash.
|
||||||
|
*
|
||||||
|
* @param logIssuer information about the class that caused the crash
|
||||||
|
* @param message crash error detail
|
||||||
|
* @param exception simply to provide stacktrace and further insight into the crash, can be set to {@code null}
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void handleCrash(@NotNull LogIssuer logIssuer, @NotNull String message, @Nullable Exception exception) {
|
||||||
|
crashed = true;
|
||||||
|
String base = crashTemplate;
|
||||||
|
|
||||||
|
// Convert crashContent to String and replace %content% in crashTemplate with the result
|
||||||
|
base = base.replace("%content%", processCrashContent()); // This is so simple we don't need the PlaceholderEngine to do it for us
|
||||||
|
|
||||||
|
// Execute LoggerImpl#prePlaceholder
|
||||||
|
base = Logger.getLoggerImplementation().prePlaceholder(LogLevel.CRASH, logIssuer, base);
|
||||||
|
|
||||||
|
// Create list of temporary placeholders
|
||||||
|
List<Placeholder> temporaryPlaceholders = new ArrayList<>();
|
||||||
|
temporaryPlaceholders.add(new IssuerMessage(message)); // log_message is out of order to allow for placeholder usage
|
||||||
|
|
||||||
|
// issuer_*
|
||||||
|
temporaryPlaceholders.add(new IssuerClass(logIssuer));
|
||||||
|
temporaryPlaceholders.add(new IssuerCodePart(logIssuer));
|
||||||
|
temporaryPlaceholders.add(new IssuerInfo(logIssuer));
|
||||||
|
temporaryPlaceholders.add(new IssuerPackage(logIssuer));
|
||||||
|
temporaryPlaceholders.add(new IssuerPath(logIssuer));
|
||||||
|
// etc
|
||||||
|
temporaryPlaceholders.add(new Stacktrace(exception));
|
||||||
|
|
||||||
|
// Replace placeholders
|
||||||
|
base = PlaceholderEngine.getInstance().process(base, temporaryPlaceholders);
|
||||||
|
|
||||||
|
// Execute LoggerImpl#postPlaceholder
|
||||||
|
base = Logger.getLoggerImplementation().postPlaceholder(LogLevel.CRASH, logIssuer, base);
|
||||||
|
|
||||||
|
// Print log message
|
||||||
|
Logger.getLoggerImplementation().print(LogLevel.CRASH, logIssuer, base);
|
||||||
|
|
||||||
|
// Shutdown JVM
|
||||||
|
if (EngineConfiguration.getInstance().isLoggerImmediateShutdown())
|
||||||
|
Runtime.getRuntime().halt(69);
|
||||||
|
else
|
||||||
|
Runtime.getRuntime().exit(69);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Internal method for generating the crash message content. Do not call.
|
||||||
|
*
|
||||||
|
* @param map the {@link LinkedHashMap} to process
|
||||||
|
* @param indentationSize the indentation level
|
||||||
|
* @return crash content string
|
||||||
|
* @see CrashHandler#processCrashContent()
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
/*
|
||||||
|
Note: This entire method causes a compilation warning as we are using "unchecked or unsecure operations".
|
||||||
|
We can safely ignore this as this method
|
||||||
|
1. checks data types as best as it can, and
|
||||||
|
2. only works on a String and not on a File or something which could cause damage.
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private static String processCrashContent(@NotNull LinkedHashMap<Object, Object> map, int indentationSize) {
|
||||||
|
StringBuilder content = new StringBuilder();
|
||||||
|
|
||||||
|
for (Object key : map.keySet()) {
|
||||||
|
if (!(key instanceof String))
|
||||||
|
// Invalid content key, skip
|
||||||
|
continue;
|
||||||
|
|
||||||
|
if (!(map.get(key) instanceof LinkedHashMap<?, ?> || map.get(key) instanceof String))
|
||||||
|
// Invalid content value, skip
|
||||||
|
continue;
|
||||||
|
|
||||||
|
if (!content.isEmpty())
|
||||||
|
content.append("\n");
|
||||||
|
|
||||||
|
if (map.get(key) instanceof String) {
|
||||||
|
if (indentationSize == 0) content.append("\n");
|
||||||
|
else content.append(" ".repeat(indentationSize)).append("-> ");
|
||||||
|
content.append(key).append(": ").append(map.get(key));
|
||||||
|
} else {
|
||||||
|
if (indentationSize == 0) content.append("\n");
|
||||||
|
else content.append(" ".repeat(indentationSize)).append("-> ");
|
||||||
|
content.append(key).append("\n");
|
||||||
|
|
||||||
|
// We are the types in this function already
|
||||||
|
//noinspection unchecked
|
||||||
|
content.append(processCrashContent((LinkedHashMap<Object, Object>) map.get(key), indentationSize + 1));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
return content.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generates the content for a crash report. Processes {@code crashContent} and spits out a String.
|
||||||
|
*
|
||||||
|
* @return crash content string
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static String processCrashContent() {
|
||||||
|
return processCrashContent(crashContent, 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,75 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.sosengine.base.classes.LoggerImpl;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import de.staropensource.sosengine.base.types.LogLevel;
|
||||||
|
import de.staropensource.sosengine.base.utility.ShortcodeConverter;
|
||||||
|
import org.fusesource.jansi.Ansi;
|
||||||
|
import org.fusesource.jansi.AnsiConsole;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The default logger implementation for the StarOpenSource Engine.
|
||||||
|
*
|
||||||
|
* @see Logger
|
||||||
|
* @see LoggerImpl
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public class DefaultLoggerImpl implements LoggerImpl {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public DefaultLoggerImpl() {}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public String prePlaceholder(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
// No modifications necessary
|
||||||
|
return message;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public String postPlaceholder(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
// No modifications necessary
|
||||||
|
return message;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void print(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
// Convert to Ansi
|
||||||
|
Ansi output = ShortcodeConverter.getInstance().process(message, true);
|
||||||
|
|
||||||
|
// Print message
|
||||||
|
if (level == LogLevel.ERROR || level == LogLevel.CRASH)
|
||||||
|
if (EngineConfiguration.getInstance().isLoggerForceStandardOutput())
|
||||||
|
AnsiConsole.out().println(output);
|
||||||
|
else
|
||||||
|
AnsiConsole.err().println(output);
|
||||||
|
else
|
||||||
|
AnsiConsole.out().println(output);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,208 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.sosengine.base.classes.LoggerImpl;
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.logging.placeholders.logger.*;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import de.staropensource.sosengine.base.types.LogLevel;
|
||||||
|
import de.staropensource.sosengine.base.utility.PlaceholderEngine;
|
||||||
|
import lombok.Getter;
|
||||||
|
import lombok.Setter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the engine's logging infrastructure except for the {@link CrashHandler}.
|
||||||
|
*
|
||||||
|
* @see CrashHandler
|
||||||
|
* @see LoggerInstance
|
||||||
|
* @see LogIssuer
|
||||||
|
* @see LogLevel
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration" })
|
||||||
|
public class Logger {
|
||||||
|
/**
|
||||||
|
* Refers to the active {@link LoggerImpl} that is used to process and print log messages.
|
||||||
|
*
|
||||||
|
* @see LoggerImpl
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the active {@link LoggerImpl}.
|
||||||
|
*
|
||||||
|
* @return active {@link LoggerImpl}
|
||||||
|
* @see LoggerImpl
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- SETTER --
|
||||||
|
* Sets the active {@link LoggerImpl}.
|
||||||
|
*
|
||||||
|
* @param loggerImplementation the new active {@link LoggerImpl}
|
||||||
|
* @see LoggerImpl
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
@Getter
|
||||||
|
@Setter
|
||||||
|
private static LoggerImpl loggerImplementation = new DefaultLoggerImpl();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public Logger() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handler for all log messages.
|
||||||
|
*
|
||||||
|
* @param level log level
|
||||||
|
* @param logIssuer log issuer
|
||||||
|
* @param message log message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private static void log(@NotNull LogLevel level, @NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
// Check if level is allowed
|
||||||
|
if (level.compareTo(EngineConfiguration.getInstance().getLoggerLevel()) < 0)
|
||||||
|
return;
|
||||||
|
|
||||||
|
// Template for now, final log message later
|
||||||
|
String base = EngineConfiguration.getInstance().getLoggerTemplate();
|
||||||
|
|
||||||
|
// Execute LoggerImpl#prePlaceholder
|
||||||
|
base = loggerImplementation.prePlaceholder(level, logIssuer, base);
|
||||||
|
|
||||||
|
// Create list of temporary placeholders
|
||||||
|
List<Placeholder> temporaryPlaceholders = new ArrayList<>();
|
||||||
|
temporaryPlaceholders.add(new LogMessage(message)); // log_message is out of order to allow for placeholder usage
|
||||||
|
|
||||||
|
temporaryPlaceholders.add(new LogColorPrimary(level));
|
||||||
|
temporaryPlaceholders.add(new LogColorSecondary(level));
|
||||||
|
temporaryPlaceholders.add(new LogClass(logIssuer));
|
||||||
|
temporaryPlaceholders.add(new LogColorPrimary(level));
|
||||||
|
temporaryPlaceholders.add(new LogInfo(logIssuer));
|
||||||
|
temporaryPlaceholders.add(new de.staropensource.sosengine.base.logging.placeholders.logger.LogLevel(level));
|
||||||
|
temporaryPlaceholders.add(new LogPackage(logIssuer));
|
||||||
|
temporaryPlaceholders.add(new LogPath(logIssuer));
|
||||||
|
|
||||||
|
// Replace placeholders
|
||||||
|
base = PlaceholderEngine.getInstance().process(base, temporaryPlaceholders);
|
||||||
|
|
||||||
|
// Execute LoggerImpl#postPlaceholder
|
||||||
|
base = loggerImplementation.postPlaceholder(level, logIssuer, base);
|
||||||
|
|
||||||
|
// Print log message
|
||||||
|
loggerImplementation.print(level, logIssuer, base);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints a diagnostic message.
|
||||||
|
*
|
||||||
|
* @param logIssuer issuing class
|
||||||
|
* @param message diagnostic message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void diag(@NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
log(LogLevel.DIAGNOSTIC, logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints a verbose message.
|
||||||
|
*
|
||||||
|
* @param logIssuer issuing class
|
||||||
|
* @param message verbose message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void verb(@NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
log(LogLevel.VERBOSE, logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints a silent warning message.
|
||||||
|
*
|
||||||
|
* @param logIssuer issuing class
|
||||||
|
* @param message silent warning message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void sarn(@NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
log(LogLevel.SILENT_WARNING, logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints an informational message.
|
||||||
|
*
|
||||||
|
* @param logIssuer issuing class
|
||||||
|
* @param message informational message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void info(@NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
log(LogLevel.INFORMATIONAL, logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints a warning message.
|
||||||
|
*
|
||||||
|
* @param logIssuer issuing class
|
||||||
|
* @param message warning message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void warn(@NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
log(LogLevel.WARNING, logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints an error message.
|
||||||
|
*
|
||||||
|
* @param logIssuer issuing class
|
||||||
|
* @param message error message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void error(@NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
log(LogLevel.ERROR, logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Crashes the entire engine.
|
||||||
|
*
|
||||||
|
* @param logIssuer issuing class
|
||||||
|
* @param message diagnostic message
|
||||||
|
* @param exception the exception that caused this crash
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void crash(@NotNull LogIssuer logIssuer, @NotNull String message, @NotNull Exception exception) {
|
||||||
|
CrashHandler.handleCrash(logIssuer, message, exception);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Crashes the entire engine.
|
||||||
|
*
|
||||||
|
* @param logIssuer issuing class
|
||||||
|
* @param message diagnostic message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static void crash(@NotNull LogIssuer logIssuer, @NotNull String message) {
|
||||||
|
CrashHandler.handleCrash(logIssuer, message, null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,140 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes the need to add {@code getClass()} to all calls to {@link Logger}.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
@Getter
|
||||||
|
public class LoggerInstance {
|
||||||
|
/**
|
||||||
|
* Contains the class that this {@link LoggerInstance} belongs to.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the class that this {@link LoggerInstance} belongs to.
|
||||||
|
*
|
||||||
|
* @return the parent class
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer information about the parent class
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LoggerInstance(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints a diagnostic message.
|
||||||
|
*
|
||||||
|
* @param message the diagnostic message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void diag(@NotNull String message) {
|
||||||
|
Logger.diag(logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints a verbose message.
|
||||||
|
*
|
||||||
|
* @param message the verbose message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void verb(@NotNull String message) {
|
||||||
|
Logger.verb(logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints a silent warning message.
|
||||||
|
*
|
||||||
|
* @param message the silent warning message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void sarn(@NotNull String message) {
|
||||||
|
Logger.sarn(logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints an informational message.
|
||||||
|
*
|
||||||
|
* @param message the informational message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void info(@NotNull String message) {
|
||||||
|
Logger.info(logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints a warning message.
|
||||||
|
*
|
||||||
|
* @param message the warning message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void warn(@NotNull String message) {
|
||||||
|
Logger.warn(logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prints an error message.
|
||||||
|
*
|
||||||
|
* @param message the error message
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void error(@NotNull String message) {
|
||||||
|
Logger.error(logIssuer, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Crashes the entire engine.
|
||||||
|
*
|
||||||
|
* @param message the diagnostic message
|
||||||
|
* @param exception the exception that caused this crash
|
||||||
|
* @see CrashHandler
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void crash(@NotNull String message, @NotNull Exception exception) {
|
||||||
|
Logger.crash(logIssuer, message, exception);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Crashes the entire engine.
|
||||||
|
*
|
||||||
|
* @param message the diagnostic message
|
||||||
|
* @see CrashHandler
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public void crash(@NotNull String message) {
|
||||||
|
Logger.crash(logIssuer, message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains sos!engine's logging infrastructure.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.logging.Logger
|
||||||
|
* @see de.staropensource.sosengine.base.logging.LoggerInstance
|
||||||
|
* @see de.staropensource.sosengine.base.logging.CrashHandler
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.logging;
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.crashhandler;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code issuer_class} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class IssuerClass implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public IssuerClass(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "issuer_class";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getClazz().getName().replace(logIssuer.getClazz().getPackageName() + ".", ""));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.crashhandler;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code issuer_code_part} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class IssuerCodePart implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public IssuerCodePart(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "issuer_code_part";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getCodePart().name());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,66 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.crashhandler;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code issuer_info} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class IssuerInfo implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public IssuerInfo(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "issuer_info";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
if (logIssuer.getAdditionalInformation() == null)
|
||||||
|
return text.replace("%" + getName() + "%", "<none>");
|
||||||
|
else
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getAdditionalInformation());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,62 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.crashhandler;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code issuer_message} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class IssuerMessage implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The message to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final String message;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param message the message to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public IssuerMessage(@NotNull String message) {
|
||||||
|
this.message = message;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "issuer_message";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.crashhandler;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code issuer_package} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class IssuerPackage implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public IssuerPackage(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "issuer_package";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getClazz().getPackageName());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.crashhandler;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code issuer_path} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class IssuerPath implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public IssuerPath(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "issuer_path";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getClazz().getName());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,70 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.crashhandler;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.utility.StackTraceParser;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code stacktrace} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class Stacktrace implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link Exception} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
private final Exception exception;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param exception the {@link Exception} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public Stacktrace(@Nullable Exception exception) {
|
||||||
|
this.exception = exception;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "stacktrace";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
if (exception == null)
|
||||||
|
return text.replace("%" + getName() + "%", "No stacktrace is available.");
|
||||||
|
else {
|
||||||
|
StackTraceParser stackTraceParser = new StackTraceParser(exception);
|
||||||
|
|
||||||
|
return text.replace("%" + getName() + "%", stackTraceParser.getHeader() + "\n" + stackTraceParser.getStackTrace());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all placeholders used in the {@link de.staropensource.sosengine.base.logging.CrashHandler}.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.logging.CrashHandler
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.logging.placeholders.crashhandler;
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_class} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogClass implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogClass(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_class";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getClazz().getName().replace(logIssuer.getClazz().getPackageName() + ".", ""));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_code_part} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogCodePart implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogCodePart(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_code_part";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getCodePart().name());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,74 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogLevel;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_color_primary} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogColorPrimary implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogLevel} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogLevel level;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param level the {@link LogLevel} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogColorPrimary(@NotNull LogLevel level) {
|
||||||
|
this.level = level;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_color_primary";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
String color;
|
||||||
|
|
||||||
|
switch (level) {
|
||||||
|
case DIAGNOSTIC, VERBOSE -> color = "<fg:blue>";
|
||||||
|
case SILENT_WARNING, WARNING -> color = "<fg:yellow>";
|
||||||
|
case INFORMATIONAL -> color = "<fg:white>";
|
||||||
|
case ERROR -> color = "<fg:red>";
|
||||||
|
case CRASH -> color = "You should not be seeing this";
|
||||||
|
default -> color = "";
|
||||||
|
}
|
||||||
|
|
||||||
|
return text.replace("%" + getName() + "%", color);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,70 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogLevel;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_color_secondary} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogColorSecondary implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogLevel} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogLevel level;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param level the {@link LogLevel} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogColorSecondary(@NotNull LogLevel level) {
|
||||||
|
this.level = level;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_color_secondary";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
String color;
|
||||||
|
|
||||||
|
switch (level) {
|
||||||
|
case DIAGNOSTIC, SILENT_WARNING -> color = "<italic>";
|
||||||
|
default -> color = "";
|
||||||
|
}
|
||||||
|
|
||||||
|
return text.replace("%" + getName() + "%", color);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_info} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogInfo implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogInfo(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_info";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
if (logIssuer.getAdditionalInformation() != null)
|
||||||
|
return text.replace("%" + getName() + "%", "/" + logIssuer.getAdditionalInformation());
|
||||||
|
return text.replace("%" + getName() + "%", "");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,71 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_level} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogLevel implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link de.staropensource.sosengine.base.types.LogLevel} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final de.staropensource.sosengine.base.types.LogLevel level;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param level the {@link de.staropensource.sosengine.base.types.LogLevel} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogLevel(@NotNull de.staropensource.sosengine.base.types.LogLevel level) {
|
||||||
|
this.level = level;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_level";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
String levelText;
|
||||||
|
|
||||||
|
switch (level) {
|
||||||
|
case CRASH -> levelText = "CRSH";
|
||||||
|
case ERROR -> levelText = "ERR!";
|
||||||
|
case SILENT_WARNING -> levelText = "SARN";
|
||||||
|
default -> levelText = level.name().substring(0, 4);
|
||||||
|
}
|
||||||
|
|
||||||
|
return text.replace("%" + getName() + "%", levelText);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,62 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_message} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogMessage implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The message to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final String message;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param message the message to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogMessage(@NotNull String message) {
|
||||||
|
this.message = message;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_message";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_package} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogPackage implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogPackage(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_package";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getClazz().getPackageName());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements the {@code log_path} placeholder.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class LogPath implements Placeholder {
|
||||||
|
/**
|
||||||
|
* The {@link LogIssuer} to use.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LogIssuer logIssuer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param logIssuer the {@link LogIssuer} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogPath(@NotNull LogIssuer logIssuer) {
|
||||||
|
this.logIssuer = logIssuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "log_path";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String replace(@NotNull String text) {
|
||||||
|
return text.replace("%" + getName() + "%", logIssuer.getClazz().getName());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all placeholders used in the {@link de.staropensource.sosengine.base.logging.Logger}.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.logging.Logger
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.logging.placeholders.logger;
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains placeholders used by the {@link de.staropensource.sosengine.base.logging.Logger} or {@link de.staropensource.sosengine.base.logging.CrashHandler}.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.logging.Logger
|
||||||
|
* @see de.staropensource.sosengine.base.logging.CrashHandler
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.logging.placeholders;
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the core engine code.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.Engine
|
||||||
|
* @since v1-alpha0
|
||||||
|
* @author jeremystartm <jeremystartm@staropensource.de>
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base;
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.types;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates whether the class belongs to the engine, application or modification.
|
||||||
|
*
|
||||||
|
* @see LogIssuer
|
||||||
|
* @see de.staropensource.sosengine.base.logging.Logger
|
||||||
|
* @see de.staropensource.sosengine.base.logging.CrashHandler
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public enum CodePart {
|
||||||
|
/**
|
||||||
|
* Indicates that the specified code or class belongs to the sos!engine.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
ENGINE,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that the specified code or class belongs to the running application.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
APPLICATION,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that the specified code or class belongs to a modification to the running application.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
MODIFICATION
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,127 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.types;
|
||||||
|
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Used for identifying a log message's origin.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.logging.Logger
|
||||||
|
* @see de.staropensource.sosengine.base.logging.CrashHandler
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
@Getter
|
||||||
|
public class LogIssuer {
|
||||||
|
/**
|
||||||
|
* Contains the issuing class.
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the issuing class.
|
||||||
|
*
|
||||||
|
* @return the issuing class
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final Class<?> clazz;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains additional information about the issuer.
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns additional information about the issuer.
|
||||||
|
*
|
||||||
|
* @return additional information about the issuer
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Nullable
|
||||||
|
private final String additionalInformation;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates whether the class belongs to the engine, application or a modification.
|
||||||
|
*
|
||||||
|
* @see CodePart
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@link CodePart} that indicates whether the class belongs to the engine, application or a modification.
|
||||||
|
*
|
||||||
|
* @return the {@link CodePart}
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final CodePart codePart;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param clazz the issuing class
|
||||||
|
* @param additionalInformation additional information about the issuer
|
||||||
|
* @param codePart identifies to which part of the program the class belongs to
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogIssuer(@NotNull Class<?> clazz, @NotNull String additionalInformation, @NotNull CodePart codePart) {
|
||||||
|
this.clazz = clazz;
|
||||||
|
if (additionalInformation.isEmpty()) this.additionalInformation = null;
|
||||||
|
else this.additionalInformation = additionalInformation;
|
||||||
|
this.codePart = codePart;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param clazz the issuing class
|
||||||
|
* @param additionalInformation additional information about the issuer
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogIssuer(@NotNull Class<?> clazz, @NotNull String additionalInformation) {
|
||||||
|
this.clazz = clazz;
|
||||||
|
if (additionalInformation.isEmpty()) this.additionalInformation = null;
|
||||||
|
else this.additionalInformation = additionalInformation;
|
||||||
|
this.codePart = CodePart.APPLICATION;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param clazz the issuing class
|
||||||
|
* @param codePart identifies to which part of the program the class belongs to
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogIssuer(@NotNull Class<?> clazz, @NotNull CodePart codePart) {
|
||||||
|
this.clazz = clazz;
|
||||||
|
this.additionalInformation = null;
|
||||||
|
this.codePart = codePart;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param clazz the issuing class
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public LogIssuer(@NotNull Class<?> clazz) {
|
||||||
|
this.clazz = clazz;
|
||||||
|
this.additionalInformation = null;
|
||||||
|
this.codePart = CodePart.APPLICATION;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,78 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.types;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Used for determining a log message's priority.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.logging.Logger
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public enum LogLevel {
|
||||||
|
/**
|
||||||
|
* Indicates that the log message is diagnostic and solely provides debugging information. It is not important.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
DIAGNOSTIC,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that the log message contains more details about some action. It is not important but nice to have.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
VERBOSE,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that an unimportant warning occurred.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
SILENT_WARNING,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that the log message provides useful information and is important.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
INFORMATIONAL,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that an important warning occurred.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
WARNING,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that a non-fatal error occurred.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
ERROR,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that a fatal error occurred.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
CRASH,
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,59 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.types;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.utility.BuildInfo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides all available version types.
|
||||||
|
*
|
||||||
|
* @see BuildInfo#getVersioningType()
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public enum VersionType {
|
||||||
|
/**
|
||||||
|
* Indicates that the next version is in the early stages of development and is highly experimental. Behaviour may break at and time and may contain bugs and issues.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
ALPHA,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that the next version is in development and is experimental. It may contain bugs and issues.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
BETA,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates that the application is nearing the next release. The application may be stable but needs to be tested before release.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
RELEASECANDIDATE,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Should be used for tested, stable and working builds.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
RELEASE
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains various data types using {@link java.lang.Enum}s and regular {@code Class}es.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.types;
|
||||||
|
|
@ -0,0 +1,221 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.utility;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.logging.LoggerInstance;
|
||||||
|
import de.staropensource.sosengine.base.types.CodePart;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import de.staropensource.sosengine.base.types.VersionType;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.util.Properties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides build information about the sos!engine.
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
@Getter
|
||||||
|
public class BuildInfo {
|
||||||
|
/**
|
||||||
|
* Instance.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@link BuildInfo} instance.
|
||||||
|
*
|
||||||
|
* @return {@link BuildInfo} instance
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static BuildInfo instance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the engine's version.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the engine's version.
|
||||||
|
*
|
||||||
|
* @return engine version
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private int versioningVersion;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the engine's version type.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the engine's version type.
|
||||||
|
*
|
||||||
|
* @return engine version type
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private VersionType versioningType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the engine's type release.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the engine's type release.
|
||||||
|
*
|
||||||
|
* @return engine type release
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private int versioningTyperelease;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the engine's fork identifier.<br/>
|
||||||
|
* Likely empty. If not, it must be prefixed with a dash.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the engine's fork identifier.<br/>
|
||||||
|
* Likely empty. If not, it must be prefixed with a dash.
|
||||||
|
*
|
||||||
|
* @return engine fork identifier
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private String versioningFork;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the version of the dependency {@code Lombok}.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the version of the dependency {@code Lombok}.
|
||||||
|
*
|
||||||
|
* @return Lombok dependency version
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private String dependencyLombok;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the version of the dependency {@code Jetbrains Annotations}.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the version of the dependency {@code Jetbrains Annotations}.
|
||||||
|
*
|
||||||
|
* @return Jetbrains Annotations dependency version
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private String dependencyJetbrainsAnnotations;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the version of the dependency {@code Jansi}.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the version of the dependency {@code Jansi}.
|
||||||
|
*
|
||||||
|
* @return Jansi dependency version
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private String dependencyJansi;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the version of the Gradle plugin {@code Shadow}.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the version of the Gradle plugin {@code Shadow}.
|
||||||
|
*
|
||||||
|
* @return Shadow plugin version
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private String pluginShadow;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the version of the Gradle plugin {@code Lombok}.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Provides the version of the Gradle plugin {@code Lombok}.
|
||||||
|
*
|
||||||
|
* @return Lombok plugin version
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private String pluginLombok;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public BuildInfo() {
|
||||||
|
LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE));
|
||||||
|
|
||||||
|
// Only allow one instance
|
||||||
|
if (instance == null)
|
||||||
|
instance = this;
|
||||||
|
else {
|
||||||
|
logger.crash("Tried reinitializing " + getClass().getName() + " twice");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load properties from gradle.properties
|
||||||
|
Properties properties = new Properties();
|
||||||
|
InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("gradle.properties");
|
||||||
|
|
||||||
|
if (inputStream == null) {
|
||||||
|
logger.crash("Unable to load build information: InputStream is null");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
properties.load(inputStream);
|
||||||
|
inputStream.close();
|
||||||
|
} catch (IOException exception) {
|
||||||
|
logger.crash("Unable to load build information: InputStream failed", exception);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create new PropertyParser
|
||||||
|
PropertyParser parser = new PropertyParser(properties);
|
||||||
|
|
||||||
|
// Apply properties to fields
|
||||||
|
versioningVersion = parser.getInteger("versioningVersion", true);
|
||||||
|
versioningType = VersionType.valueOf(parser.getString("versioningType").toUpperCase());
|
||||||
|
versioningTyperelease = parser.getInteger("versioningTyperelease", true);
|
||||||
|
versioningFork = parser.getString("versioningFork");
|
||||||
|
|
||||||
|
dependencyLombok = parser.getString("dependencyLombok");
|
||||||
|
dependencyJetbrainsAnnotations = parser.getString("dependencyJetbrainsAnnotations");
|
||||||
|
dependencyJansi = parser.getString("dependencyJansi");
|
||||||
|
|
||||||
|
pluginShadow = parser.getString("pluginShadow");
|
||||||
|
pluginLombok = parser.getString("pluginLombok");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,105 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.utility;
|
||||||
|
|
||||||
|
import java.lang.management.ManagementFactory;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides information about the running Java Virtual Machine.
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class JvmInformation {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public JvmInformation() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the Java version this JVM implements.
|
||||||
|
*
|
||||||
|
* @return the Java version
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static int getJavaVersion() {
|
||||||
|
String version = System.getProperty("java.version");
|
||||||
|
|
||||||
|
if (version.startsWith("1."))
|
||||||
|
version = version.substring(2, 3);
|
||||||
|
else {
|
||||||
|
if (version.contains("."))
|
||||||
|
version = version.substring(0, version.indexOf("."));
|
||||||
|
}
|
||||||
|
|
||||||
|
return Integer.parseInt(version);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the JVM implementation name.
|
||||||
|
*
|
||||||
|
* @return the JVM implementation name
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static String getImplementationName() {
|
||||||
|
return ManagementFactory.getRuntimeMXBean().getVmName();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the JVM implementation version.
|
||||||
|
*
|
||||||
|
* @return the JVM implementation version
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static String getImplementationVersion() {
|
||||||
|
return ManagementFactory.getRuntimeMXBean().getVmVersion();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the JVM implementation vendor.
|
||||||
|
*
|
||||||
|
* @return the JVM implementation vendor
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static String getImplementationVendor() {
|
||||||
|
return ManagementFactory.getRuntimeMXBean().getVmVendor();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the uptime of the JVM.
|
||||||
|
*
|
||||||
|
* @return uptime in milliseconds
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static long getUptime() {
|
||||||
|
return ManagementFactory.getRuntimeMXBean().getUptime();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the arguments passed to the JVM (not to the running program).
|
||||||
|
*
|
||||||
|
* @return the JVM arguments
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public static List<String> getArguments() {
|
||||||
|
return ManagementFactory.getRuntimeMXBean().getInputArguments();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,50 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.utility;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains smaller functions that don't fit into other utility classes.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public class Miscellaneous {
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public Miscellaneous() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds padding zeros to a number.
|
||||||
|
*
|
||||||
|
* @param number number
|
||||||
|
* @param length length
|
||||||
|
* @return the padded number
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static String padNumbers(long number, int length) {
|
||||||
|
return String.format("%0" + length + "d", number);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,152 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.utility;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.classes.Placeholder;
|
||||||
|
import de.staropensource.sosengine.base.data.placeholders.*;
|
||||||
|
import de.staropensource.sosengine.base.logging.Logger;
|
||||||
|
import de.staropensource.sosengine.base.types.CodePart;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A modular and extensible placeholder engine.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
public class PlaceholderEngine {
|
||||||
|
/**
|
||||||
|
* Instance.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@link PlaceholderEngine} instance.
|
||||||
|
*
|
||||||
|
* @return {@link PlaceholderEngine} instance
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static PlaceholderEngine instance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all global placeholders.
|
||||||
|
*
|
||||||
|
* @see Placeholder
|
||||||
|
* @since 1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the list containing all global placeholders.
|
||||||
|
*
|
||||||
|
* @return list of all global placeholders
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings("FieldMayBeFinal")
|
||||||
|
@Getter
|
||||||
|
@NotNull
|
||||||
|
private List<Placeholder> placeholders = new ArrayList<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public PlaceholderEngine() {
|
||||||
|
// Only allow one instance
|
||||||
|
if (instance == null)
|
||||||
|
instance = this;
|
||||||
|
else {
|
||||||
|
Logger.crash(new LogIssuer(getClass(), CodePart.ENGINE), "Tried reinitializing " + getClass().getName() + " twice");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add default placeholders.
|
||||||
|
// date_*
|
||||||
|
placeholders.add(new DateDay());
|
||||||
|
placeholders.add(new DateMonth());
|
||||||
|
placeholders.add(new DateYear());
|
||||||
|
// engine_dependency_*
|
||||||
|
placeholders.add(new EngineDependencyLombok());
|
||||||
|
placeholders.add(new EngineDependencyJetbrainsAnnotations());
|
||||||
|
placeholders.add(new EngineDependencyJansi());
|
||||||
|
// engine_plugin_*
|
||||||
|
placeholders.add(new EnginePluginLombok());
|
||||||
|
placeholders.add(new EnginePluginShadow());
|
||||||
|
// engine_version*
|
||||||
|
placeholders.add(new EngineVersion());
|
||||||
|
placeholders.add(new EngineVersionVersion());
|
||||||
|
placeholders.add(new EngineVersionType());
|
||||||
|
placeholders.add(new EngineVersionTyperelease());
|
||||||
|
placeholders.add(new EngineVersionFork());
|
||||||
|
// jvm_*
|
||||||
|
placeholders.add(new JvmArguments());
|
||||||
|
placeholders.add(new JvmVersion());
|
||||||
|
// jvm_implementation_*
|
||||||
|
placeholders.add(new JvmImplementationName());
|
||||||
|
placeholders.add(new JvmImplementationVendor());
|
||||||
|
placeholders.add(new JvmImplementationVersion());
|
||||||
|
// time_*
|
||||||
|
placeholders.add(new TimeEpoch());
|
||||||
|
placeholders.add(new TimeHour());
|
||||||
|
placeholders.add(new TimeMinute());
|
||||||
|
placeholders.add(new TimeSecond());
|
||||||
|
placeholders.add(new TimeZone());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Process all placeholders for a given {@code text}.
|
||||||
|
*
|
||||||
|
* @param text the text to process
|
||||||
|
* @param temporaryPlaceholders placeholders to process only for this run
|
||||||
|
* @return the processed text
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public String process(@NotNull String text, List<Placeholder> temporaryPlaceholders) {
|
||||||
|
// Process temporary placeholders
|
||||||
|
for (Placeholder temporaryPlaceholder : temporaryPlaceholders)
|
||||||
|
if (text.contains("%" + temporaryPlaceholder.getName() + "%"))
|
||||||
|
text = temporaryPlaceholder.replace(text);
|
||||||
|
|
||||||
|
// Process normal placeholders
|
||||||
|
for (Placeholder placeholder : placeholders)
|
||||||
|
if (text.contains("%" + placeholder.getName() + "%"))
|
||||||
|
text = placeholder.replace(text);
|
||||||
|
|
||||||
|
return text;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Process all placeholders for a given {@code text}.
|
||||||
|
*
|
||||||
|
* @param text the text to process
|
||||||
|
* @return the processed text
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public String process(@NotNull String text) {
|
||||||
|
return process(text, new ArrayList<>());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,295 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.utility;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.logging.LoggerInstance;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Properties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allows parsing various data types against a set of {@link Properties}.
|
||||||
|
*
|
||||||
|
* @see Properties
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration" })
|
||||||
|
@NotNull
|
||||||
|
public final class PropertyParser {
|
||||||
|
/**
|
||||||
|
* Instance providing access to the JVM-wide properties.
|
||||||
|
*
|
||||||
|
* @see System#getProperties()
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns a {@link Properties} instance providing access to the JVM-wide properties.
|
||||||
|
*
|
||||||
|
* @return {@link Properties} using the JVM-wide properties
|
||||||
|
* @see System#getProperties()
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
@Getter
|
||||||
|
private static final PropertyParser instance = new PropertyParser(System.getProperties());
|
||||||
|
/**
|
||||||
|
* The {@link Properties} in use by this instance.
|
||||||
|
*
|
||||||
|
* @see Properties
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@link Properties} in use by this instance.
|
||||||
|
*
|
||||||
|
* @return the {@link Properties} in use by this instance
|
||||||
|
* @see Properties
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private final @NotNull Properties properties;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logger instance,
|
||||||
|
*
|
||||||
|
* @see LoggerInstance
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
private final LoggerInstance logger;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param properties the {@link Properties} to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public PropertyParser(@NotNull Properties properties) {
|
||||||
|
this.properties = properties;
|
||||||
|
this.logger = new LoggerInstance(new LogIssuer(getClass(), String.valueOf(properties.hashCode())));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Just returns the property value.
|
||||||
|
*
|
||||||
|
* @param name the property name
|
||||||
|
* @return a {@link String}
|
||||||
|
* @throws NullPointerException if the specified property does not exist
|
||||||
|
* @see String
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public String getString(@NotNull String name) throws NullPointerException {
|
||||||
|
if (properties.getProperty(name) == null) {
|
||||||
|
logger.sarn("Unable to get String from property '" + name + "': Property does not exist");
|
||||||
|
throw new NullPointerException("Unable to get String from property '" + name + "': Property does not exist");
|
||||||
|
}
|
||||||
|
return properties.getProperty(name);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a property as a {@link Boolean}.
|
||||||
|
*
|
||||||
|
* @param name the property name
|
||||||
|
* @return a {@link Boolean}
|
||||||
|
* @throws NullPointerException if the specified property does not exist
|
||||||
|
* @see Boolean
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Boolean getBoolean(@NotNull String name) {
|
||||||
|
if (properties.getProperty(name) == null) {
|
||||||
|
logger.sarn("Unable to get Boolean from property '" + name + "': Property does not exist");
|
||||||
|
throw new NullPointerException("Unable to get Boolean from property '" + name + "': Property does not exist");
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (properties.getProperty(name)) {
|
||||||
|
case "1", "true", "yes", "y" -> {
|
||||||
|
return Boolean.TRUE;
|
||||||
|
}
|
||||||
|
case null, default -> {
|
||||||
|
return Boolean.FALSE;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a property as a {@link Byte}.
|
||||||
|
*
|
||||||
|
* @param name the property name
|
||||||
|
* @return a {@link Byte}
|
||||||
|
* @throws NullPointerException if the specified property does not exist
|
||||||
|
* @throws NumberFormatException if the specified property cannot be parsed as a {@link Byte}
|
||||||
|
* @see Byte
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Byte getByte(@NotNull String name) throws NullPointerException, NumberFormatException {
|
||||||
|
if (properties.getProperty(name) == null) {
|
||||||
|
logger.sarn("Unable to get Byte from property '" + name + "': Property does not exist");
|
||||||
|
throw new NullPointerException("Unable to get Byte from property '" + name + "': Property does not exist");
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return Byte.parseByte(properties.getProperty(name));
|
||||||
|
} catch (NumberFormatException exception) {
|
||||||
|
logger.sarn("Unable to get Byte from property '" + name + "': String cannot be parsed as a Byte.");
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a property as a {@link Short}.
|
||||||
|
*
|
||||||
|
* @param name the property name
|
||||||
|
* @return a {@link Short}
|
||||||
|
* @throws NullPointerException if the specified property does not exist
|
||||||
|
* @throws NumberFormatException if the specified property cannot be parsed as a {@link Short}
|
||||||
|
* @see Short
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Short getShort(@NotNull String name) throws NumberFormatException {
|
||||||
|
if (properties.getProperty(name) == null) {
|
||||||
|
logger.sarn("Unable to get Short from property '" + name + "': Property does not exist");
|
||||||
|
throw new NullPointerException("Unable to get Short from property '" + name + "': Property does not exist");
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return Short.parseShort(properties.getProperty(name));
|
||||||
|
} catch (NumberFormatException exception) {
|
||||||
|
logger.sarn("Unable to get Short from property '" + name + "': String cannot be parsed as a Short.");
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a property as an {@link Integer}.
|
||||||
|
*
|
||||||
|
* @param name the property name
|
||||||
|
* @param unsigned determines if the {@link Integer} is unsigned
|
||||||
|
* @return an {@link Integer}
|
||||||
|
* @throws NullPointerException if the specified property does not exist
|
||||||
|
* @throws NumberFormatException if the specified property cannot be parsed as an {@link Integer}
|
||||||
|
* @see Integer
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Integer getInteger(@NotNull String name, boolean unsigned) throws NumberFormatException {
|
||||||
|
if (properties.getProperty(name) == null) {
|
||||||
|
logger.sarn("Unable to get Integer from property '" + name + "': Property does not exist");
|
||||||
|
throw new NullPointerException("Unable to get Integer from property '" + name + "': Property does not exist");
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (unsigned)
|
||||||
|
return Integer.parseUnsignedInt(properties.getProperty(name));
|
||||||
|
else
|
||||||
|
return Integer.parseInt(properties.getProperty(name));
|
||||||
|
} catch (NumberFormatException exception) {
|
||||||
|
logger.sarn("Unable to get Integer from property '" + name + "': String cannot be parsed as an Integer.");
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a property as a {@link Long}.
|
||||||
|
*
|
||||||
|
* @param name the property name
|
||||||
|
* @param unsigned determines if the {@link Long} is unsigned
|
||||||
|
* @return a {@link Long}
|
||||||
|
* @throws NullPointerException if the specified property does not exist
|
||||||
|
* @throws NumberFormatException if the specified property cannot be parsed as an {@link Long}
|
||||||
|
* @see Long
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Long getLong(@NotNull String name, boolean unsigned) throws NumberFormatException {
|
||||||
|
if (properties.getProperty(name) == null) {
|
||||||
|
logger.sarn("Unable to get Long from property '" + name + "': Property does not exist");
|
||||||
|
throw new NullPointerException("Unable to get Long from property '" + name + "': Property does not exist");
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (unsigned)
|
||||||
|
return Long.parseUnsignedLong(properties.getProperty(name));
|
||||||
|
else
|
||||||
|
return Long.parseLong(properties.getProperty(name));
|
||||||
|
} catch (NumberFormatException exception) {
|
||||||
|
logger.sarn("Unable to get Long from property '" + name + "': String cannot be parsed as a Long.");
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a property as a {@link Float}.
|
||||||
|
*
|
||||||
|
* @param name the property name
|
||||||
|
* @return a {@link Float}
|
||||||
|
* @throws NullPointerException if the specified property does not exist
|
||||||
|
* @throws NumberFormatException if the specified property cannot be parsed as an {@link Float}
|
||||||
|
* @see Float
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Float getFloat(@NotNull String name) throws NullPointerException, NumberFormatException {
|
||||||
|
if (properties.getProperty(name) == null) {
|
||||||
|
logger.sarn("Unable to get Float from property '" + name + "': Property does not exist");
|
||||||
|
throw new NullPointerException("Unable to get Float from property '" + name + "': Property does not exist");
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return Float.parseFloat(properties.getProperty(name));
|
||||||
|
} catch (NumberFormatException exception) {
|
||||||
|
logger.sarn("Unable to get Float from property '" + name + "': String cannot be parsed as a Float.");
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a property as a {@link Double}.
|
||||||
|
*
|
||||||
|
* @param name the property name
|
||||||
|
* @return a {@link Double}
|
||||||
|
* @throws NullPointerException if the specified property does not exist
|
||||||
|
* @throws NumberFormatException if the specified property cannot be parsed as an {@link Double}
|
||||||
|
* @see Double
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Double getDouble(@NotNull String name) throws NullPointerException, NumberFormatException {
|
||||||
|
if (properties.getProperty(name) == null) {
|
||||||
|
logger.sarn("Unable to get Double from property '" + name + "': Property does not exist");
|
||||||
|
throw new NullPointerException("Unable to get Double from property '" + name + "': Property does not exist");
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return Double.parseDouble(properties.getProperty(name));
|
||||||
|
} catch (NullPointerException exception) {
|
||||||
|
logger.sarn("Unable to get Double from property '" + name + "': String is null.");
|
||||||
|
throw exception;
|
||||||
|
} catch (NumberFormatException exception) {
|
||||||
|
logger.sarn("Unable to get Double from property '" + name + "': String cannot be parsed as a Double.");
|
||||||
|
throw exception;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,255 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.utility;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.sosengine.base.logging.Logger;
|
||||||
|
import de.staropensource.sosengine.base.logging.LoggerInstance;
|
||||||
|
import de.staropensource.sosengine.base.types.CodePart;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.fusesource.jansi.Ansi;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converts shortcodes like {@code <red>} or {@code <bold>} into ANSI escape sequences.<br/>
|
||||||
|
* The following shortcodes are supported: {@code fg:<Ansi.Color>, bg:<Ansi.Color>, attr:<Ansi.Attribute>, bold, italic, strikethrough, underline, blink, italic}
|
||||||
|
*
|
||||||
|
* @see Ansi
|
||||||
|
* @see Ansi.Color
|
||||||
|
* @see Ansi.Attribute
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
public class ShortcodeConverter {
|
||||||
|
/**
|
||||||
|
* Instance.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@link ShortcodeConverter} instance.
|
||||||
|
*
|
||||||
|
* @return {@link ShortcodeConverter} instance
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static ShortcodeConverter instance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logger instance.
|
||||||
|
*
|
||||||
|
* @see LoggerInstance
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass()));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public ShortcodeConverter() {
|
||||||
|
// Only allow one instance
|
||||||
|
if (instance == null)
|
||||||
|
instance = this;
|
||||||
|
else {
|
||||||
|
Logger.crash(new LogIssuer(getClass(), CodePart.ENGINE), "Tried reinitializing " + getClass().getName() + " twice");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converts shortcodes into ANSI escape sequences.
|
||||||
|
*
|
||||||
|
* @param text the text to process
|
||||||
|
* @param noErrors prevents printing tag/shortcode errors, overrides the engine configuration setting
|
||||||
|
* @return {@link Ansi} sequence
|
||||||
|
* @see EngineConfiguration#isErrorShortcodeConverter()
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Ansi process(@NotNull String text, boolean noErrors) {
|
||||||
|
Ansi ansi = Ansi.ansi();
|
||||||
|
boolean tagActive = false;
|
||||||
|
String part = "";
|
||||||
|
|
||||||
|
for (char character : text.toCharArray()) {
|
||||||
|
if (tagActive) {
|
||||||
|
if (character == '>') {
|
||||||
|
tagActive = false;
|
||||||
|
|
||||||
|
// fg:*
|
||||||
|
if (part.startsWith("fg:")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
try {
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=fg data=" + part.substring(3).toUpperCase() + " enum=" + Ansi.Color.valueOf(part.substring(3).toUpperCase()));
|
||||||
|
} catch (IllegalArgumentException ignored) {
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=fg data=" + part.substring(3).toUpperCase() + " enum=<invalid>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert text to 'Color' value and insert it on the foreground
|
||||||
|
try {
|
||||||
|
ansi.fg(Ansi.Color.valueOf(part.substring(3).toUpperCase()));
|
||||||
|
} catch (IllegalArgumentException ignored) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// bg:*
|
||||||
|
else if (part.startsWith("bg:")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
try {
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=bg data=" + part.substring(3).toUpperCase() + " enum=" + Ansi.Color.valueOf(part.substring(3).toUpperCase()));
|
||||||
|
} catch (IllegalArgumentException ignored) {
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=bg data=" + part.substring(3).toUpperCase() + " enum=<invalid>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert text to 'Color' value and insert it on the background
|
||||||
|
try {
|
||||||
|
ansi.bg(Ansi.Color.valueOf(part.substring(3).toUpperCase()));
|
||||||
|
} catch (IllegalArgumentException ignored) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// attr:*
|
||||||
|
else if (part.startsWith("attr:")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
try {
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=attr data=" + part.substring(3).toUpperCase() + " enum=" + Ansi.Attribute.valueOf(part.substring(3).toUpperCase()));
|
||||||
|
} catch (IllegalArgumentException ignored) {
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=attr data=" + part.substring(3).toUpperCase() + " enum=<invalid>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert text into 'Attribute' value and insert it
|
||||||
|
try {
|
||||||
|
ansi.a(Ansi.Attribute.valueOf(part.substring(3).toUpperCase()));
|
||||||
|
} catch (IllegalArgumentException ignored) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// bold
|
||||||
|
else if (part.equals("bold")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=bold");
|
||||||
|
|
||||||
|
// Insert attribute
|
||||||
|
ansi.a(Ansi.Attribute.INTENSITY_BOLD);
|
||||||
|
}
|
||||||
|
|
||||||
|
// italic
|
||||||
|
else if (part.equals("italic")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=italic");
|
||||||
|
|
||||||
|
// Insert attribute
|
||||||
|
ansi.a(Ansi.Attribute.ITALIC);
|
||||||
|
}
|
||||||
|
|
||||||
|
// strikethrough
|
||||||
|
else if (part.equals("strikethrough")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=strikethrough");
|
||||||
|
|
||||||
|
// Insert attribute
|
||||||
|
ansi.a(Ansi.Attribute.STRIKETHROUGH_ON);
|
||||||
|
}
|
||||||
|
|
||||||
|
// underline
|
||||||
|
else if (part.equals("underline")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=underline");
|
||||||
|
|
||||||
|
// Insert attribute
|
||||||
|
ansi.a(Ansi.Attribute.UNDERLINE);
|
||||||
|
}
|
||||||
|
|
||||||
|
// blink
|
||||||
|
else if (part.equals("blink")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=blink");
|
||||||
|
|
||||||
|
// Insert attribute
|
||||||
|
ansi.a(Ansi.Attribute.BLINK_SLOW);
|
||||||
|
}
|
||||||
|
|
||||||
|
// reset
|
||||||
|
else if (part.equals("reset")) {
|
||||||
|
// Print debug message
|
||||||
|
if (EngineConfiguration.getInstance().isDebugShortcodeConverter())
|
||||||
|
System.out.println("SCC textHash=" + text.hashCode() + " tag=reset");
|
||||||
|
|
||||||
|
// Insert reset
|
||||||
|
ansi.reset();
|
||||||
|
}
|
||||||
|
|
||||||
|
// error case
|
||||||
|
else {
|
||||||
|
// Complain about invalid shortcode
|
||||||
|
if (EngineConfiguration.getInstance().isErrorShortcodeConverter())
|
||||||
|
logger.sarn("Invalid shortcode: " + part);
|
||||||
|
|
||||||
|
// Convert tag regular text
|
||||||
|
ansi.a("<" + part + ">");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reset part
|
||||||
|
part = "";
|
||||||
|
} else
|
||||||
|
// Add character to part
|
||||||
|
//noinspection StringConcatenationInLoop // It bloats the code to do it with StringBuilder
|
||||||
|
part += character;
|
||||||
|
} else {
|
||||||
|
// Detect if character is start of tag
|
||||||
|
if (character == '<') {
|
||||||
|
// Insert previous text
|
||||||
|
ansi.a(part);
|
||||||
|
|
||||||
|
// Prepare variables
|
||||||
|
part = "";
|
||||||
|
tagActive = true;
|
||||||
|
} else
|
||||||
|
// Add character to part
|
||||||
|
//noinspection StringConcatenationInLoop // It bloats the code to do it with StringBuilder
|
||||||
|
part += character;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Insert remaining characters
|
||||||
|
ansi.a(part);
|
||||||
|
|
||||||
|
return ansi;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converts shortcodes into ANSI escape sequences.
|
||||||
|
*
|
||||||
|
* @param text the text to process
|
||||||
|
* @return {@link Ansi} sequence
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public Ansi process(@NotNull String text) {
|
||||||
|
return process(text, false);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,80 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.base.utility;
|
||||||
|
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses the {@link StackTraceElement}s of an {@link Exception} for use in {@link String}.
|
||||||
|
*
|
||||||
|
* @see Exception
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused" })
|
||||||
|
public final class StackTraceParser {
|
||||||
|
/**
|
||||||
|
* The exception to use.
|
||||||
|
*
|
||||||
|
* @see Exception
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
private final @NotNull Exception exception;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param exception the exception to use
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public StackTraceParser(@NotNull Exception exception) {
|
||||||
|
this.exception = exception;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the stack trace header.<br/>
|
||||||
|
* It looks like this: {@code Caused by java.lang.NullPointerException: This application can crash!}
|
||||||
|
*
|
||||||
|
* @return the stack trace header
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public String getHeader() {
|
||||||
|
if (exception.getMessage() == null)
|
||||||
|
return "Caused by: " + exception.getClass().getName();
|
||||||
|
else
|
||||||
|
return "Caused by: " + exception.getClass().getName() + ": " + exception.getMessage();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the stack trace.
|
||||||
|
*
|
||||||
|
* @return the stack trace
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
public String getStackTrace() {
|
||||||
|
StringBuilder output = new StringBuilder();
|
||||||
|
|
||||||
|
for (StackTraceElement element : exception.getStackTrace()) {
|
||||||
|
if (!output.isEmpty()) output.append("\n");
|
||||||
|
output.append("\tat ").append(element.toString());
|
||||||
|
}
|
||||||
|
|
||||||
|
return output.toString();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides various utility classes specifically made for one task.
|
||||||
|
*
|
||||||
|
* @see de.staropensource.sosengine.base.utility.Miscellaneous
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.base.utility;
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the code for the sos!engine, it's subsystems as well as official modules.
|
||||||
|
*
|
||||||
|
* @since 1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine;
|
||||||
30
base/src/main/javadoc/overview.html
Normal file
30
base/src/main/javadoc/overview.html
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
<!--
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
-->
|
||||||
|
<body>
|
||||||
|
<p>Welcome to the sos!engine documentation!<br/>
|
||||||
|
You are currently in the documentation for the <b>base</b> subsystem, the core of the engine.</p>
|
||||||
|
<p>The most interesting parts for developers wanting to use the engine are:</p>
|
||||||
|
<ul>
|
||||||
|
<li>{@link de.staropensource.sosengine.base.Engine} (main engine object)</li>
|
||||||
|
<li>{@link de.staropensource.sosengine.base.EngineConfiguration} (engine configuration)</li>
|
||||||
|
<li>stuff in {@link de.staropensource.sosengine.base.utility}</li>
|
||||||
|
<li>{@link de.staropensource.sosengine.base.classes.Placeholder} (for implementing custom placeholders)</li>
|
||||||
|
<li>{@link de.staropensource.sosengine.base.utility.PlaceholderEngine} (for adding those custom placeholders)</li>
|
||||||
|
</ul>
|
||||||
|
</body>
|
||||||
1
base/src/main/resources/gradle.properties
Symbolic link
1
base/src/main/resources/gradle.properties
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../../../../gradle.properties
|
||||||
17
gradle.properties
Normal file
17
gradle.properties
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
# Versioning
|
||||||
|
versioningVersion=1
|
||||||
|
versioningType=alpha
|
||||||
|
versioningTyperelease=0
|
||||||
|
versioningFork=
|
||||||
|
|
||||||
|
# Dependencies
|
||||||
|
dependencyLombok=1.18.32
|
||||||
|
dependencyJetbrainsAnnotations=24.1.0
|
||||||
|
dependencyJansi=2.4.1
|
||||||
|
|
||||||
|
# Plugins
|
||||||
|
pluginShadow=8.1.1
|
||||||
|
pluginLombok=8.6
|
||||||
|
|
||||||
|
# etc
|
||||||
|
group = de.staropensource.sosengine
|
||||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
Binary file not shown.
7
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
7
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
|
||||||
|
networkTimeout=10000
|
||||||
|
validateDistributionUrl=true
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
zipStorePath=wrapper/dists
|
||||||
249
gradlew
vendored
Executable file
249
gradlew
vendored
Executable file
|
|
@ -0,0 +1,249 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
#
|
||||||
|
# Copyright © 2015-2021 the original authors.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
|
||||||
|
##############################################################################
|
||||||
|
#
|
||||||
|
# Gradle start up script for POSIX generated by Gradle.
|
||||||
|
#
|
||||||
|
# Important for running:
|
||||||
|
#
|
||||||
|
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
|
||||||
|
# noncompliant, but you have some other compliant shell such as ksh or
|
||||||
|
# bash, then to run this script, type that shell name before the whole
|
||||||
|
# command line, like:
|
||||||
|
#
|
||||||
|
# ksh Gradle
|
||||||
|
#
|
||||||
|
# Busybox and similar reduced shells will NOT work, because this script
|
||||||
|
# requires all of these POSIX shell features:
|
||||||
|
# * functions;
|
||||||
|
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
|
||||||
|
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
|
||||||
|
# * compound commands having a testable exit status, especially «case»;
|
||||||
|
# * various built-in commands including «command», «set», and «ulimit».
|
||||||
|
#
|
||||||
|
# Important for patching:
|
||||||
|
#
|
||||||
|
# (2) This script targets any POSIX shell, so it avoids extensions provided
|
||||||
|
# by Bash, Ksh, etc; in particular arrays are avoided.
|
||||||
|
#
|
||||||
|
# The "traditional" practice of packing multiple parameters into a
|
||||||
|
# space-separated string is a well documented source of bugs and security
|
||||||
|
# problems, so this is (mostly) avoided, by progressively accumulating
|
||||||
|
# options in "$@", and eventually passing that to Java.
|
||||||
|
#
|
||||||
|
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
|
||||||
|
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
|
||||||
|
# see the in-line comments for details.
|
||||||
|
#
|
||||||
|
# There are tweaks for specific operating systems such as AIX, CygWin,
|
||||||
|
# Darwin, MinGW, and NonStop.
|
||||||
|
#
|
||||||
|
# (3) This script is generated from the Groovy template
|
||||||
|
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
|
||||||
|
# within the Gradle project.
|
||||||
|
#
|
||||||
|
# You can find Gradle at https://github.com/gradle/gradle/.
|
||||||
|
#
|
||||||
|
##############################################################################
|
||||||
|
|
||||||
|
# Attempt to set APP_HOME
|
||||||
|
|
||||||
|
# Resolve links: $0 may be a link
|
||||||
|
app_path=$0
|
||||||
|
|
||||||
|
# Need this for daisy-chained symlinks.
|
||||||
|
while
|
||||||
|
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
|
||||||
|
[ -h "$app_path" ]
|
||||||
|
do
|
||||||
|
ls=$( ls -ld "$app_path" )
|
||||||
|
link=${ls#*' -> '}
|
||||||
|
case $link in #(
|
||||||
|
/*) app_path=$link ;; #(
|
||||||
|
*) app_path=$APP_HOME$link ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
# This is normally unused
|
||||||
|
# shellcheck disable=SC2034
|
||||||
|
APP_BASE_NAME=${0##*/}
|
||||||
|
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||||
|
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
|
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
|
MAX_FD=maximum
|
||||||
|
|
||||||
|
warn () {
|
||||||
|
echo "$*"
|
||||||
|
} >&2
|
||||||
|
|
||||||
|
die () {
|
||||||
|
echo
|
||||||
|
echo "$*"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
} >&2
|
||||||
|
|
||||||
|
# OS specific support (must be 'true' or 'false').
|
||||||
|
cygwin=false
|
||||||
|
msys=false
|
||||||
|
darwin=false
|
||||||
|
nonstop=false
|
||||||
|
case "$( uname )" in #(
|
||||||
|
CYGWIN* ) cygwin=true ;; #(
|
||||||
|
Darwin* ) darwin=true ;; #(
|
||||||
|
MSYS* | MINGW* ) msys=true ;; #(
|
||||||
|
NONSTOP* ) nonstop=true ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||||
|
|
||||||
|
|
||||||
|
# Determine the Java command to use to start the JVM.
|
||||||
|
if [ -n "$JAVA_HOME" ] ; then
|
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||||
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
|
JAVACMD=$JAVA_HOME/jre/sh/java
|
||||||
|
else
|
||||||
|
JAVACMD=$JAVA_HOME/bin/java
|
||||||
|
fi
|
||||||
|
if [ ! -x "$JAVACMD" ] ; then
|
||||||
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
JAVACMD=java
|
||||||
|
if ! command -v java >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can.
|
||||||
|
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
|
||||||
|
case $MAX_FD in #(
|
||||||
|
max*)
|
||||||
|
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
|
||||||
|
# shellcheck disable=SC2039,SC3045
|
||||||
|
MAX_FD=$( ulimit -H -n ) ||
|
||||||
|
warn "Could not query maximum file descriptor limit"
|
||||||
|
esac
|
||||||
|
case $MAX_FD in #(
|
||||||
|
'' | soft) :;; #(
|
||||||
|
*)
|
||||||
|
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
|
||||||
|
# shellcheck disable=SC2039,SC3045
|
||||||
|
ulimit -n "$MAX_FD" ||
|
||||||
|
warn "Could not set maximum file descriptor limit to $MAX_FD"
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Collect all arguments for the java command, stacking in reverse order:
|
||||||
|
# * args from the command line
|
||||||
|
# * the main class name
|
||||||
|
# * -classpath
|
||||||
|
# * -D...appname settings
|
||||||
|
# * --module-path (only if needed)
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
|
||||||
|
|
||||||
|
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||||
|
if "$cygwin" || "$msys" ; then
|
||||||
|
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||||
|
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||||
|
|
||||||
|
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||||
|
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
for arg do
|
||||||
|
if
|
||||||
|
case $arg in #(
|
||||||
|
-*) false ;; # don't mess with options #(
|
||||||
|
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
|
||||||
|
[ -e "$t" ] ;; #(
|
||||||
|
*) false ;;
|
||||||
|
esac
|
||||||
|
then
|
||||||
|
arg=$( cygpath --path --ignore --mixed "$arg" )
|
||||||
|
fi
|
||||||
|
# Roll the args list around exactly as many times as the number of
|
||||||
|
# args, so each arg winds up back in the position where it started, but
|
||||||
|
# possibly modified.
|
||||||
|
#
|
||||||
|
# NB: a `for` loop captures its iteration list before it begins, so
|
||||||
|
# changing the positional parameters here affects neither the number of
|
||||||
|
# iterations, nor the values presented in `arg`.
|
||||||
|
shift # remove old arg
|
||||||
|
set -- "$@" "$arg" # push replacement arg
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||||
|
|
||||||
|
# Collect all arguments for the java command:
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||||
|
# and any embedded shellness will be escaped.
|
||||||
|
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
|
||||||
|
# treated as '${Hostname}' itself on the command line.
|
||||||
|
|
||||||
|
set -- \
|
||||||
|
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||||
|
-classpath "$CLASSPATH" \
|
||||||
|
org.gradle.wrapper.GradleWrapperMain \
|
||||||
|
"$@"
|
||||||
|
|
||||||
|
# Stop when "xargs" is not available.
|
||||||
|
if ! command -v xargs >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "xargs is not available"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Use "xargs" to parse quoted args.
|
||||||
|
#
|
||||||
|
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
|
||||||
|
#
|
||||||
|
# In Bash we could simply go:
|
||||||
|
#
|
||||||
|
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
|
||||||
|
# set -- "${ARGS[@]}" "$@"
|
||||||
|
#
|
||||||
|
# but POSIX shell has neither arrays nor command substitution, so instead we
|
||||||
|
# post-process each arg (as a line of input to sed) to backslash-escape any
|
||||||
|
# character that might be a shell metacharacter, then use eval to reverse
|
||||||
|
# that process (while maintaining the separation between arguments), and wrap
|
||||||
|
# the whole thing up as a single "set" statement.
|
||||||
|
#
|
||||||
|
# This will of course break if any of these variables contains a newline or
|
||||||
|
# an unmatched quote.
|
||||||
|
#
|
||||||
|
|
||||||
|
eval "set -- $(
|
||||||
|
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
|
||||||
|
xargs -n1 |
|
||||||
|
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
|
||||||
|
tr '\n' ' '
|
||||||
|
)" '"$@"'
|
||||||
|
|
||||||
|
exec "$JAVACMD" "$@"
|
||||||
92
gradlew.bat
vendored
Normal file
92
gradlew.bat
vendored
Normal file
|
|
@ -0,0 +1,92 @@
|
||||||
|
@rem
|
||||||
|
@rem Copyright 2015 the original author or authors.
|
||||||
|
@rem
|
||||||
|
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@rem you may not use this file except in compliance with the License.
|
||||||
|
@rem You may obtain a copy of the License at
|
||||||
|
@rem
|
||||||
|
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
@rem
|
||||||
|
@rem Unless required by applicable law or agreed to in writing, software
|
||||||
|
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
@rem See the License for the specific language governing permissions and
|
||||||
|
@rem limitations under the License.
|
||||||
|
@rem
|
||||||
|
|
||||||
|
@if "%DEBUG%"=="" @echo off
|
||||||
|
@rem ##########################################################################
|
||||||
|
@rem
|
||||||
|
@rem Gradle startup script for Windows
|
||||||
|
@rem
|
||||||
|
@rem ##########################################################################
|
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell
|
||||||
|
if "%OS%"=="Windows_NT" setlocal
|
||||||
|
|
||||||
|
set DIRNAME=%~dp0
|
||||||
|
if "%DIRNAME%"=="" set DIRNAME=.
|
||||||
|
@rem This is normally unused
|
||||||
|
set APP_BASE_NAME=%~n0
|
||||||
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||||
|
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||||
|
|
||||||
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||||
|
|
||||||
|
@rem Find java.exe
|
||||||
|
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||||
|
|
||||||
|
set JAVA_EXE=java.exe
|
||||||
|
%JAVA_EXE% -version >NUL 2>&1
|
||||||
|
if %ERRORLEVEL% equ 0 goto execute
|
||||||
|
|
||||||
|
echo. 1>&2
|
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
|
||||||
|
echo. 1>&2
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
|
||||||
|
echo location of your Java installation. 1>&2
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:findJavaFromJavaHome
|
||||||
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto execute
|
||||||
|
|
||||||
|
echo. 1>&2
|
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
|
||||||
|
echo. 1>&2
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
|
||||||
|
echo location of your Java installation. 1>&2
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:execute
|
||||||
|
@rem Setup the command line
|
||||||
|
|
||||||
|
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||||
|
|
||||||
|
|
||||||
|
@rem Execute Gradle
|
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||||
|
|
||||||
|
:end
|
||||||
|
@rem End local scope for the variables with windows NT shell
|
||||||
|
if %ERRORLEVEL% equ 0 goto mainEnd
|
||||||
|
|
||||||
|
:fail
|
||||||
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
|
rem the _cmd.exe /c_ return code!
|
||||||
|
set EXIT_CODE=%ERRORLEVEL%
|
||||||
|
if %EXIT_CODE% equ 0 set EXIT_CODE=1
|
||||||
|
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
|
||||||
|
exit /b %EXIT_CODE%
|
||||||
|
|
||||||
|
:mainEnd
|
||||||
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|
||||||
|
:omega
|
||||||
4
settings.gradle
Normal file
4
settings.gradle
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
rootProject.name = 'sosengine'
|
||||||
|
|
||||||
|
include 'base'
|
||||||
|
include 'testapp'
|
||||||
57
testapp/build.gradle
Normal file
57
testapp/build.gradle
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
plugins {
|
||||||
|
id 'com.github.johnrengelman.shadow' version "${pluginShadow}"
|
||||||
|
id 'java'
|
||||||
|
id 'application'
|
||||||
|
id "io.freefair.lombok" version "${pluginLombok}"
|
||||||
|
}
|
||||||
|
|
||||||
|
group = project.group
|
||||||
|
version = project.versioningVersion + "-" + project.versioningType + project.versioningTyperelease + project.versioningFork
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
// Lombok
|
||||||
|
compileOnly 'org.projectlombok:lombok:' + project.dependencyLombok
|
||||||
|
annotationProcessor 'org.projectlombok:lombok:' + project.dependencyLombok
|
||||||
|
|
||||||
|
// JetBrains annotations
|
||||||
|
compileOnly 'org.jetbrains:annotations:' + project.dependencyJetbrainsAnnotations
|
||||||
|
|
||||||
|
// Project
|
||||||
|
implementation project(":base")
|
||||||
|
}
|
||||||
|
|
||||||
|
javadoc.options {
|
||||||
|
setMemberLevel(JavadocMemberLevel.PUBLIC)
|
||||||
|
setOverview("src/main/javadoc/overview.html")
|
||||||
|
setLocale("en_US");
|
||||||
|
setJFlags([
|
||||||
|
// Force Javadoc to use English translations
|
||||||
|
"-Duser.language=en_US"
|
||||||
|
])
|
||||||
|
}
|
||||||
|
|
||||||
|
jar {
|
||||||
|
manifest {
|
||||||
|
attributes(
|
||||||
|
'Main-Class': 'de.staropensource.sosengine.testapp.Main'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
application {
|
||||||
|
mainClass.set("de.staropensource.sosengine.testapp.Main")
|
||||||
|
applicationDefaultJvmArgs = [
|
||||||
|
// Set log level to DIAGNOSTIC
|
||||||
|
"-Dsosengine.base.loggerLevel=diagnostic",
|
||||||
|
|
||||||
|
// Force writing to standard output
|
||||||
|
"-Dsosengine.base.loggerForceStandardOutput=true",
|
||||||
|
|
||||||
|
// Force Jansi to write escape sequences
|
||||||
|
"-Djansi.mode=force",
|
||||||
|
]
|
||||||
|
}
|
||||||
1
testapp/gradle
Symbolic link
1
testapp/gradle
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradle
|
||||||
1
testapp/gradlew
vendored
Symbolic link
1
testapp/gradlew
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradlew
|
||||||
1
testapp/gradlew.bat
vendored
Symbolic link
1
testapp/gradlew.bat
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradlew.bat
|
||||||
|
|
@ -0,0 +1,103 @@
|
||||||
|
/*
|
||||||
|
STAROPENSOURCE ENGINE SOURCE FILE
|
||||||
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
||||||
|
Licensed under the GNU Affero General Public License v3
|
||||||
|
|
||||||
|
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 de.staropensource.sosengine.testapp;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.Engine;
|
||||||
|
import de.staropensource.sosengine.base.logging.LoggerInstance;
|
||||||
|
import de.staropensource.sosengine.base.types.LogIssuer;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The initialization class for sos!engine's development application.
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
|
||||||
|
public class Main {
|
||||||
|
/**
|
||||||
|
* Instance.
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@link Main} instance.
|
||||||
|
*
|
||||||
|
* @return {@link Main} instance
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static final Main instance = new Main();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reference to the main engine object.
|
||||||
|
*
|
||||||
|
* @see Engine
|
||||||
|
*
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the main engine object.
|
||||||
|
*
|
||||||
|
* @return sos!engine object
|
||||||
|
* @see Engine
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private Engine engine;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logger instance.
|
||||||
|
*
|
||||||
|
* @see LoggerInstance
|
||||||
|
*/
|
||||||
|
private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass()));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*/
|
||||||
|
public Main() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The program's entrypoint.
|
||||||
|
* Calls {@code run()} after invocation.
|
||||||
|
*
|
||||||
|
* @see Main#run(String[])
|
||||||
|
* @param args program's command line arguments
|
||||||
|
*/
|
||||||
|
public static void main(String[] args) {
|
||||||
|
getInstance().run(args);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The program's entrypoint but not static.
|
||||||
|
* Here's where the "real magic" happens-
|
||||||
|
*
|
||||||
|
* @see Main#main(String[])
|
||||||
|
* @param args program's command line arguments
|
||||||
|
*/
|
||||||
|
public void run(String[] args) {
|
||||||
|
// Initialize sos!engine
|
||||||
|
engine = new Engine();
|
||||||
|
|
||||||
|
// Say hello to the world!
|
||||||
|
logger.info("Hello world!");
|
||||||
|
|
||||||
|
// Test logger levels
|
||||||
|
logger.diag("Diagnostic message!");
|
||||||
|
logger.verb("Verbose message!");
|
||||||
|
logger.sarn("Silent warning message!");
|
||||||
|
logger.info("Informational message!");
|
||||||
|
logger.warn("Warning message!");
|
||||||
|
logger.error("Error message!");
|
||||||
|
logger.crash("Crash message!");
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue