lots of mod info added
This commit is contained in:
@@ -0,0 +1,677 @@
|
||||
Copyright 2026 James David Clarke <james@jamesdavidclarke.com>
|
||||
|
||||
# GNU GENERAL PUBLIC LICENSE
|
||||
|
||||
Version 3, 29 June 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 General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom
|
||||
to share and change all versions of a program--to make sure it remains
|
||||
free software for all its users. We, the Free Software Foundation, use
|
||||
the GNU General Public License for most of our software; it applies
|
||||
also to any other work released this way by its authors. You can apply
|
||||
it to your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you
|
||||
have certain responsibilities if you distribute copies of the
|
||||
software, or if you modify it: responsibilities to respect the freedom
|
||||
of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the
|
||||
manufacturer can do so. This is fundamentally incompatible with the
|
||||
aim of protecting users' freedom to change the software. The
|
||||
systematic pattern of such abuse occurs in the area of products for
|
||||
individuals to use, which is precisely where it is most unacceptable.
|
||||
Therefore, we have designed this version of the GPL to prohibit the
|
||||
practice for those products. If such problems arise substantially in
|
||||
other domains, we stand ready to extend this provision to those
|
||||
domains in future versions of the GPL, as needed to protect the
|
||||
freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish
|
||||
to avoid the special danger that patents applied to a free program
|
||||
could make it effectively proprietary. To prevent this, the GPL
|
||||
assures that patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
## TERMS AND CONDITIONS
|
||||
|
||||
### 0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds
|
||||
of works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of
|
||||
an exact copy. The resulting work is called a "modified version" of
|
||||
the earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user
|
||||
through a computer network, with no transfer of a copy, is not
|
||||
conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices" to
|
||||
the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
### 1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work for
|
||||
making modifications to it. "Object code" means any non-source form of
|
||||
a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can
|
||||
regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same
|
||||
work.
|
||||
|
||||
### 2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey,
|
||||
without conditions so long as your license otherwise remains in force.
|
||||
You may convey covered works to others for the sole purpose of having
|
||||
them make modifications exclusively for you, or provide you with
|
||||
facilities for running those works, provided that you comply with the
|
||||
terms of this License in conveying all material for which you do not
|
||||
control copyright. Those thus making or running the covered works for
|
||||
you must do so exclusively on your behalf, under your direction and
|
||||
control, on terms that prohibit them from making any copies of your
|
||||
copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the
|
||||
conditions stated below. Sublicensing is not allowed; section 10 makes
|
||||
it unnecessary.
|
||||
|
||||
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such
|
||||
circumvention is effected by exercising rights under this License with
|
||||
respect to the covered work, and you disclaim any intention to limit
|
||||
operation or modification of the work as a means of enforcing, against
|
||||
the work's users, your or third parties' legal rights to forbid
|
||||
circumvention of technological measures.
|
||||
|
||||
### 4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
### 5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these
|
||||
conditions:
|
||||
|
||||
- a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
- b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under
|
||||
section 7. This requirement modifies the requirement in section 4
|
||||
to "keep intact all notices".
|
||||
- c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
- d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
### 6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms of
|
||||
sections 4 and 5, provided that you also convey the machine-readable
|
||||
Corresponding Source under the terms of this License, in one of these
|
||||
ways:
|
||||
|
||||
- a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
- b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the Corresponding
|
||||
Source from a network server at no charge.
|
||||
- c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
- d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
- e) Convey the object code using peer-to-peer transmission,
|
||||
provided you inform other peers where the object code and
|
||||
Corresponding Source of the work are being offered to the general
|
||||
public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal,
|
||||
family, or household purposes, or (2) anything designed or sold for
|
||||
incorporation into a dwelling. In determining whether a product is a
|
||||
consumer product, doubtful cases shall be resolved in favor of
|
||||
coverage. For a particular product received by a particular user,
|
||||
"normally used" refers to a typical or common use of that class of
|
||||
product, regardless of the status of the particular user or of the way
|
||||
in which the particular user actually uses, or expects or is expected
|
||||
to use, the product. A product is a consumer product regardless of
|
||||
whether the product has substantial commercial, industrial or
|
||||
non-consumer uses, unless such uses represent the only significant
|
||||
mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to
|
||||
install and execute modified versions of a covered work in that User
|
||||
Product from a modified version of its Corresponding Source. The
|
||||
information must suffice to ensure that the continued functioning of
|
||||
the modified object code is in no case prevented or interfered with
|
||||
solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or
|
||||
updates for a work that has been modified or installed by the
|
||||
recipient, or for the User Product in which it has been modified or
|
||||
installed. Access to a network may be denied when the modification
|
||||
itself materially and adversely affects the operation of the network
|
||||
or violates the rules and protocols for communication across the
|
||||
network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
### 7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders
|
||||
of that material) supplement the terms of this License with terms:
|
||||
|
||||
- a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
- b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
- c) Prohibiting misrepresentation of the origin of that material,
|
||||
or requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
- d) Limiting the use for publicity purposes of names of licensors
|
||||
or authors of the material; or
|
||||
- e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
- f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions
|
||||
of it) with contractual assumptions of liability to the recipient,
|
||||
for any liability that these contractual assumptions directly
|
||||
impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions; the
|
||||
above requirements apply either way.
|
||||
|
||||
### 8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license
|
||||
from a particular copyright holder is reinstated (a) provisionally,
|
||||
unless and until the copyright holder explicitly and finally
|
||||
terminates your license, and (b) permanently, if the copyright holder
|
||||
fails to notify you of the violation by some reasonable means prior to
|
||||
60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
### 9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or run
|
||||
a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
### 10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
### 11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims owned
|
||||
or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within the
|
||||
scope of its coverage, prohibits the exercise of, or is conditioned on
|
||||
the non-exercise of one or more of the rights that are specifically
|
||||
granted under this License. You may not convey a covered work if you
|
||||
are a party to an arrangement with a third party that is in the
|
||||
business of distributing software, under which you make payment to the
|
||||
third party based on the extent of your activity of conveying the
|
||||
work, and under which the third party grants, to any of the parties
|
||||
who would receive the covered work from you, a discriminatory patent
|
||||
license (a) in connection with copies of the covered work conveyed by
|
||||
you (or copies made from those copies), or (b) primarily for and in
|
||||
connection with specific products or compilations that contain the
|
||||
covered work, unless you entered into that arrangement, or that patent
|
||||
license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
### 12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under
|
||||
this License and any other pertinent obligations, then as a
|
||||
consequence you may not convey it at all. For example, if you agree to
|
||||
terms that obligate you to collect a royalty for further conveying
|
||||
from those to whom you convey the Program, the only way you could
|
||||
satisfy both those terms and this License would be to refrain entirely
|
||||
from conveying the Program.
|
||||
|
||||
### 13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
### 14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in
|
||||
detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies that a certain numbered version of the GNU General Public
|
||||
License "or any later version" applies to it, you have the option of
|
||||
following the terms and conditions either of that numbered version or
|
||||
of any later version published by the Free Software Foundation. If the
|
||||
Program does not specify a version number of the GNU General Public
|
||||
License, you may choose any version ever published by the Free
|
||||
Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions
|
||||
of the GNU General Public License can be used, that proxy's public
|
||||
statement of acceptance of a version permanently authorizes you to
|
||||
choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
### 15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
||||
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
||||
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
||||
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
||||
CORRECTION.
|
||||
|
||||
### 16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
||||
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
||||
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
||||
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
||||
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
||||
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
||||
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
### 17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
## How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these
|
||||
terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest to
|
||||
attach them to the start of each source file to most effectively state
|
||||
the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<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 General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper
|
||||
mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands \`show w' and \`show c' should show the
|
||||
appropriate parts of the General Public License. Of course, your
|
||||
program's commands might be different; for a GUI interface, you would
|
||||
use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. For more information on this, and how to apply and follow
|
||||
the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your
|
||||
program into proprietary programs. If your program is a subroutine
|
||||
library, you may consider it more useful to permit linking proprietary
|
||||
applications with the library. If this is what you want to do, use the
|
||||
GNU Lesser General Public License instead of this License. But first,
|
||||
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -0,0 +1,43 @@
|
||||
# Privileges Manager
|
||||
|
||||
A visual, searchable GUI for managing player privileges in Luanti (Minetest).
|
||||
Works on **Minetest Game** and **Mineclonia / VoxeLibre**, and can manage
|
||||
**offline players** as well as online ones.
|
||||
|
||||

|
||||
|
||||
## Features
|
||||
|
||||
- **Searchable player list** with a search bar — type part of a name and press
|
||||
**Enter** (or click *Search*) to filter. Online players are shown first
|
||||
(● green) above offline players (○ grey).
|
||||
- **Toggle switches** for every registered privilege. Click a switch to grant
|
||||
(green **ON**) or revoke (grey **OFF**) instantly. Each switch shows the
|
||||
privilege description as a tooltip.
|
||||
- **Offline player support** — every account known to the server's auth
|
||||
database is listed, so you can adjust privileges for players who aren't
|
||||
connected. You can also open any player by exact name (bottom-left field),
|
||||
which works even for accounts that don't exist yet.
|
||||
- **Game-aware look** — the formspec uses real coordinates (formspec v4) and
|
||||
adapts its palette to Minetest Game or the Mineclone family automatically.
|
||||
- **Respects the engine permission model** — you need the `privs` privilege to
|
||||
manage any privilege, or `basic_privs` to manage only the privileges listed
|
||||
in the `basic_privs` setting. Privileges you may not grant are shown locked
|
||||
(🔒). Permissions are re-checked on the server for every toggle, so the GUI
|
||||
can't be used to escalate privileges.
|
||||
|
||||
## Usage
|
||||
|
||||
- `/privman` — open the manager.
|
||||
- `/privman <player>` — open it with a player pre-selected.
|
||||
- `/privileges_manager` — alias for `/privman`.
|
||||
|
||||
On games with **sfinv** (e.g. Minetest Game) a *Privileges* tab is added to the
|
||||
inventory for players who may use it. On games with **unified_inventory** a
|
||||
button is added too.
|
||||
|
||||
## Notes
|
||||
|
||||
- Granting a privilege to a name that has never logged in creates a new account
|
||||
with the server's default password — exactly like the `/grant` command.
|
||||
- Changes take effect immediately; online players are notified in chat.
|
||||
@@ -0,0 +1,25 @@
|
||||
-- Privileges Manager
|
||||
-- A visual, searchable privilege management GUI.
|
||||
|
||||
priviledges_manager = {}
|
||||
|
||||
local modpath = minetest.get_modpath("priviledges_manager")
|
||||
priviledges_manager.modpath = modpath
|
||||
|
||||
-- Detect the running game so the GUI can adapt its look between
|
||||
-- Minetest Game and Mineclonia / VoxeLibre.
|
||||
local game = (minetest.get_game_info and minetest.get_game_info()) or {}
|
||||
priviledges_manager.game_id = game.id or "unknown"
|
||||
priviledges_manager.game_title = game.title or "Luanti"
|
||||
|
||||
-- Mineclone family uses a darker UI palette; Minetest Game a lighter one.
|
||||
local mcl = priviledges_manager.game_id:find("mineclon")
|
||||
or priviledges_manager.game_id:find("voxelibre")
|
||||
or minetest.get_modpath("mcl_core")
|
||||
priviledges_manager.is_mcl = mcl ~= nil
|
||||
|
||||
local src = modpath .. "/src/"
|
||||
dofile(src .. "players.lua")
|
||||
dofile(src .. "privs.lua")
|
||||
dofile(src .. "gui.lua")
|
||||
dofile(src .. "integration.lua")
|
||||
@@ -0,0 +1,7 @@
|
||||
name = priviledges_manager
|
||||
title = Privileges Manager
|
||||
description = A visual, searchable GUI to manage player privileges with toggle switches. Works on Minetest Game and Mineclonia/VoxeLibre, and can manage offline players.
|
||||
author = jamesdavidclarke
|
||||
optional_depends = sfinv, unified_inventory
|
||||
supported_games = voxelibre, mineclone2, mineclonia, minetest_game
|
||||
min_minetest_version = 5.4
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 106 KiB |
@@ -0,0 +1,347 @@
|
||||
-- The Privileges Manager formspec: searchable player list on the left,
|
||||
-- toggle-switch privilege rows on the right. Built with formspec version 4
|
||||
-- (real coordinates) so it renders identically on Minetest Game and
|
||||
-- Mineclonia / VoxeLibre.
|
||||
|
||||
local FORMNAME = "priviledges_manager:main"
|
||||
local esc = minetest.formspec_escape
|
||||
|
||||
-- Per-viewer interface state. Cleared when the form is closed.
|
||||
local ctx = {}
|
||||
|
||||
local function get_ctx(name)
|
||||
ctx[name] = ctx[name] or { query = "", target = nil, filtered = {} }
|
||||
return ctx[name]
|
||||
end
|
||||
|
||||
-- Theme colours, adapted to the host game's palette.
|
||||
local THEME = priviledges_manager.is_mcl and {
|
||||
bg = "#0d0d0fee",
|
||||
panel = "#00000055",
|
||||
on = "#3fae54", -- switch ON (green)
|
||||
off = "#5a5a5e", -- switch OFF (grey)
|
||||
locked = "#3a2a2a", -- not grantable by this viewer
|
||||
} or {
|
||||
bg = "#23232bee",
|
||||
panel = "#0000004f",
|
||||
on = "#4caf50",
|
||||
off = "#6d6d75",
|
||||
locked = "#4a3030",
|
||||
}
|
||||
|
||||
-- Layout constants. The formspec is deliberately wide so that long
|
||||
-- privilege descriptions fit on the right without being clipped.
|
||||
local W, H = 19.0, 12.0
|
||||
local PRIV_ROW_H = 1.15
|
||||
local CONTENT_X, CONTENT_Y = 6.1, 2.2
|
||||
local CONTENT_W, CONTENT_H = 12.0, 9.0
|
||||
|
||||
-- Word-wrap `text` into at most `maxlines` lines of about `maxchars`
|
||||
-- characters each, appending an ellipsis if it had to be cut short. This is
|
||||
-- deterministic (no reliance on a widget auto-wrapping), so descriptions can
|
||||
-- never spill under the toggle button.
|
||||
local function wrap(text, maxchars, maxlines)
|
||||
local words = {}
|
||||
for w in tostring(text or ""):gmatch("%S+") do
|
||||
words[#words + 1] = w
|
||||
end
|
||||
|
||||
local lines, cur, i = {}, "", 1
|
||||
while i <= #words do
|
||||
local cand = cur == "" and words[i] or (cur .. " " .. words[i])
|
||||
if #cand <= maxchars then
|
||||
cur = cand
|
||||
i = i + 1
|
||||
elseif cur == "" then
|
||||
-- A single word longer than the line: hard-cut it.
|
||||
cur = words[i]:sub(1, maxchars - 1) .. "\u{2026}"
|
||||
i = i + 1
|
||||
else
|
||||
lines[#lines + 1] = cur
|
||||
cur = ""
|
||||
if #lines == maxlines then
|
||||
break
|
||||
end
|
||||
end
|
||||
end
|
||||
if #lines < maxlines and cur ~= "" then
|
||||
lines[#lines + 1] = cur
|
||||
cur = ""
|
||||
end
|
||||
|
||||
-- Words still remaining means we ran out of lines: mark a truncation.
|
||||
if i <= #words then
|
||||
local last = lines[#lines] or ""
|
||||
if #last + 1 > maxchars then
|
||||
last = last:sub(1, maxchars - 1)
|
||||
end
|
||||
lines[#lines] = last .. "\u{2026}"
|
||||
end
|
||||
|
||||
return lines
|
||||
end
|
||||
|
||||
local function build_player_list(c)
|
||||
local players = priviledges_manager.players.list(c.query)
|
||||
c.filtered = players
|
||||
|
||||
local items, selidx = {}, 0
|
||||
for i, p in ipairs(players) do
|
||||
local marker = p.online and "\u{25CF} " or "\u{25CB} "
|
||||
local colour = p.online and "#7fe07f" or "#bfbfbf"
|
||||
items[i] = colour .. esc(marker .. p.name)
|
||||
if p.name == c.target then
|
||||
selidx = i
|
||||
end
|
||||
end
|
||||
|
||||
return table.concat(items, ","), selidx, #players
|
||||
end
|
||||
|
||||
local function build_priv_rows(c, viewer)
|
||||
if not c.target then
|
||||
return ("label[%f,%f;%s]"):format(
|
||||
CONTENT_X + 0.3, CONTENT_Y + 0.4,
|
||||
esc("Select a player on the left to manage their privileges."))
|
||||
end
|
||||
|
||||
local privs = priviledges_manager.privs.all()
|
||||
local held = minetest.get_player_privs(c.target)
|
||||
|
||||
-- Geometry shared by every row. The toggle is pinned to the right and the
|
||||
-- text is wrapped to end well before it, so they can never overlap.
|
||||
local btn_w, btn_h = 1.7, 0.7
|
||||
local btn_x = CONTENT_W - btn_w - 0.5 -- toggle pinned to the right
|
||||
local text_right = btn_x - 0.3 -- text must end before here
|
||||
local text_w = text_right - 0.5
|
||||
-- Conservative character budget for the wrapped description (tuned for the
|
||||
-- default font so it stays inside even if the smaller font is unavailable).
|
||||
local desc_chars = math.max(12, math.floor(text_w / 0.23))
|
||||
local LINE_H = 0.27
|
||||
|
||||
-- First pass: wrap every description (no truncation) and work out each
|
||||
-- row's height so the full text always fits. Rows grow as tall as needed.
|
||||
local rows = {}
|
||||
local y = 0.1
|
||||
for i, p in ipairs(privs) do
|
||||
local desc = (p.def and p.def.description) or ""
|
||||
local dlines = desc ~= "" and wrap(desc, desc_chars, math.huge) or {}
|
||||
local row_h = #dlines > 0
|
||||
and (0.52 + #dlines * LINE_H + 0.12) or 0.72
|
||||
rows[i] = { p = p, desc = desc, dlines = dlines, y = y, h = row_h }
|
||||
y = y + row_h + 0.06
|
||||
end
|
||||
local content_h = y + 0.05
|
||||
|
||||
-- Size the scrollbar to the actual content so the full list is reachable
|
||||
-- and the thumb reflects how much is visible.
|
||||
local scroll_factor = 0.1
|
||||
local overflow = math.max(0, content_h - CONTENT_H)
|
||||
local max_units = math.ceil(overflow / scroll_factor)
|
||||
local thumb = overflow > 0
|
||||
and math.max(1, math.floor(max_units * CONTENT_H / overflow)) or 0
|
||||
local value = math.min(c.scroll or 0, max_units)
|
||||
|
||||
local fs = {}
|
||||
fs[#fs + 1] = ("scrollbaroptions[arrows=default;max=%d;thumbsize=%d]"):format(
|
||||
max_units, thumb)
|
||||
fs[#fs + 1] = ("scrollbar[%f,%f;0.35,%f;vertical;privscroll;%d]"):format(
|
||||
CONTENT_X + CONTENT_W + 0.05, CONTENT_Y, CONTENT_H, value)
|
||||
fs[#fs + 1] = ("scroll_container[%f,%f;%f,%f;privscroll;vertical;%f]"):format(
|
||||
CONTENT_X, CONTENT_Y, CONTENT_W, CONTENT_H, scroll_factor)
|
||||
|
||||
-- Slightly smaller text for the privilege rows. Only affects labels emitted
|
||||
-- after this point (the rows + nothing else of note before the container end).
|
||||
fs[#fs + 1] = "style_type[label;font_size=*0.9]"
|
||||
|
||||
for _, r in ipairs(rows) do
|
||||
local p, desc, row_h = r.p, r.desc, r.h
|
||||
local is_on = held[p.name] == true
|
||||
local grantable = priviledges_manager.privs.can_grant(viewer, p.name)
|
||||
local btn = "t_" .. p.name
|
||||
|
||||
-- Row background.
|
||||
fs[#fs + 1] = ("box[0.1,%f;%f,%f;#ffffff10]"):format(
|
||||
r.y, CONTENT_W - 0.5, row_h)
|
||||
|
||||
-- Privilege name.
|
||||
fs[#fs + 1] = ("label[0.35,%f;%s]"):format(r.y + 0.27, esc(p.name))
|
||||
|
||||
-- Full description, wrapped across as many lines as it needs.
|
||||
for k, line in ipairs(r.dlines) do
|
||||
fs[#fs + 1] = ("label[0.5,%f;%s]"):format(
|
||||
r.y + 0.52 + (k - 1) * LINE_H, esc(line))
|
||||
end
|
||||
|
||||
-- The toggle switch itself: a coloured button, vertically centred.
|
||||
local colour = grantable and (is_on and THEME.on or THEME.off) or THEME.locked
|
||||
local face = is_on and "ON" or "OFF"
|
||||
if not grantable then
|
||||
face = "\u{1F512}" -- padlock: cannot change this privilege
|
||||
end
|
||||
fs[#fs + 1] = ("style[%s;bgcolor=%s;textcolor=#ffffff]"):format(btn, colour)
|
||||
fs[#fs + 1] = ("button[%f,%f;%f,%f;%s;%s]"):format(
|
||||
btn_x, r.y + (row_h - btn_h) / 2, btn_w, btn_h, btn, face)
|
||||
|
||||
-- Full description on hover: an area tooltip over the text, plus the
|
||||
-- same text on the toggle itself.
|
||||
local tip = desc ~= "" and desc or p.name
|
||||
if not grantable then
|
||||
tip = tip .. "\nYou are not allowed to change this privilege."
|
||||
end
|
||||
fs[#fs + 1] = ("tooltip[%f,%f;%f,%f;%s]"):format(
|
||||
0.1, r.y, text_right, row_h, esc(tip))
|
||||
fs[#fs + 1] = ("tooltip[%s;%s]"):format(btn, esc(tip))
|
||||
end
|
||||
|
||||
fs[#fs + 1] = "scroll_container_end[]"
|
||||
fs[#fs + 1] = "style_type[label;font_size=*1.0]"
|
||||
return table.concat(fs)
|
||||
end
|
||||
|
||||
local function build(viewer)
|
||||
local c = get_ctx(viewer)
|
||||
local list_items, selidx, count = build_player_list(c)
|
||||
|
||||
local target_label
|
||||
if c.target then
|
||||
local online = minetest.get_player_by_name(c.target) ~= nil
|
||||
local known = priviledges_manager.players.exists(c.target)
|
||||
target_label = "Managing: " .. c.target ..
|
||||
(online and " (online)" or known and " (offline)" or " (new account)")
|
||||
else
|
||||
target_label = "No player selected"
|
||||
end
|
||||
|
||||
local fs = {
|
||||
"formspec_version[4]",
|
||||
("size[%f,%f]"):format(W, H),
|
||||
("bgcolor[%s;true]"):format(THEME.bg),
|
||||
|
||||
-- Header.
|
||||
("label[0.4,0.55;%s]"):format(esc("\u{1F511} Privileges Manager \u{2014} " ..
|
||||
priviledges_manager.game_title)),
|
||||
|
||||
-- Left panel: search + player list.
|
||||
("box[0.3,1.0;5.5,%f;%s]"):format(H - 1.3, THEME.panel),
|
||||
"field_close_on_enter[query;false]",
|
||||
("field[0.5,1.25;3.7,0.7;query;;%s]"):format(esc(c.query)),
|
||||
"button[4.3,1.25;1.3,0.7;search;Search]",
|
||||
("tooltip[query;%s]"):format(esc(
|
||||
"Type part of a name and press Enter to filter the list.")),
|
||||
("textlist[0.5,2.15;5.1,%f;playerlist;%s;%d;false]"):format(
|
||||
H - 4.2, list_items, selidx),
|
||||
("label[0.5,%f;%s]"):format(H - 1.85,
|
||||
esc(count .. " player(s) \u{25CF} online \u{25CB} offline")),
|
||||
|
||||
-- Manage an arbitrary (possibly never-seen) account by exact name.
|
||||
"field_close_on_enter[newname;true]",
|
||||
("field[0.5,%f;3.7,0.7;newname;;]"):format(H - 1.5),
|
||||
("button[4.3,%f;1.3,0.7;manage;Open]"):format(H - 1.5),
|
||||
("tooltip[newname;%s]"):format(esc(
|
||||
"Manage an offline player by exact name, then press Enter / Open.")),
|
||||
|
||||
-- Right panel: privilege toggles.
|
||||
("box[6.0,1.0;%f,%f;%s]"):format(W - 6.3, H - 1.3, THEME.panel),
|
||||
("label[6.2,1.55;%s]"):format(esc(target_label)),
|
||||
build_priv_rows(c, viewer),
|
||||
|
||||
"button_exit[" .. ("%f,%f;2.0,0.7;close;Close]"):format(W - 2.3, H - 0.95),
|
||||
}
|
||||
|
||||
return table.concat(fs)
|
||||
end
|
||||
|
||||
function priviledges_manager.show(viewer, target)
|
||||
if target and target ~= "" then
|
||||
local c = get_ctx(viewer)
|
||||
c.target = target
|
||||
priviledges_manager.players.remember(target)
|
||||
end
|
||||
minetest.show_formspec(viewer, FORMNAME, build(viewer))
|
||||
end
|
||||
|
||||
minetest.register_on_player_receive_fields(function(player, formname, fields)
|
||||
if formname ~= FORMNAME then
|
||||
return
|
||||
end
|
||||
local viewer = player:get_player_name()
|
||||
|
||||
-- Security: never trust the client. Re-check permission on every action.
|
||||
if not priviledges_manager.privs.can_use(viewer) then
|
||||
minetest.chat_send_player(viewer, "You may no longer use the Privileges Manager.")
|
||||
ctx[viewer] = nil
|
||||
return true
|
||||
end
|
||||
|
||||
local c = get_ctx(viewer)
|
||||
|
||||
if fields.quit or fields.close then
|
||||
ctx[viewer] = nil
|
||||
return true
|
||||
end
|
||||
|
||||
local rerender = false
|
||||
|
||||
-- Remember the scroll position so toggling a switch doesn't jump to top.
|
||||
if fields.privscroll then
|
||||
local ev = minetest.explode_scrollbar_event(fields.privscroll)
|
||||
if ev.type == "CHG" then
|
||||
c.scroll = ev.value
|
||||
end
|
||||
end
|
||||
|
||||
-- Live search (fires on Enter in the query field or the Search button).
|
||||
if fields.query ~= nil and fields.query ~= c.query then
|
||||
c.query = fields.query
|
||||
rerender = true
|
||||
end
|
||||
if fields.search then
|
||||
rerender = true
|
||||
end
|
||||
|
||||
-- Player picked from the list.
|
||||
if fields.playerlist then
|
||||
local ev = minetest.explode_textlist_event(fields.playerlist)
|
||||
if ev.type == "CHG" or ev.type == "DCL" then
|
||||
local item = c.filtered[ev.index]
|
||||
if item then
|
||||
c.target = item.name
|
||||
rerender = true
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
-- Manage an arbitrary account by exact name.
|
||||
if (fields.manage or fields.key_enter_field == "newname")
|
||||
and fields.newname and fields.newname:trim() ~= "" then
|
||||
c.target = fields.newname:trim()
|
||||
priviledges_manager.players.remember(c.target)
|
||||
rerender = true
|
||||
end
|
||||
|
||||
-- A privilege toggle was pressed.
|
||||
for key in pairs(fields) do
|
||||
local priv = key:match("^t_(.+)$")
|
||||
if priv and c.target and minetest.registered_privileges[priv] then
|
||||
if priviledges_manager.privs.can_grant(viewer, priv) then
|
||||
local held = minetest.get_player_privs(c.target)
|
||||
priviledges_manager.privs.set(c.target, priv, not held[priv], viewer)
|
||||
else
|
||||
minetest.chat_send_player(viewer,
|
||||
"You are not allowed to change the '" .. priv .. "' privilege.")
|
||||
end
|
||||
rerender = true
|
||||
break
|
||||
end
|
||||
end
|
||||
|
||||
if rerender then
|
||||
priviledges_manager.show(viewer)
|
||||
end
|
||||
return true
|
||||
end)
|
||||
|
||||
minetest.register_on_leaveplayer(function(player)
|
||||
ctx[player:get_player_name()] = nil
|
||||
end)
|
||||
@@ -0,0 +1,67 @@
|
||||
-- Entry points: chat command, plus optional inventory buttons for the two
|
||||
-- common inventory frameworks (sfinv on Minetest Game, unified_inventory).
|
||||
|
||||
local function open_for(name, target)
|
||||
if not priviledges_manager.privs.can_use(name) then
|
||||
return false, "You need the 'privs' (or 'basic_privs') privilege to manage privileges."
|
||||
end
|
||||
priviledges_manager.show(name, target ~= "" and target or nil)
|
||||
return true
|
||||
end
|
||||
|
||||
minetest.register_chatcommand("privman", {
|
||||
params = "[player]",
|
||||
description = "Open the visual Privileges Manager (optionally for a player)",
|
||||
-- No priv requirement here so basic_privs holders can open it too;
|
||||
-- the real check happens in open_for and on every toggle.
|
||||
func = function(name, param)
|
||||
return open_for(name, param:trim())
|
||||
end,
|
||||
})
|
||||
|
||||
minetest.register_chatcommand("privileges_manager", {
|
||||
params = "[player]",
|
||||
description = "Alias for /privman",
|
||||
func = function(name, param)
|
||||
return open_for(name, param:trim())
|
||||
end,
|
||||
})
|
||||
|
||||
-- sfinv tab (Minetest Game and games that use sfinv).
|
||||
if minetest.get_modpath("sfinv") and sfinv and sfinv.register_page then
|
||||
sfinv.register_page("priviledges_manager:tab", {
|
||||
title = "Privileges",
|
||||
is_in_nav = function(self, player, context)
|
||||
return priviledges_manager.privs.can_use(player:get_player_name())
|
||||
end,
|
||||
get = function(self, player, context)
|
||||
return sfinv.make_formspec(player, context,
|
||||
"button[2.5,3;5,1;privman_open;Open Privileges Manager]"
|
||||
.. "label[0.5,1;Manage player privileges visually.]",
|
||||
false)
|
||||
end,
|
||||
on_player_receive_fields = function(self, player, context, fields)
|
||||
if fields.privman_open then
|
||||
priviledges_manager.show(player:get_player_name())
|
||||
end
|
||||
end,
|
||||
})
|
||||
end
|
||||
|
||||
-- unified_inventory button (used by many games incl. some Mineclone setups).
|
||||
if minetest.get_modpath("unified_inventory") and unified_inventory
|
||||
and unified_inventory.register_button then
|
||||
unified_inventory.register_button("privman", {
|
||||
type = "image",
|
||||
image = "ui_skins_button.png", -- generic; falls back gracefully if missing
|
||||
tooltip = "Privileges Manager",
|
||||
action = function(player)
|
||||
if priviledges_manager.privs.can_use(player:get_player_name()) then
|
||||
priviledges_manager.show(player:get_player_name())
|
||||
end
|
||||
end,
|
||||
condition = function(player)
|
||||
return priviledges_manager.privs.can_use(player:get_player_name())
|
||||
end,
|
||||
})
|
||||
end
|
||||
@@ -0,0 +1,98 @@
|
||||
-- Player discovery: online players, plus every account the auth backend
|
||||
-- knows about (so offline players can be managed too).
|
||||
|
||||
priviledges_manager.players = {}
|
||||
|
||||
local storage = minetest.get_mod_storage()
|
||||
local STORE_KEY = "seen_players"
|
||||
|
||||
-- A fallback set of names we have personally seen join. This is only used
|
||||
-- when the active auth handler does not support iterate() (most custom
|
||||
-- auth handlers). The builtin handler does support it, covering everyone.
|
||||
local seen = minetest.deserialize(storage:get_string(STORE_KEY)) or {}
|
||||
|
||||
local function persist()
|
||||
storage:set_string(STORE_KEY, minetest.serialize(seen))
|
||||
end
|
||||
|
||||
local function remember(name)
|
||||
if name and name ~= "" and not seen[name] then
|
||||
seen[name] = true
|
||||
persist()
|
||||
end
|
||||
end
|
||||
priviledges_manager.players.remember = remember
|
||||
|
||||
minetest.register_on_joinplayer(function(player)
|
||||
remember(player:get_player_name())
|
||||
end)
|
||||
|
||||
-- Returns a set { [name] = true } of every account we can discover.
|
||||
local function all_known_names()
|
||||
local names = {}
|
||||
|
||||
-- 1. Currently connected players.
|
||||
for _, player in ipairs(minetest.get_connected_players()) do
|
||||
names[player:get_player_name()] = true
|
||||
end
|
||||
|
||||
-- 2. Offline accounts via the auth handler, if it supports iteration.
|
||||
local handler = minetest.get_auth_handler and minetest.get_auth_handler()
|
||||
if handler and handler.iterate then
|
||||
-- iterate() returns the full pairs() triple (generator, state, control);
|
||||
-- capture all three so the for-loop has its iterator state.
|
||||
local ok, gen, state, control = pcall(handler.iterate)
|
||||
if ok and type(gen) == "function" then
|
||||
for name in gen, state, control do
|
||||
names[name] = true
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
-- 3. Anyone we have remembered ourselves (fallback / extra safety).
|
||||
for name in pairs(seen) do
|
||||
names[name] = true
|
||||
end
|
||||
|
||||
return names
|
||||
end
|
||||
|
||||
-- Returns a sorted array of { name = string, online = bool } filtered by
|
||||
-- a case-insensitive substring query. Online players are listed first.
|
||||
function priviledges_manager.players.list(query)
|
||||
query = (query or ""):lower()
|
||||
|
||||
local online = {}
|
||||
for _, player in ipairs(minetest.get_connected_players()) do
|
||||
online[player:get_player_name()] = true
|
||||
end
|
||||
|
||||
local result = {}
|
||||
for name in pairs(all_known_names()) do
|
||||
if query == "" or name:lower():find(query, 1, true) then
|
||||
result[#result + 1] = { name = name, online = online[name] == true }
|
||||
end
|
||||
end
|
||||
|
||||
table.sort(result, function(a, b)
|
||||
if a.online ~= b.online then
|
||||
return a.online -- online players bubble to the top
|
||||
end
|
||||
return a.name:lower() < b.name:lower()
|
||||
end)
|
||||
|
||||
return result
|
||||
end
|
||||
|
||||
-- True if the account exists in the auth database (used to warn when a
|
||||
-- never-seen name is opened, which would create a fresh account on grant).
|
||||
function priviledges_manager.players.exists(name)
|
||||
local handler = minetest.get_auth_handler and minetest.get_auth_handler()
|
||||
if handler and handler.get_auth then
|
||||
local ok, auth = pcall(handler.get_auth, name)
|
||||
if ok and auth then
|
||||
return true
|
||||
end
|
||||
end
|
||||
return seen[name] == true or minetest.get_player_by_name(name) ~= nil
|
||||
end
|
||||
@@ -0,0 +1,75 @@
|
||||
-- Privilege model: which privileges exist, who may grant them, and the
|
||||
-- safe online/offline grant + revoke operations.
|
||||
|
||||
priviledges_manager.privs = {}
|
||||
|
||||
-- Sorted array of { name = string, def = table } for every registered
|
||||
-- privilege. Works on any game because privileges are an engine concept.
|
||||
function priviledges_manager.privs.all()
|
||||
local list = {}
|
||||
for name, def in pairs(minetest.registered_privileges) do
|
||||
list[#list + 1] = { name = name, def = def }
|
||||
end
|
||||
table.sort(list, function(a, b)
|
||||
return a.name < b.name
|
||||
end)
|
||||
return list
|
||||
end
|
||||
|
||||
-- The set of privileges a "basic_privs" holder is allowed to manage.
|
||||
local function basic_set()
|
||||
local set = {}
|
||||
local conf = minetest.settings:get("basic_privs") or "interact,shout"
|
||||
for _, priv in ipairs(conf:split(",")) do
|
||||
set[priv:trim()] = true
|
||||
end
|
||||
return set
|
||||
end
|
||||
priviledges_manager.privs.basic_set = basic_set
|
||||
|
||||
-- May `granter` toggle privilege `priv`? Mirrors the engine's /grant rules:
|
||||
-- * "privs" -> may manage any privilege
|
||||
-- * "basic_privs" -> may manage only privileges in the basic_privs setting
|
||||
function priviledges_manager.privs.can_grant(granter, priv)
|
||||
local gp = minetest.get_player_privs(granter)
|
||||
if gp.privs then
|
||||
return true
|
||||
end
|
||||
if gp.basic_privs then
|
||||
return basic_set()[priv] == true
|
||||
end
|
||||
return false
|
||||
end
|
||||
|
||||
-- May `name` open the manager at all? (Has any granting capability.)
|
||||
function priviledges_manager.privs.can_use(name)
|
||||
local gp = minetest.get_player_privs(name)
|
||||
return gp.privs == true or gp.basic_privs == true
|
||||
end
|
||||
|
||||
-- Apply a single privilege change. `value` true = grant, false = revoke.
|
||||
-- Works for offline players via the auth handler. set_player_privs runs the
|
||||
-- registered on_grant / on_revoke callbacks itself, so we must not double-run.
|
||||
function priviledges_manager.privs.set(target, priv, value, caller)
|
||||
local privs = minetest.get_player_privs(target)
|
||||
|
||||
-- Revoking must remove the key entirely; the engine warns on a `false`
|
||||
-- value passed through set_player_privs.
|
||||
privs[priv] = value and true or nil
|
||||
minetest.set_player_privs(target, privs)
|
||||
|
||||
-- Keep our own seen-list in sync so freshly created accounts show up.
|
||||
priviledges_manager.players.remember(target)
|
||||
|
||||
-- Notify the affected player if they are online.
|
||||
if minetest.get_player_by_name(target) then
|
||||
local verb = value and "granted to" or "revoked from"
|
||||
minetest.chat_send_player(target,
|
||||
minetest.colorize("#f5d76e",
|
||||
("[Privileges] '%s' was %s you by %s."):format(priv, verb, caller)))
|
||||
end
|
||||
|
||||
minetest.log("action",
|
||||
("[priviledges_manager] %s %s '%s' for %s"):format(
|
||||
caller, value and "granted" or "revoked", priv, target))
|
||||
end
|
||||
Reference in New Issue
Block a user