seika/linastk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Initial commit

Browse source
This commit is contained in:
searinminecraft 2023-12-31 11:27:32 +06:00
commit f36af42522
16 changed files with 2635 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.gitignore vendored Normal file
View file

@ -0,0 +1,4 @@
lina.log
__pycache__
constants.py
venv

661
LICENSE Normal file
View file

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

77
README.md Normal file
View file

@ -0,0 +1,77 @@
# linaSTK Discord Edition
This is lina rewritten to work on Discord. It has the same functions as the Revolt version but it's still work in progress and is incomplete. It is intended for this to be used on one server, for example the SuperTuxKart Discord.
# Features
## General
[x] Player tracking
[x] STK Seen
[x] Top 10 ranked players
[x] Player searching
[ ] Friends list (partial)
[x] Server list
[ ] PokeMap
[ ] Addon querying
[ ] Ranking info of a player
## Internal
[x] Authentication
[ ] Polling
[ ] Session revalidation
# How to set up
> This assumes you have knowledge on how to create a Discord bot and set up the proper intents, as well as how to use the Linux command line, and how to create a PostgreSQL database
> Only Linux is supported. Other platforms will not be supported.
1. Initial set up
```
git clone https://github.com/searinminecraft/lina-discord
cd lina-discord
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
2. Create a file named `constants.py` in the root of the folder. Then fill in the information.
```py
# Accent color (used for embeds)
# You must use the hexadecimal representation of the color, or it won't work!
# Example: if your color is #fbce3a then put 0xfbce3a
ACCENT_COLOR = 0xfbce3a
# SuperTuxKart credentials
# This is required to make most features work.
# It is not recommended to use your main account for this.
# You can create an account here: https://online.supertuxkart.net/register.php
STK_USERNAME = ""
STK_PASSWORD = ""
# This is where you put your bot's Discord token. In any circumstances, DO NOT share this
# to anyone, not even your best friend that you trust! If you accidentally share it,
# IMMEDIATELY reset it.
TOKEN = ""
# Prefix for the bot.
# While lina mostly uses slash commands, some are hybrid and some only use
# the old prefix-based command system.
PREFIX = '&'
# PostgreSQL connection
POSTGRESQL = "postgresql://user:pass@localhost/db"
# Max amount of players a user can track.
# If the user goes above this value, they will not be able to add additional
# players to track unless a user removes one to free up space.
MAX_PTRACK = 15
```
3. Run the bot
```
python launch.py
```
# License
This bot is licensed under the GNU Affero General Public License, version 3.
Certain portions of the source code are from Rapptz's RoboDanny bot, licensed under the Mozilla Public License, version 2.

135
bot.py Normal file
View file

@ -0,0 +1,135 @@
import discord
from discord.ext import tasks, commands
import logging
import xml.etree.ElementTree as et
from aiohttp import ClientSession
import asyncio
import asyncpg
from utils import bigip, flagconverter
import constants
log = logging.getLogger("lina.main")
log_ptrack = logging.getLogger("lina.ptrack.triggerDiff")
extensions = (
"cogs.online",
"cogs.playertrack",
"cogs.core",
"cogs.misc"
)
class STKRequestError(Exception):
"""Raised when an error occurs upon performing a request to STK servers."""
pass
class Lina(commands.Bot):
"""
Class representing lina herself.
"""
pool: asyncpg.Pool
def __init__(self):
intents = discord.Intents.default()
intents.message_content = True
intents.members = True
allowed_mentions = discord.AllowedMentions(everyone=False, roles=False)
super().__init__(intents=intents,
activity=discord.Game(name="SuperTuxKart"),
allowed_mentions=allowed_mentions,
command_prefix=constants.PREFIX)
self.accent_color = constants.ACCENT_COLOR
self.addons_dict = {}
self.serverlist: et.Element = None
self.lastserverlist: et.Element = None
self.onlinePlayers = {}
async def stkPostReq(self, target, args):
"""Helper function to send a POST request to STK servers."""
async with self.session.post(
target, data=args,
headers={
**self.session.headers,
"Content-Type": "application/x-www-form-urlencoded"
}
) as r:
r.raise_for_status()
data = et.fromstring(await r.text())
if data.attrib["success"] == "no":
raise STKRequestError(data.attrib["info"])
else:
return data
async def stkGetReq(self, target):
"""Helper function to send a GET request to STK servers."""
async with self.session.get(target) as r:
r.raise_for_status()
return et.fromstring(await r.text())
async def setup_hook(self):
if not hasattr(self, "uptime"):
self.uptime = discord.utils.utcnow()
self.session = ClientSession(
"https://online.supertuxkart.net",
headers={
"User-Agent": "DiscordBot (linaSTK 1.0)"
}
)
log.info(f"Trying to authenticate STK account {constants.STK_USERNAME}")
try:
loginPayload = await self.stkPostReq(
"/api/v2/user/connect",
f"username={constants.STK_USERNAME}&" \
f"password={constants.STK_PASSWORD}&" \
"save_session=true"
)
except Exception:
log.exception("Unable to authenticate due to error. The bot will now shut down.")
return await self.close()
if loginPayload.attrib["success"] == "no":
log.critical(f"Unable to login! {loginPayload.attrib['info']}")
log.critical("The bot will now shut down.")
return await self.close()
self.stk_userid = loginPayload.attrib["userid"]
self.stk_token = loginPayload.attrib["token"]
log.info(f"STK user {loginPayload.attrib['username']} logged in successfully.")
for extension in extensions:
try:
await self.load_extension(extension)
except Exception as e:
log.exception(f"Unable to load extension {extension}.")
async def close(self):
"""Shut down lina"""
log.info("lina is shutting down...")
await super().close()
if hasattr(self, 'session'):
await self.session.close()
async def start(self):
"""Bring lina to life"""
await super().start(constants.TOKEN, reconnect=True)
@property
def playertrack(self):
return self.get_cog("PlayerTrack")
async def on_ready(self):
log.info(f"Bot {self.user} ({self.user.id}) is ready!")

73
cogs/core.py Normal file
View file

@ -0,0 +1,73 @@
import discord
from discord.ext import commands
from typing import Optional
from bot import Lina
class Core(commands.Cog):
def __init__(self, bot: Lina):
self.bot: Lina = bot
async def cog_check(self, ctx: commands.Context) -> bool:
return await self.bot.is_owner(ctx.author)
@commands.command(hidden=True)
async def load(self, ctx: commands.Context, *, mod: str):
try:
await self.bot.load_extension(mod)
except commands.ExtensionError as e:
await ctx.reply(f"{e.__class__.__name__}: {e}")
else:
await ctx.reply("Loaded.")
@commands.command(hidden=True)
async def unload(self, ctx: commands.Context, *, mod: str):
try:
await self.bot.unload_extension(mod)
except commands.ExtensionError as e:
await ctx.reply(f"{e.__class__.__name__}: {e}")
else:
await ctx.reply("Unloaded.")
@commands.command(hidden=True)
async def reload(self, ctx: commands.Context, *, mod: str):
try:
await self.bot.reload_extension(mod)
except commands.ExtensionError as e:
await ctx.reply(f"{e.__class__.__name__}: {e}")
else:
await ctx.reply("Reloaded.")
@commands.group(invoke_without_command=True)
@commands.is_owner()
@commands.guild_only()
async def sync(self, ctx: commands.Context, guild_id: Optional[int], copy: bool = False):
if guild_id:
guild = discord.Object(guild_id)
else:
guild = ctx.guild
if copy:
self.bot.tree.copy_global_to(guild=guild)
commands = await self.bot.tree.sync(guild=guild)
await ctx.reply(f"Successfully synced {len(commands)} commands.")
@sync.command(name="global")
@commands.is_owner()
async def sync_global(self, ctx: commands.Context):
commands = await self.bot.tree.sync()
await ctx.reply(f"Successfully synced {len(commands)} commands.")
async def setup(bot: Lina):
await bot.add_cog(Core(bot))

43
cogs/misc.py Normal file
View file

@ -0,0 +1,43 @@
import discord
from discord import app_commands
from discord.ext import commands
import datetime
from bot import Lina
from utils.formatting import humanize_timedelta
class Misc(commands.Cog):
def __init__(self, bot: Lina):
self.bot: Lina = bot
@commands.hybrid_command(name="uptime", description="Know how long I have been up.")
async def uptime(self, ctx: commands.Context):
delta = discord.utils.utcnow() - self.bot.uptime
uptime = self.bot.uptime
uptime_str = humanize_timedelta(timedelta=delta)
await ctx.reply(
"I have been up for **{time}** (since {ts})".format(
time=uptime_str, ts=discord.utils.format_dt(uptime)
), mention_author=False
)
@commands.hybrid_command(name="stats", description="General bot stats")
async def stats(self, ctx: commands.Context):
await ctx.reply(embed=discord.Embed(
title="Bot statistics",
description=(
"**Bot started:** {ts}\n" \
"**Players in STK Seen database** {stkseen_count}\n" \
"**Online Players**: {onlinecount}"
).format(
ts=discord.utils.format_dt(self.bot.uptime),
stkseen_count=(await self.bot.pool.fetchrow("SELECT COUNT(*) FROM lina_discord_stk_seen"))["count"],
onlinecount=len(self.bot.playertrack.onlinePlayers)
),
color=self.bot.accent_color
), mention_author=False)
async def setup(bot: Lina):
await bot.add_cog(Misc(bot))

272
cogs/online.py Normal file
View file

@ -0,0 +1,272 @@
import discord
from discord import app_commands, ui
from discord.ext import commands, menus, tasks
import logging
import xml.etree.ElementTree as et
from bot import Lina
from utils import bigip, flagconverter
log = logging.getLogger("lina.cogs.online")
class EmbedPageSource(menus.ListPageSource):
async def format_page(self, menu, items):
embed = discord.Embed(description="\n".join(
items
))
embed.set_footer(text=f"Page {menu.current_page+1}/{self.get_max_pages()} ({len(self.entries)} items)")
# you can format the embed however you'd like
return embed
class Online(commands.Cog):
def __init__(self, bot: Lina):
self.bot: Lina = bot
self.addons_dict = {}
@tasks.loop(hours=2)
async def syncAddons(self):
addondata = await self.bot.stkGetReq("/downloads/xml/online_assets.xml")
addons = []
for a in addondata.findall("track"):
addons.append((
a.attrib["id"],
a.attrib["name"],
a.attrib["file"],
int(a.attrib["date"]),
a.attrib["uploader"],
a.attrib["designer"],
a.attrib["description"],
a.get("image", ""),
int(a.attrib["format"]),
int(a.attrib["revision"]),
int(a.attrib["status"]),
int(a.attrib["size"]),
float(a.attrib["rating"])
))
self.addons_dict[a.attrib["id"]] = {
"id": a.attrib["id"],
"name": a.attrib["name"],
"file": a.attrib["file"],
"date": int(a.attrib["date"]),
"uploader": a.attrib["uploader"],
"designer": a.attrib["designer"],
"description": a.attrib["description"],
"image": a.get("image", ""),
"format": int(a.attrib["format"]),
"revision": int(a.attrib["revision"]),
"status": int(a.attrib["status"]),
"size": int(a.attrib["size"]),
"rating": float(a.attrib["rating"])
}
async with self.bot.pool.acquire() as con:
pre = await con.prepare(
"""
INSERT INTO lina_discord_addons
(id, name, file, date, uploader, designer, description,
image, format, revision, status, size, rating)
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13)
ON CONFLICT (id) DO UPDATE SET
id = $1,
name = $2,
file = $3,
date = $4,
uploader = $5,
designer = $6,
description = $7,
image = $8,
format = $9,
revision = $10,
status = $11,
size = $12,
rating = $13
;
"""
)
await pre.executemany(addons)
def convertAddonIdToName(self, _id: str):
_id = _id.removeprefix('addon_')
match _id:
case 'abyss': return 'Abyss'
case 'alien_signal': return 'Alien Signal'
case 'ancient_colosseum_labrynth': return 'Ancient Colosseum Labrynth'
case 'arena_candela_city': return 'Candela City'
case 'battleisland': return 'Battle Island'
case 'black_forest': return 'Black Forest'
case 'candela_city': return 'Candela City'
case 'cave': return 'Cave X'
case 'cocoa_temple': return 'Cocoa Temple'
case 'cornfield_crossing': return 'Cornfield Crossing'
case 'endcutscene': return 'What the fuck?'
case 'featunlock': return 'lina is the best!!'
case 'fortmagma': return 'Fort Magma'
case 'gplose': return 'You lost? Too bad.'
case 'gpwin': return 'Huh?'
case 'gran_paradiso_island': return 'Gran Paradiso Island'
case 'hacienda': return 'Hacienda'
case 'hole_drop': return 'Hole Drop'
case 'icy_soccer_field': return 'Icy Soccer Field'
case 'introcutscene': return 'Intro Cutscene'
case 'introcutscene2': return 'Intro Cutscene (Part 2)'
case 'lasdunasarena': return 'Las Dunas Arena'
case 'lighthouse': return 'Around the Lighthouse'
case 'mines': return 'Old Mine'
case 'minigolf': return 'Minigolf'
case 'oasis': return 'Oasis'
case 'olivermath': return 'Oliver\'s Math Class'
case 'overworld': return 'Overworld'
case 'pumpkin_park': return 'Pumpkin Park'
case 'ravenbridge_mansion': return 'Ravenbridge Mansion'
case 'sandtrack': return 'Shifting Sands'
case 'scotland': return 'Nessie\'s Pond'
case 'snowmountain': return 'Northern Resort'
case 'snowtuxpeak': return 'Snow Peak'
case 'soccer_field': return 'Soccer Field'
case 'stadium': return 'The Stadium'
case 'stk_enterprise': return 'STK Enterprise'
case 'temple': return 'Temple'
case 'tutorial': return 'Tutorial'
case 'volcano_island': return 'Volcan Island'
case 'xr591': return 'XR591'
case 'zengarden': return 'Zen Garden'
case _: pass
try:
return self.addons_dict[_id]['name']
except KeyError:
if _id == '':
return 'None'
else:
return f'Unknown track (ID: `{_id}`)'
def cog_load(self):
self.syncAddons.start()
def cog_unload(self):
self.syncAddons.cancel()
@app_commands.command(
name="online",
description="See currently online users."
)
async def online(self, interaction: discord.Interaction):
serverlist = self.bot.playertrack.serverlist
result = ""
fields = []
embed = discord.Embed(
title = "Public Online",
color = self.bot.accent_color
)
for i in range(len(serverlist[0])):
serverInfo = serverlist[0][i][0]
# Some servers (such as Frankfurt servers) have
# newlines on their names, and it looks ugly on embed
# and can potentially break the layout. So strip them out.
serverName = serverInfo.attrib["name"] \
.replace("\r", "") \
.replace("\n", "")
serverCountry = flagconverter(serverInfo.attrib["country_code"])
currentTrack = self.convertAddonIdToName(serverInfo.attrib["current_track"])
currentPlayers = int(serverInfo.attrib["current_players"])
password = int(serverInfo.attrib["password"]) == 1
ip = bigip(serverInfo.attrib["ip"])
port = int(serverInfo.attrib["port"])
players = serverlist[0][i][1]
log.debug(f"Server {serverName} players: {len(players)}")
if len(players) == 0:
continue
embed.add_field(
name=f"{serverCountry} {serverName} ({ip}): {len(players)} player{'s' if len(players) > 1 else ''} - {currentTrack}:",
value="\n".join(
[f"{flagconverter(x.attrib['country-code'])} {x.attrib['username']}" for x in players]
),
inline=False
)
if len(embed.fields) == 0:
await interaction.response.send_message(embed=discord.Embed(
description="Nobody is currently playing.",
color=self.bot.accent_color
))
else:
await interaction.response.send_message(embed=embed)
@app_commands.command(name="top-players", description="Get top 10 ranked players.")
async def topplayers(self, interaction: discord.Interaction):
data = await self.bot.stkPostReq("/api/v2/user/top-players",
f"userid={self.bot.stk_userid}&" \
f"token={self.bot.stk_token}")
await interaction.response.send_message(embed=discord.Embed(
title="Top 10 ranked players",
description="\n".join([
f"{x + 1}. {data[0][x].attrib['username']} — {round(float(data[0][x].attrib['scores']), ndigits=2)} (Max: {round(float(data[0][x].attrib['max-scores']), ndigits=2)})" for x in range(len(data[0]))
]),
color=self.bot.accent_color
))
@app_commands.command(name="usersearch", description="Search for a user in STK.")
@app_commands.describe(query="The search query.")
async def usersearch(self, interaction: discord.Interaction, query: str):
data = await self.bot.stkPostReq(
"/api/v2/user/user-search",
f"userid={self.bot.stk_userid}&" \
f"token={self.bot.stk_token}&" \
f"search-string={query}"
)
if len(data[0]) == 0:
await interaction.response.send_message(embed=discord.Embed(
title=f"Search results for \"{query}\"",
description="No results :(",
color=self.bot.accent_color
))
else:
await interaction.response.send_message(embed=discord.Embed(
title=f"Search results for \"{query}\"",
description="\n".join([
f"* {x.attrib['user_name']} ({x.attrib['id']})" for x in data[0]
]),
color=self.bot.accent_color
))
@commands.hybrid_command(name="friendslist", description="Get a user's friends list.")
@app_commands.describe(userid="The user ID of target user. To know their user ID, you can search them using /usersearch.")
async def friendslist(self, ctx: commands.Context, userid: int):
data = await self.bot.stkPostReq(
"/api/v2/user/get-friends-list",
f"userid={self.bot.stk_userid}&" \
f"token={self.bot.stk_token}&" \
f"visitingid={userid}"
)
res = []
for x in range(len(data[0])):
res.append("{name} ({_id})".format(
name=data[0][x][0].attrib["user_name"],
_id=data[0][x][0].attrib["id"])
)
page = menus.MenuPages(EmbedPageSource(res, per_page=50))
await page.start(ctx)
async def setup(bot: Lina):
await bot.add_cog(Online(bot))

531
cogs/playertrack.py Normal file
View file

@ -0,0 +1,531 @@
import discord
from discord.ext import commands, tasks
from discord import app_commands
import logging
import datetime
import time
import xml.etree.ElementTree as et
from bot import Lina
import constants
from utils import flagconverter
from utils import formatting
from utils import bigip
log = logging.getLogger("lina.cogs.playertrack")
class PlayerTrack(commands.Cog):
def __init__(self, bot: Lina):
self.bot: Lina = bot
self.lastserverlist = None
self.serverlist = None
self.onlinePlayers = {}
async def ptrackNotifyJoin(self, user: int, username: str, country: str, server: str, serverCountry: str):
user = self.bot.get_user(user)
assert user is not None
await user.send(embed=discord.Embed(
title=f"STK Player Tracker",
description=(
f"{flagconverter(country)} {username} joined a server.\n" \
f"Server: {flagconverter(serverCountry)} {server}"
),
color=self.bot.accent_color
))
async def ptrackNotifyLeft(self, user: int, username: str, country: str, server: str, serverCountry: str):
user = self.bot.get_user(user)
assert user is not None
await user.send(embed=discord.Embed(
title=f"STK Player Tracker",
description=(
f"{flagconverter(country)} {username} left.\n" \
f"Server: {flagconverter(serverCountry)} {server}"
),
color=self.bot.accent_color
))
async def triggerDiff(self, tree: et.Element):
if not self.lastserverlist:
self.lastserverlist = tree
ids_old = set(int(x[0].attrib["id"]) for x in self.lastserverlist[0])
ids_new = set(int(x[0].attrib["id"]) for x in tree[0])
srvCreated = ids_new.difference(ids_old)
srvDeleted = ids_old.difference(ids_new)
playersToInsert = []
playersToInsertnocc = []
for i in range(len(tree[0])):
_id = int(tree[0][i][0].attrib["id"])
if _id in srvCreated:
log.info("New server created: %s (%s) with id %d and address %s:%d" % (
tree[0][i][0].attrib['name'],
tree[0][i][0].attrib['country_code'],
int(tree[0][i][0].attrib['id']),
bigip(int(tree[0][i][0].attrib['ip'])),
int(tree[0][i][0].attrib['port'])
))
playersJoined = tree[0][i][1]
for player in playersJoined:
username = player.attrib["username"]
country = player.attrib["country-code"]
serverInfo = tree[0][i][0]
serverName = serverInfo.attrib["name"]
serverCountry = serverInfo.attrib['country_code']
playersToInsert.append((username, country,
serverName, serverCountry))
if username not in self.onlinePlayers:
self.onlinePlayers[username] = serverInfo
for i in range(len(self.lastserverlist[0])):
_id = int(self.lastserverlist[0][i][0].attrib["id"])
if _id in srvDeleted:
log.info("Server deleted: %s (%s) with id %d and address %s:%d" % (
self.lastserverlist[0][i][0].attrib['name'],
self.lastserverlist[0][i][0].attrib['country_code'],
int(self.lastserverlist[0][i][0].attrib['id']),
bigip(int(self.lastserverlist[0][i][0].attrib['ip'])),
int(self.lastserverlist[0][i][0].attrib['port'])
))
playersLeft = self.lastserverlist[0][i][1]
for player in playersLeft:
username = player.attrib['username']
serverInfo = self.lastserverlist[0][i][0]
serverName = serverInfo.attrib['name']
serverCountry = serverInfo.attrib['country_code']
playersToInsertnocc.append((username,
serverName,
serverCountry))
if username in self.onlinePlayers:
del self.onlinePlayers[username]
# Some optimization procedure stuff
pairs = {}
offset = 0
for i in range(min(len(tree[0]), len(self.lastserverlist[0]))):
_id_next = int(tree[0][i][0].attrib['id'])
try:
_id_prev = int(self.lastserverlist[0][i + offset][0].attrib['id'])
except IndexError:
log.error(
"Bad index: prevTree[0][%s][0] is out of boundaries, offset %s, i=%s, len(tree[0]) = %s, len(prevTree[0] = %s)" % (
i + offset,
offset,
i,
len(tree[0]),
len(self.lastserverlist[0])
))
continue
if _id_next == _id_prev:
pairs[tree[0][i]] = self.lastserverlist[0][i + offset]
elif _id_next in srvCreated:
offset -= 1
elif len(tree[0]) != len(self.lastserverlist[0]):
while _id_prev in srvDeleted:
_id_prev = int(self.lastserverlist[0][i + offset][0].attrib['id'])
if _id_prev in srvDeleted:
offset += 1
elif _id_prev == _id_next:
pairs[tree[0][i]] = self.lastserverlist[0][i + offset]
break
else:
log.error(
"Failed to find an offset at _id_next %s" % _id_next)
for pair in pairs:
oldServerInfo = pairs[pair][0]
oldServerPlayers = pairs[pair][1]
serverInfo = pair[0]
serverPlayers = pair[1]
if serverInfo.attrib['id'] != oldServerInfo.attrib['id']:
log.warn("Server IDs don't match: %s %s" % (
serverInfo.attrib['id'],
oldServerInfo.attrib['id']
))
continue
serverCTrack = None
oldserverCTrack = None
if "current_track" in serverInfo.attrib:
serverCTrack = serverInfo.attrib["current_track"]
if "current_track" in oldServerInfo.attrib:
oldserverCTrack = oldServerInfo.attrib["current_track"]
if serverCTrack != oldserverCTrack:
if not oldserverCTrack:
log.info("Stub: Game started at %s %s - %s" % (
serverInfo.attrib['name'],
serverInfo.attrib['id'],
serverCTrack
))
elif not serverCTrack:
log.info(
"Stub: Game ended at %s %s" % (
serverInfo.attrib['name'],
serverInfo.attrib['id']
))
diff_attrib = set()
for attrib in ('max_players',
'game_mode',
'difficulty'):
if serverInfo.attrib[attrib] != oldServerInfo.attrib[attrib]:
diff_attrib.add(attrib)
if diff_attrib:
log.info("Stub: Config difference detected at %s: %s"
% (serverInfo.attrib['name'], diff_attrib))
playersNew = set(str(x.attrib['username']) for x in serverPlayers)
playersOld = set(str(x.attrib['username']) for x in oldServerPlayers)
playersJoined = playersNew.difference(playersOld)
playersLeft = playersOld.difference(playersNew)
for i in range(len(serverPlayers)):
username = serverPlayers[i].attrib['username']
userCountryCode = serverPlayers[i].attrib['country-code'].lower() if 'country-code' in serverPlayers[i].attrib else ''
if username in playersJoined:
if 'country-code' in serverPlayers[i].attrib:
serverName = serverInfo.attrib['name']
serverCountry = serverInfo.attrib['country_code']
playersToInsert.append((
username,
userCountryCode,
serverName,
serverCountry
))
async with self.bot.pool.acquire() as con:
for i in await con.fetch("SELECT * FROM lina_discord_ptrack;"):
if username in i["usernames"]:
self.bot.loop.create_task(self.ptrackNotifyJoin(
i["id"],
username,
userCountryCode,
serverName,
serverCountry
))
self.onlinePlayers[username] = serverInfo
for i in range(len(oldServerPlayers)):
if i >= len(oldServerPlayers):
log.warning(
"Impossible happened: iteration %s is over oldServerPlayers length: %s"
% (i, len(oldServerPlayers)))
continue
username = oldServerPlayers[i].attrib['username']
userCountryCode = oldServerPlayers[i].attrib['country-code']
if username in playersLeft:
if 'country-code' in oldServerPlayers[i].attrib:
serverName = oldServerInfo.attrib['name']
serverCountry = oldServerInfo.attrib['country_code']
playersToInsert.append((
username,
userCountryCode,
serverName,
serverCountry
))
async with self.bot.pool.acquire() as con:
for i in await con.fetch("SELECT * FROM lina_discord_ptrack;"):
if username in i["usernames"]:
self.bot.loop.create_task(self.ptrackNotifyLeft(
i["id"],
username,
userCountryCode,
serverName,
serverCountry
))
if username in self.onlinePlayers:
del self.onlinePlayers[username]
if len(oldServerPlayers) != len(serverPlayers):
log.info(
f"Stub: Server {serverName} became full or free")
try:
if playersToInsertnocc:
async with self.bot.pool.acquire() as con:
sel = await con.prepare("""
INSERT INTO lina_discord_stk_seen (username, date, server_name, server_country)
VALUES ($1, now() at time zone 'utc', $2, lower($3))
ON CONFLICT (username) DO UPDATE SET
date = now() at time zone 'utc', server_name = $2, server_country = lower($3);
""")
await sel.executemany(playersToInsertnocc)
if playersToInsert:
async with self.bot.pool.acquire() as con:
sel = await con.prepare("""
INSERT INTO lina_discord_stk_seen (username, country, date, server_name, server_country)
VALUES ($1, lower($2), now() at time zone 'utc', $3, lower($4))
ON CONFLICT (username) DO UPDATE SET
country = lower($2), date = now() at time zone 'utc',
server_name = $3, server_country = lower($4);
""")
await sel.executemany(playersToInsert)
playersToInsert.clear()
playersToInsertnocc.clear()
except Exception as e:
log.exception(
f"Unable to save player info to DB: {e.__class__.__name__}: {e}")
self.lastserverlist = self.serverlist
@tasks.loop(seconds=5)
async def fetcherWrapper(self):
try:
self.serverlist = await self.bot.stkGetReq("/api/v2/server/get-all")
await self.triggerDiff(self.serverlist)
except Exception:
log.exception("Failed to get server list.")
def cog_load(self):
self.fetcherWrapper.start()
def cog_unload(self):
self.fetcherWrapper.cancel()
@commands.hybrid_command(name="stk-seen", aliases=["seen"], description="See when user was last online")
@app_commands.describe(player="Player to check")
async def stk_seen(self, interaction: commands.Context, player: str):
sql_esc = str.maketrans({
"%": "\\%",
"_": "\\_",
"\\": "\\\\"
})
try:
data = await self.bot.pool.fetchrow("""SELECT username, LOWER(country) AS country,
date, server_name, LOWER(server_country) AS server_country FROM stk_seen
WHERE username ILIKE $1 GROUP BY username FETCH FIRST 1 ROW ONLY""",
player.translate(sql_esc) + "%")
except Exception:
log.exception("Could not get stk-seen data for query {player}")
return await interaction.reply(embed=discord.Embed(
title="Error",
description="An error has occurred while processing your request. Please try again.",
color=self.bot.accent_color
), mention_author=False)
if data:
if data["username"] in self.onlinePlayers:
return await interaction.reply(embed=discord.Embed(
title="{country} {username} is currently online.".format(
country=flagconverter(data["country"]),
username=data["username"]
),
description="Currently in server: {country} {name}".format(
country=flagconverter(data["server_country"]),
name=str(data["server_name"]).replace("\r", "").replace("\n", "")
),
color=self.bot.accent_color
), mention_author=False)
else:
return await interaction.reply(embed=discord.Embed(
title="{country} {username} is offline.".format(
country=flagconverter(data["country"]),
username=data["username"]
),
description="I last saw {flag} {username} online **{time} ago** (since {ts}) in server: {serverflag} {server}".format(
flag=flagconverter(data["country"]),
username=data["username"],
time=formatting.humanize_timedelta(timedelta=(discord.utils.utcnow() - data["date"].replace(tzinfo=datetime.timezone.utc))),
ts=discord.utils.format_dt(datetime.datetime.fromtimestamp(data["date"].timestamp() - time.timezone)),
serverflag=flagconverter(data["server_country"]),
server=str(data["server_name"]).replace("\r","").replace("\n","")
),
color=self.bot.accent_color
), mention_author=False)
else:
return await interaction.reply(embed=discord.Embed(
title="Unknown player",
description=f"I have not seen this player before.\nCheck spelling or track them using `/trackuser {player}`",
color=self.bot.accent_color
), mention_author=False)
@app_commands.command(name="trackuser", description="Track a user.")
@app_commands.describe(player="The player to track.")
async def trackuser(self, interaction: discord.Interaction, player: str):
try:
ptracks = await self.bot.pool.fetchrow("""
SELECT usernames FROM lina_discord_ptrack
WHERE id = $1
""", interaction.user.id)
except Exception:
log.exception(f"Could not get ptracks for {interaction.user.id}")
return await interaction.response.send_message(embed=discord.Embed(
title="Error",
description="An error has occurred while processing your request. Please try again.",
color=self.bot.accent_color
), ephemeral=True)
if ptracks:
if player in ptracks["usernames"]:
return await interaction.response.send_message(embed=discord.Embed(
description=f"You are already tracking {player}.",
color=self.bot.accent_color
), ephemeral=True)
if len(ptracks["usernames"]) >= constants.MAX_PTRACK:
return await interaction.response.send_message(embed=discord.Embed(
title="Maximum amount of tracked players reached",
description=(
f"You have reached the maximum amount of players you can track ({constants.MAX_PTRACK}). " \
"Please untrack a user before tracking another one."
),
color=self.bot.accent_color
), ephemeral=True)
try:
await self.bot.pool.execute("""
INSERT INTO lina_discord_ptrack
VALUES ($1, $2)
ON CONFLICT (id) DO UPDATE SET
usernames = array_append(lina_discord_ptrack.usernames, $3)
""", interaction.user.id, {player}, player)
await interaction.response.send_message(embed=discord.Embed(
title=f"Tracking {player} privately.",
description=(
"Okay, I will send a direct message to you every time the user joins/leaves a server. " \
f"To stop me from tracking {player}, execute `/untrackuser {player}`."
),
color=self.bot.accent_color
), ephemeral=True)
except Exception:
log.exception(f"Could not add player {player} for {interaction.user.id}")
await interaction.response.send_message(embed=discord.Embed(
title="Error",
description="An error has occurred while processing your request. Please try again.",
color=self.bot.accent_color
), ephemeral=True)
@app_commands.command(name="untrackuser", description="No longer track a user")
@app_commands.describe(player="The player you're tracking to not track anymore")
async def untrackuser(self, interaction: discord.Interaction, player: str):
try:
data = await self.bot.pool.fetchrow("""
SELECT usernames FROM lina_discord_ptrack
WHERE id = $1
""", interaction.user.id)
except Exception:
log.exception(f"Could not get ptracks of user {interaction.user.id}")
return await interaction.response.send_message(embed=discord.Embed(
title="Error",
description="An error has occurred while processing your request. Please try again.",
color=self.bot.accent_color
), ephemeral=True)
if not data:
return await interaction.response.send_message(embed=discord.Embed(
title="Error",
description="No data from you is in the database yet.",
color=self.bot.accent_color
), ephemeral=True)
if player in data["usernames"]:
try:
await self.bot.pool.execute("""
UPDATE lina_discord_ptrack
SET usernames = array_remove(lina_discord_ptrack.usernames, $1)
WHERE id = $2
""", player, interaction.user.id)
except Exception:
log.exception(f"Could not remove player {player} from {interaction.user.id}")
return await interaction.response.send_message(embed=discord.Embed(
title="Error",
description="An error has occurred while processing your request. Please try again.",
color=self.bot.accent_color
), ephemeral=True)
else:
return await interaction.response.send_message(embed=discord.Embed(
title=f"No longer tracking {player}",
description=f"You are no longer tracking {player}.",
color=self.bot.accent_color
), ephemeral=True)
else:
return await interaction.response.send_message(embed=discord.Embed(
title="Error",
description="You are not currently tracking this player.",
color=self.bot.accent_color
), ephemeral=True)
@app_commands.command(name="usertracks", description="See list of players you're tracking.")
async def usertracks(self, interaction: discord.Interaction):
try:
data = await self.bot.pool.fetchrow("""
SELECT usernames FROM lina_discord_ptrack
WHERE id = $1
""", interaction.user.id)
except Exception:
log.exception(f"Could not get ptracks of user {interaction.user.id}")
return await interaction.response.send_message(embed=discord.Embed(
title="Error",
description="An error has occurred while processing your request. Please try again.",
color=self.bot.accent_color
), ephemeral=True)
noPlayersEmbed = discord.Embed(
title="You aren't tracking any players yet.",
description="To start tracking players, execute `/trackuser username`",
color=self.bot.accent_color
)
if not data:
return await interaction.response.send_message(embed=noPlayersEmbed, ephemeral=True)
else:
if len(data["usernames"]) == 0:
return await interaction.response.send_message(embed=noPlayersEmbed, ephemeral=True)
else:
return await interaction.response.send_message(embed=discord.Embed(
title=f"Players you're currently tracking",
description="\n".join([
f"* {x}" for x in data["usernames"]
]),
color=self.bot.accent_color
).set_footer(text=f"Total: {len(data['usernames'])}"), ephemeral=True)
async def setup(bot: Lina):
await bot.add_cog(PlayerTrack(bot))

107
launch.py Normal file
View file

@ -0,0 +1,107 @@
from bot import Lina
import constants
import asyncio
import asyncpg
import contextlib
import discord
import logging
from logging.handlers import RotatingFileHandler
class RemoveNoise(logging.Filter):
def __init__(self):
super().__init__(name='discord.state')
def filter(self, record: logging.LogRecord) -> bool:
if record.levelname == 'WARNING' and 'referencing an unknown' in record.msg:
return False
return True
@contextlib.contextmanager
def setup_logging():
log = logging.getLogger()
try:
discord.utils.setup_logging()
# __enter__
max_bytes = 32 * 1024 * 1024 # 32 MiB
logging.getLogger('discord').setLevel(logging.INFO)
logging.getLogger('discord.http').setLevel(logging.WARNING)
logging.getLogger('discord.state').addFilter(RemoveNoise())
log.setLevel(logging.INFO)
handler = RotatingFileHandler(filename='lina.log', encoding='utf-8', mode='w', maxBytes=max_bytes, backupCount=5)
dt_fmt = '%Y-%m-%d %H:%M:%S'
fmt = logging.Formatter('[{asctime}] [{levelname:<7}] {name}: {message}', dt_fmt, style='{')
handler.setFormatter(fmt)
log.addHandler(handler)
yield
finally:
# __exit__
handlers = log.handlers[:]
for hdlr in handlers:
hdlr.close()
log.removeHandler(hdlr)
async def createPool() -> asyncpg.Pool:
return await asyncpg.create_pool(
constants.POSTGRESQL,
command_timeout=300,
min_size=20,
max_size=20
)
async def initDatabase(pool: asyncpg.Pool) -> None:
async with pool.acquire() as con:
async with con.transaction():
await con.execute("""
CREATE TABLE IF NOT EXISTS lina_discord_ptrack(
id bigint NOT NULL PRIMARY KEY,
usernames text[]
)
""")
await con.execute("""
CREATE TABLE IF NOT EXISTS lina_discord_stk_seen(
username varchar(30) NOT NULL PRIMARY KEY,
date timestamp without time zone NOT NULL,
server_name varchar(255) NOT NULL,
country varchar(2),
server_country varchar(2)
)
""")
await con.execute("""
CREATE TABLE IF NOT EXISTS lina_discord_addons(
id varchar(255) NOT NULL PRIMARY KEY,
name varchar(255) NOT NULL,
file text NOT NULL,
date int NOT NULL,
uploader varchar(30),
designer varchar(255),
description text,
image text NOT NULL,
format int NOT NULL,
revision int NOT NULL,
status int NOT NULL,
size int NOT NULL,
rating float NOT NULL
)
""")
async def runBot():
log = logging.getLogger()
try:
pool = await createPool()
await initDatabase(pool)
except Exception:
log.exception("Could not set up PostgreSQL pool. Will now exit.")
return
async with Lina() as lina:
lina.pool = pool
await lina.start()
if __name__ == "__main__":
with setup_logging():
asyncio.run(runBot())

3
requirements.txt Normal file
View file

@ -0,0 +1,3 @@
discord.py
asyncpg
git+https://github.com/Rapptz/discord-ext-menus

373
utils/LICENSE.paginator Normal file
View file

@ -0,0 +1,373 @@
Mozilla Public License Version 2.0
==================================
1. Definitions
--------------
1.1. "Contributor"
means each individual or legal entity that creates, contributes to
the creation of, or owns Covered Software.
1.2. "Contributor Version"
means the combination of the Contributions of others (if any) used
by a Contributor and that particular Contributor's Contribution.
1.3. "Contribution"
means Covered Software of a particular Contributor.
1.4. "Covered Software"
means Source Code Form to which the initial Contributor has attached
the notice in Exhibit A, the Executable Form of such Source Code
Form, and Modifications of such Source Code Form, in each case
including portions thereof.
1.5. "Incompatible With Secondary Licenses"
means
(a) that the initial Contributor has attached the notice described
in Exhibit B to the Covered Software; or
(b) that the Covered Software was made available under the terms of
version 1.1 or earlier of the License, but not also under the
terms of a Secondary License.
1.6. "Executable Form"
means any form of the work other than Source Code Form.
1.7. "Larger Work"
means a work that combines Covered Software with other material, in
a separate file or files, that is not Covered Software.
1.8. "License"
means this document.
1.9. "Licensable"
means having the right to grant, to the maximum extent possible,
whether at the time of the initial grant or subsequently, any and
all of the rights conveyed by this License.
1.10. "Modifications"
means any of the following:
(a) any file in Source Code Form that results from an addition to,
deletion from, or modification of the contents of Covered
Software; or
(b) any new file in Source Code Form that contains any Covered
Software.
1.11. "Patent Claims" of a Contributor
means any patent claim(s), including without limitation, method,
process, and apparatus claims, in any patent Licensable by such
Contributor that would be infringed, but for the grant of the
License, by the making, using, selling, offering for sale, having
made, import, or transfer of either its Contributions or its
Contributor Version.
1.12. "Secondary License"
means either the GNU General Public License, Version 2.0, the GNU
Lesser General Public License, Version 2.1, the GNU Affero General
Public License, Version 3.0, or any later versions of those
licenses.
1.13. "Source Code Form"
means the form of the work preferred for making modifications.
1.14. "You" (or "Your")
means an individual or a legal entity exercising rights under this
License. For legal entities, "You" includes any entity that
controls, is controlled by, or is under common control with You. For
purposes of this definition, "control" means (a) the power, direct
or indirect, to cause the direction or management of such entity,
whether by contract or otherwise, or (b) ownership of more than
fifty percent (50%) of the outstanding shares or beneficial
ownership of such entity.
2. License Grants and Conditions
--------------------------------
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
(a) under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
(b) under Patent Claims of such Contributor to make, use, sell, offer
for sale, have made, import, and otherwise transfer either its
Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:
(a) for any code that a Contributor has removed from Covered Software;
or
(b) for infringements caused by: (i) Your and any other third party's
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
(c) under Patent Claims infringed by Covered Software in the absence of
its Contributions.
This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights
to grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
in Section 2.1.
3. Responsibilities
-------------------
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
(a) such Covered Software must also be made available in Source Code
Form, as described in Section 3.1, and You must inform recipients of
the Executable Form how they can obtain a copy of such Source Code
Form by reasonable means in a timely manner, at a charge no more
than the cost of distribution to the recipient; and
(b) You may distribute such Executable Form under the terms of this
License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter
the recipients' rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
3.4. Notices
You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty,
or limitations of liability) contained within the Source Code Form of
the Covered Software, except that You may alter any license notices to
the extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
---------------------------------------------------
If it is impossible for You to comply with any of the terms of this
License with respect to some or all of the Covered Software due to
statute, judicial order, or regulation then You must: (a) comply with
the terms of this License to the maximum extent possible; and (b)
describe the limitations and the code they affect. Such description must
be placed in a text file included with all distributions of the Covered
Software under this License. Except to the extent prohibited by statute
or regulation, such description must be sufficiently detailed for a
recipient of ordinary skill to be able to understand it.
5. Termination
--------------
5.1. The rights granted under this License will terminate automatically
if You fail to comply with any of its terms. However, if You become
compliant, then the rights granted under this License from a particular
Contributor are reinstated (a) provisionally, unless and until such
Contributor explicitly and finally terminates Your grants, and (b) on an
ongoing basis, if such Contributor fails to notify You of the
non-compliance by some reasonable means prior to 60 days after You have
come back into compliance. Moreover, Your grants from a particular
Contributor are reinstated on an ongoing basis if such Contributor
notifies You of the non-compliance by some reasonable means, this is the
first time You have received notice of non-compliance with this License
from such Contributor, and You become compliant prior to 30 days after
Your receipt of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
end user license agreements (excluding distributors and resellers) which
have been validly granted by You or Your distributors under this License
prior to termination shall survive termination.
************************************************************************
* *
* 6. Disclaimer of Warranty *
* ------------------------- *
* *
* Covered Software is provided under this License on an "as is" *
* basis, without warranty of any kind, either expressed, implied, or *
* statutory, including, without limitation, warranties that the *
* Covered Software is free of defects, merchantable, fit for a *
* particular purpose or non-infringing. The entire risk as to the *
* quality and performance of the Covered Software is with You. *
* Should any Covered Software prove defective in any respect, You *
* (not any Contributor) assume the cost of any necessary servicing, *
* repair, or correction. This disclaimer of warranty constitutes an *
* essential part of this License. No use of any Covered Software is *
* authorized under this License except under this disclaimer. *
* *
************************************************************************
************************************************************************
* *
* 7. Limitation of Liability *
* -------------------------- *
* *
* Under no circumstances and under no legal theory, whether tort *
* (including negligence), contract, or otherwise, shall any *
* Contributor, or anyone who distributes Covered Software as *
* permitted above, be liable to You for any direct, indirect, *
* special, incidental, or consequential damages of any character *
* including, without limitation, damages for lost profits, loss of *
* goodwill, work stoppage, computer failure or malfunction, or any *
* and all other commercial damages or losses, even if such party *
* shall have been informed of the possibility of such damages. This *
* limitation of liability shall not apply to liability for death or *
* personal injury resulting from such party's negligence to the *
* extent applicable law prohibits such limitation. Some *
* jurisdictions do not allow the exclusion or limitation of *
* incidental or consequential damages, so this exclusion and *
* limitation may not apply to You. *
* *
************************************************************************
8. Litigation
-------------
Any litigation relating to this License may be brought only in the
courts of a jurisdiction where the defendant maintains its principal
place of business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions.
Nothing in this Section shall prevent a party's ability to bring
cross-claims or counter-claims.
9. Miscellaneous
----------------
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides
that the language of a contract shall be construed against the drafter
shall not be used to construe this License against a Contributor.
10. Versions of the License
---------------------------
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses
If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
-------------------------------------------
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to look
for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
---------------------------------------------------------
This Source Code Form is "Incompatible With Secondary Licenses", as
defined by the Mozilla Public License, v. 2.0.

2
utils/__init__.py Normal file
View file

@ -0,0 +1,2 @@
from .bigip import bigip
from .flagconverter import flagconverter

2
utils/bigip.py Normal file
View file

@ -0,0 +1,2 @@
def bigip(x):
return '.'.join([str(y) for y in int.to_bytes(int(x), 4, 'big')])

5
utils/flagconverter.py Normal file
View file

@ -0,0 +1,5 @@
def flagconverter(code: str):
if code == 'None':
return ''
res = f"{''.join(chr(127397 + ord(str.upper(k))) for k in code)}"
return res

59
utils/formatting.py Normal file
View file

@ -0,0 +1,59 @@
import datetime
from typing import Optional, SupportsInt
def humanize_timedelta(
*, timedelta: Optional[datetime.timedelta] = None, seconds: Optional[SupportsInt] = None
) -> str:
"""
Get a locale aware human timedelta representation.
This works with either a timedelta object or a number of seconds.
Fractional values will be omitted, and values less than 1 second
an empty string.
Parameters
----------
timedelta: Optional[datetime.timedelta]
A timedelta object
seconds: Optional[SupportsInt]
A number of seconds
Returns
-------
str
A locale aware representation of the timedelta or seconds.
Raises
------
ValueError
The function was called with neither a number of seconds nor a timedelta object
"""
try:
obj = seconds if seconds is not None else timedelta.total_seconds()
except AttributeError:
raise ValueError("You must provide either a timedelta or a number of seconds")
seconds = int(obj)
periods = [
("year", "years", 60 * 60 * 24 * 365),
("month", "months", 60 * 60 * 24 * 30),
("day", "days", 60 * 60 * 24),
("hour", "hours", 60 * 60),
("minute", "minutes", 60),
("second", "seconds", 1),
]
strings = []
for period_name, plural_period_name, period_seconds in periods:
if seconds >= period_seconds:
period_value, seconds = divmod(seconds, period_seconds)
if period_value == 0:
continue
unit = plural_period_name if period_value > 1 else period_name
strings.append(f"{period_value} {unit}")
return ", ".join(strings)

288
utils/paginator.py Normal file
View file

@ -0,0 +1,288 @@
from __future__ import annotations
import asyncio
from typing import TYPE_CHECKING, Any, Dict, Optional
import discord
import traceback
from discord.ext import commands
from discord.ext.commands import Paginator as CommandPaginator
from discord.ext import menus
class NumberedPageModal(discord.ui.Modal, title='Go to page'):
page = discord.ui.TextInput(label='Page', placeholder='Enter a number', min_length=1)
def __init__(self, max_pages: Optional[int]) -> None:
super().__init__()
if max_pages is not None:
as_string = str(max_pages)
self.page.placeholder = f'Enter a number between 1 and {as_string}'
self.page.max_length = len(as_string)
async def on_submit(self, interaction: discord.Interaction) -> None:
self.interaction = interaction
self.stop()
class RoboPages(discord.ui.View):
def __init__(
self,
source: menus.PageSource,
*,
ctx: commands.Context,
check_embeds: bool = True,
compact: bool = False,
):
super().__init__()
self.source: menus.PageSource = source
self.check_embeds: bool = check_embeds
self.ctx: commands.Context = ctx
self.message: Optional[discord.Message] = None
self.current_page: int = 0
self.compact: bool = compact
self.clear_items()
self.fill_items()
def fill_items(self) -> None:
if not self.compact:
self.numbered_page.row = 1
self.stop_pages.row = 1
if self.source.is_paginating():
max_pages = self.source.get_max_pages()
use_last_and_first = max_pages is not None and max_pages >= 2
if use_last_and_first:
self.add_item(self.go_to_first_page)
self.add_item(self.go_to_previous_page)
if not self.compact:
self.add_item(self.go_to_current_page)
self.add_item(self.go_to_next_page)
if use_last_and_first:
self.add_item(self.go_to_last_page)
if not self.compact:
self.add_item(self.numbered_page)
self.add_item(self.stop_pages)
async def _get_kwargs_from_page(self, page: int) -> Dict[str, Any]:
value = await discord.utils.maybe_coroutine(self.source.format_page, self, page)
if isinstance(value, dict):
return value
elif isinstance(value, str):
return {'content': value, 'embed': None}
elif isinstance(value, discord.Embed):
return {'embed': value, 'content': None}
else:
return {}
async def show_page(self, interaction: discord.Interaction, page_number: int) -> None:
page = await self.source.get_page(page_number)
self.current_page = page_number
kwargs = await self._get_kwargs_from_page(page)
self._update_labels(page_number)
if kwargs:
if interaction.response.is_done():
if self.message:
await self.message.edit(**kwargs, view=self)
else:
await interaction.response.edit_message(**kwargs, view=self)
def _update_labels(self, page_number: int) -> None:
self.go_to_first_page.disabled = page_number == 0
if self.compact:
max_pages = self.source.get_max_pages()
self.go_to_last_page.disabled = max_pages is None or (page_number + 1) >= max_pages
self.go_to_next_page.disabled = max_pages is not None and (page_number + 1) >= max_pages
self.go_to_previous_page.disabled = page_number == 0
return
self.go_to_current_page.label = str(page_number + 1)
self.go_to_previous_page.label = str(page_number)
self.go_to_next_page.label = str(page_number + 2)
self.go_to_next_page.disabled = False
self.go_to_previous_page.disabled = False
self.go_to_first_page.disabled = False
max_pages = self.source.get_max_pages()
if max_pages is not None:
self.go_to_last_page.disabled = (page_number + 1) >= max_pages
if (page_number + 1) >= max_pages:
self.go_to_next_page.disabled = True
self.go_to_next_page.label = '…'
if page_number == 0:
self.go_to_previous_page.disabled = True
self.go_to_previous_page.label = '…'
async def show_checked_page(self, interaction: discord.Interaction, page_number: int) -> None:
max_pages = self.source.get_max_pages()
try:
if max_pages is None:
# If it doesn't give maximum pages, it cannot be checked
await self.show_page(interaction, page_number)
elif max_pages > page_number >= 0:
await self.show_page(interaction, page_number)
except IndexError:
# An error happened that can be handled, so ignore it.
pass
async def interaction_check(self, interaction: discord.Interaction) -> bool:
if interaction.user and interaction.user.id in (self.ctx.bot.owner_id, self.ctx.author.id):
return True
await interaction.response.send_message('This pagination menu cannot be controlled by you, sorry!', ephemeral=True)
return False
async def on_timeout(self) -> None:
if self.message:
await self.message.edit(view=None)
async def on_error(self, interaction: discord.Interaction, error: Exception, item: discord.ui.Item) -> None:
if interaction.response.is_done():
await interaction.followup.send('An unknown error occurred, sorry', ephemeral=True)
else:
await interaction.response.send_message('An unknown error occurred, sorry', ephemeral=True)
async def start(self, *, content: Optional[str] = None, ephemeral: bool = False) -> None:
if self.check_embeds and not self.ctx.channel.permissions_for(self.ctx.me).embed_links: # type: ignore
await self.ctx.send('Bot does not have embed links permission in this channel.', ephemeral=True)
return
await self.source._prepare_once()
page = await self.source.get_page(0)
kwargs = await self._get_kwargs_from_page(page)
if content:
kwargs.setdefault('content', content)
self._update_labels(0)
self.message = await self.ctx.send(**kwargs, view=self, ephemeral=ephemeral)
@discord.ui.button(label='≪', style=discord.ButtonStyle.grey)
async def go_to_first_page(self, interaction: discord.Interaction, button: discord.ui.Button):
"""go to the first page"""
await self.show_page(interaction, 0)
@discord.ui.button(label='Back', style=discord.ButtonStyle.blurple)
async def go_to_previous_page(self, interaction: discord.Interaction, button: discord.ui.Button):
"""go to the previous page"""
await self.show_checked_page(interaction, self.current_page - 1)
@discord.ui.button(label='Current', style=discord.ButtonStyle.grey, disabled=True)
async def go_to_current_page(self, interaction: discord.Interaction, button: discord.ui.Button):
pass
@discord.ui.button(label='Next', style=discord.ButtonStyle.blurple)
async def go_to_next_page(self, interaction: discord.Interaction, button: discord.ui.Button):
"""go to the next page"""
await self.show_checked_page(interaction, self.current_page + 1)
@discord.ui.button(label='≫', style=discord.ButtonStyle.grey)
async def go_to_last_page(self, interaction: discord.Interaction, button: discord.ui.Button):
"""go to the last page"""
# The call here is safe because it's guarded by skip_if
await self.show_page(interaction, self.source.get_max_pages() - 1) # type: ignore
@discord.ui.button(label='Skip to page...', style=discord.ButtonStyle.grey)
async def numbered_page(self, interaction: discord.Interaction, button: discord.ui.Button):
"""lets you type a page number to go to"""
if self.message is None:
return
modal = NumberedPageModal(self.source.get_max_pages())
await interaction.response.send_modal(modal)
timed_out = await modal.wait()
if timed_out:
await interaction.followup.send('Took too long', ephemeral=True)
return
elif self.is_finished():
await modal.interaction.response.send_message('Took too long', ephemeral=True)
return
value = str(modal.page.value)
if not value.isdigit():
await modal.interaction.response.send_message(f'Expected a number not {value!r}', ephemeral=True)
return
value = int(value)
await self.show_checked_page(modal.interaction, value - 1)
if not modal.interaction.response.is_done():
error = modal.page.placeholder.replace('Enter', 'Expected') # type: ignore # Can't be None
await modal.interaction.response.send_message(error, ephemeral=True)
@discord.ui.button(label='Quit', style=discord.ButtonStyle.red)
async def stop_pages(self, interaction: discord.Interaction, button: discord.ui.Button):
"""stops the pagination session."""
await interaction.response.defer()
await interaction.delete_original_response()
self.stop()
class FieldPageSource(menus.ListPageSource):
"""A page source that requires (field_name, field_value) tuple items."""
def __init__(
self,
entries: list[tuple[Any, Any]],
*,
per_page: int = 12,
inline: bool = False,
clear_description: bool = True,
) -> None:
super().__init__(entries, per_page=per_page)
self.embed: discord.Embed = discord.Embed(colour=discord.Colour.blurple())
self.clear_description: bool = clear_description
self.inline: bool = inline
async def format_page(self, menu: RoboPages, entries: list[tuple[Any, Any]]) -> discord.Embed:
self.embed.clear_fields()
if self.clear_description:
self.embed.description = None
for key, value in entries:
self.embed.add_field(name=key, value=value, inline=self.inline)
maximum = self.get_max_pages()
if maximum > 1:
text = f'Page {menu.current_page + 1}/{maximum} ({len(self.entries)} entries)'
self.embed.set_footer(text=text)
return self.embed
class TextPageSource(menus.ListPageSource):
def __init__(self, text, *, prefix='```', suffix='```', max_size=2000):
pages = CommandPaginator(prefix=prefix, suffix=suffix, max_size=max_size - 200)
for line in text.split('\n'):
pages.add_line(line)
super().__init__(entries=pages.pages, per_page=1)
async def format_page(self, menu, content):
maximum = self.get_max_pages()
if maximum > 1:
return f'{content}\nPage {menu.current_page + 1}/{maximum}'
return content
class SimplePageSource(menus.ListPageSource):
async def format_page(self, menu, entries):
pages = []
for index, entry in enumerate(entries, start=menu.current_page * self.per_page):
pages.append(f'{index + 1}. {entry}')
maximum = self.get_max_pages()
if maximum > 1:
footer = f'Page {menu.current_page + 1}/{maximum} ({len(self.entries)} entries)'
menu.embed.set_footer(text=footer)
menu.embed.description = '\n'.join(pages)
return menu.embed
class SimplePages(RoboPages):
"""A simple pagination session reminiscent of the old Pages interface.
Basically an embed with some normal formatting.
"""
def __init__(self, entries, *, ctx: Context, per_page: int = 12):
super().__init__(SimplePageSource(entries, per_page=per_page), ctx=ctx)
self.embed = discord.Embed(colour=discord.Colour.blurple())