Compare commits
3 Commits
331599eb38
...
cebb1b0123
Author | SHA1 | Date |
---|---|---|
Romain J | cebb1b0123 | |
Romain J | e0788137ff | |
Romain J | d68d54be44 |
|
@ -2,7 +2,30 @@ __pycache__/
|
|||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
.idea/workspace.xml
|
||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
|
||||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||
|
||||
# User-specific stuff
|
||||
.idea/**/workspace.xml
|
||||
.idea/**/tasks.xml
|
||||
.idea/**/usage.statistics.xml
|
||||
.idea/**/dictionaries
|
||||
.idea/**/shelf
|
||||
|
||||
# Generated files
|
||||
.idea/**/contentModel.xml
|
||||
|
||||
# Sensitive or high-churn files
|
||||
.idea/**/dataSources/
|
||||
.idea/**/dataSources.ids
|
||||
.idea/**/dataSources.local.xml
|
||||
.idea/**/sqlDataSources.xml
|
||||
.idea/**/dynamic.xml
|
||||
.idea/**/uiDesigner.xml
|
||||
.idea/**/dbnavigator.xml
|
||||
|
||||
|
||||
.idea/sonarlint/
|
||||
|
||||
*.log
|
||||
|
||||
|
|
|
@ -1,19 +1,27 @@
|
|||
<component name="ProjectDictionaryState">
|
||||
<dictionary name="romain">
|
||||
<words>
|
||||
<w>anglais</w>
|
||||
<w>appdirs</w>
|
||||
<w>asctime</w>
|
||||
<w>commandstats</w>
|
||||
<w>francais</w>
|
||||
<w>français</w>
|
||||
<w>gnous</w>
|
||||
<w>ipinfo</w>
|
||||
<w>iplocalise</w>
|
||||
<w>jishaku</w>
|
||||
<w>levelname</w>
|
||||
<w>localiseip</w>
|
||||
<w>postgresql</w>
|
||||
<w>pred</w>
|
||||
<w>pylint</w>
|
||||
<w>releaselevel</w>
|
||||
<w>rprint</w>
|
||||
<w>socketstats</w>
|
||||
<w>splt</w>
|
||||
<w>systemd</w>
|
||||
<w>tldr</w>
|
||||
<w>tutux</w>
|
||||
<w>tuxbot</w>
|
||||
<w>tuxbot's</w>
|
||||
|
|
|
@ -0,0 +1,11 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="Statistic">
|
||||
<option name="excludedDirectories">
|
||||
<list>
|
||||
<option value="$PROJECT_DIR$/Tuxbot_bot.egg-info" />
|
||||
<option value="$PROJECT_DIR$/venv" />
|
||||
</list>
|
||||
</option>
|
||||
</component>
|
||||
</project>
|
|
@ -0,0 +1,13 @@
|
|||
[BASIC]
|
||||
good-names=
|
||||
e, # (exception) as e
|
||||
f, # (file) as f
|
||||
|
||||
[MASTER]
|
||||
disable=
|
||||
C0114, # missing-module-docstring
|
||||
C0115, # missing-class-docstring
|
||||
C0116, # missing-function-docstring
|
||||
W0703, # broad-except
|
||||
R0902, # too-many-instance-attributes
|
||||
R0903, # too-few-public-methods
|
|
@ -1,35 +1,35 @@
|
|||
GNU Affero General Public License
|
||||
=================================
|
||||
_Copyright © 2017-2020 GnousEU Developper Team, <<http://gnous.eu/>>_
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
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
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
|
@ -39,7 +39,7 @@ 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
|
||||
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
|
||||
|
@ -47,79 +47,79 @@ 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
|
||||
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
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
## TERMS AND CONDITIONS
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
### 0. Definitions
|
||||
0. Definitions.
|
||||
|
||||
“This License” refers to version 3 of the GNU Affero General Public License.
|
||||
"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
|
||||
"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.
|
||||
"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
|
||||
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.
|
||||
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
|
||||
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
|
||||
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
|
||||
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”
|
||||
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)**
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
"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 "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
|
||||
|
@ -132,16 +132,16 @@ 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
|
||||
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
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
### 2. Basic Permissions
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
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
|
||||
|
@ -149,7 +149,7 @@ 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
|
||||
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
|
||||
|
@ -160,19 +160,19 @@ 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
|
||||
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
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
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
|
||||
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
|
||||
|
@ -180,9 +180,9 @@ 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
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
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
|
||||
|
@ -190,97 +190,104 @@ 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,
|
||||
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
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
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) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
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
|
||||
"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
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
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) 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.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
|
@ -288,7 +295,7 @@ 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,
|
||||
"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
|
||||
|
@ -296,7 +303,7 @@ 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
|
||||
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
|
||||
|
@ -307,7 +314,7 @@ 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
|
||||
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
|
||||
|
@ -315,15 +322,15 @@ 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,
|
||||
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
|
||||
7. Additional Terms.
|
||||
|
||||
“Additional permissions” are terms that supplement the terms of this
|
||||
"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
|
||||
|
@ -332,37 +339,42 @@ 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
|
||||
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
|
||||
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.
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
All other non-permissive additional terms are considered “further
|
||||
restrictions” within the meaning of section 10. If the Program as you
|
||||
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
|
||||
|
@ -371,46 +383,46 @@ 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
|
||||
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
|
||||
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
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
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)**
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
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,
|
||||
|
@ -419,14 +431,14 @@ 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
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
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
|
||||
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
|
||||
|
@ -436,7 +448,7 @@ 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
|
||||
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
|
||||
|
@ -444,49 +456,49 @@ rights granted under this License, and you may not initiate litigation
|
|||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
### 11. Patents
|
||||
11. Patents.
|
||||
|
||||
A “contributor” is a copyright holder who authorizes use under this
|
||||
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”.
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's “essential patent claims” are all patent claims
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
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,
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
|
@ -494,7 +506,7 @@ 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
|
||||
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
|
||||
|
@ -503,19 +515,19 @@ 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
|
||||
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
|
||||
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
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
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
|
||||
|
@ -525,9 +537,9 @@ 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
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
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
|
||||
|
@ -538,7 +550,7 @@ 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
|
||||
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
|
||||
|
@ -546,46 +558,46 @@ 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
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
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
|
||||
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
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
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
|
||||
|
@ -595,11 +607,55 @@ 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
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
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.
|
||||
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/>.
|
2
Makefile
2
Makefile
|
@ -14,7 +14,7 @@ update:
|
|||
|
||||
# Blackify code
|
||||
reformat:
|
||||
$(PYTHON) -m black `git ls-files "*.py"`
|
||||
$(PYTHON) -m black `git ls-files "*.py"` --line-length=79 && pylint tuxbot
|
||||
|
||||
# Translations
|
||||
xgettext:
|
||||
|
|
76
README.md
76
README.md
|
@ -1,76 +0,0 @@
|
|||
![](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-%23007ec6)
|
||||
![](https://img.shields.io/badge/dynamic/json?color=%23dfb317&label=issues&query=%24.open_issues_count&suffix=%20open&url=https%3A%2F%2Fgit.gnous.eu%2Fapi%2Fv1%2Frepos%2FGnousEU%2Ftuxbot-bot%2F)
|
||||
|
||||
# Installing Tuxbot
|
||||
|
||||
It is preferable to install the bot on a dedicated user. If you don't know how to do it, please refer to [this guide](https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart)
|
||||
|
||||
## Installing the pre-requirements
|
||||
|
||||
- The pre-requirements are:
|
||||
- Python 3.7 or greater
|
||||
- Pip
|
||||
- Git
|
||||
|
||||
### Operating systems
|
||||
|
||||
-----
|
||||
|
||||
### Arch Linux
|
||||
|
||||
```shell script
|
||||
sudo pacman -Syu python python-pip python-virtualenv git
|
||||
```
|
||||
|
||||
Continue to [create the venv](#creating-the-virtual-environnement).
|
||||
|
||||
-----
|
||||
|
||||
#### Debian
|
||||
|
||||
```shell script
|
||||
sudo apt update
|
||||
sudo apt -y install python3 python3-dev python3-pip python3-venv git
|
||||
```
|
||||
|
||||
Continue to [create the venv](#creating-the-virtual-environnement).
|
||||
|
||||
-----
|
||||
|
||||
#### Windows
|
||||
|
||||
*not for now and not for the future*
|
||||
|
||||
|
||||
## Creating the Virtual Environment
|
||||
|
||||
To set up the virtual environment and install the bot, simply run this two commands:
|
||||
|
||||
```shell script
|
||||
make
|
||||
make install
|
||||
```
|
||||
|
||||
Now, switch your environment to the virtual one by run this single command:
|
||||
```shell script
|
||||
source ~/tuxvenv/bin/activate
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
It's time to set up your first instance, to do this, you can simply execute this command:
|
||||
|
||||
```shell script
|
||||
tuxbot-setup [your instance name]
|
||||
```
|
||||
|
||||
After following the instructions, you can run your instance by executing this command:
|
||||
|
||||
```shell script
|
||||
tuxbot [your instance name]
|
||||
```
|
||||
|
||||
|
||||
## Update
|
||||
|
||||
*todo*
|
|
@ -0,0 +1,89 @@
|
|||
|image0| |image1|
|
||||
|
||||
.. role:: bash(code)
|
||||
:language: bash
|
||||
|
||||
Installing Tuxbot
|
||||
=================
|
||||
|
||||
It is preferable to install the bot on a dedicated user. If you don't
|
||||
know how to do it, please refer to `this guide <https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart>`__
|
||||
|
||||
Installing the pre-requirements
|
||||
-------------------------------
|
||||
|
||||
- The pre-requirements are:
|
||||
|
||||
- Python 3.7 or greater
|
||||
- Pip
|
||||
- Git
|
||||
|
||||
Operating systems
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
Arch Linux
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ sudo pacman -Syu python python-pip python-virtualenv git
|
||||
|
||||
Continue to `create the venv <#creating-the-virtual-environnement>`__.
|
||||
|
||||
--------------
|
||||
|
||||
Debian
|
||||
^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ sudo apt update
|
||||
$ sudo apt -y install python3 python3-dev python3-pip python3-venv git
|
||||
|
||||
Continue to `create the venv <#creating-the-virtual-environnement>`__.
|
||||
|
||||
--------------
|
||||
|
||||
Windows
|
||||
^^^^^^^
|
||||
|
||||
*not for now and not for the future*
|
||||
|
||||
Creating the Virtual Environment
|
||||
--------------------------------
|
||||
|
||||
To set up the virtual environment and install the bot, simply run this
|
||||
two commands:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ make
|
||||
$ make install
|
||||
|
||||
Now, switch your environment to the virtual one by run this single
|
||||
command: :bash:`source ~/tuxvenv/bin/activate`
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
It's time to set up your first instance, to do this, you can simply
|
||||
execute this command:
|
||||
|
||||
:bash:`tuxbot-setup [your instance name]`
|
||||
|
||||
After following the instructions, you can run your instance by executing
|
||||
this command:
|
||||
|
||||
:bash:`tuxbot [your instance name]`
|
||||
|
||||
Update
|
||||
------
|
||||
|
||||
To update the whole bot after a :bash:`git pull`, just execute
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ make update
|
||||
|
||||
.. |image0| image:: https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-%23007ec6
|
||||
.. |image1| image:: https://img.shields.io/badge/dynamic/json?color=%23dfb317&label=issues&query=%24.open_issues_count&suffix=%20open&url=https%3A%2F%2Fgit.gnous.eu%2Fapi%2Fv1%2Frepos%2FGnousEU%2Ftuxbot-bot%2F
|
62
setup.cfg
62
setup.cfg
|
@ -1,57 +1,31 @@
|
|||
[metadata]
|
||||
name = Tuxbot-bot
|
||||
version = attr: tuxbot.__version__
|
||||
description = A bot made for GnousEU and OpenSource
|
||||
url = https://git.gnous.eu/gnouseu/tuxbot-bot/
|
||||
author = Romain J.
|
||||
author_email = romain@gnous.eu
|
||||
url = https://git.gnous.eu/gnouseu/tuxbot-bot/
|
||||
maintainer = Romain J.
|
||||
maintainer_email = romain@gnous.eu
|
||||
description = A discord bot made for GnousEU's guild and OpenSource
|
||||
long_description = file: README.rst
|
||||
license = agplv3
|
||||
platforms = linux
|
||||
|
||||
[options]
|
||||
packages = find_namespace:
|
||||
python_requires = >=3.7
|
||||
install_requires =
|
||||
aiohttp==3.6.2
|
||||
aiosqlite==0.13.0
|
||||
appdirs==1.4.4
|
||||
astunparse==1.6.3
|
||||
async-timeout==3.0.1
|
||||
asyncpg==0.20.1
|
||||
attrs==19.3.0
|
||||
babel==2.8.0
|
||||
black==19.10b0
|
||||
braceexpand==0.1.5
|
||||
cachetools==4.1.0
|
||||
certifi==2020.4.5.1
|
||||
chardet==3.0.4
|
||||
ciso8601==2.1.3
|
||||
colorama==0.4.3
|
||||
discord-flags==2.1.1
|
||||
discord.py==1.3.4
|
||||
dnspython==1.16.0
|
||||
flatten-dict==0.3.0
|
||||
humanize==2.4.0
|
||||
idna==2.9
|
||||
import-expression==1.1.3
|
||||
ipinfo==3.0.0
|
||||
ipwhois==1.1.0
|
||||
iso8601==0.1.12
|
||||
jishaku==1.18.2.188
|
||||
multidict==4.7.6
|
||||
pathspec<1,>=0.6
|
||||
psutil==5.7.0
|
||||
PyPika==0.37.7
|
||||
pytz==2020.1
|
||||
regex==2020.6.7
|
||||
requests==2.23.0
|
||||
rich==6.0.0
|
||||
six==1.15.0
|
||||
toml>=0.9.4
|
||||
tortoise-orm==0.16.13
|
||||
typed-ast>=1.4.0
|
||||
typing-extensions==3.7.4.2
|
||||
urllib3==1.25.9
|
||||
wheel==0.34.2
|
||||
yarl==1.4.2
|
||||
appdirs>=1.4.4
|
||||
Babel>=2.8.0
|
||||
black==1.4.4
|
||||
discord.py==1.5.0
|
||||
discord_flags==2.1.1
|
||||
humanize==2.6.0
|
||||
jishaku>=1.19.1.200
|
||||
psutil>=5.7.2
|
||||
pyyaml>=5.3.1
|
||||
rich>=6.0.0
|
||||
structured_config>=4.12
|
||||
|
||||
[options.entry_points]
|
||||
console_scripts =
|
||||
|
|
|
@ -1,15 +1,14 @@
|
|||
import os
|
||||
from collections import namedtuple
|
||||
|
||||
build = os.popen('git rev-parse --short HEAD').read().strip()
|
||||
build = os.popen("git rev-parse --short HEAD").read().strip()
|
||||
info = os.popen('git log -n 1 -s --format="%s"').read().strip()
|
||||
|
||||
VersionInfo = namedtuple(
|
||||
"VersionInfo", "major minor micro releaselevel build, info"
|
||||
)
|
||||
version_info = VersionInfo(
|
||||
major=3, minor=0, micro=0,
|
||||
releaselevel="alpha", build=build, info=info
|
||||
major=3, minor=0, micro=0, releaselevel="alpha", build=build, info=info
|
||||
)
|
||||
|
||||
__version__ = "v{}.{}.{}-{}.{}".format(
|
||||
|
|
|
@ -1,318 +1,28 @@
|
|||
import argparse
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
import signal
|
||||
import sys
|
||||
import os
|
||||
from argparse import Namespace
|
||||
from typing import NoReturn
|
||||
|
||||
import discord
|
||||
import pip
|
||||
import tracemalloc
|
||||
from rich.columns import Columns
|
||||
from rich.console import Console
|
||||
from rich.panel import Panel
|
||||
from rich.traceback import install
|
||||
from rich.table import Table, box
|
||||
from rich.text import Text
|
||||
from rich import print
|
||||
|
||||
import tuxbot.logging
|
||||
from tuxbot.core import data_manager
|
||||
from tuxbot.core.bot import Tux
|
||||
from . import __version__, version_info, ExitCodes
|
||||
|
||||
log = logging.getLogger("tuxbot.main")
|
||||
from tuxbot import ExitCodes
|
||||
|
||||
console = Console()
|
||||
install(console=console)
|
||||
tracemalloc.start()
|
||||
|
||||
|
||||
def list_instances() -> NoReturn:
|
||||
"""List all available instances
|
||||
|
||||
"""
|
||||
with data_manager.config_file.open() as fs:
|
||||
data = json.load(fs)
|
||||
|
||||
console.print(
|
||||
Panel("[bold green]Instances", style="green"),
|
||||
justify="center"
|
||||
)
|
||||
console.print()
|
||||
|
||||
columns = Columns(expand=True, padding=2, align="center")
|
||||
for instance, details in data.items():
|
||||
is_running = details.get('IS_RUNNING')
|
||||
|
||||
table = Table(
|
||||
style="dim", border_style="not dim",
|
||||
box=box.HEAVY_HEAD
|
||||
)
|
||||
table.add_column("Name")
|
||||
table.add_column(("Running" if is_running else "Down") + " since")
|
||||
table.add_row(instance, "42")
|
||||
table.title = Text(
|
||||
instance,
|
||||
style="green" if is_running else "red"
|
||||
)
|
||||
columns.add_renderable(table)
|
||||
console.print(columns)
|
||||
console.print()
|
||||
|
||||
sys.exit(os.EX_OK)
|
||||
|
||||
|
||||
def debug_info() -> NoReturn:
|
||||
"""Show debug info relatives to the bot
|
||||
|
||||
"""
|
||||
python_version = sys.version.replace("\n", "")
|
||||
pip_version = pip.__version__
|
||||
tuxbot_version = __version__
|
||||
dpy_version = discord.__version__
|
||||
|
||||
uptime = os.popen('uptime').read().strip().split()
|
||||
|
||||
console.print(
|
||||
Panel("[bold blue]Debug Info", style="blue"),
|
||||
justify="center"
|
||||
)
|
||||
console.print()
|
||||
|
||||
columns = Columns(expand=True, padding=2, align="center")
|
||||
|
||||
table = Table(
|
||||
style="dim", border_style="not dim",
|
||||
box=box.HEAVY_HEAD
|
||||
)
|
||||
table.add_column(
|
||||
"Bot Info",
|
||||
)
|
||||
table.add_row(f"[u]Tuxbot version:[/u] {tuxbot_version}")
|
||||
table.add_row(f"[u]Major:[/u] {version_info.major}")
|
||||
table.add_row(f"[u]Minor:[/u] {version_info.minor}")
|
||||
table.add_row(f"[u]Micro:[/u] {version_info.micro}")
|
||||
table.add_row(f"[u]Level:[/u] {version_info.releaselevel}")
|
||||
table.add_row(f"[u]Last change:[/u] {version_info.info}")
|
||||
columns.add_renderable(table)
|
||||
|
||||
table = Table(
|
||||
style="dim", border_style="not dim",
|
||||
box=box.HEAVY_HEAD
|
||||
)
|
||||
table.add_column(
|
||||
"Python Info",
|
||||
)
|
||||
table.add_row(f"[u]Python version:[/u] {python_version}")
|
||||
table.add_row(f"[u]Python executable path:[/u] {sys.executable}")
|
||||
table.add_row(f"[u]Pip version:[/u] {pip_version}")
|
||||
table.add_row(f"[u]Discord.py version:[/u] {dpy_version}")
|
||||
columns.add_renderable(table)
|
||||
|
||||
table = Table(
|
||||
style="dim", border_style="not dim",
|
||||
box=box.HEAVY_HEAD
|
||||
)
|
||||
table.add_column(
|
||||
"Server Info",
|
||||
)
|
||||
table.add_row(f"[u]System:[/u] {os.uname().sysname}")
|
||||
table.add_row(f"[u]System arch:[/u] {os.uname().machine}")
|
||||
table.add_row(f"[u]Kernel:[/u] {os.uname().release}")
|
||||
table.add_row(f"[u]User:[/u] {os.getlogin()}")
|
||||
table.add_row(f"[u]Uptime:[/u] {uptime[2]}")
|
||||
table.add_row(
|
||||
f"[u]Load Average:[/u] {' '.join(map(str, os.getloadavg()))}"
|
||||
)
|
||||
columns.add_renderable(table)
|
||||
|
||||
console.print(columns)
|
||||
console.print()
|
||||
|
||||
sys.exit(os.EX_OK)
|
||||
|
||||
|
||||
def parse_cli_flags(args: list) -> Namespace:
|
||||
"""Parser for cli values.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
args:list
|
||||
Is a list of all passed values.
|
||||
Returns
|
||||
-------
|
||||
Namespace
|
||||
"""
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Tuxbot - OpenSource bot",
|
||||
usage="tuxbot <instance_name> [arguments]",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--version", "-V", action="store_true",
|
||||
help="Show tuxbot's used version"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--debug", action="store_true",
|
||||
help="Show debug information."
|
||||
)
|
||||
parser.add_argument(
|
||||
"--list-instances", "-L", action="store_true",
|
||||
help="List all instance names"
|
||||
)
|
||||
parser.add_argument("--token", "-T", type=str,
|
||||
help="Run Tuxbot with passed token")
|
||||
parser.add_argument(
|
||||
"instance_name",
|
||||
nargs="?",
|
||||
help="Name of the bot instance created during `tuxbot-setup`.",
|
||||
)
|
||||
|
||||
args = parser.parse_args(args)
|
||||
|
||||
return args
|
||||
|
||||
|
||||
async def shutdown_handler(tux: Tux, signal_type, exit_code=None) -> NoReturn:
|
||||
"""Handler when the bot shutdown
|
||||
|
||||
It cancels all running task.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
tux:Tux
|
||||
Object for the bot.
|
||||
signal_type:int, None
|
||||
Exiting signal code.
|
||||
exit_code:None|int
|
||||
Code to show when exiting.
|
||||
"""
|
||||
if signal_type:
|
||||
log.info("%s received. Quitting...", signal_type)
|
||||
elif exit_code is None:
|
||||
log.info("Shutting down from unhandled exception")
|
||||
tux.shutdown_code = ExitCodes.CRITICAL
|
||||
|
||||
if exit_code is not None:
|
||||
tux.shutdown_code = exit_code
|
||||
|
||||
await tux.shutdown()
|
||||
|
||||
|
||||
async def run_bot(tux: Tux, cli_flags: Namespace) -> None:
|
||||
"""This run the bot.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
tux:Tux
|
||||
Object for the bot.
|
||||
cli_flags:Namespace
|
||||
All different flags passed in the console.
|
||||
|
||||
Returns
|
||||
-------
|
||||
None
|
||||
When exiting, this function return None.
|
||||
"""
|
||||
data_path = data_manager.data_path(tux.instance_name)
|
||||
|
||||
tuxbot.logging.init_logging(10, location=data_path / "logs")
|
||||
|
||||
log.debug("====Basic Config====")
|
||||
log.debug("Data Path: %s", data_path)
|
||||
|
||||
if cli_flags.token:
|
||||
token = cli_flags.token
|
||||
else:
|
||||
token = tux.config("core").get("token")
|
||||
|
||||
if not token:
|
||||
log.critical("Token must be set if you want to login.")
|
||||
sys.exit(ExitCodes.CRITICAL)
|
||||
|
||||
try:
|
||||
await tux.load_packages()
|
||||
console.print()
|
||||
await tux.start(token=token, bot=True)
|
||||
except discord.LoginFailure:
|
||||
log.critical("This token appears to be valid.")
|
||||
console.print()
|
||||
console.print(
|
||||
"[prompt.invalid]This token appears to be valid. [i]exiting...[/i]"
|
||||
)
|
||||
sys.exit(ExitCodes.CRITICAL)
|
||||
except Exception as e:
|
||||
raise e
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def main() -> NoReturn:
|
||||
"""Main function
|
||||
|
||||
"""
|
||||
tux = None
|
||||
cli_flags = parse_cli_flags(sys.argv[1:])
|
||||
|
||||
if cli_flags.list_instances:
|
||||
list_instances()
|
||||
elif cli_flags.debug:
|
||||
debug_info()
|
||||
elif cli_flags.version:
|
||||
print(f"Tuxbot V{version_info.major}")
|
||||
print(f"Complete Version: {__version__}")
|
||||
|
||||
sys.exit(os.EX_OK)
|
||||
|
||||
loop = asyncio.new_event_loop()
|
||||
asyncio.set_event_loop(loop)
|
||||
|
||||
try:
|
||||
if not cli_flags.instance_name:
|
||||
console.print(
|
||||
"[red]No instance provided ! "
|
||||
"You can use 'tuxbot -L' to list all available instances"
|
||||
)
|
||||
sys.exit(ExitCodes.CRITICAL)
|
||||
from .__run__ import run # pylint: disable=import-outside-toplevel
|
||||
|
||||
tux = Tux(
|
||||
cli_flags=cli_flags,
|
||||
description="Tuxbot, made from and for OpenSource",
|
||||
dm_help=None,
|
||||
)
|
||||
|
||||
loop.run_until_complete(run_bot(tux, cli_flags))
|
||||
except KeyboardInterrupt:
|
||||
console.print(
|
||||
" [red]Please use <prefix>quit instead of Ctrl+C to Shutdown!"
|
||||
)
|
||||
log.warning("Please use <prefix>quit instead of Ctrl+C to Shutdown!")
|
||||
log.error("Received KeyboardInterrupt")
|
||||
console.print("[i]Trying to shutdown...")
|
||||
if tux is not None:
|
||||
loop.run_until_complete(shutdown_handler(tux, signal.SIGINT))
|
||||
run()
|
||||
except SystemExit as exc:
|
||||
log.info("Shutting down with exit code: %s", exc.code)
|
||||
if tux is not None:
|
||||
loop.run_until_complete(shutdown_handler(tux, None, exc.code))
|
||||
except Exception as exc:
|
||||
console.print_exception()
|
||||
log.exception("Unexpected exception (%s): ", type(exc), exc_info=exc)
|
||||
if tux is not None:
|
||||
loop.run_until_complete(shutdown_handler(tux, None, 1))
|
||||
finally:
|
||||
loop.run_until_complete(loop.shutdown_asyncgens())
|
||||
log.info("Please wait, cleaning up a bit more")
|
||||
loop.run_until_complete(asyncio.sleep(1))
|
||||
asyncio.set_event_loop(None)
|
||||
loop.stop()
|
||||
loop.close()
|
||||
exit_code = ExitCodes.CRITICAL if tux is None else tux.shutdown_code
|
||||
if exc.code == ExitCodes.RESTART:
|
||||
# reimport to load changes
|
||||
from .__run__ import run # pylint: disable=import-outside-toplevel
|
||||
|
||||
sys.exit(exit_code)
|
||||
run()
|
||||
else:
|
||||
raise exc
|
||||
except Exception:
|
||||
console.print_exception()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
|
|
@ -0,0 +1,311 @@
|
|||
import argparse
|
||||
import asyncio
|
||||
import logging
|
||||
import signal
|
||||
import sys
|
||||
import os
|
||||
import tracemalloc
|
||||
from argparse import Namespace
|
||||
from typing import NoReturn
|
||||
from datetime import datetime
|
||||
|
||||
import discord
|
||||
import humanize
|
||||
import pip
|
||||
from rich.columns import Columns
|
||||
from rich.console import Console
|
||||
from rich.panel import Panel
|
||||
from rich.traceback import install
|
||||
from rich.table import Table, box
|
||||
from rich.text import Text
|
||||
from rich import print as rprint
|
||||
|
||||
import tuxbot.logging
|
||||
from tuxbot.core.bot import Tux
|
||||
from tuxbot.core import data_manager
|
||||
from tuxbot.core import config
|
||||
from . import __version__, version_info, ExitCodes
|
||||
|
||||
log = logging.getLogger("tuxbot.main")
|
||||
|
||||
console = Console()
|
||||
install(console=console)
|
||||
tracemalloc.start()
|
||||
|
||||
BORDER_STYLE = "not dim"
|
||||
|
||||
|
||||
def list_instances() -> NoReturn:
|
||||
"""List all available instances"""
|
||||
app_config = config.ConfigFile(
|
||||
data_manager.config_dir / "config.yaml", config.AppConfig
|
||||
).config
|
||||
|
||||
console.print(
|
||||
Panel("[bold green]Instances", style="green"), justify="center"
|
||||
)
|
||||
console.print()
|
||||
|
||||
columns = Columns(expand=True, padding=2, align="center")
|
||||
for instance, details in app_config.instances.items():
|
||||
active = details["active"]
|
||||
last_run = (
|
||||
humanize.naturaltime(
|
||||
datetime.now() - datetime.fromtimestamp(details["last_run"])
|
||||
)
|
||||
or "[i]unknown"
|
||||
)
|
||||
|
||||
table = Table(
|
||||
style="dim", border_style=BORDER_STYLE, box=box.HEAVY_HEAD
|
||||
)
|
||||
table.add_column("Name")
|
||||
table.add_column(("Running since" if active else "Last run"))
|
||||
table.add_row(instance, last_run)
|
||||
table.title = Text(instance, style="green" if active else "red")
|
||||
columns.add_renderable(table)
|
||||
console.print(columns)
|
||||
console.print()
|
||||
|
||||
sys.exit(os.EX_OK)
|
||||
|
||||
|
||||
def debug_info() -> NoReturn:
|
||||
"""Show debug info relatives to the bot"""
|
||||
python_version = sys.version.replace("\n", "")
|
||||
pip_version = pip.__version__
|
||||
tuxbot_version = __version__
|
||||
dpy_version = discord.__version__
|
||||
|
||||
uptime = os.popen("uptime").read().strip().split()
|
||||
|
||||
console.print(
|
||||
Panel("[bold blue]Debug Info", style="blue"), justify="center"
|
||||
)
|
||||
console.print()
|
||||
|
||||
columns = Columns(expand=True, padding=2, align="center")
|
||||
|
||||
table = Table(style="dim", border_style=BORDER_STYLE, box=box.HEAVY_HEAD)
|
||||
table.add_column(
|
||||
"Bot Info",
|
||||
)
|
||||
table.add_row(f"[u]Tuxbot version:[/u] {tuxbot_version}")
|
||||
table.add_row(f"[u]Major:[/u] {version_info.major}")
|
||||
table.add_row(f"[u]Minor:[/u] {version_info.minor}")
|
||||
table.add_row(f"[u]Micro:[/u] {version_info.micro}")
|
||||
table.add_row(f"[u]Level:[/u] {version_info.releaselevel}")
|
||||
table.add_row(f"[u]Last change:[/u] {version_info.info}")
|
||||
columns.add_renderable(table)
|
||||
|
||||
table = Table(style="dim", border_style=BORDER_STYLE, box=box.HEAVY_HEAD)
|
||||
table.add_column(
|
||||
"Python Info",
|
||||
)
|
||||
table.add_row(f"[u]Python version:[/u] {python_version}")
|
||||
table.add_row(f"[u]Python executable path:[/u] {sys.executable}")
|
||||
table.add_row(f"[u]Pip version:[/u] {pip_version}")
|
||||
table.add_row(f"[u]Discord.py version:[/u] {dpy_version}")
|
||||
columns.add_renderable(table)
|
||||
|
||||
table = Table(style="dim", border_style=BORDER_STYLE, box=box.HEAVY_HEAD)
|
||||
table.add_column(
|
||||
"Server Info",
|
||||
)
|
||||
table.add_row(f"[u]System:[/u] {os.uname().sysname}")
|
||||
table.add_row(f"[u]System arch:[/u] {os.uname().machine}")
|
||||
table.add_row(f"[u]Kernel:[/u] {os.uname().release}")
|
||||
table.add_row(f"[u]User:[/u] {os.getlogin()}")
|
||||
table.add_row(f"[u]Uptime:[/u] {uptime[2]}")
|
||||
table.add_row(
|
||||
f"[u]Load Average:[/u] {' '.join(map(str, os.getloadavg()))}"
|
||||
)
|
||||
columns.add_renderable(table)
|
||||
|
||||
console.print(columns)
|
||||
console.print()
|
||||
|
||||
sys.exit(os.EX_OK)
|
||||
|
||||
|
||||
def parse_cli_flags(args: list) -> Namespace:
|
||||
"""Parser for cli values.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
args:list
|
||||
Is a list of all passed values.
|
||||
Returns
|
||||
-------
|
||||
Namespace
|
||||
"""
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Tuxbot - OpenSource bot",
|
||||
usage="tuxbot <instance_name> [arguments]",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--version",
|
||||
"-V",
|
||||
action="store_true",
|
||||
help="Show tuxbot's used version",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--debug", action="store_true", help="Show debug information."
|
||||
)
|
||||
parser.add_argument(
|
||||
"--list-instances",
|
||||
"-L",
|
||||
action="store_true",
|
||||
help="List all instance names",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--token", "-T", type=str, help="Run Tuxbot with passed token"
|
||||
)
|
||||
parser.add_argument(
|
||||
"instance_name",
|
||||
nargs="?",
|
||||
help="Name of the bot instance created during `tuxbot-setup`.",
|
||||
)
|
||||
|
||||
args = parser.parse_args(args)
|
||||
|
||||
return args
|
||||
|
||||
|
||||
async def shutdown_handler(tux: Tux, signal_type, exit_code=None) -> NoReturn:
|
||||
"""Handler when the bot shutdown
|
||||
|
||||
It cancels all running task.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
tux:Tux
|
||||
Object for the bot.
|
||||
signal_type:int, None
|
||||
Exiting signal code.
|
||||
exit_code:None|int
|
||||
Code to show when exiting.
|
||||
"""
|
||||
if signal_type:
|
||||
log.info("%s received. Quitting...", signal_type)
|
||||
elif exit_code is None:
|
||||
log.info("Shutting down from unhandled exception")
|
||||
tux.shutdown_code = ExitCodes.CRITICAL
|
||||
|
||||
if exit_code is not None:
|
||||
tux.shutdown_code = exit_code
|
||||
|
||||
await tux.shutdown()
|
||||
|
||||
|
||||
async def run_bot(tux: Tux, cli_flags: Namespace) -> None:
|
||||
"""This run the bot.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
tux:Tux
|
||||
Object for the bot.
|
||||
cli_flags:Namespace
|
||||
All different flags passed in the console.
|
||||
|
||||
Returns
|
||||
-------
|
||||
None
|
||||
When exiting, this function return None.
|
||||
"""
|
||||
data_path = data_manager.data_path(tux.instance_name)
|
||||
|
||||
tuxbot.logging.init_logging(10, location=data_path / "logs")
|
||||
|
||||
log.debug("====Basic Config====")
|
||||
log.debug("Data Path: %s", data_path)
|
||||
|
||||
if cli_flags.token:
|
||||
token = cli_flags.token
|
||||
else:
|
||||
token = tux.config.Core.token
|
||||
|
||||
if not token:
|
||||
log.critical("Token must be set if you want to login.")
|
||||
sys.exit(ExitCodes.CRITICAL)
|
||||
|
||||
try:
|
||||
await tux.load_packages()
|
||||
console.print()
|
||||
await tux.start(token=token, bot=True)
|
||||
except discord.LoginFailure:
|
||||
log.critical("This token appears to be valid.")
|
||||
console.print()
|
||||
console.print(
|
||||
"[prompt.invalid]This token appears to be valid. [i]exiting...[/i]"
|
||||
)
|
||||
sys.exit(ExitCodes.CRITICAL)
|
||||
except Exception as e:
|
||||
log.critical(e)
|
||||
raise e
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def run() -> NoReturn:
|
||||
"""Main function"""
|
||||
tux = None
|
||||
cli_flags = parse_cli_flags(sys.argv[1:])
|
||||
|
||||
if cli_flags.list_instances:
|
||||
list_instances()
|
||||
elif cli_flags.debug:
|
||||
debug_info()
|
||||
elif cli_flags.version:
|
||||
rprint(f"Tuxbot V{version_info.major}")
|
||||
rprint(f"Complete Version: {__version__}")
|
||||
|
||||
sys.exit(os.EX_OK)
|
||||
|
||||
loop = asyncio.new_event_loop()
|
||||
asyncio.set_event_loop(loop)
|
||||
|
||||
try:
|
||||
if not cli_flags.instance_name:
|
||||
console.print(
|
||||
"[red]No instance provided ! "
|
||||
"You can use 'tuxbot -L' to list all available instances"
|
||||
)
|
||||
sys.exit(ExitCodes.CRITICAL)
|
||||
|
||||
tux = Tux(
|
||||
cli_flags=cli_flags,
|
||||
description="Tuxbot, made from and for OpenSource",
|
||||
dm_help=None,
|
||||
)
|
||||
|
||||
loop.run_until_complete(run_bot(tux, cli_flags))
|
||||
except KeyboardInterrupt:
|
||||
console.print(
|
||||
" [red]Please use <prefix>quit instead of Ctrl+C to Shutdown!"
|
||||
)
|
||||
log.warning("Please use <prefix>quit instead of Ctrl+C to Shutdown!")
|
||||
log.info("Received KeyboardInterrupt")
|
||||
console.print("[i]Trying to shutdown...")
|
||||
if tux is not None:
|
||||
loop.run_until_complete(shutdown_handler(tux, signal.SIGINT))
|
||||
except SystemExit as exc:
|
||||
log.info("Shutting down with exit code: %s", exc.code)
|
||||
if tux is not None:
|
||||
loop.run_until_complete(shutdown_handler(tux, None, exc.code))
|
||||
raise
|
||||
except Exception as exc:
|
||||
log.error("Unexpected exception (%s): ", type(exc))
|
||||
console.print_exception()
|
||||
if tux is not None:
|
||||
loop.run_until_complete(shutdown_handler(tux, None, 1))
|
||||
finally:
|
||||
loop.run_until_complete(loop.shutdown_asyncgens())
|
||||
log.info("Please wait, cleaning up a bit more")
|
||||
loop.run_until_complete(asyncio.sleep(1))
|
||||
asyncio.set_event_loop(None)
|
||||
loop.stop()
|
||||
loop.close()
|
||||
exit_code = ExitCodes.CRITICAL if tux is None else tux.shutdown_code
|
||||
|
||||
sys.exit(exit_code)
|
|
@ -1,6 +1,7 @@
|
|||
from collections import namedtuple
|
||||
|
||||
from .admin import Admin
|
||||
from .config import AdminConfig
|
||||
from ...core.bot import Tux
|
||||
|
||||
VersionInfo = namedtuple("VersionInfo", "major minor micro release_level")
|
||||
|
|
|
@ -5,8 +5,17 @@ from discord.ext import commands
|
|||
|
||||
from tuxbot.core import checks
|
||||
from tuxbot.core.bot import Tux
|
||||
from tuxbot.core.i18n import Translator, find_locale, get_locale_name, available_locales
|
||||
from tuxbot.core.utils.functions.extra import group_extra, ContextPlus
|
||||
from tuxbot.core.i18n import (
|
||||
Translator,
|
||||
find_locale,
|
||||
get_locale_name,
|
||||
available_locales,
|
||||
)
|
||||
from tuxbot.core.utils.functions.extra import (
|
||||
group_extra,
|
||||
command_extra,
|
||||
ContextPlus,
|
||||
)
|
||||
|
||||
log = logging.getLogger("tuxbot.cogs.admin")
|
||||
_ = Translator("Admin", __file__)
|
||||
|
@ -17,33 +26,56 @@ class Admin(commands.Cog, name="Admin"):
|
|||
self.bot = bot
|
||||
|
||||
async def _save_lang(self, ctx: ContextPlus, lang: str):
|
||||
await self.bot.config.update("core", f"guild.{ctx.guild.id}.locale", lang)
|
||||
await self.bot.config.update(
|
||||
"core", f"guild.{ctx.guild.id}.locale", lang
|
||||
)
|
||||
|
||||
@group_extra(name="lang", aliases=["locale", "langue"], deletable=True)
|
||||
@commands.guild_only()
|
||||
@checks.is_admin()
|
||||
async def _lang(self, ctx: ContextPlus):
|
||||
"""Manage lang settings."""
|
||||
pass
|
||||
|
||||
@_lang.command(name="set", aliases=["define", "choice"])
|
||||
async def _lang_set(self, ctx: ContextPlus, lang: str):
|
||||
try:
|
||||
await self._save_lang(ctx, find_locale(lang.lower()))
|
||||
await ctx.send(
|
||||
_("Locale changed to {lang} successfully", ctx, self.bot.config).format(
|
||||
lang=f"`{get_locale_name(lang).lower()}`"
|
||||
)
|
||||
_(
|
||||
"Locale changed to {lang} successfully",
|
||||
ctx,
|
||||
self.bot.config,
|
||||
).format(lang=f"`{get_locale_name(lang).lower()}`")
|
||||
)
|
||||
except NotImplementedError:
|
||||
await self._lang_list(ctx)
|
||||
|
||||
@_lang.command(name="list", aliases=["liste", "all", "view"])
|
||||
async def _lang_list(self, ctx: ContextPlus):
|
||||
description = ""
|
||||
for key, value in available_locales.items():
|
||||
description += f":flag_{key[-2:].lower()}: {value[0]}\n"
|
||||
|
||||
e = discord.Embed(
|
||||
title=_("List of available locales: ", ctx, self.bot.config),
|
||||
description="\n".join([i[0] for i in available_locales.values()]),
|
||||
description=description,
|
||||
color=0x36393E,
|
||||
)
|
||||
|
||||
await ctx.send(embed=e)
|
||||
|
||||
# =========================================================================
|
||||
|
||||
@command_extra(name="quit", aliases=["shutdown"], deletable=False)
|
||||
@commands.guild_only()
|
||||
@checks.is_owner()
|
||||
async def _quit(self, ctx: ContextPlus):
|
||||
await ctx.send("*quit...*")
|
||||
await self.bot.shutdown()
|
||||
|
||||
@command_extra(name="restart", deletable=False)
|
||||
@commands.guild_only()
|
||||
@checks.is_owner()
|
||||
async def _restart(self, ctx: ContextPlus):
|
||||
await ctx.send("*restart...*")
|
||||
await self.bot.shutdown(restart=True)
|
||||
|
|
|
@ -0,0 +1,18 @@
|
|||
from structured_config import Structure, StrField
|
||||
|
||||
|
||||
class AdminConfig(Structure):
|
||||
dm: str = StrField("")
|
||||
mentions: str = StrField("")
|
||||
guilds: str = StrField("")
|
||||
errors: str = StrField("")
|
||||
gateway: str = StrField("")
|
||||
|
||||
|
||||
extra = {
|
||||
"dm": str,
|
||||
"mentions": str,
|
||||
"guilds": str,
|
||||
"errors": str,
|
||||
"gateway": str,
|
||||
}
|
|
@ -1,18 +0,0 @@
|
|||
from collections import namedtuple
|
||||
|
||||
from .anti_raid import AntiRaid
|
||||
from ...core.bot import Tux
|
||||
|
||||
VersionInfo = namedtuple("VersionInfo", "major minor micro releaselevel")
|
||||
version_info = VersionInfo(major=1, minor=0, micro=0, releaselevel="alpha")
|
||||
|
||||
__version__ = "v{}.{}.{}-{}".format(
|
||||
version_info.major,
|
||||
version_info.minor,
|
||||
version_info.micro,
|
||||
version_info.releaselevel,
|
||||
).replace("\n", "")
|
||||
|
||||
|
||||
def setup(bot: Tux):
|
||||
bot.add_cog(AntiRaid(bot))
|
|
@ -1,24 +0,0 @@
|
|||
import logging
|
||||
|
||||
from discord.ext import commands
|
||||
|
||||
from tuxbot.core import checks
|
||||
from tuxbot.core.bot import Tux
|
||||
from tuxbot.core.i18n import Translator
|
||||
|
||||
log = logging.getLogger("tuxbot.cogs.anti_raid")
|
||||
T_ = Translator("AntiRaid", __file__)
|
||||
|
||||
|
||||
class AntiRaid(commands.Cog, name="AntiRaid"):
|
||||
def __init__(self, bot: Tux):
|
||||
self.bot = bot
|
||||
|
||||
@commands.group(
|
||||
name="anti_raid",
|
||||
alias=["anti-raid", "raid_protect", "raid-protect", "no_raid", "no-raid"],
|
||||
)
|
||||
@commands.guild_only()
|
||||
@checks.is_admin()
|
||||
async def _anti_raid(self, ctx: commands.Context):
|
||||
pass
|
|
@ -1,18 +0,0 @@
|
|||
from collections import namedtuple
|
||||
|
||||
from .images import Images
|
||||
from ...core.bot import Tux
|
||||
|
||||
VersionInfo = namedtuple("VersionInfo", "major minor micro releaselevel")
|
||||
version_info = VersionInfo(major=1, minor=0, micro=0, releaselevel="alpha")
|
||||
|
||||
__version__ = "v{}.{}.{}-{}".format(
|
||||
version_info.major,
|
||||
version_info.minor,
|
||||
version_info.micro,
|
||||
version_info.releaselevel,
|
||||
).replace("\n", "")
|
||||
|
||||
|
||||
def setup(bot: Tux):
|
||||
bot.add_cog(Images(bot))
|
|
@ -1,188 +0,0 @@
|
|||
import logging
|
||||
from io import BytesIO
|
||||
|
||||
import discord
|
||||
from discord.ext import commands, flags
|
||||
|
||||
from app import TuxBot
|
||||
from utils.functions.extra import ContextPlus, command_extra
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Images(commands.Cog, name="Images"):
|
||||
def __init__(self, bot):
|
||||
self.bot = bot
|
||||
self.image_api = "http://0.0.0.0:8080"
|
||||
|
||||
async def _send_meme(self, ctx: ContextPlus, endpoint: str, **passed_flags):
|
||||
async with ctx.typing():
|
||||
url = f"{self.image_api}/{endpoint}?"
|
||||
for key, val in passed_flags.items():
|
||||
if val:
|
||||
url += f"{key}={val}&"
|
||||
|
||||
async with self.bot.session.get(url) as r:
|
||||
if r.status != 200:
|
||||
return await ctx.send("Failed...")
|
||||
|
||||
data = BytesIO(await r.read())
|
||||
|
||||
await ctx.send(file=discord.File(data, "output.png"))
|
||||
|
||||
@command_extra(name="phcomment")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _phcomment(
|
||||
self,
|
||||
ctx: ContextPlus,
|
||||
user: discord.User = None,
|
||||
*,
|
||||
message: commands.clean_content(
|
||||
fix_channel_mentions=True, escape_markdown=True
|
||||
),
|
||||
):
|
||||
async with ctx.typing():
|
||||
message = message.replace("&", "%26")
|
||||
if user is None:
|
||||
avatar = ctx.author.avatar_url_as(format="png")
|
||||
username = ctx.author.name
|
||||
else:
|
||||
avatar = user.avatar_url_as(format="png")
|
||||
username = user.name
|
||||
|
||||
url = (
|
||||
f"{self.image_api}/ph/comment"
|
||||
f"?image={avatar}"
|
||||
f"&username={username}"
|
||||
f"&message={message}"
|
||||
)
|
||||
|
||||
async with self.bot.session.get(url) as r:
|
||||
if r.status != 200:
|
||||
return await ctx.send("Failed...")
|
||||
|
||||
data = BytesIO(await r.read())
|
||||
|
||||
await ctx.send(file=discord.File(data, "output.png"))
|
||||
|
||||
@command_extra(name="phvideo")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _phvideo(
|
||||
self,
|
||||
ctx: ContextPlus,
|
||||
image: str,
|
||||
author: discord.User,
|
||||
*,
|
||||
title: commands.clean_content(fix_channel_mentions=True, escape_markdown=True),
|
||||
):
|
||||
async with ctx.typing():
|
||||
url = (
|
||||
f"{self.image_api}/ph/video"
|
||||
f"?image={image}"
|
||||
f"&username={author.name}"
|
||||
f"&title={title}"
|
||||
)
|
||||
|
||||
async with self.bot.session.get(url) as r:
|
||||
if r.status != 200:
|
||||
return await ctx.send("Failed...")
|
||||
|
||||
data = BytesIO(await r.read())
|
||||
|
||||
await ctx.send(file=discord.File(data, "output.png"))
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str)
|
||||
@flags.add_flag("--text3", type=str)
|
||||
@command_extra(name="balloon")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _balloon(self, ctx: ContextPlus, **passed_flags):
|
||||
passed_flags["text3"] = passed_flags.get("text3")
|
||||
passed_flags["text4"] = passed_flags.get("text1")
|
||||
passed_flags["text5"] = passed_flags.get("text2")
|
||||
|
||||
await self._send_meme(ctx, "balloon", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str)
|
||||
@flags.add_flag("--text3", type=str)
|
||||
@command_extra(name="butterfly")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _butterfly(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "butterfly", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str)
|
||||
@command_extra(name="buttons")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _buttons(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "buttons", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@command_extra(name="cmm")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _cmm(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "change_my_mind", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str)
|
||||
@command_extra(name="drake")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _drake(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "drake", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str, default=False)
|
||||
@command_extra(name="fry")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _fry(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "fry", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str, default=False)
|
||||
@command_extra(name="imagination")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _imagination(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "imagination", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str, default=False)
|
||||
@command_extra(name="everywhere")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _everywhere(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "everywhere", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str)
|
||||
@flags.add_flag("--text3", type=str)
|
||||
@command_extra(name="choice")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _choice(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "choice", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@command_extra(name="pika")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _pika(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "pika", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str)
|
||||
@flags.add_flag("--text3", type=str)
|
||||
@command_extra(name="pkp")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _pkp(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "pkp", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@flags.add_flag("--text2", type=str)
|
||||
@command_extra(name="puppet")
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _puppet(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "puppet", **passed_flags)
|
||||
|
||||
@flags.add_flag("--text1", type=str)
|
||||
@command_extra(name="scroll_of_truth", alias=["sot"])
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _sot(self, ctx: ContextPlus, **passed_flags):
|
||||
await self._send_meme(ctx, "scroll_of_truth", **passed_flags)
|
|
@ -1,26 +0,0 @@
|
|||
import logging
|
||||
from collections import namedtuple
|
||||
|
||||
from discord.ext import commands
|
||||
|
||||
from .logs import Logs, GatewayHandler, on_error
|
||||
from ...core.bot import Tux
|
||||
|
||||
VersionInfo = namedtuple("VersionInfo", "major minor micro releaselevel")
|
||||
version_info = VersionInfo(major=2, minor=0, micro=0, releaselevel="alpha")
|
||||
|
||||
__version__ = "v{}.{}.{}-{}".format(
|
||||
version_info.major,
|
||||
version_info.minor,
|
||||
version_info.micro,
|
||||
version_info.releaselevel,
|
||||
).replace("\n", "")
|
||||
|
||||
|
||||
def setup(bot: Tux):
|
||||
cog = Logs(bot)
|
||||
bot.add_cog(cog)
|
||||
|
||||
handler = GatewayHandler(cog)
|
||||
logging.getLogger().addHandler(handler)
|
||||
commands.AutoShardedBot.on_error = on_error
|
|
@ -1,22 +0,0 @@
|
|||
{
|
||||
"dm": {
|
||||
"description": "Webhook url for DMs events",
|
||||
"value": "str"
|
||||
},
|
||||
"mentions": {
|
||||
"description": "Webhook url for mentions events",
|
||||
"value": "str"
|
||||
},
|
||||
"guilds": {
|
||||
"description": "Webhook url for guilds events",
|
||||
"value": "str"
|
||||
},
|
||||
"errors": {
|
||||
"description": "Webhook url for errors events",
|
||||
"value": "str"
|
||||
},
|
||||
"gateway": {
|
||||
"description": "Webhook url for gateway events",
|
||||
"value": "str"
|
||||
}
|
||||
}
|
|
@ -1,319 +0,0 @@
|
|||
"""
|
||||
|
||||
Based on https://github.com/Rapptz/RoboDanny/blob/3d94e89ef27f702a5f57f432a9131bdfb60bb3ec/cogs/stats.py
|
||||
Adapted by Romain J.
|
||||
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import datetime
|
||||
import json
|
||||
import logging
|
||||
import textwrap
|
||||
import traceback
|
||||
from collections import defaultdict
|
||||
|
||||
import discord
|
||||
import humanize
|
||||
import psutil
|
||||
from discord.ext import commands, tasks
|
||||
|
||||
from app import TuxBot
|
||||
from utils.functions.extra import command_extra
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class GatewayHandler(logging.Handler):
|
||||
def __init__(self, cog):
|
||||
self.cog = cog
|
||||
super().__init__(logging.INFO)
|
||||
|
||||
def filter(self, record):
|
||||
return (
|
||||
record.name == "discord.gateway"
|
||||
or "Shard ID" in record.msg
|
||||
or "Websocket closed " in record.msg
|
||||
)
|
||||
|
||||
def emit(self, record):
|
||||
self.cog.add_record(record)
|
||||
|
||||
|
||||
class Logs(commands.Cog):
|
||||
def __init__(self, bot: TuxBot):
|
||||
self.bot = bot
|
||||
self.process = psutil.Process()
|
||||
self._batch_lock = asyncio.Lock(loop=bot.loop)
|
||||
self._data_batch = []
|
||||
self._gateway_queue = asyncio.Queue(loop=bot.loop)
|
||||
self.gateway_worker.start()
|
||||
|
||||
self._resumes = []
|
||||
self._identifies = defaultdict(list)
|
||||
|
||||
def _clear_gateway_data(self):
|
||||
one_week_ago = datetime.datetime.utcnow() - datetime.timedelta(days=7)
|
||||
to_remove = [
|
||||
index for index, dt in enumerate(self._resumes) if dt < one_week_ago
|
||||
]
|
||||
for index in reversed(to_remove):
|
||||
del self._resumes[index]
|
||||
|
||||
for shard_id, dates in self._identifies.items():
|
||||
to_remove = [index for index, dt in enumerate(dates) if dt < one_week_ago]
|
||||
for index in reversed(to_remove):
|
||||
del dates[index]
|
||||
|
||||
@tasks.loop(seconds=0.0)
|
||||
async def gateway_worker(self):
|
||||
record = await self._gateway_queue.get()
|
||||
await self.notify_gateway_status(record)
|
||||
|
||||
async def register_command(self, ctx):
|
||||
if ctx.command is None:
|
||||
return
|
||||
|
||||
command = ctx.command.qualified_name
|
||||
self.bot.command_stats[command] += 1
|
||||
message = ctx.message
|
||||
if ctx.guild is None:
|
||||
destination = "Private Message"
|
||||
guild_id = None
|
||||
else:
|
||||
destination = f"#{message.channel} ({message.guild})"
|
||||
guild_id = ctx.guild.id
|
||||
|
||||
log.info(
|
||||
f"{message.created_at}: {message.author} "
|
||||
f"in {destination}: {message.content}"
|
||||
)
|
||||
async with self._batch_lock:
|
||||
self._data_batch.append(
|
||||
{
|
||||
"guild": guild_id,
|
||||
"channel": ctx.channel.id,
|
||||
"author": ctx.author.id,
|
||||
"used": message.created_at.isoformat(),
|
||||
"prefix": ctx.prefix,
|
||||
"command": command,
|
||||
"failed": ctx.command_failed,
|
||||
}
|
||||
)
|
||||
|
||||
@commands.Cog.listener()
|
||||
async def on_command_completion(self, ctx):
|
||||
await self.register_command(ctx)
|
||||
|
||||
@commands.Cog.listener()
|
||||
async def on_socket_response(self, msg):
|
||||
self.bot.socket_stats[msg.get("t")] += 1
|
||||
|
||||
@property
|
||||
def logs(self):
|
||||
webhooks = {}
|
||||
|
||||
for key, value in self.bot.logs_channels.items():
|
||||
webhooks[key] = discord.Webhook.partial(
|
||||
id=value.get("webhook")["id"],
|
||||
token=value.get("webhook")["token"],
|
||||
adapter=discord.AsyncWebhookAdapter(self.bot.session),
|
||||
)
|
||||
|
||||
return webhooks
|
||||
|
||||
async def log_error(self, *, ctx=None, extra=None):
|
||||
e = discord.Embed(title="Error", colour=0xDD5F53)
|
||||
e.description = f"```py\n{traceback.format_exc()}\n```"
|
||||
e.add_field(name="Extra", value=extra, inline=False)
|
||||
e.timestamp = datetime.datetime.utcnow()
|
||||
|
||||
if ctx is not None:
|
||||
fmt = "{0} (ID: {0.id})"
|
||||
author = fmt.format(ctx.author)
|
||||
channel = fmt.format(ctx.channel)
|
||||
guild = "None" if ctx.guild is None else fmt.format(ctx.guild)
|
||||
|
||||
e.add_field(name="Author", value=author)
|
||||
e.add_field(name="Channel", value=channel)
|
||||
e.add_field(name="Guild", value=guild)
|
||||
|
||||
await self.logs.get("errors").send(embed=e)
|
||||
|
||||
async def send_guild_stats(self, e, guild):
|
||||
e.add_field(name="Name", value=guild.name)
|
||||
e.add_field(name="ID", value=guild.id)
|
||||
e.add_field(name="Shard ID", value=guild.shard_id or "N/A")
|
||||
e.add_field(name="Owner", value=f"{guild.owner} (ID: {guild.owner.id})")
|
||||
|
||||
bots = sum(member.bot for member in guild.members)
|
||||
total = guild.member_count
|
||||
online = sum(member.status is discord.Status.online for member in guild.members)
|
||||
|
||||
e.add_field(name="Members", value=str(total))
|
||||
e.add_field(name="Bots", value=f"{bots} ({bots / total:.2%})")
|
||||
e.add_field(name="Online", value=f"{online} ({online / total:.2%})")
|
||||
|
||||
if guild.icon:
|
||||
e.set_thumbnail(url=guild.icon_url)
|
||||
|
||||
if guild.me:
|
||||
e.timestamp = guild.me.joined_at
|
||||
|
||||
await self.logs.get("guilds").send(embed=e)
|
||||
|
||||
@commands.Cog.listener()
|
||||
async def on_guild_join(self, guild: discord.guild):
|
||||
e = discord.Embed(colour=0x53DDA4, title="New Guild") # green colour
|
||||
await self.send_guild_stats(e, guild)
|
||||
|
||||
@commands.Cog.listener()
|
||||
async def on_guild_remove(self, guild: discord.guild):
|
||||
e = discord.Embed(colour=0xDD5F53, title="Left Guild") # red colour
|
||||
await self.send_guild_stats(e, guild)
|
||||
|
||||
@commands.Cog.listener()
|
||||
async def on_message(self, message: discord.message):
|
||||
ctx = await self.bot.get_context(message)
|
||||
if ctx.valid:
|
||||
return
|
||||
|
||||
if isinstance(message.channel, discord.DMChannel):
|
||||
if message.author is self.bot.user:
|
||||
e = discord.Embed(
|
||||
title=f"DM to: {message.channel.recipient}",
|
||||
description=message.content,
|
||||
color=0x39E326,
|
||||
)
|
||||
else:
|
||||
e = discord.Embed(
|
||||
title="New DM:", description=message.content, color=0x0A97F5
|
||||
)
|
||||
e.set_author(
|
||||
name=message.channel.recipient,
|
||||
icon_url=message.channel.recipient.avatar_url_as(format="png"),
|
||||
)
|
||||
|
||||
if message.attachments:
|
||||
attachment_url = message.attachments[0].url
|
||||
e.set_image(url=attachment_url)
|
||||
|
||||
e.set_footer(text=f"User ID: {message.channel.recipient.id}")
|
||||
|
||||
await self.logs["dm"].send(embed=e)
|
||||
|
||||
@commands.Cog.listener()
|
||||
async def on_command_error(self, ctx, error):
|
||||
await self.register_command(ctx)
|
||||
if not isinstance(
|
||||
error, (commands.CommandInvokeError, commands.ConversionError)
|
||||
):
|
||||
return
|
||||
|
||||
error = error.original
|
||||
if isinstance(error, (discord.Forbidden, discord.NotFound)):
|
||||
return
|
||||
|
||||
e = discord.Embed(title="Command Error", colour=0xCC3366)
|
||||
e.add_field(name="Name", value=ctx.command.qualified_name)
|
||||
e.add_field(name="Author", value=f"{ctx.author} (ID: {ctx.author.id})")
|
||||
|
||||
fmt = f"Channel: {ctx.channel} (ID: {ctx.channel.id})"
|
||||
if ctx.guild:
|
||||
fmt = f"{fmt}\nGuild: {ctx.guild} (ID: {ctx.guild.id})"
|
||||
|
||||
e.add_field(name="Location", value=fmt, inline=False)
|
||||
e.add_field(
|
||||
name="Content", value=textwrap.shorten(ctx.message.content, width=512)
|
||||
)
|
||||
|
||||
exc = "".join(
|
||||
traceback.format_exception(
|
||||
type(error), error, error.__traceback__, chain=False
|
||||
)
|
||||
)
|
||||
e.description = f"```py\n{exc}\n```"
|
||||
e.timestamp = datetime.datetime.utcnow()
|
||||
await self.logs.get("errors").send(embed=e)
|
||||
|
||||
@commands.Cog.listener()
|
||||
async def on_socket_raw_send(self, data):
|
||||
if '"op":2' not in data and '"op":6' not in data:
|
||||
return
|
||||
|
||||
back_to_json = json.loads(data)
|
||||
if back_to_json["op"] == 2:
|
||||
payload = back_to_json["d"]
|
||||
inner_shard = payload.get("shard", [0])
|
||||
self._identifies[inner_shard[0]].append(datetime.datetime.utcnow())
|
||||
else:
|
||||
self._resumes.append(datetime.datetime.utcnow())
|
||||
|
||||
self._clear_gateway_data()
|
||||
|
||||
def add_record(self, record):
|
||||
self._gateway_queue.put_nowait(record)
|
||||
|
||||
async def notify_gateway_status(self, record):
|
||||
types = {"INFO": ":information_source:", "WARNING": ":warning:"}
|
||||
|
||||
emoji = types.get(record.levelname, ":heavy_multiplication_x:")
|
||||
dt = datetime.datetime.utcfromtimestamp(record.created)
|
||||
msg = f"{emoji} `[{dt:%Y-%m-%d %H:%M:%S}] {record.message}`"
|
||||
await self.logs.get("gateway").send(msg)
|
||||
|
||||
@command_extra(name="commandstats")
|
||||
@commands.is_owner()
|
||||
async def _commandstats(self, ctx, limit=20):
|
||||
counter = self.bot.command_stats
|
||||
width = len(max(counter, key=len))
|
||||
|
||||
if limit > 0:
|
||||
common = counter.most_common(limit)
|
||||
else:
|
||||
common = counter.most_common()[limit:]
|
||||
|
||||
output = "\n".join(f"{k:<{width}}: {c}" for k, c in common)
|
||||
|
||||
await ctx.send(f"```\n{output}\n```")
|
||||
|
||||
@commands.command("socketstats")
|
||||
@commands.is_owner()
|
||||
async def _socketstats(self, ctx):
|
||||
delta = datetime.datetime.utcnow() - self.bot.uptime
|
||||
minutes = delta.total_seconds() / 60
|
||||
total = sum(self.bot.socket_stats.values())
|
||||
cpm = total / minutes
|
||||
await ctx.send(
|
||||
f"{total} socket events observed ({cpm:.2f}/minute):\n"
|
||||
f"{self.bot.socket_stats}"
|
||||
)
|
||||
|
||||
@commands.command("uptime")
|
||||
async def _uptime(self, ctx):
|
||||
uptime = humanize.naturaltime(datetime.datetime.utcnow() - self.bot.uptime)
|
||||
await ctx.send(f"Uptime: **{uptime}**")
|
||||
|
||||
|
||||
async def on_error(self, event, *args):
|
||||
e = discord.Embed(title="Event Error", colour=0xA32952)
|
||||
e.add_field(name="Event", value=event)
|
||||
e.description = f"```py\n{traceback.format_exc()}\n```"
|
||||
e.timestamp = datetime.datetime.utcnow()
|
||||
|
||||
args_str = ["```py"]
|
||||
for index, arg in enumerate(args):
|
||||
args_str.append(f"[{index}]: {arg!r}")
|
||||
args_str.append("```")
|
||||
e.add_field(name="Args", value="\n".join(args_str), inline=False)
|
||||
|
||||
hook = self.get_cog("Logs").logs.get("errors")
|
||||
try:
|
||||
await hook.send(embed=e)
|
||||
except (
|
||||
discord.HTTPException,
|
||||
discord.NotFound,
|
||||
discord.Forbidden,
|
||||
discord.InvalidArgument,
|
||||
):
|
||||
pass
|
|
@ -1,18 +0,0 @@
|
|||
from collections import namedtuple
|
||||
|
||||
from .network import Network
|
||||
from ...core.bot import Tux
|
||||
|
||||
VersionInfo = namedtuple("VersionInfo", "major minor micro releaselevel")
|
||||
version_info = VersionInfo(major=2, minor=0, micro=0, releaselevel="alpha")
|
||||
|
||||
__version__ = "v{}.{}.{}-{}".format(
|
||||
version_info.major,
|
||||
version_info.minor,
|
||||
version_info.micro,
|
||||
version_info.releaselevel,
|
||||
).replace("\n", "")
|
||||
|
||||
|
||||
def setup(bot: Tux):
|
||||
bot.add_cog(Network(bot))
|
|
@ -1,6 +0,0 @@
|
|||
{
|
||||
"ipinfo": {
|
||||
"description": "API token for ipinfo.io",
|
||||
"value": "str"
|
||||
}
|
||||
}
|
|
@ -1,112 +0,0 @@
|
|||
import logging
|
||||
import socket
|
||||
import ipinfo
|
||||
import discord
|
||||
|
||||
from discord.ext import commands, flags
|
||||
from ipwhois import Net
|
||||
from ipwhois.asn import IPASN
|
||||
from ipinfo.exceptions import RequestQuotaExceededError
|
||||
from requests.exceptions import HTTPError
|
||||
|
||||
from app import TuxBot
|
||||
from utils.functions.extra import ContextPlus, command_extra
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Network(commands.Cog, name="Useless"):
|
||||
def __init__(self, bot: TuxBot):
|
||||
self.bot = bot
|
||||
|
||||
@flags.add_flag(
|
||||
"-i", "--ip", type=str, default="v4", choices=["v4", "4", "v6", "6"]
|
||||
)
|
||||
@command_extra(name="iplocalise", aliases=["localiseip"])
|
||||
@commands.cooldown(1, 5, commands.BucketType.user)
|
||||
async def _iplocalise(self, ctx: ContextPlus, target: str, **passed_flags):
|
||||
loading = await ctx.send("_Récupération des informations..._", deletable=False)
|
||||
|
||||
def get_hostname(dtl, tgt):
|
||||
try:
|
||||
return dtl.hostname
|
||||
except AttributeError:
|
||||
try:
|
||||
return socket.gethostbyaddr(tgt)[0]
|
||||
except (ValueError, socket.herror):
|
||||
return "N/A"
|
||||
|
||||
ip_type = passed_flags.get("ip")
|
||||
target_copy = target
|
||||
|
||||
# clean https://, last /, ...
|
||||
spltTgt = target.split("://")
|
||||
target = (
|
||||
spltTgt[(0, 1)[len(spltTgt) > 1]]
|
||||
.split("?")[0]
|
||||
.split("/")[0]
|
||||
.split(":")[0]
|
||||
.lower()
|
||||
)
|
||||
|
||||
try:
|
||||
target = socket.getaddrinfo(
|
||||
target,
|
||||
None,
|
||||
socket.AF_INET if ip_type in ["v4", "4"] else socket.AF_INET6,
|
||||
)[1][4][0]
|
||||
except socket.gaierror:
|
||||
return await ctx.send("Erreur, cette adresse n'est pas disponible.")
|
||||
|
||||
net = Net(target)
|
||||
obj = IPASN(net)
|
||||
ip_info = obj.lookup()
|
||||
|
||||
try:
|
||||
handler = ipinfo.getHandler(self.bot.config.ipinfo)
|
||||
details = handler.getDetails(target)
|
||||
api_result = True
|
||||
except (RequestQuotaExceededError, HTTPError):
|
||||
details = None
|
||||
api_result = False
|
||||
|
||||
if api_result:
|
||||
belongs = f"{details.org}"
|
||||
|
||||
osm = (
|
||||
f"https://www.openstreetmap.org/"
|
||||
f"?mlat={details.latitude}"
|
||||
f"&mlon={details.longitude}"
|
||||
f"#map=5/{details.latitude}/{details.longitude}"
|
||||
f"&layers=H"
|
||||
)
|
||||
|
||||
region = (
|
||||
f"[{details.city} - {details.region} " f"({details.country})]({osm})"
|
||||
)
|
||||
flag = f"https://www.countryflags.io/" f"{details.country}/shiny/64.png"
|
||||
else:
|
||||
belongs = f"{ip_info['asn_description']} (AS{ip_info['asn']})"
|
||||
region = f"{ip_info['asn_country_code']}"
|
||||
flag = (
|
||||
f"https://www.countryflags.io/"
|
||||
f"{ip_info['asn_country_code']}/shiny/64.png"
|
||||
)
|
||||
|
||||
e = discord.Embed(
|
||||
title=f"**Information sur __{target_copy}__ :**" f" `{target}`",
|
||||
color=0x5858D7,
|
||||
)
|
||||
|
||||
e.add_field(name="Appartient à :", value=belongs)
|
||||
e.add_field(name="RIR :", value=f"{ip_info['asn_registry']}")
|
||||
e.add_field(name="Region :", value=region)
|
||||
|
||||
e.add_field(
|
||||
name="Nom de l'hôte :", value=get_hostname(details, target), inline=False
|
||||
)
|
||||
|
||||
e.set_thumbnail(url=flag)
|
||||
|
||||
await loading.delete()
|
||||
await ctx.send(embed=e)
|
|
@ -1,18 +0,0 @@
|
|||
from collections import namedtuple
|
||||
|
||||
from .warnings import Warnings
|
||||
from ...core.bot import Tux
|
||||
|
||||
VersionInfo = namedtuple("VersionInfo", "major minor micro releaselevel")
|
||||
version_info = VersionInfo(major=1, minor=0, micro=0, releaselevel="alpha")
|
||||
|
||||
__version__ = "v{}.{}.{}-{}".format(
|
||||
version_info.major,
|
||||
version_info.minor,
|
||||
version_info.micro,
|
||||
version_info.releaselevel,
|
||||
).replace("\n", "")
|
||||
|
||||
|
||||
def setup(bot: Tux):
|
||||
bot.add_cog(Warnings(bot))
|
|
@ -1,40 +0,0 @@
|
|||
from typing import Union
|
||||
|
||||
import discord
|
||||
from discord.ext import commands
|
||||
|
||||
from tuxbot.core import checks
|
||||
from tuxbot.core.bot import Tux
|
||||
|
||||
|
||||
class Warnings(commands.Cog, name="Warnings"):
|
||||
def __init__(self, bot: Tux):
|
||||
self.bot = bot
|
||||
|
||||
@commands.group(name="warn", alias=["warning"])
|
||||
@commands.guild_only()
|
||||
@checks.is_mod()
|
||||
async def _warn(self, ctx: commands.Context):
|
||||
division_by_zero = 1 / 0
|
||||
|
||||
@_warn.command(name="add")
|
||||
@commands.guild_only()
|
||||
async def _warn_add(
|
||||
self,
|
||||
ctx: commands.Context,
|
||||
member: Union[discord.User, discord.Member],
|
||||
reason: str,
|
||||
):
|
||||
pass
|
||||
|
||||
@_warn.command(name="delete", aliases=["del", "remove"])
|
||||
@commands.guild_only()
|
||||
async def action_del(self, ctx: commands.Context, warn_id: int, reason: str = ""):
|
||||
pass
|
||||
|
||||
@_warn.command(name="list", aliases=["all"])
|
||||
@commands.guild_only()
|
||||
async def action_del(
|
||||
self, ctx: commands.Context, member: Union[discord.User, discord.Member] = None
|
||||
):
|
||||
pass
|
|
@ -1,8 +1,9 @@
|
|||
from .. import __version__, version_info, VersionInfo, ExitCodes
|
||||
from .config import Config
|
||||
from .config import Config, ConfigFile
|
||||
|
||||
__all__ = [
|
||||
"Config",
|
||||
"ConfigFile",
|
||||
"__version__",
|
||||
"version_info",
|
||||
"VersionInfo",
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
import asyncio
|
||||
import datetime
|
||||
import logging
|
||||
import sys
|
||||
from typing import List, Union
|
||||
|
||||
import discord
|
||||
|
@ -13,37 +12,32 @@ from rich.panel import Panel
|
|||
from rich.progress import Progress, TextColumn, BarColumn
|
||||
from rich.table import Table
|
||||
from rich.traceback import install
|
||||
|
||||
from tuxbot import version_info
|
||||
|
||||
from . import Config
|
||||
from .data_manager import logs_data_path
|
||||
from . import Config, ConfigFile
|
||||
from .data_manager import logs_data_path, data_path
|
||||
|
||||
from . import __version__, ExitCodes
|
||||
from . import exceptions
|
||||
from .utils.functions.extra import ContextPlus
|
||||
from .utils.functions.prefix import get_prefixes
|
||||
|
||||
log = logging.getLogger("tuxbot")
|
||||
console = Console()
|
||||
install(console=console)
|
||||
|
||||
NAME = r"""
|
||||
_____ _ _ _ _
|
||||
|_ _| ___ _| |__ ___ | |_ | |__ ___ | |_
|
||||
| || | | \ \/ / '_ \ / _ \| __|____| '_ \ / _ \| __|
|
||||
| || |_| |> <| |_) | (_) | ||_____| |_) | (_) | |_
|
||||
|_| \__,_/_/\_\_.__/ \___/ \__| |_.__/ \___/ \__|
|
||||
"""
|
||||
|
||||
packages: List[str] = ["jishaku", "tuxbot.cogs.warnings", "tuxbot.cogs.admin"]
|
||||
packages: List[str] = ["jishaku", "tuxbot.cogs.admin"]
|
||||
|
||||
|
||||
class Tux(commands.AutoShardedBot):
|
||||
_loading: asyncio.Task
|
||||
_progress = {
|
||||
'main': Progress(
|
||||
"main": Progress(
|
||||
TextColumn("[bold blue]{task.fields[task_name]}", justify="right"),
|
||||
BarColumn()
|
||||
BarColumn(),
|
||||
),
|
||||
'tasks': {}
|
||||
"tasks": {},
|
||||
}
|
||||
|
||||
def __init__(self, *args, cli_flags=None, **kwargs):
|
||||
|
@ -55,14 +49,16 @@ class Tux(commands.AutoShardedBot):
|
|||
self.last_exception = None
|
||||
self.logs = logs_data_path(self.instance_name)
|
||||
|
||||
self.config = Config(self.instance_name)
|
||||
self.config: Config = ConfigFile(
|
||||
str(data_path(self.instance_name) / "config.yaml"), Config
|
||||
).config
|
||||
|
||||
async def _prefixes(bot, message) -> List[str]:
|
||||
prefixes = self.config("core").get("prefixes")
|
||||
prefixes = self.config.Core.prefixes
|
||||
|
||||
prefixes.extend(self.config.get_prefixes(message.guild))
|
||||
prefixes.extend(get_prefixes(self, message.guild))
|
||||
|
||||
if self.config("core").get("mentionable"):
|
||||
if self.config.Core.mentionable:
|
||||
return commands.when_mentioned_or(*prefixes)(bot, message)
|
||||
return prefixes
|
||||
|
||||
|
@ -72,7 +68,7 @@ class Tux(commands.AutoShardedBot):
|
|||
if "owner_ids" in kwargs:
|
||||
kwargs["owner_ids"] = set(kwargs["owner_ids"])
|
||||
else:
|
||||
kwargs["owner_ids"] = self.config.owners_id()
|
||||
kwargs["owner_ids"] = self.config.Core.owners_id
|
||||
|
||||
message_cache_size = 100_000
|
||||
kwargs["max_messages"] = message_cache_size
|
||||
|
@ -87,8 +83,7 @@ class Tux(commands.AutoShardedBot):
|
|||
if packages:
|
||||
with Progress() as progress:
|
||||
task = progress.add_task(
|
||||
"Loading packages...",
|
||||
total=len(packages)
|
||||
"Loading packages...", total=len(packages)
|
||||
)
|
||||
|
||||
for package in packages:
|
||||
|
@ -97,8 +92,7 @@ class Tux(commands.AutoShardedBot):
|
|||
progress.console.print(f"{package} loaded")
|
||||
except Exception as e:
|
||||
log.exception(
|
||||
f"Failed to load package {package}",
|
||||
exc_info=e
|
||||
"Failed to load package %s", package, exc_info=e
|
||||
)
|
||||
progress.console.print(
|
||||
f"[red]Failed to load package {package} "
|
||||
|
@ -117,26 +111,24 @@ class Tux(commands.AutoShardedBot):
|
|||
self._progress.get("main").remove_task(
|
||||
self._progress.get("tasks")["connecting"]
|
||||
)
|
||||
self._progress.get("tasks").pop("connecting")
|
||||
console.clear()
|
||||
|
||||
console.print(
|
||||
Panel(f"[bold blue]Tuxbot V{version_info.major}", style="blue"),
|
||||
justify="center"
|
||||
justify="center",
|
||||
)
|
||||
console.print()
|
||||
|
||||
columns = Columns(expand=True, padding=2, align="center")
|
||||
|
||||
table = Table(
|
||||
style="dim", border_style="not dim",
|
||||
box=box.HEAVY_HEAD
|
||||
)
|
||||
table = Table(style="dim", border_style="not dim", box=box.HEAVY_HEAD)
|
||||
table.add_column(
|
||||
"INFO",
|
||||
)
|
||||
table.add_row(str(self.user))
|
||||
table.add_row(f"Prefixes: {', '.join(self.config('core').get('prefixes'))}")
|
||||
table.add_row(f"Language: {self.config('core').get('locale')}")
|
||||
table.add_row(f"Prefixes: {', '.join(self.config.Core.prefixes)}")
|
||||
table.add_row(f"Language: {self.config.Core.locale}")
|
||||
table.add_row(f"Tuxbot Version: {__version__}")
|
||||
table.add_row(f"Discord.py Version: {discord.__version__}")
|
||||
table.add_row(f"Shards: {self.shard_count}")
|
||||
|
@ -144,18 +136,15 @@ class Tux(commands.AutoShardedBot):
|
|||
table.add_row(f"Users: {len(self.users)}")
|
||||
columns.add_renderable(table)
|
||||
|
||||
table = Table(
|
||||
style="dim", border_style="not dim",
|
||||
box=box.HEAVY_HEAD
|
||||
)
|
||||
table = Table(style="dim", border_style="not dim", box=box.HEAVY_HEAD)
|
||||
table.add_column(
|
||||
"COGS",
|
||||
)
|
||||
for extension in packages:
|
||||
if extension in self.extensions:
|
||||
status = f"[green]:heavy_check_mark: {extension} "
|
||||
status = f"[green]:heavy_check_mark: {extension}"
|
||||
else:
|
||||
status = f"[red]:cross_mark: {extension} "
|
||||
status = f"[red]:heavy_multiplication_x: {extension}"
|
||||
|
||||
table.add_row(status)
|
||||
columns.add_renderable(table)
|
||||
|
@ -163,8 +152,9 @@ class Tux(commands.AutoShardedBot):
|
|||
console.print(columns)
|
||||
console.print()
|
||||
|
||||
async def is_owner(self,
|
||||
user: Union[discord.User, discord.Member]) -> bool:
|
||||
async def is_owner(
|
||||
self, user: Union[discord.User, discord.Member]
|
||||
) -> bool:
|
||||
"""Determines if the user is a bot owner.
|
||||
|
||||
Parameters
|
||||
|
@ -175,7 +165,7 @@ class Tux(commands.AutoShardedBot):
|
|||
-------
|
||||
bool
|
||||
"""
|
||||
if user.id in self.config.owners_id():
|
||||
if user.id in self.config.Core.owners_id:
|
||||
return True
|
||||
|
||||
owner = False
|
||||
|
@ -183,50 +173,59 @@ class Tux(commands.AutoShardedBot):
|
|||
app = await self.application_info()
|
||||
if app.team:
|
||||
ids = [m.id for m in app.team.members]
|
||||
await self.config.update("core", "owners_id", ids)
|
||||
self.config.Core.owners_id = ids
|
||||
owner = user.id in ids
|
||||
self._app_owners_fetched = True
|
||||
|
||||
return owner
|
||||
|
||||
# pylint: disable=unused-argument
|
||||
async def get_context(self, message: discord.Message, *, cls=None):
|
||||
return await super().get_context(message, cls=ContextPlus)
|
||||
|
||||
async def process_commands(self, message: discord.Message):
|
||||
"""Check for blacklists.
|
||||
|
||||
"""
|
||||
"""Check for blacklists."""
|
||||
if message.author.bot:
|
||||
return
|
||||
|
||||
if (
|
||||
message.guild.id in self.config.get_blacklist("guild")
|
||||
or message.channel.id in self.config.get_blacklist("channel")
|
||||
or message.author.id in self.config.get_blacklist("user")
|
||||
self.config.Servers.all[message.guild.id].blacklisted
|
||||
or self.config.Channels.all[message.channel.id].blacklisted
|
||||
or self.config.Users.all[message.author.id].blacklisted
|
||||
):
|
||||
return
|
||||
|
||||
ctx = await self.get_context(message)
|
||||
ctx: ContextPlus = await self.get_context(message)
|
||||
|
||||
if ctx is None or ctx.valid is False:
|
||||
self.dispatch("message_without_command", message)
|
||||
else:
|
||||
if (
|
||||
ctx.command
|
||||
in self.config.Servers.all[message.guild.id].disabled_command
|
||||
):
|
||||
raise exceptions.DisabledCommandByServerOwner
|
||||
|
||||
if ctx.command in self.config.Core.disabled_command:
|
||||
raise exceptions.DisabledCommandByBotOwner
|
||||
|
||||
await self.invoke(ctx)
|
||||
|
||||
async def on_message(self, message: discord.Message):
|
||||
await self.process_commands(message)
|
||||
|
||||
async def start(self, token, bot):
|
||||
async def start(self, token, bot): # pylint: disable=arguments-differ
|
||||
"""Connect to Discord and start all connections.
|
||||
|
||||
Todo: add postgresql connect here
|
||||
"""
|
||||
with self._progress.get("main") as pg:
|
||||
task_id = self._progress.get("tasks")["connecting"] = pg.add_task(
|
||||
"connecting",
|
||||
task_name="Connecting to Discord...", start=False
|
||||
with self._progress.get("main") as progress:
|
||||
task_id = self._progress.get("tasks")[
|
||||
"connecting"
|
||||
] = progress.add_task(
|
||||
"connecting", task_name="Connecting to Discord...", start=False
|
||||
)
|
||||
pg.update(task_id)
|
||||
progress.update(task_id)
|
||||
await super().start(token, bot=bot)
|
||||
|
||||
async def logout(self):
|
||||
|
@ -246,14 +245,13 @@ class Tux(commands.AutoShardedBot):
|
|||
self._progress.get("main").stop()
|
||||
|
||||
pending = [
|
||||
t for t in asyncio.all_tasks() if
|
||||
t is not asyncio.current_task()
|
||||
t for t in asyncio.all_tasks() if t is not asyncio.current_task()
|
||||
]
|
||||
|
||||
for task in pending:
|
||||
console.log("Canceling", task.get_name(), f"({task.get_coro()})")
|
||||
task.cancel()
|
||||
await asyncio.gather(*pending, return_exceptions=True)
|
||||
await asyncio.gather(*pending, return_exceptions=False)
|
||||
|
||||
await super().logout()
|
||||
|
||||
|
@ -273,4 +271,8 @@ class Tux(commands.AutoShardedBot):
|
|||
self.shutdown_code = ExitCodes.RESTART
|
||||
|
||||
await self.logout()
|
||||
sys.exit(self.shutdown_code)
|
||||
|
||||
sys_e = SystemExit()
|
||||
sys_e.code = self.shutdown_code
|
||||
|
||||
raise sys_e
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
from typing import Awaitable, Dict
|
||||
from typing import Dict
|
||||
|
||||
import discord
|
||||
from discord.ext import commands
|
||||
|
@ -22,34 +22,34 @@ __all__ = [
|
|||
|
||||
|
||||
def is_mod():
|
||||
"""Is the user a moderator ?
|
||||
|
||||
"""
|
||||
"""Is the user a moderator ?"""
|
||||
|
||||
async def pred(ctx):
|
||||
if await ctx.bot.is_owner(ctx.author):
|
||||
return True
|
||||
permissions: discord.Permissions = ctx.channel.permissions_for(ctx.author)
|
||||
permissions: discord.Permissions = ctx.channel.permissions_for(
|
||||
ctx.author
|
||||
)
|
||||
return permissions.manage_messages
|
||||
|
||||
return commands.check(pred)
|
||||
|
||||
|
||||
def is_admin():
|
||||
"""Is the user admin ?
|
||||
|
||||
"""
|
||||
"""Is the user admin ?"""
|
||||
|
||||
async def pred(ctx):
|
||||
if await ctx.bot.is_owner(ctx.author):
|
||||
return True
|
||||
permissions: discord.Permissions = ctx.channel.permissions_for(ctx.author)
|
||||
permissions: discord.Permissions = ctx.channel.permissions_for(
|
||||
ctx.author
|
||||
)
|
||||
return permissions.administrator
|
||||
|
||||
return commands.check(pred)
|
||||
|
||||
|
||||
async def check_permissions(ctx: "ContextPlus", **perms: Dict[str, bool]):
|
||||
async def check_permissions(ctx: ContextPlus, **perms: Dict[str, bool]):
|
||||
"""Does a user have any perms ?
|
||||
|
||||
Parameters
|
||||
|
@ -62,11 +62,14 @@ async def check_permissions(ctx: "ContextPlus", **perms: Dict[str, bool]):
|
|||
if await ctx.bot.is_owner(ctx.author):
|
||||
return True
|
||||
|
||||
elif not perms:
|
||||
if not perms:
|
||||
return False
|
||||
|
||||
resolved = ctx.channel.permissions_for(ctx.author)
|
||||
|
||||
return all(getattr(resolved, name, None) == value for name, value in perms.items())
|
||||
return all(
|
||||
getattr(resolved, name, None) == value for name, value in perms.items()
|
||||
)
|
||||
|
||||
|
||||
def guild_owner_or_permissions(**perms: Dict[str, bool]):
|
||||
|
|
|
@ -1,171 +1,69 @@
|
|||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
from typing import List, Dict, Union, Any
|
||||
from flatten_dict import flatten, unflatten
|
||||
from typing import List, Dict
|
||||
from structured_config import (
|
||||
Structure,
|
||||
IntField,
|
||||
StrField,
|
||||
BoolField,
|
||||
ConfigFile,
|
||||
)
|
||||
|
||||
import discord
|
||||
|
||||
from tuxbot.core.data_manager import data_path
|
||||
|
||||
__all__ = ["Config"]
|
||||
__all__ = ["Config", "ConfigFile"]
|
||||
|
||||
log = logging.getLogger("tuxbot.core.config")
|
||||
|
||||
|
||||
class Config:
|
||||
def __init__(self, cog_instance: str = None):
|
||||
self._cog_instance = cog_instance
|
||||
class Server(Structure):
|
||||
prefixes: List[str] = []
|
||||
disabled_command: List[str] = []
|
||||
locale: str = StrField("")
|
||||
blacklisted: bool = BoolField(False)
|
||||
|
||||
self.lock = asyncio.Lock()
|
||||
self.loop = asyncio.get_event_loop()
|
||||
|
||||
self._settings_file = None
|
||||
self._datas = {}
|
||||
class Channel(Structure):
|
||||
disabled_command: List[str] = []
|
||||
locale: str = StrField("")
|
||||
blacklisted: bool = BoolField(False)
|
||||
|
||||
def __getitem__(self, item) -> Dict:
|
||||
path = data_path(self._cog_instance)
|
||||
|
||||
if item != "core":
|
||||
path = path / "cogs" / item
|
||||
else:
|
||||
path /= "core"
|
||||
class User(Structure):
|
||||
aliases: List[dict] = []
|
||||
locale: str = StrField("")
|
||||
blacklisted: bool = BoolField(False)
|
||||
|
||||
settings_file = path / "settings.json"
|
||||
|
||||
if not settings_file.exists():
|
||||
raise FileNotFoundError(
|
||||
f"Unable to find settings file " f"'{settings_file}'"
|
||||
)
|
||||
else:
|
||||
with settings_file.open("r") as f:
|
||||
return json.load(f)
|
||||
class Config(Structure):
|
||||
class Servers(Structure):
|
||||
all: Dict[int, Server] = {}
|
||||
|
||||
def __call__(self, item):
|
||||
return self.__getitem__(item)
|
||||
class Channels(Structure):
|
||||
all: Dict[int, Channel] = {}
|
||||
|
||||
def owners_id(self) -> List[int]:
|
||||
"""Simply return the owners id saved in config file.
|
||||
class Users(Structure):
|
||||
all: Dict[int, User] = {}
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
Owners id.
|
||||
"""
|
||||
return self.__getitem__("core").get("owners_id")
|
||||
class Core(Structure):
|
||||
owners_id: List[int] = []
|
||||
prefixes: List[str] = []
|
||||
token: str = StrField("")
|
||||
mentionable: bool = BoolField("")
|
||||
locale: str = StrField("")
|
||||
disabled_command: List[str] = []
|
||||
|
||||
def token(self) -> str:
|
||||
"""Simply return the bot token saved in config file.
|
||||
class Cogs(Structure):
|
||||
pass
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
Bot token.
|
||||
"""
|
||||
return self.__getitem__("core").get("token")
|
||||
|
||||
def get_prefixes(self, guild: discord.Guild) -> List[str]:
|
||||
"""Get custom prefixes for one guild.
|
||||
# =============================================================================
|
||||
# Configuration of Tuxbot Application (not the bot)
|
||||
# =============================================================================
|
||||
|
||||
Parameters
|
||||
----------
|
||||
guild:discord.Guild
|
||||
The required guild prefixes.
|
||||
|
||||
Returns
|
||||
-------
|
||||
List[str]
|
||||
List of all prefixes.
|
||||
"""
|
||||
core = self.__getitem__("core")
|
||||
prefixes = core.get("guild", {}).get(guild.id, {}).get("prefixes", [])
|
||||
class AppConfig(Structure):
|
||||
class Instance(Structure):
|
||||
path: str = StrField("")
|
||||
active: bool = BoolField(False)
|
||||
last_run: int = IntField(0)
|
||||
|
||||
return prefixes
|
||||
|
||||
def get_blacklist(self, key: str) -> List[Union[str, int]]:
|
||||
"""Return list off all blacklisted values
|
||||
|
||||
Parameters
|
||||
----------
|
||||
key:str
|
||||
Which type of blacklist to choice (guilds ? channels ?,...).
|
||||
|
||||
Returns
|
||||
-------
|
||||
List[Union[str, int]]
|
||||
List containing blacklisted values.
|
||||
"""
|
||||
core = self.__getitem__("core")
|
||||
blacklist = core.get("blacklist", {}).get(key, [])
|
||||
|
||||
return blacklist
|
||||
|
||||
def _dump(self):
|
||||
with self._settings_file.open("w") as f:
|
||||
json.dump(self._datas, f, indent=4)
|
||||
|
||||
async def update(self, cog_name: str, item: str, value: Any) -> dict:
|
||||
"""Update values in config file.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
cog_name:str
|
||||
Name of cog who's corresponding to the config file.
|
||||
item:str
|
||||
Key to update.
|
||||
value:Any
|
||||
New values to apply.
|
||||
|
||||
Returns
|
||||
-------
|
||||
dict:
|
||||
Updated values.
|
||||
|
||||
"""
|
||||
datas = self.__getitem__(cog_name)
|
||||
path = data_path(self._cog_instance)
|
||||
|
||||
flat_datas = flatten(datas)
|
||||
flat_datas[tuple(item.split("."))] = value
|
||||
datas = unflatten(flat_datas)
|
||||
|
||||
self._datas = datas
|
||||
|
||||
if cog_name != "core":
|
||||
path = path / "cogs" / cog_name
|
||||
else:
|
||||
path /= "core"
|
||||
|
||||
self._settings_file = path / "settings.json"
|
||||
|
||||
async with self.lock:
|
||||
await self.loop.run_in_executor(None, self._dump)
|
||||
|
||||
return datas
|
||||
|
||||
def get_value(self, cog_name: str, key: str, default: Any = None) -> Any:
|
||||
"""Get value by key.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
cog_name:str
|
||||
Name of cog who's corresponding to the config file.
|
||||
key:str
|
||||
Key to fetch.
|
||||
default:Any|Optional
|
||||
Default value.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any:
|
||||
Recovered value.
|
||||
|
||||
"""
|
||||
datas = self.__getitem__(cog_name)
|
||||
|
||||
flat_datas = flatten(datas)
|
||||
|
||||
try:
|
||||
return flat_datas[tuple(key.split("."))]
|
||||
except KeyError:
|
||||
return default
|
||||
instances: Dict[str, Instance] = {}
|
||||
|
|
|
@ -7,7 +7,7 @@ log = logging.getLogger("tuxbot.core.data_manager")
|
|||
|
||||
app_dir = appdirs.AppDirs("Tuxbot-bot")
|
||||
config_dir = Path(app_dir.user_config_dir)
|
||||
config_file = config_dir / "config.json"
|
||||
config_file = config_dir / "config.yaml"
|
||||
|
||||
|
||||
def data_path(instance_name: str) -> Path:
|
||||
|
@ -25,52 +25,6 @@ def data_path(instance_name: str) -> Path:
|
|||
return Path(app_dir.user_data_dir) / "data" / instance_name
|
||||
|
||||
|
||||
def core_path(instance_name: str) -> Path:
|
||||
"""Return Path for core configs.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
instance_name:str
|
||||
|
||||
Returns
|
||||
-------
|
||||
Path
|
||||
Generated path for core configs.
|
||||
"""
|
||||
return data_path(instance_name) / "data" / instance_name / "core"
|
||||
|
||||
|
||||
def cogs_data_path(instance_name: str) -> Path:
|
||||
"""Return Path for cogs configs.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
instance_name:str
|
||||
|
||||
Returns
|
||||
-------
|
||||
Path
|
||||
Generated path for cogs configs.
|
||||
"""
|
||||
return data_path(instance_name) / "data" / instance_name / "cogs"
|
||||
|
||||
|
||||
def cog_data_path(instance_name: str, cog_name: str) -> Path:
|
||||
"""Return Path for chosen configs for cog.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
instance_name:str
|
||||
cog_name:str
|
||||
|
||||
Returns
|
||||
-------
|
||||
Path
|
||||
Generated path for cog's configs.
|
||||
"""
|
||||
return data_path(instance_name) / "data" / instance_name / "cogs" / cog_name
|
||||
|
||||
|
||||
def logs_data_path(instance_name: str) -> Path:
|
||||
"""Return Path for logs.
|
||||
|
||||
|
|
|
@ -0,0 +1,9 @@
|
|||
from discord.ext import commands
|
||||
|
||||
|
||||
class DisabledCommandByServerOwner(commands.CheckFailure):
|
||||
pass
|
||||
|
||||
|
||||
class DisabledCommandByBotOwner(commands.CheckFailure):
|
||||
pass
|
|
@ -29,23 +29,21 @@ def find_locale(locale: str) -> str:
|
|||
|
||||
|
||||
def get_locale_name(locale: str) -> str:
|
||||
"""Return the name of this `locale`
|
||||
|
||||
"""
|
||||
"""Return the name of this `locale`"""
|
||||
return available_locales.get(find_locale(locale))[0]
|
||||
|
||||
|
||||
class Translator(Callable[[str], str]):
|
||||
"""Class to load texts at init."""
|
||||
|
||||
def __init__(self, name: str, file_location: Union[str, Path, os.PathLike]):
|
||||
def __init__(self, name: str, file_location: Union[Path, os.PathLike]):
|
||||
"""Initializes the Translator object.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
name : str
|
||||
The cog name.
|
||||
file_location:str|Path|os.PathLike
|
||||
file_location:Path|os.PathLike
|
||||
File path for the required extension.
|
||||
|
||||
"""
|
||||
|
@ -57,7 +55,9 @@ class Translator(Callable[[str], str]):
|
|||
|
||||
self.load_translations()
|
||||
|
||||
def __call__(self, untranslated: str, ctx: ContextPlus, config: Config) -> str:
|
||||
def __call__(
|
||||
self, untranslated: str, ctx: ContextPlus, config: Config
|
||||
) -> str:
|
||||
try:
|
||||
locale = config.get_value(
|
||||
"core",
|
||||
|
@ -75,10 +75,8 @@ class Translator(Callable[[str], str]):
|
|||
)
|
||||
|
||||
def load_translations(self):
|
||||
"""Loads the current translations.
|
||||
|
||||
"""
|
||||
for locale in available_locales.keys():
|
||||
"""Loads the current translations."""
|
||||
for locale in available_locales:
|
||||
locale_path = self.cog_folder / "locales" / f"{locale}.po"
|
||||
|
||||
with locale_path.open("r") as f:
|
||||
|
@ -88,7 +86,9 @@ class Translator(Callable[[str], str]):
|
|||
if message.id:
|
||||
self._add_translation(locale, message.id, message.string)
|
||||
|
||||
def _add_translation(self, locale: str, untranslated: str, translated: str):
|
||||
def _add_translation(
|
||||
self, locale: str, untranslated: str, translated: str
|
||||
):
|
||||
if translated:
|
||||
if not self.translations.get(locale, False):
|
||||
self.translations[locale] = {}
|
||||
|
|
|
@ -1,89 +0,0 @@
|
|||
import codecs
|
||||
import itertools
|
||||
import sys
|
||||
|
||||
|
||||
def bordered(*columns: dict) -> str:
|
||||
"""
|
||||
credits to https://github.com/Cog-Creators/Red-DiscordBot/blob/V3/develop/redbot/core/utils/chat_formatting.py
|
||||
|
||||
Get two blocks of text in a borders.
|
||||
|
||||
Note
|
||||
----
|
||||
This will only work with a monospaced font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
*columns : `sequence` of `str`
|
||||
The columns of text, each being a list of lines in that column.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
The bordered text.
|
||||
|
||||
"""
|
||||
encoder = codecs.getencoder(sys.stdout.encoding)
|
||||
try:
|
||||
encoder("┌┐└┘─│") # border symbols
|
||||
except UnicodeEncodeError:
|
||||
ascii_border = True
|
||||
else:
|
||||
ascii_border = False
|
||||
|
||||
borders = {
|
||||
"TL": "+" if ascii_border else "┌", # Top-left
|
||||
"TR": "+" if ascii_border else "┐", # Top-right
|
||||
"BL": "+" if ascii_border else "└", # Bottom-left
|
||||
"BR": "+" if ascii_border else "┘", # Bottom-right
|
||||
"HZ": "-" if ascii_border else "─", # Horizontal
|
||||
"VT": "|" if ascii_border else "│", # Vertical
|
||||
}
|
||||
|
||||
sep = " " * 4 # Separator between boxes
|
||||
widths = tuple(
|
||||
max(len(row) for row in column.get("rows")) + 9 for column in columns
|
||||
) # width of each col
|
||||
cols_done = [False] * len(columns) # whether or not each column is done
|
||||
lines = [""]
|
||||
|
||||
for i, column in enumerate(columns):
|
||||
lines[0] += (
|
||||
"{TL}"
|
||||
+ "{HZ}"
|
||||
+ column.get("title")
|
||||
+ "{HZ}" * (widths[i] - len(column.get("title")) - 1)
|
||||
+ "{TR}"
|
||||
+ sep
|
||||
)
|
||||
|
||||
for line in itertools.zip_longest(*[column.get("rows") for column in columns]):
|
||||
row = []
|
||||
for colidx, column in enumerate(line):
|
||||
width = widths[colidx]
|
||||
done = cols_done[colidx]
|
||||
if column is None:
|
||||
if not done:
|
||||
# bottom border of column
|
||||
column = "{HZ}" * width
|
||||
row.append("{BL}" + column + "{BR}")
|
||||
cols_done[colidx] = True # mark column as done
|
||||
else:
|
||||
# leave empty
|
||||
row.append(" " * (width + 2))
|
||||
else:
|
||||
column += " " * (width - len(column)) # append padded spaces
|
||||
row.append("{VT}" + column + "{VT}")
|
||||
|
||||
lines.append(sep.join(row))
|
||||
|
||||
final_row = []
|
||||
for width, done in zip(widths, cols_done):
|
||||
if not done:
|
||||
final_row.append("{BL}" + "{HZ}" * width + "{BR}")
|
||||
else:
|
||||
final_row.append(" " * (width + 2))
|
||||
lines.append(sep.join(final_row))
|
||||
|
||||
return "\n".join(lines).format(**borders)
|
|
@ -1,14 +1,32 @@
|
|||
import asyncio
|
||||
import yaml
|
||||
|
||||
import discord
|
||||
from discord import Embed
|
||||
from discord.ext import commands, flags
|
||||
|
||||
from rich.console import Console
|
||||
|
||||
console = Console()
|
||||
|
||||
console.clear()
|
||||
|
||||
|
||||
class ContextPlus(commands.Context):
|
||||
async def send(self, content=None, *args, **kwargs):
|
||||
if content is not None:
|
||||
content = content.replace(
|
||||
self.bot.config("core").get("token"), "<token>"
|
||||
)
|
||||
if kwargs.get("embed"):
|
||||
e = str(kwargs.get("embed").to_dict())
|
||||
e = e.replace(self.bot.config("core").get("token"), "<token>")
|
||||
e = yaml.load(e, Loader=yaml.FullLoader)
|
||||
kwargs["embed"] = Embed.from_dict(e)
|
||||
|
||||
if (
|
||||
hasattr(self.command, "deletable") and self.command.deletable
|
||||
) and kwargs.pop("deletable", True):
|
||||
) or kwargs.pop("deletable", False):
|
||||
message = await super().send(content, *args, **kwargs)
|
||||
await message.add_reaction("🗑")
|
||||
|
||||
|
@ -20,7 +38,9 @@ class ContextPlus(commands.Context):
|
|||
)
|
||||
|
||||
try:
|
||||
await self.bot.wait_for("reaction_add", timeout=45.0, check=check)
|
||||
await self.bot.wait_for(
|
||||
"reaction_add", timeout=42.0, check=check
|
||||
)
|
||||
except asyncio.TimeoutError:
|
||||
await message.remove_reaction("🗑", self.bot.user)
|
||||
else:
|
||||
|
|
|
@ -0,0 +1,22 @@
|
|||
from typing import List
|
||||
|
||||
import discord
|
||||
|
||||
from tuxbot.core.bot import Tux
|
||||
|
||||
|
||||
def get_prefixes(tux: Tux, guild: discord.Guild) -> List[str]:
|
||||
"""Get custom prefixes for one guild.
|
||||
Parameters
|
||||
----------
|
||||
tux:Tux
|
||||
The bot instance.
|
||||
|
||||
guild:discord.Guild
|
||||
The required guild prefixes.
|
||||
Returns
|
||||
-------
|
||||
List[str]
|
||||
List of all prefixes.
|
||||
"""
|
||||
return tux.config.Servers.all[guild.id].prefixes or []
|
|
@ -6,6 +6,12 @@ import sys
|
|||
MAX_OLD_LOGS = 8
|
||||
MAX_BYTES = 5_000_000
|
||||
|
||||
formatter = logging.Formatter(
|
||||
"[{asctime}] [{levelname}] {name}: {message}",
|
||||
datefmt="%Y-%m-%d %H:%M:%S",
|
||||
style="{",
|
||||
)
|
||||
|
||||
|
||||
def init_logging(level: int, location: pathlib.Path) -> None:
|
||||
"""Initialize loggers.
|
||||
|
@ -26,19 +32,15 @@ def init_logging(level: int, location: pathlib.Path) -> None:
|
|||
base_logger.setLevel(level)
|
||||
base_logger_file = location / "tuxbot.log"
|
||||
|
||||
formatter = logging.Formatter(
|
||||
"[{asctime}] [{levelname}] {name}: {message}",
|
||||
datefmt="%Y-%m-%d %H:%M:%S",
|
||||
style="{",
|
||||
)
|
||||
|
||||
dpy_handler = logging.handlers.RotatingFileHandler(
|
||||
str(dpy_logger_file.resolve()),
|
||||
maxBytes=MAX_BYTES, backupCount=MAX_OLD_LOGS
|
||||
maxBytes=MAX_BYTES,
|
||||
backupCount=MAX_OLD_LOGS,
|
||||
)
|
||||
base_handler = logging.handlers.RotatingFileHandler(
|
||||
str(base_logger_file.resolve()),
|
||||
maxBytes=MAX_BYTES, backupCount=MAX_OLD_LOGS
|
||||
maxBytes=MAX_BYTES,
|
||||
backupCount=MAX_OLD_LOGS,
|
||||
)
|
||||
|
||||
stdout_handler = logging.StreamHandler(sys.stdout)
|
||||
|
|
244
tuxbot/setup.py
244
tuxbot/setup.py
|
@ -9,9 +9,10 @@ from rich.prompt import Prompt, IntPrompt
|
|||
from rich.console import Console
|
||||
from rich.rule import Rule
|
||||
from rich.traceback import install
|
||||
from rich import print
|
||||
|
||||
from tuxbot.logging import formatter
|
||||
from tuxbot.core.data_manager import config_dir, app_dir
|
||||
from tuxbot.core import config
|
||||
|
||||
console = Console()
|
||||
console.clear()
|
||||
|
@ -20,56 +21,17 @@ install(console=console)
|
|||
try:
|
||||
config_dir.mkdir(parents=True, exist_ok=True)
|
||||
except PermissionError:
|
||||
print(f"mkdir: cannot create directory '{config_dir}': Permission denied")
|
||||
console.print(
|
||||
f"mkdir: cannot create directory '{config_dir}': Permission denied"
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
config_file = config_dir / "config.json"
|
||||
app_config = config.ConfigFile(config_dir / "config.yaml", config.AppConfig)
|
||||
|
||||
|
||||
def load_existing_config() -> dict:
|
||||
"""Loading and returning configs.
|
||||
|
||||
Returns
|
||||
-------
|
||||
dict
|
||||
a dict containing all configurations.
|
||||
|
||||
"""
|
||||
if not config_file.exists():
|
||||
return {}
|
||||
|
||||
with config_file.open() as fs:
|
||||
return json.load(fs)
|
||||
|
||||
|
||||
instances_data = load_existing_config()
|
||||
if not instances_data:
|
||||
if not app_config.config.instances:
|
||||
instances_list = []
|
||||
else:
|
||||
instances_list = list(instances_data.keys())
|
||||
|
||||
|
||||
def save_config(name: str, data: dict, delete=False) -> NoReturn:
|
||||
"""save data in config file.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
name:str
|
||||
name of instance.
|
||||
data:dict
|
||||
settings for `name` instance.
|
||||
delete:bool
|
||||
delete or no data.
|
||||
"""
|
||||
_config = load_existing_config()
|
||||
|
||||
if delete and name in _config:
|
||||
_config.pop(name)
|
||||
else:
|
||||
_config[name] = data
|
||||
|
||||
with config_file.open("w") as fs:
|
||||
json.dump(_config, fs, indent=4)
|
||||
instances_list = list(app_config.config.instances.keys())
|
||||
|
||||
|
||||
def get_name() -> str:
|
||||
|
@ -86,11 +48,11 @@ def get_name() -> str:
|
|||
"What name do you want to give this instance?\n"
|
||||
"[i](valid characters: A-Z, a-z, 0-9, _, -)[/i]\n",
|
||||
default="prod",
|
||||
console=console
|
||||
console=console,
|
||||
)
|
||||
if re.fullmatch(r"[a-zA-Z0-9_\-]*", name) is None:
|
||||
print()
|
||||
print("[prompt.invalid]ERROR: Invalid characters provided")
|
||||
console.print()
|
||||
console.print("[prompt.invalid]ERROR: Invalid characters provided")
|
||||
name = ""
|
||||
return name
|
||||
|
||||
|
@ -111,14 +73,14 @@ def get_data_dir(instance_name: str) -> Path:
|
|||
"""
|
||||
data_path = Path(app_dir.user_data_dir) / "data" / instance_name
|
||||
data_path_input = ""
|
||||
print()
|
||||
console.print()
|
||||
|
||||
def make_data_dir(path: Path) -> Union[Path, str]:
|
||||
try:
|
||||
path.mkdir(parents=True, exist_ok=True)
|
||||
except OSError:
|
||||
print()
|
||||
print(
|
||||
console.print()
|
||||
console.print(
|
||||
f"mkdir: cannot create directory '{path}': Permission denied"
|
||||
)
|
||||
path = ""
|
||||
|
@ -130,15 +92,15 @@ def get_data_dir(instance_name: str) -> Path:
|
|||
Prompt.ask(
|
||||
"where do you want to save the configurations?",
|
||||
default=str(data_path),
|
||||
console=console
|
||||
console=console,
|
||||
)
|
||||
)
|
||||
|
||||
try:
|
||||
exists = data_path_input.exists()
|
||||
except OSError:
|
||||
print()
|
||||
print(
|
||||
console.print()
|
||||
console.print(
|
||||
"[prompt.invalid]"
|
||||
"Impossible to verify the validity of the path,"
|
||||
" make sure it does not contain any invalid characters."
|
||||
|
@ -149,22 +111,21 @@ def get_data_dir(instance_name: str) -> Path:
|
|||
if data_path_input and not exists:
|
||||
data_path_input = make_data_dir(data_path_input)
|
||||
|
||||
print()
|
||||
print(
|
||||
console.print()
|
||||
console.print(
|
||||
f"You have chosen {data_path_input} to be your config directory for "
|
||||
f"`{instance_name}` instance"
|
||||
)
|
||||
|
||||
if Prompt.ask(
|
||||
"Please confirm",
|
||||
choices=["y", "n"], default="y",
|
||||
console=console
|
||||
) != "y":
|
||||
print("Rerun the process to redo this configuration.")
|
||||
if (
|
||||
Prompt.ask(
|
||||
"Please confirm", choices=["y", "n"], default="y", console=console
|
||||
)
|
||||
!= "y"
|
||||
):
|
||||
console.print("Rerun the process to redo this configuration.")
|
||||
sys.exit(0)
|
||||
|
||||
(data_path_input / "core").mkdir(parents=True, exist_ok=True)
|
||||
(data_path_input / "cogs").mkdir(parents=True, exist_ok=True)
|
||||
(data_path_input / "logs").mkdir(parents=True, exist_ok=True)
|
||||
|
||||
return data_path_input
|
||||
|
@ -184,20 +145,23 @@ def get_token() -> str:
|
|||
token = Prompt.ask(
|
||||
"Please enter the bot token "
|
||||
"(you can find it at https://discord.com/developers/applications)",
|
||||
console=console
|
||||
console=console,
|
||||
)
|
||||
if re.fullmatch(
|
||||
if (
|
||||
re.fullmatch(
|
||||
r"([a-zA-Z0-9]{24}\.[a-zA-Z0-9_]{6}\.[a-zA-Z0-9_\-]{27}"
|
||||
r"|mfa\.[a-zA-Z0-9_\-]{84})",
|
||||
token) \
|
||||
is None:
|
||||
print("[prompt.invalid]ERROR: Invalid token provided")
|
||||
token,
|
||||
)
|
||||
is None
|
||||
):
|
||||
console.print("[prompt.invalid]ERROR: Invalid token provided")
|
||||
token = ""
|
||||
return token
|
||||
|
||||
|
||||
def get_multiple(
|
||||
question: str, confirmation: str, value_type: type
|
||||
question: str, confirmation: str, value_type: type
|
||||
) -> List[Union[str, int]]:
|
||||
"""Give possibility to user to fill multiple value.
|
||||
|
||||
|
@ -224,17 +188,18 @@ def get_multiple(
|
|||
|
||||
values = [user_input]
|
||||
|
||||
while Prompt.ask(
|
||||
confirmation,
|
||||
choices=["y", "n"], default="y",
|
||||
console=console
|
||||
) != "n":
|
||||
while (
|
||||
Prompt.ask(
|
||||
confirmation, choices=["y", "n"], default="n", console=console
|
||||
)
|
||||
!= "n"
|
||||
):
|
||||
new = prompt.ask("Other")
|
||||
|
||||
if new not in values:
|
||||
values.append(new)
|
||||
else:
|
||||
print(
|
||||
console.print(
|
||||
f"[prompt.invalid]"
|
||||
f"ERROR: `{new}` is already present, [i]ignored[/i]"
|
||||
)
|
||||
|
@ -250,21 +215,21 @@ def additional_config() -> dict:
|
|||
dict:
|
||||
Dict with cog name as key and configs as value.
|
||||
"""
|
||||
p = Path(r"tuxbot/cogs").glob("**/additional_config.json")
|
||||
paths = Path("tuxbot/cogs").glob("**/config.py")
|
||||
data = {}
|
||||
|
||||
for file in p:
|
||||
print("\n" * 4)
|
||||
for file in paths:
|
||||
console.print("\n" * 4)
|
||||
cog_name = str(file.parent).split("/")[-1]
|
||||
data[cog_name] = {}
|
||||
|
||||
with file.open("r") as f:
|
||||
data = json.load(f)
|
||||
|
||||
print(Rule(f"\nConfiguration for `{cog_name}` module"))
|
||||
console.print(Rule(f"\nConfiguration for `{cog_name}` module"))
|
||||
|
||||
for key, value in data.items():
|
||||
print()
|
||||
console.print()
|
||||
data[cog_name][key] = Prompt.ask(value["description"])
|
||||
|
||||
return data
|
||||
|
@ -278,98 +243,88 @@ def finish_setup(data_dir: Path) -> NoReturn:
|
|||
data_dir:Path
|
||||
Where to save configs.
|
||||
"""
|
||||
print(
|
||||
Rule(
|
||||
"Now, it's time to finish this setup by giving bot information"
|
||||
)
|
||||
console.print(
|
||||
Rule("Now, it's time to finish this setup by giving bot information")
|
||||
)
|
||||
print()
|
||||
console.print()
|
||||
|
||||
token = get_token()
|
||||
|
||||
print()
|
||||
console.print()
|
||||
prefixes = get_multiple(
|
||||
"Choice a (or multiple) prefix for the bot", "Add another prefix ?",
|
||||
str
|
||||
"Choice a (or multiple) prefix for the bot",
|
||||
"Add another prefix ?",
|
||||
str,
|
||||
)
|
||||
|
||||
print()
|
||||
mentionable = Prompt.ask(
|
||||
"Does the bot answer if it's mentioned?",
|
||||
choices=["y", "n"],
|
||||
default="y"
|
||||
) == "y"
|
||||
console.print()
|
||||
mentionable = (
|
||||
Prompt.ask(
|
||||
"Does the bot answer if it's mentioned?",
|
||||
choices=["y", "n"],
|
||||
default="y",
|
||||
)
|
||||
== "y"
|
||||
)
|
||||
|
||||
print()
|
||||
console.print()
|
||||
owners_id = get_multiple(
|
||||
"Give the owner id of this bot", "Add another owner ?", int
|
||||
)
|
||||
|
||||
cogs_config = additional_config()
|
||||
instance_config = config.ConfigFile(
|
||||
str(data_dir / "config.yaml"), config.Config
|
||||
)
|
||||
|
||||
core_file = data_dir / "core" / "settings.json"
|
||||
core = {
|
||||
"token": token,
|
||||
"prefixes": prefixes,
|
||||
"mentionable": mentionable,
|
||||
"owners_id": owners_id,
|
||||
"locale": "en-US",
|
||||
}
|
||||
|
||||
with core_file.open("w") as fs:
|
||||
json.dump(core, fs, indent=4)
|
||||
|
||||
for cog, data in cogs_config.items():
|
||||
data_cog_dir = data_dir / "cogs" / cog
|
||||
data_cog_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
data_cog_file = data_cog_dir / "settings.json"
|
||||
|
||||
with data_cog_file.open("w") as fs:
|
||||
json.dump(data, fs, indent=4)
|
||||
instance_config.config.Core.owners_id = owners_id
|
||||
instance_config.config.Core.prefixes = prefixes
|
||||
instance_config.config.Core.token = token
|
||||
instance_config.config.Core.mentionable = mentionable
|
||||
instance_config.config.Core.locale = "en-US"
|
||||
|
||||
|
||||
def basic_setup() -> NoReturn:
|
||||
"""Configs who refer to instances.
|
||||
|
||||
"""
|
||||
print(
|
||||
"""Configs who refer to instances."""
|
||||
console.print(
|
||||
Rule(
|
||||
"Hi ! it's time for you to give me information about you instance"
|
||||
)
|
||||
)
|
||||
print()
|
||||
console.print()
|
||||
name = get_name()
|
||||
|
||||
data_dir = get_data_dir(name)
|
||||
|
||||
configs = load_existing_config()
|
||||
instance_config = configs[name] if name in instances_list else {}
|
||||
|
||||
instance_config["DATA_PATH"] = str(data_dir.resolve())
|
||||
instance_config["IS_RUNNING"] = False
|
||||
|
||||
if name in instances_list:
|
||||
print()
|
||||
console.print()
|
||||
console.print(
|
||||
f"WARNING: An instance named `{name}` already exists "
|
||||
f"Continuing will overwrite this instance configs.", style="red"
|
||||
f"Continuing will overwrite this instance configs.",
|
||||
style="red",
|
||||
)
|
||||
if Prompt.ask(
|
||||
if (
|
||||
Prompt.ask(
|
||||
"Are you sure you want to continue?",
|
||||
choices=["y", "n"], default="n"
|
||||
) == "n":
|
||||
print("Abandon...")
|
||||
choices=["y", "n"],
|
||||
default="n",
|
||||
)
|
||||
== "n"
|
||||
):
|
||||
console.print("Abandon...")
|
||||
sys.exit(0)
|
||||
|
||||
save_config(name, instance_config)
|
||||
instance = config.AppConfig.Instance()
|
||||
instance.path = str(data_dir.resolve())
|
||||
instance.active = False
|
||||
|
||||
print("\n" * 4)
|
||||
app_config.config.instances[name] = instance
|
||||
|
||||
console.print("\n" * 4)
|
||||
|
||||
finish_setup(data_dir)
|
||||
|
||||
print()
|
||||
print(
|
||||
console.print()
|
||||
console.print(
|
||||
f"Instance successfully created! "
|
||||
f"You can now run `tuxbot {name}` to launch this instance"
|
||||
)
|
||||
|
@ -377,23 +332,18 @@ def basic_setup() -> NoReturn:
|
|||
|
||||
def setup() -> NoReturn:
|
||||
try:
|
||||
"""Create a new instance."""
|
||||
# Create a new instance.
|
||||
level = logging.DEBUG
|
||||
base_logger = logging.getLogger("tuxbot")
|
||||
base_logger.setLevel(level)
|
||||
formatter = logging.Formatter(
|
||||
"[{asctime}] [{levelname}] {name}: {message}",
|
||||
datefmt="%Y-%m-%d %H:%M:%S",
|
||||
style="{",
|
||||
)
|
||||
stdout_handler = logging.StreamHandler(sys.stdout)
|
||||
stdout_handler.setFormatter(formatter)
|
||||
base_logger.addHandler(stdout_handler)
|
||||
|
||||
basic_setup()
|
||||
except KeyboardInterrupt:
|
||||
print("Exiting...")
|
||||
except:
|
||||
console.print("Exiting...")
|
||||
except Exception:
|
||||
console.print_exception()
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue