forked from sch/KaikOut
[WIP] This is the first commit, due to a demand of Kris. We will continue after Sunday in order to be coordinated with our Christian brothers.
This commit is contained in:
commit
632622f98f
27 changed files with 4744 additions and 0 deletions
661
LICENSE
Normal file
661
LICENSE
Normal file
|
@ -0,0 +1,661 @@
|
|||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
KaikOut moderation chat bot for the XMPP communication network.
|
||||
Copyright (C) 2024 Schimon Jehudah Zakai Zockaim Zachary
|
||||
|
||||
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/>.
|
130
README.md
Normal file
130
README.md
Normal file
|
@ -0,0 +1,130 @@
|
|||
# Moderation bot for XMPP
|
||||
|
||||
KaikOut is a portmanteau of Kaiko and Out.
|
||||
|
||||
Kaiko (懐古) translates from Japanese to "Old-Fashioned".
|
||||
|
||||
_Because spam has never been in fashion, unless it is served on a plate._
|
||||
|
||||
## KaikOut
|
||||
|
||||
KaikOut is a moderation bot for the XMPP communication network.
|
||||
|
||||
KaikOut is an XMPP bot that suprvises group chat activity and assists in blocking and preventing of abusive and unsolicited type of messages and activities.
|
||||
|
||||
KaikOut is designed primarily for the XMPP communication network (aka Jabber). Visit https://xmpp.org/software/ for more information.
|
||||
|
||||
You can run your own KaikOut instance as a client, from your own computer, server, and even from a Linux phone (i.e. Droidian, Kupfer, Mobian, NixOS, postmarketOS), as well as from Termux.
|
||||
|
||||
All you need is one of the above and an XMPP account to connect KaikOut with.
|
||||
|
||||
Good luck!
|
||||
|
||||
### Slixmpp
|
||||
|
||||
KaikOut is a powered by [slixmpp](https://codeberg.org/poezio/slixmpp).
|
||||
|
||||
### XMPP
|
||||
|
||||
XMPP is the Extensible Messaging and Presence Protocol, a set of open technologies for instant messaging, presence, multi-party chat, voice and video calls, collaboration, lightweight middleware, content syndication, and generalized routing of XML data.
|
||||
|
||||
Visit [XMPP](https://xmpp.org/) for more information [about](https://xmpp.org/about/) the XMPP protocol and check the [list](https://xmpp.org/software/) of XMPP clients.
|
||||
|
||||
KaikOut is primarily designed for XMPP (aka Jabber), yet it is built to be extended to other protocols.
|
||||
|
||||
## Features
|
||||
|
||||
### Control
|
||||
|
||||
- **Blocklist** - Check messages for denied phrases and words (activated by default).
|
||||
- **Frequency** - Check the frequency of messages and status messages (activated by default).
|
||||
- **Inactivity** - Check for inactivity (deactivated by default).
|
||||
- **Moderation Abuse** - KaikOut moderates the moderators.
|
||||
|
||||
### Report
|
||||
|
||||
- **Logger** - Log messages to CSV files.
|
||||
- **Moderation Reports** - KaikOut immediately reports to moderators about moderation activities made by other moderators.
|
||||
- **Self Reports** - KaikOut immediately reports to moderators about its moderation activities.
|
||||
|
||||
### Special
|
||||
|
||||
- **Remote Management** - KaikOut can be managed in two fashions, publicly (groupchat) and privately (chat).
|
||||
- **Simultaneous** - KaikOut is designed to handle multiple contacts, including groupchats, Simultaneously.
|
||||
- **Visual interface** - Interactive interface for XMPP using Ad-Hoc Commands,
|
||||
|
||||
## Preview
|
||||
|
||||
KaikOut as appears with Cheogram.
|
||||
|
||||
<img alt="Chat: Session" src="kaikout/documentation/screenshots/chat_session.jpg" width="200px"/>
|
||||
<img alt="Ad-Hoc: Commands" src="kaikout/documentation/screenshots/adhoc_commands.jpg" width="200px"/>
|
||||
<img alt="Ad-Hoc: Edit bookmark" src="kaikout/documentation/screenshots/adhoc_edit.jpg" width="200px"/>
|
||||
<img alt="Ad-Hoc: Settings" width="200px" src="kaikout/documentation/screenshots/adhoc_settings.jpg"/>
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Install
|
||||
|
||||
It is possible to install KaikOut using pip and pipx.
|
||||
|
||||
#### pip inside venv
|
||||
|
||||
```
|
||||
$ python3 -m venv .venv
|
||||
$ source .venv/bin/activate
|
||||
$ pip install git+https://git.xmpp-it.net/sch/KaikOut
|
||||
```
|
||||
|
||||
#### pipx
|
||||
|
||||
##### Install
|
||||
|
||||
```
|
||||
$ pipx install git+https://git.xmpp-it.net/sch/KaikOut
|
||||
```
|
||||
|
||||
##### Update
|
||||
|
||||
```
|
||||
$ pipx uninstall kaikout
|
||||
$ pipx install git+https://git.xmpp-it.net/sch/KaikOut
|
||||
```
|
||||
|
||||
### Start
|
||||
|
||||
Start by executing the command `kaikout` and enter Username and Password of an existing XMPP account.
|
||||
|
||||
```
|
||||
$ kaikout
|
||||
```
|
||||
|
||||
You can also start KaikOut as follows:
|
||||
|
||||
```
|
||||
$ kaikout --jid ACCOUNT_JABBER_ID --password ACCOUNT_PASSWORD
|
||||
```
|
||||
|
||||
It is advised to use a dedicated extra account for KaikOut.
|
||||
|
||||
## Recommended Clients
|
||||
|
||||
KaikOut works with any XMPP chat client; if you want to make use of the visual interface which KaikOut has to offer (i.e. Ad-Hoc Commands), then you are advised to use [Cheogram](https://cheogram.com), [Converse](https://conversejs.org), [Gajim](https://gajim.org), [monocles chat](https://monocles.chat), [Movim](https://mov.im), [Poezio](https://poez.io), [Profanity](https://profanity-im.github.io), [Psi](https://psi-im.org) or [Psi+](https://psi-plus.com).
|
||||
|
||||
### Support
|
||||
|
||||
Please join our support groupchat whether you want help, discuss new features or just greet us.
|
||||
|
||||
- [Main Groupchat](xmpp:kaikout@chat.woodpeckersnest.space?join) (International)
|
||||
|
||||
## Authors
|
||||
|
||||
[Schimon](xmpp:sch@pimux.de?message) (Author).
|
||||
|
||||
## License
|
||||
|
||||
AGPL3 license.
|
||||
|
||||
## Copyright
|
||||
|
||||
Schimon Jehudah Zackary, 2024
|
3
kaikout/__init__.py
Normal file
3
kaikout/__init__.py
Normal file
|
@ -0,0 +1,3 @@
|
|||
from kaikout.version import __version__, __version_info__
|
||||
|
||||
print('kaikout', __version__)
|
60
kaikout/__main__.py
Normal file
60
kaikout/__main__.py
Normal file
|
@ -0,0 +1,60 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
# Kaikout: Kaiko Out anti-spam bot for XMPP
|
||||
# Copyright (C) 2024 Schimon Zackary
|
||||
# This file is part of Kaikout.
|
||||
# See the file LICENSE for copying permission.
|
||||
|
||||
# from kaikout.about import Documentation
|
||||
from kaikout.utilities import Config
|
||||
# from kaikout.xmpp.chat import XmppChat
|
||||
from kaikout.xmpp.client import XmppClient
|
||||
from getpass import getpass
|
||||
from argparse import ArgumentParser
|
||||
import logging
|
||||
# import os
|
||||
# import slixmpp
|
||||
# import sys
|
||||
|
||||
def main():
|
||||
# Setup the command line arguments.
|
||||
parser = ArgumentParser(description=XmppClient.__doc__)
|
||||
|
||||
# Output verbosity options.
|
||||
parser.add_argument("-q", "--quiet", help="set logging to ERROR",
|
||||
action="store_const", dest="loglevel",
|
||||
const=logging.ERROR, default=logging.INFO)
|
||||
parser.add_argument("-d", "--debug", help="set logging to DEBUG",
|
||||
action="store_const", dest="loglevel",
|
||||
const=logging.DEBUG, default=logging.INFO)
|
||||
|
||||
# JID and password options.
|
||||
parser.add_argument("-j", "--jid", dest="jid",
|
||||
help="JID to use")
|
||||
parser.add_argument("-p", "--password", dest="password",
|
||||
help="password to use")
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
# Setup logging.
|
||||
logging.basicConfig(level=args.loglevel,
|
||||
format='%(levelname)-8s %(message)s')
|
||||
|
||||
if args.jid is None:
|
||||
args.jid = input("Username: ")
|
||||
if args.password is None:
|
||||
args.password = getpass("Password: ")
|
||||
|
||||
account_xmpp = Config.get_values('accounts.toml', 'xmpp')
|
||||
|
||||
# Try configuration file
|
||||
if 'client' in account_xmpp:
|
||||
jid = account_xmpp['client']['jid']
|
||||
password = account_xmpp['client']['password']
|
||||
alias = account_xmpp['client']['alias'] if 'alias' in account_xmpp['client'] else None
|
||||
hostname = account_xmpp['client']['hostname'] if 'hostname' in account_xmpp['client'] else None
|
||||
port = account_xmpp['client']['port'] if 'port' in account_xmpp['client'] else None
|
||||
XmppClient(jid, password, hostname, port, alias)
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
100
kaikout/about.py
Normal file
100
kaikout/about.py
Normal file
|
@ -0,0 +1,100 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
class Documentation:
|
||||
|
||||
def about():
|
||||
return ('KaikOut'
|
||||
'\n'
|
||||
'KaikOut - Kaiko Out group chat anti-spam and moderation bot.'
|
||||
'Spam has never been in fashion.'
|
||||
'\n\n'
|
||||
'KaikOut is an XMPP bot that suprvises group chat activity '
|
||||
'and assists in blocking and preventing of unsolicited type '
|
||||
'of messages.'
|
||||
'\n\n'
|
||||
'KaikOut is a portmanteau of Kaiko and Out'
|
||||
'\n'
|
||||
'Kaiko (懐古) translates from Japanese to "Old-Fashioned"'
|
||||
'\n\n'
|
||||
'https://git.xmpp-it.net/sch/Kaikout'
|
||||
'\n\n'
|
||||
'Copyright 2024 Schimon Jehudah Zackary'
|
||||
'\n\n'
|
||||
'Made in Switzerland'
|
||||
'\n\n'
|
||||
'🇨🇭️')
|
||||
|
||||
def commands():
|
||||
return ("add URL [tag1,tag2,tag3,...]"
|
||||
"\n"
|
||||
" Bookmark URL along with comma-separated tags."
|
||||
"\n\n"
|
||||
"mod name <ID> <TEXT>"
|
||||
"\n"
|
||||
" Modify bookmark title."
|
||||
"\n"
|
||||
"mod note <ID> <TEXT>"
|
||||
"\n"
|
||||
" Modify bookmark description."
|
||||
"\n"
|
||||
"tag [+|-] <ID> [tag1,tag2,tag3,...]"
|
||||
"\n"
|
||||
" Modify bookmark tags. Appends or deletes tags, if flag tag "
|
||||
"is preceded by \'+\' or \'-\' respectively."
|
||||
"\n"
|
||||
"del <ID> or <URL>"
|
||||
"\n"
|
||||
" Delete a bookmark by ID or URL."
|
||||
"\n"
|
||||
"\n"
|
||||
"id <ID>"
|
||||
"\n"
|
||||
" Print a bookmark by ID."
|
||||
"\n"
|
||||
"last"
|
||||
"\n"
|
||||
" Print most recently bookmarked item."
|
||||
"\n"
|
||||
"tag <TEXT>"
|
||||
"\n"
|
||||
" Search bookmarks of given tag."
|
||||
"\n"
|
||||
"search <TEXT>"
|
||||
"\n"
|
||||
" Search bookmarks by a given search query."
|
||||
"\n"
|
||||
"search any <TEXT>"
|
||||
"\n"
|
||||
" Search bookmarks by a any given keyword."
|
||||
# "\n"
|
||||
# "regex"
|
||||
# "\n"
|
||||
# " Search bookmarks using Regular Expression."
|
||||
"\n")
|
||||
|
||||
def notice():
|
||||
return ('Copyright 2024 Schimon Jehudah Zackary'
|
||||
'\n\n'
|
||||
'Permission is hereby granted, free of charge, to any person '
|
||||
'obtaining a copy of this software and associated '
|
||||
'documentation files (the “Software”), to deal in the '
|
||||
'Software without restriction, including without limitation '
|
||||
'the rights to use, copy, modify, merge, publish, distribute, '
|
||||
'sublicense, and/or sell copies of the Software, and to '
|
||||
'permit persons to whom the Software is furnished to do so, '
|
||||
'subject to the following conditions:'
|
||||
'\n\n'
|
||||
'The above copyright notice and this permission notice shall '
|
||||
'be included in all copies or substantial portions of the '
|
||||
'Software.'
|
||||
'\n\n'
|
||||
'THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY '
|
||||
'KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE '
|
||||
'WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR '
|
||||
'PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR '
|
||||
'COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER '
|
||||
'LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR '
|
||||
'OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE '
|
||||
'SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.')
|
||||
|
327
kaikout/assets/about.toml
Normal file
327
kaikout/assets/about.toml
Normal file
|
@ -0,0 +1,327 @@
|
|||
[[about]]
|
||||
title = "About"
|
||||
subtitle = "KaikOut"
|
||||
|
||||
[[about]]
|
||||
name = "KaikOut"
|
||||
desc = "XMPP moderation bot. Spam has never been in fashion."
|
||||
info = ["""
|
||||
KaikOut is an XMPP bot that suprvises group chat activity and \
|
||||
assists in blocking and preventing of unsolicited type of messages.
|
||||
|
||||
KaikOut is a portmanteau of Kaiko and Out.
|
||||
Kaiko (懐古) translates from Japanese to "Old-Fashioned".
|
||||
|
||||
KaikOut is designed primarily for the XMPP communication network \
|
||||
(aka Jabber). Visit https://xmpp.org/software/ for more information.
|
||||
|
||||
You can run your own KaikOut instance as a client, from your own \
|
||||
computer, server, and even from a Linux phone (i.e. Droidian, \
|
||||
Kupfer, Mobian, NixOS, postmarketOS), as well as from Termux.
|
||||
|
||||
All you need is one of the above and an XMPP account to connect \
|
||||
KaikOut with.
|
||||
|
||||
Good luck!
|
||||
"""]
|
||||
|
||||
platforms = "XMPP"
|
||||
# platforms = "ActivityPub, Briar, DeltaChat, Email, IRC, LXMF, MQTT, Nostr, Session, Tox."
|
||||
comment = "For an ideal experience, we recommend of using XMPP."
|
||||
url = "https://git.xmpp-it.net/sch/Kaikout"
|
||||
|
||||
[[about]]
|
||||
name = "slixmpp"
|
||||
desc = "XMPP library"
|
||||
info = ["""
|
||||
Slixmpp is an MIT licensed XMPP library for Python 3.7+. It is a fork of \
|
||||
SleekXMPP.
|
||||
|
||||
Slixmpp's goals is to only rewrite the core of the SleekXMPP library \
|
||||
(the low level socket handling, the timers, the events dispatching) \
|
||||
in order to remove all threads.
|
||||
"""]
|
||||
url = "https://codeberg.org/poezio/slixmpp"
|
||||
|
||||
[[about]]
|
||||
name = "SleekXMPP"
|
||||
desc = "XMPP library"
|
||||
info = ["""
|
||||
SleekXMPP is an MIT licensed XMPP library for Python 2.6/3.1+, and is \
|
||||
featured in examples in the book XMPP: The Definitive Guide by Kevin Smith, \
|
||||
Remko Tronçon, and Peter Saint-Andre.
|
||||
"""]
|
||||
url = "https://codeberg.org/fritzy/SleekXMPP"
|
||||
|
||||
[[about]]
|
||||
name = "XMPP"
|
||||
desc = "Messaging protocol (also known as Jabber)"
|
||||
info = ["""
|
||||
XMPP is the Extensible Messaging and Presence Protocol, a set of open \
|
||||
technologies for instant messaging, presence, multi-party chat, voice and \
|
||||
video calls, collaboration, lightweight middleware, content syndication, \
|
||||
and generalized routing of XML data.
|
||||
|
||||
XMPP was originally developed in the Jabber open-source community to \
|
||||
provide an open, decentralized alternative to the closed instant messaging \
|
||||
services at that time.
|
||||
"""]
|
||||
url = "https://xmpp.org/about"
|
||||
|
||||
[[authors]]
|
||||
title = "Authors"
|
||||
subtitle = "The people who have made KaikOut"
|
||||
|
||||
[[authors]]
|
||||
name = "Schimon Zackary"
|
||||
role = "Author and Creator"
|
||||
info = ["""
|
||||
A middle eastern cowboy, farmer, pianist and lawyer who engages in criminal \
|
||||
and corporate law, and who took a decision to make a moderation bot for XMPP, \
|
||||
after he was informed that several spy agencies attempt to discredit the XMPP \
|
||||
network, albeit they make an extensive use of XMPP themselves.
|
||||
"""]
|
||||
url = "http://schimon.i2p"
|
||||
|
||||
[[legal]]
|
||||
title = "Legal"
|
||||
subtitle = "Legal Notice"
|
||||
|
||||
[[legal]]
|
||||
info = ["""
|
||||
Kaikout is free software; you can redistribute it and/or modify it under the \
|
||||
terms of the AGPL License version 3.
|
||||
|
||||
Kaikout 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 AGPL License (version 3) 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/>.
|
||||
"""]
|
||||
link = "https://git.xmpp-it.net/sch/Kaikout"
|
||||
|
||||
[[license]]
|
||||
title = "License"
|
||||
subtitle = "AGPL-3.0-only"
|
||||
|
||||
[[license]]
|
||||
info = ["""
|
||||
KaikOut moderation chat bot for the XMPP communication network.
|
||||
Copyright (C) 2024 Schimon Zachary
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License version 3 as
|
||||
published by the Free Software Foundation.
|
||||
|
||||
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/>.
|
||||
"""]
|
||||
owner = "Schimon Zachary"
|
||||
|
||||
[[support]]
|
||||
title = "Support"
|
||||
subtitle = "Kaikout Support Groupchat"
|
||||
|
||||
[[support]]
|
||||
jid = "xmpp:kaikout@chat.woodpeckersnest.space?join"
|
||||
lang = "de, en, fr, ja, nl"
|
||||
|
||||
[[operators]]
|
||||
title = "Operators"
|
||||
subtitle = "Kaikout Operators"
|
||||
|
||||
[[operators]]
|
||||
name = "Mr. Operator"
|
||||
info = "No operator was specified for this instance."
|
||||
|
||||
[[policies]]
|
||||
title = "Policies"
|
||||
subtitle = "Terms of service"
|
||||
|
||||
[[policies]]
|
||||
name = "Terms and Conditions"
|
||||
info = ["""
|
||||
Abusers will be baptized.
|
||||
"""]
|
||||
|
||||
[[policies]]
|
||||
name = "Privacy Policy"
|
||||
info = ["""
|
||||
1. KaikOut logs public message activity, including status messages and aliases;
|
||||
2. KaikOut logs private activities of moderators, including Jabber ID;
|
||||
3. KaikOut reports moderators private activities to respective groupchat owners;
|
||||
4. KaikOut does not log Jabber ID addresses, excluding Jabber ID addresses of \
|
||||
banned and outcasted Jabber IDs.
|
||||
"""]
|
||||
|
||||
[[clients]]
|
||||
title = "Clients"
|
||||
subtitle = """
|
||||
As a chat bot, Kaikout works with any XMPP messenger, yet we have deemed it \
|
||||
appropriate to list the software that work best with Kaikout, namely those \
|
||||
that provide support for XEP-0050: Ad-Hoc Commands.
|
||||
"""
|
||||
|
||||
[[clients]]
|
||||
name = "Cheogram"
|
||||
desc = "XMPP client for mobile"
|
||||
info = ["""
|
||||
The Cheogram Android app allows you to join a worldwide communication network. \
|
||||
It especially focuses on features useful to users who want to contact those on \
|
||||
other networks as well, such as SMS-enabled phone numbers.
|
||||
"""]
|
||||
url = "https://cheogram.com"
|
||||
platform = "Android"
|
||||
|
||||
# [[clients]]
|
||||
# name = "Conversations"
|
||||
# info = "XMPP client for mobile"
|
||||
# url = "https://conversations.im"
|
||||
|
||||
[[clients]]
|
||||
name = "Converse"
|
||||
desc = "XMPP client for desktop and mobile"
|
||||
info = ["""
|
||||
Converse is a free and open-source XMPP chat client that runs in an HTML \
|
||||
browser or on your desktop.
|
||||
"""]
|
||||
url = "https://conversejs.org"
|
||||
platform = "HTML"
|
||||
|
||||
[[clients]]
|
||||
name = "Gajim"
|
||||
info = "XMPP client for desktop"
|
||||
url = "https://gajim.org"
|
||||
|
||||
# [[clients]]
|
||||
# name = "Monal IM"
|
||||
# info = "XMPP client for desktop and mobile"
|
||||
# url = "https://monal-im.org"
|
||||
|
||||
[[clients]]
|
||||
name = "monocles chat"
|
||||
desc = "XMPP client for mobile"
|
||||
info = """
|
||||
monocles chat is a modern and secure Android XMPP chat client. Based on \
|
||||
blabber.im and Conversations with a lot of changes and additional features \
|
||||
to improve usability and security.
|
||||
"""
|
||||
url = "https://monocles.chat"
|
||||
platform = "Android"
|
||||
|
||||
[[clients]]
|
||||
name = "Movim"
|
||||
desc = "XMPP client for desktop and mobile"
|
||||
info = ["""
|
||||
Movim is a social and chat platform that acts as a frontend for the XMPP network.
|
||||
|
||||
Once deployed Movim offers a complete social and chat experience for the \
|
||||
decentralized XMPP network users. It can easily connect to several XMPP \
|
||||
servers at the same time.
|
||||
|
||||
With a simple configuration it can also be restricted to one XMPP server \
|
||||
and will then act as a powerful frontend for it. Movim is fully compatible \
|
||||
with the most used XMPP servers such as ejabberd or Prosody.
|
||||
"""]
|
||||
url = "https://mov.im"
|
||||
platform = "HTML"
|
||||
|
||||
# [[clients]]
|
||||
# name = "Moxxy"
|
||||
# info = "XMPP client for mobile"
|
||||
# url = "https://moxxy.org"
|
||||
|
||||
[[clients]]
|
||||
name = "Poezio"
|
||||
desc = "XMPP client for console"
|
||||
info = ["""
|
||||
Poezio is a free console XMPP client (the protocol on which the Jabber IM \
|
||||
network is built).
|
||||
|
||||
Its goal is to let you connect very easily (no account creation needed) to \
|
||||
the network and join various chatrooms, immediately. It tries to look like \
|
||||
the most famous IRC clients (weechat, irssi, etc). Many commands are identical \
|
||||
and you won't be lost if you already know these clients. Configuration can be \
|
||||
made in a configuration file or directly from the client.
|
||||
"""]
|
||||
url = "https://poez.io"
|
||||
platform = "FreeBSD and Linux"
|
||||
|
||||
[[clients]]
|
||||
name = "Psi"
|
||||
desc = "XMPP client for desktop"
|
||||
info = ["""
|
||||
Instant messaging as free and open as it should be.
|
||||
|
||||
Psi is a free instant messaging application designed for the XMPP network. \
|
||||
Fast and lightweight, Psi is fully open-source and compatible with Windows, \
|
||||
Linux, and macOS.
|
||||
|
||||
With Psi's full Unicode support and localizations, easy file transfers, \
|
||||
customizable iconsets, and many other great features, you'll learn why users \
|
||||
around the world are making the switch to free, open instant messaging.
|
||||
"""]
|
||||
url = "https://psi-im.org"
|
||||
platform = "Any"
|
||||
|
||||
[[clients]]
|
||||
name = "Psi+"
|
||||
desc = "XMPP client for desktop"
|
||||
info = ["""
|
||||
In 2009 a Psi fork named Psi+ was started. Project purpose are: implementation \
|
||||
of new features, writing of patches and plugins for transferring them to upstream. \
|
||||
As of 2017 the most of active Psi+ developers have become official Psi developers, \
|
||||
but Psi+ still has a number of unique features. From developers point of view Psi+ \
|
||||
is just a development branch of Psi IM client which is hosted at separate git \
|
||||
repositories and for which rolling release development model is used.
|
||||
"""]
|
||||
url = "https://psi-plus.com"
|
||||
platform = "Any"
|
||||
|
||||
# [[clients]]
|
||||
# name = "Swift"
|
||||
# info = "XMPP client for desktop"
|
||||
# url = "https://swift.im"
|
||||
|
||||
# [[clients]]
|
||||
# name = "yaxim"
|
||||
# info = "XMPP client for mobile"
|
||||
# url = "https://yaxim.org"
|
||||
|
||||
[[resources]]
|
||||
title = "Useful Resources"
|
||||
subtitle = "Technologies which Kaikout is based upon"
|
||||
|
||||
[[resources]]
|
||||
name = "Slixmpp"
|
||||
info = "XMPP library"
|
||||
desc = """
|
||||
Slixmpp is an MIT licensed XMPP library for Python 3.7+. It is a fork of \
|
||||
SleekXMPP.
|
||||
|
||||
Slixmpp's goals is to only rewrite the core of the SleekXMPP library \
|
||||
(the low level socket handling, the timers, the events dispatching) \
|
||||
in order to remove all threads.
|
||||
"""
|
||||
url = "https://slixmpp.readthedocs.io"
|
||||
|
||||
[[resources]]
|
||||
name = "XMPP"
|
||||
info = "Messaging protocol (also known as Jabber)"
|
||||
desc = """
|
||||
XMPP is the Extensible Messaging and Presence Protocol, a set of open \
|
||||
technologies for instant messaging, presence, multi-party chat, voice and \
|
||||
video calls, collaboration, lightweight middleware, content syndication, \
|
||||
and generalized routing of XML data.
|
||||
|
||||
XMPP was originally developed in the Jabber open-source community to \
|
||||
provide an open, decentralized alternative to the closed instant messaging \
|
||||
services at that time.
|
||||
"""
|
||||
url = "https://xmpp.org/about"
|
57
kaikout/assets/accounts.toml
Normal file
57
kaikout/assets/accounts.toml
Normal file
|
@ -0,0 +1,57 @@
|
|||
# Settings to tell the bot to which accounts to connect
|
||||
# and also from which accounts it receives instructions.
|
||||
|
||||
[xmpp.settings]
|
||||
reconnect_timeout = 3
|
||||
|
||||
[[xmpp.operators]]
|
||||
name = ""
|
||||
jid = ""
|
||||
|
||||
[xmpp.proxy.socks5]
|
||||
host = "127.0.0.1"
|
||||
port = 9050
|
||||
#username = ""
|
||||
#password = ""
|
||||
|
||||
[xmpp.profile]
|
||||
FN = "KaikOut"
|
||||
NICKNAME = "KaikOut"
|
||||
ROLE = "KaikOut Moderation Chat Bot"
|
||||
ORG = "KaikOut Inc."
|
||||
URL = "https://xmpp-it.net/sch/KaikOut"
|
||||
NOTE = "A moderation chat bot made for XMPP."
|
||||
BDAY = "20 June 2024"
|
||||
#TITLE = ""
|
||||
#DESC = ""
|
||||
|
||||
[xmpp.client]
|
||||
alias = "KaikOut"
|
||||
jid = "/KaikOut"
|
||||
password = ""
|
||||
|
||||
[tox]
|
||||
username = ""
|
||||
password = ""
|
||||
operator = ""
|
||||
|
||||
[session]
|
||||
username = ""
|
||||
password = ""
|
||||
operator = ""
|
||||
|
||||
[irc]
|
||||
username = ""
|
||||
password = ""
|
||||
#port = 6667
|
||||
operator = ""
|
||||
|
||||
[deltachat]
|
||||
username = ""
|
||||
password = ""
|
||||
operator = ""
|
||||
|
||||
[cabal]
|
||||
username = ""
|
||||
password = ""
|
||||
operator = ""
|
174
kaikout/assets/commands.toml
Normal file
174
kaikout/assets/commands.toml
Normal file
|
@ -0,0 +1,174 @@
|
|||
[all]
|
||||
all = """
|
||||
all
|
||||
Show all options.
|
||||
"""
|
||||
|
||||
[bookmarks]
|
||||
bookmark = """
|
||||
bookmark [+|-] <muc>
|
||||
Groupchat to add or remove.
|
||||
'+' appends to, '-' removes from.
|
||||
"""
|
||||
bookmarks = """
|
||||
bookmarks
|
||||
List bookmarked groupchats.
|
||||
"""
|
||||
|
||||
[filters]
|
||||
allow = """
|
||||
allow [+|-] <keyword>
|
||||
Keywords to allow
|
||||
comma-separated keywords
|
||||
'+' appends to, '-' removes from.
|
||||
"""
|
||||
deny = """
|
||||
deny [+|-] <keyword>
|
||||
Keywords to block
|
||||
comma-separated keywords
|
||||
'+' appends to, '-' removes from.
|
||||
"""
|
||||
clear = """
|
||||
clear allow/deny
|
||||
Clear allow or deny list.
|
||||
"""
|
||||
reset = """
|
||||
Reset allow/deny
|
||||
Reset allow or deny list.
|
||||
"""
|
||||
|
||||
[groupchat]
|
||||
uri = """
|
||||
<muc>
|
||||
Join groupchat by given <muc> (prefix xmpp).
|
||||
"""
|
||||
join = """
|
||||
join <muc>
|
||||
Join groupchat by given <muc>.
|
||||
"""
|
||||
leave = """
|
||||
goodbye
|
||||
Leave groupchat and delete it from bookmarks.
|
||||
"""
|
||||
|
||||
[manual]
|
||||
all = """
|
||||
help all
|
||||
Print a complete list of commands.
|
||||
"""
|
||||
help = """
|
||||
help
|
||||
Print list of command types.
|
||||
"""
|
||||
command = """
|
||||
help key command
|
||||
Print command usage and description.
|
||||
"""
|
||||
info = """
|
||||
info
|
||||
Print information page.
|
||||
"""
|
||||
key = """
|
||||
help <key>
|
||||
Print list of commands for selected command type.
|
||||
"""
|
||||
|
||||
[options]
|
||||
action = """
|
||||
action <boolean>
|
||||
Set action. 1 for ban, 0 for devoice.
|
||||
"""
|
||||
count = """
|
||||
count <number>
|
||||
Number of maximum allowed words to repeat per message.
|
||||
"""
|
||||
default = """
|
||||
default <key>
|
||||
Restore a setting to its default value.
|
||||
"""
|
||||
defaults = """
|
||||
defaults
|
||||
Restore all settings to default value.
|
||||
"""
|
||||
finished = """
|
||||
finished [off|on]
|
||||
Display a consequent message with the amount of a done task time.
|
||||
"""
|
||||
frequency_messages = """
|
||||
frequency messages <number>
|
||||
Minimum allowed frequency for sending consequent messages.
|
||||
"""
|
||||
frequency_presence = """
|
||||
frequency presence <number>
|
||||
Minimum allowed frequency for sending consequent status messages.
|
||||
"""
|
||||
inactivity = """
|
||||
inactivity [off|on]
|
||||
Check for inactivity.
|
||||
"""
|
||||
inactivity_span = """
|
||||
inactivity span <number>
|
||||
The maximum allowed time (in days) of inactivity.
|
||||
"""
|
||||
inactivity_warn = """
|
||||
inactivity warn <number>
|
||||
The time (in minutes) of inactivity to send a warning upon before action. Value can not be higher than of inactivity_span.
|
||||
"""
|
||||
kick = """
|
||||
kick <alias>
|
||||
Kick a participant by specified alias.
|
||||
"""
|
||||
message = """
|
||||
message [off|on]
|
||||
Check messages for faults.
|
||||
"""
|
||||
options = """
|
||||
options
|
||||
List options.
|
||||
"""
|
||||
score_messages = """
|
||||
score messages <number>
|
||||
Number of maximum allowed message faults before committing an action.
|
||||
"""
|
||||
score_presence = """
|
||||
score presence <number>
|
||||
Number of maximum allowed presence faults before committing an action.
|
||||
"""
|
||||
scores = """
|
||||
scores <jid>
|
||||
Display scores of specified Jabber ID.
|
||||
"""
|
||||
scores_reset = """
|
||||
scores reset <jid>
|
||||
Reset scores of specified Jabber ID.
|
||||
"""
|
||||
start = """
|
||||
start
|
||||
Enable bot and send updates.
|
||||
"""
|
||||
status = """
|
||||
status [off|on]
|
||||
Check status messages for faults.
|
||||
"""
|
||||
stop = """
|
||||
stop
|
||||
Disable bot and stop updates.
|
||||
"""
|
||||
timer = """
|
||||
timer <number>
|
||||
Timer value (in seconds) for countdown before committing an action.
|
||||
"""
|
||||
|
||||
[statistics]
|
||||
score = """
|
||||
scores <jid>
|
||||
Display scores for a given Jabber ID.
|
||||
"""
|
||||
reset = """
|
||||
scores reset <jid>
|
||||
Reset scores of a given Jabber ID.
|
||||
"""
|
||||
stats = """
|
||||
stats
|
||||
Show general statistics.
|
||||
"""
|
76
kaikout/assets/settings.toml
Normal file
76
kaikout/assets/settings.toml
Normal file
|
@ -0,0 +1,76 @@
|
|||
# This file lists default settings per database.
|
||||
# See file /usr/share/kaikout/settings.toml
|
||||
|
||||
[defaults]
|
||||
action = 0 # 1 to ban, or 0 to devioce.
|
||||
check_inactivity = 0 # Enable inactivity detection.
|
||||
check_message = 1 # Enable detection of message abuse.
|
||||
check_status = 1 # Enable detection of status message abuse.
|
||||
count = 9 # The maximum allowed number of instances of a word or a phrase in a message.
|
||||
enabled = 1 # Work status (Value 0 to disable).
|
||||
finished = 0 # Send an extra message which indicates of the amount of time of a done task (Value 1 to enable).
|
||||
frequency_messages = 1 # The maximum allowed frequency (in seconds) of sent messages.
|
||||
frequency_presence = 180 # The maximum allowed frequency (in seconds) of changed status messages.
|
||||
inactivity_span = 30 # The maximum allowed time (in days) of inactivity.
|
||||
inactivity_warn = 300 # The time (in minutes) of inactivity to send a warning upon before action. Value can not be higher than of inactivity_span.
|
||||
score_messages = 3 # The maximum allowed number of message faults to act upon.
|
||||
score_presence = 10 # The maximum allowed number of presence faults to act upon.
|
||||
timer = 180 # Timer value (in seconds) for countdown before committing an action.
|
||||
allow = [
|
||||
"jesus saves",
|
||||
"oracle broadcasting radio",
|
||||
"real liberty media",
|
||||
"woop ass"
|
||||
]
|
||||
deny = [
|
||||
"666",
|
||||
"arse",
|
||||
"arsehead",
|
||||
"arsehole",
|
||||
"ass hole",
|
||||
"asshole",
|
||||
"bollocks",
|
||||
"bugger",
|
||||
"christ on a bike",
|
||||
"christ on a cracker",
|
||||
"cock sucker",
|
||||
"cocksucker",
|
||||
"damm it",
|
||||
"damn it",
|
||||
"dammit",
|
||||
"damnit",
|
||||
"dick head",
|
||||
"dickhead",
|
||||
"dumb ass",
|
||||
"dumbass",
|
||||
"frigger",
|
||||
"fuck you",
|
||||
"fucker",
|
||||
"fucking",
|
||||
"god damn",
|
||||
"god damnit",
|
||||
"god damm",
|
||||
"god dammit",
|
||||
"goddammed",
|
||||
"goddammit",
|
||||
"goddamn",
|
||||
"goddamned",
|
||||
"goddamnit",
|
||||
"holy shit",
|
||||
"holyshit",
|
||||
"horseshit",
|
||||
"in shit",
|
||||
"jack-ass",
|
||||
"jackarse",
|
||||
"jackass",
|
||||
"jesus fuck",
|
||||
"jesus wept",
|
||||
"nigga",
|
||||
"shite",
|
||||
"son of a bitch",
|
||||
"son of a whore",
|
||||
"wanker"
|
||||
]
|
||||
|
||||
[ipc]
|
||||
bsd = 0 # IPC (BSD/UDS) POSIX sockets
|
70
kaikout/config.py
Normal file
70
kaikout/config.py
Normal file
|
@ -0,0 +1,70 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from kaikout.log import Logger
|
||||
import os
|
||||
import sys
|
||||
try:
|
||||
import tomllib
|
||||
except:
|
||||
import tomli as tomllib
|
||||
|
||||
logger = Logger(__name__)
|
||||
|
||||
|
||||
class Config:
|
||||
|
||||
|
||||
def get_default_data_directory():
|
||||
if os.environ.get('HOME'):
|
||||
data_home = os.path.join(os.environ.get('HOME'), '.local', 'share')
|
||||
return os.path.join(data_home, 'kaikout')
|
||||
elif sys.platform == 'win32':
|
||||
data_home = os.environ.get('APPDATA')
|
||||
if data_home is None:
|
||||
return os.path.join(
|
||||
os.path.dirname(__file__) + '/kaikout_data')
|
||||
else:
|
||||
return os.path.join(os.path.dirname( |