From 614fab36cd79cbc303090af7ca1e31d24198c5ab Mon Sep 17 00:00:00 2001 From: luk3yx Date: Tue, 21 Jul 2020 15:09:45 +1200 Subject: [PATCH] Initial commit --- .gitignore | 65 +++++ LICENSE.md | 675 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 34 +++ trackr.example.ini | 11 + trackr.py | 656 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 1441 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 trackr.example.ini create mode 100755 trackr.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d2e0710 --- /dev/null +++ b/.gitignore @@ -0,0 +1,65 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Mypy +.mypy_cache/ + +trackr.ini +miniirc.pyi +miniirc_extras diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/README.md b/README.md new file mode 100644 index 0000000..7eb49f4 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# trackr + +An IRC bot that checks player lists for all servers in a + +## Usage + + - Make sure you are using the latest miniirc and miniirc_extras. + - `sudo pip3 install --upgrade miniirc miniirc_extras` + - Copy and edit `trackr.example.ini`. + - Run `./trackr.py /path/to/trackr.ini` + +## Moderation commands + + - `,mute `: Mutes a player permanently. + - `,unmute `: Unmutes a player. + - `,tempmute `: Temporarily mutes a player for a specified + duration. The duration cannot be greater than 2 hours. If the server is + shut down before this duration is up, the tempmute is ended prematurely due + to technical limitations with trackr. + - `,warn `: Shows the player a warning dialog. + - `,kick `: Kicks a player. + - `,badservers`: Lists the servers trackr isn't logged into. + +### Parameter format + + - `player`: A Minetest/MultiCraft/??? player. This can be the player name if + the player is in one (and only one) server on the channel. If the player + is in multiple servers, you can do `player_name@server_name`. + - `duration` (default: 5 minutes): The duration to mute the player for. By + default, this is in minutes, however this can be changed by appending `s` + (seconds), `m` (minutes), or `h` (hours). + - `message`: The message to tell the player. + - `reason`: The reason for kicking the player. This is shown to the player + when being kicked. diff --git a/trackr.example.ini b/trackr.example.ini new file mode 100644 index 0000000..6af6760 --- /dev/null +++ b/trackr.example.ini @@ -0,0 +1,11 @@ +[trackr] +ip = irc.edgy1.net +ssl_port = 6697 +channels = #edgy1, #ls-servers +nick = bot-nickname +prefix = , +secret = Random string to use when generating passwords +admins = Edgy1, luk3yx + +# Optional and case-sensitive (defaults to +v list) +# server_list = MinetestServer1, MinetestServer2 diff --git a/trackr.py b/trackr.py new file mode 100755 index 0000000..78048a8 --- /dev/null +++ b/trackr.py @@ -0,0 +1,656 @@ +#!/usr/bin/env python3 +# +# trackr 2.1.0 +# +# © 2020 by luk3yx. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see https://www.gnu.org/licenses/. +# +# Usage: +# • Make sure you are using the latest miniirc and miniirc_extras. +# · sudo pip3 install --upgrade miniirc miniirc_extras +# • Create a trackr.ini file similar to the below one. +# • Run the script. +# +# Config file (trackr.ini) format: +# [trackr] +# ip = irc.edgy1.net +# ssl_port = 6697 +# channels = #edgy1, #ls-servers +# nick = bot-nickname +# prefix = , +# secret = Random string to use when generating passwords +# admins = Edgy1, luk3yx +# +# # Optional and case-sensitive (defaults to +v list) +# # server_list = MinetestServer1, MinetestServer2 +# + +import hashlib, miniirc, miniirc_extras, os, random, sys, time +assert miniirc.ver >= (1,4,0), 'Update miniirc.' +assert miniirc_extras.ver >= (0,2,5), 'Update miniirc_extras.' + +from miniirc_extras import AbstractIRC, Hostmask +from miniirc_extras.features.chans import Channel, ModeList, ChannelTracker +from miniirc_extras.features.users import AbstractChannel, User, UserTracker + +from typing import Dict, FrozenSet, List, Optional, Set, Tuple, Union + +__version__ = '2.1.0' + +# Errors +class BotError(Exception): + pass + +def err(msg: str, *args, **kwargs) -> None: + if args or kwargs: + msg = msg.format(*args, **kwargs) + raise BotError(msg) + +# Get a plural +def plural(n: int) -> str: + return '' if n == 1 else 's' + +# Hacks to get a valid lua string +def lua_repr(s: str) -> str: + return repr(s.encode('utf-8'))[1:] + +# A player action error +class ModerationError(Exception): + pass + +# A player class +class Player(str): + total_warnings: int = 2 + warnings: int + __slots__ = ('warnings', '_server') + + # Kick the player + def kick(self, sender: str, reason: str) -> None: + assert self._server + self._server.msg(f'cmd kick {self} By {sender}: {reason}') + + # Mute the player + def mute(self) -> None: + assert self._server + self._server.msg(f'cmd revoke {self} shout') + + # Unmute the player + def unmute(self) -> None: + assert self._server + self._server.msg(f'cmd grant {self} shout') + + # Tempmute the player (mega hax) + def tempmute(self, duration: Union[str, int, float]) -> None: + assert self._server + + duration, multiplier = (duration or 5), 60 + if isinstance(duration, str): + if duration.endswith('m'): + duration = duration[:-1] + elif duration.endswith('s'): + duration, multiplier = duration[:-1], 1 + elif duration.endswith('h'): + duration, multiplier = duration[:-1], 3600 + + try: + duration = float(duration) + assert duration > 0 + except: + raise ModerationError('Invalid duration!') + duration = int(duration * multiplier) + + if duration > 7200: + raise ModerationError('You cannot tempmute someone for over 2 ' + 'hours!') + + # Create a hacky lua script + script = (f'cmd /lua local m={lua_repr(self)};' + 'core.registered_chatcommands.revoke.func("trackr",m.." shout")' + 'local function r() ' + 'if m then ' + 'core.registered_chatcommands.grant.func("trackr",' + 'm.." shout") ' + 'end ' + 'end ' + f'core.after({duration},r);' + 'core.register_on_shutdown(r)') + self._server.msg(script) + + # Warn the player + def warn(self, sender: str, msg: str) -> str: + assert self._server + + if self.warnings > 0: + msg2 = '{} warning{} left until you get temp-muted.'.format( + self.warnings, plural(self.warnings)) + self.warnings -= 1 + else: + self.tempmute(30) + msg2 = 'been temporarily muted for 30 minutes.' + self.warnings = self.total_warnings + + msg = f'{msg}\n -- {sender}\n\nYou have {msg2}' + + self._server.msg(f'cmd /lua core.show_formspec({lua_repr(self)},' + '"trackr:warning", "size[8,5;]image[0,0;1,1;bucket_lava.png]' + 'image[7,0;1,1;bucket_lava.png]' + 'label[1.25,0.25;WARNING - Please read carefully.]' + f'label[0,1.25;" .. minetest.formspec_escape({lua_repr(msg)}) .. "]' + 'button_exit[0,4.5;8,0.5;quit;Continue]' + '" .. (default.gui_bg or ""))') + + return self + ' has ' + msg2.replace('you', 'they') + + def __repr__(self) -> str: + return f'{type(self).__name__}({super().__repr__()}, {self.warnings})' + + def __new__(cls, name: str, warnings: Optional[int] = None, *, + server: Optional[User] = None): + return super().__new__(cls, name) # type: ignore + + def __init__(self, name: str, warnings: Optional[int] = None, *, + server: Optional[User] = None) -> None: + assert name + + self.warnings: int + if warnings is None: + self.warnings = self.total_warnings + else: + self.warnings = warnings + + self._server: Optional[User] = server + +# A player list +class PlayerList(dict): + __slots__ = ('server',) + + # An easy way to create new players + def Player_(self, name: str, warnings: Optional[int] = None) \ + -> Optional[Player]: + if not name: + return None + + if name in self: + player = self[name] + else: + player = Player(name, warnings, server = self.server) + self[name] = player + return player + + def get(self, key: str, *args): + return super().get(str(key).lower(), *args) + + def __getitem__(self, key: str): + return super().__getitem__(str(key).lower()) + + def __setitem__(self, key: str, value: Player): + return super().__setitem__(str(key).lower(), value) + + def __delitem__(self, key: str): + return super().__delitem__(str(key).lower()) + + def __contains__(self, key) -> bool: + return super().__contains__(str(key).lower()) + + def __init__(self, *args, **kwargs) -> None: + super().__init__(*args, **kwargs) + self.server: Optional[User] = None + + Player = Player_ + del Player_ + +# The bot +class Trackr: + cooldown: int = 15 + last_list: Union[int, float] = 0 + irc: AbstractIRC + + # Alias for self.irc.debug + @property + def debug(self): + return self.irc.debug + + # Hacks to keep mypy happy + @property + def users(self) -> UserTracker: + return self.irc.users # type: ignore + + @property + def chans(self) -> ChannelTracker: + return self.irc.chans # type: ignore + + # __init__ + def __init__(self, rawconfig: Dict[str, Dict[str, str]], + debug: bool = False) -> None: + if 'trackr' not in rawconfig: + err('Invalid or non-existent config file!') + config: Dict[str, str] = rawconfig['trackr'] + del rawconfig + self.config: Dict[str, str] = config + + self._conf_assert('ip', ('ssl_port', int), 'nick', 'channels', + 'admins') + + self._secret: bytes = config.get('secret', 'Oops').encode('utf-8') + self.admins: FrozenSet[str] = frozenset(map( + lambda n : n.strip().lower(), config['admins'].split(','))) + self.prefix = config.get('prefix', config['nick'] + ': ') + + self.server_list: Optional[FrozenSet[str]] = None + serverlist = config.get('server_list', '').strip() + if serverlist: + self.server_list = frozenset(map(str.strip, serverlist.split(','))) + + kwargs = {} + for i in 'ident', 'realname', 'ns_identity', 'connect_modes', \ + 'quit_message': + if i in config: + kwargs[i] = config[i] + + # Create the IRC object + self.irc = miniirc.IRC(config['ip'], # type: ignore + int(config['ssl_port']), config['nick'], + set(map(str.strip, config['channels'].split(','))), + debug=debug, auto_connect=False, ssl=True, **kwargs) # type: ignore + + # Load irc.chans and irc.users + self.irc.require('chans') + self.irc.require('users') + + # Add handlers + self.irc.Handler('PRIVMSG', colon=False)(self._handle_privmsg) + self.irc.Handler('JOIN', colon=False)(self._handle_join) + + # Connect + self.irc.connect() + + # Function copied from lurklite + def _conf_assert(self, *keys: Union[str, Tuple[str, type]]) -> None: + for key in keys: + req: Optional[type] = None + if isinstance(key, tuple): + key, req = key + + if key not in self.config: + err('Required config value {} missing!', repr(key)) + elif req: + try: + req(self.config[key]) + except: + err('Config value {} contains an invalid {}.', repr(key), + req.__name__) + + # Check if a hostmask is a server + def is_server(self, channel: Union[str, AbstractChannel], + hostmask: Union[Hostmask, User]) -> bool: + if not isinstance(channel, Channel): + if isinstance(channel, AbstractChannel): + channel = channel.name + + try: + channel = self.chans[channel] + except: + # Oops, use a backup method + if not isinstance(hostmask, User): + hostmask = self.users[hostmask] + return 'players' in hostmask.keys() + + modes = self.server_list or channel.modes.getset('v') + + if isinstance(hostmask, User): + hostmask = hostmask.hostmask + elif not isinstance(hostmask, Hostmask): + raise TypeError('is_server() expects User or hostmask.') + + return hostmask[0] in modes or hostmask[0].lower() in modes + + # Check if a user is an admin + def is_admin(self, channel: Union[str, AbstractChannel], + hostmask: Union[Hostmask, User, str]) -> bool: + if not isinstance(channel, Channel): + if isinstance(channel, AbstractChannel): + channel = channel.name + channel = self.chans[channel] + + nick: str + if isinstance(hostmask, User): + nick = hostmask.nick + elif isinstance(hostmask, Hostmask): + nick = hostmask[0] + else: + nick = hostmask + + lnick: str = nick.lower() + + for mode in 'oaq': + users = channel.modes.getset(mode) + if nick in users or lnick in users: + return True + + return False + + # Derive a password from a hostmask + def get_password(self, hostmask: Hostmask) -> str: + host = '/'.join(hostmask[2].split('/', 3)[:3]) + host = '.'.join(host.split('.', 2)[:2]) + pw = f'{hostmask[0]}@{host}'.encode('utf-8') + pw += b', secret: ' + self._secret + + # Hash it + return hashlib.sha512(pw).hexdigest() + + # Get an iterable list with servers + def servers(self, channel: Union[AbstractChannel, str]): + if isinstance(channel, str): + channel = self.chans[channel] + + for user in channel.users: + if self.is_server(channel, user): + yield user + + # Get a list of both servers and players + def items(self, channel: Union[AbstractChannel, str]): + for server in self.servers(channel): + yield server, server.get('players') + + # The players command + def _players_cmd(self, channel: str, nick: str) -> None: + irc: AbstractIRC = self.irc + + t = time.time() + if t <= self.last_list + self.cooldown: + irc.msg(channel, nick + ': You can only run \2.players\2 once', + f'every \2{self.cooldown} seconds\2.') + return + self.last_list = t + + # Get the player list + total: int = 0 + inactive: int = 0 + tplayers: int = 0 + slist: List[Tuple[User, PlayerList]] = list(self.items(channel)) + slist.sort(key = lambda s : s[0].nick.lower()) + + # Iterate over every server in the channel + for server, players in slist: + if not players: + inactive += 1 + continue + total += 1 + tplayers += len(players) + players2: List[Player] = list(players.values()) + players2.sort() + irc.msg(channel, 'Players on \2{}\2: {}'.format(server.nick, + ', '.join(players2))) + self.last_list += 0.5 + time.sleep(0.5) + + # Display the summary + irc.msg(channel, ('Total: \2{} player{}\2 across \2{} active ' + 'server{}\2 (and {} inactive server{}).').format(tplayers, + plural(tplayers), total, plural(total), inactive, + plural(inactive))) + + # The login command + def _login_cmd(self, nick: str, param: str) -> None: + irc: AbstractIRC = self.irc + + params = param.split(' ', 1) + del param + + if len(params) != 2: + irc.msg(nick, 'Invalid syntax! Syntax: login ') + return + + sid, pw = params + del params + + if sid not in self.users: + irc.msg(nick, f"What's a {repr(sid)}?") + return + server: User = self.users[sid] + if 'players' not in server.keys(): + irc.msg(nick, f'{repr(sid)} is not a server!') + + server['logged_in'] = 0 + server.msg('login trackr', pw) + + irc.msg(nick, 'I will attempt to log in.') + + # Handle the moderation commands + def _moderate(self, channel: str, hostmask: Hostmask, cmd: str, + param: str) -> str: + chan: AbstractChannel = self.chans[channel] + if not isinstance(chan, Channel): + return 'Error: This should never happen.' + + # Make sure the user is a channel operator + is_op = False + user: User = self.users[hostmask] + if not self.is_admin(channel, hostmask): + return 'Permission denied!' + + # Make sure the player exists + n = param.split(' ', 1) + victim: str = n[0].lower() + server: Optional[User] = None + if '@' in victim: + victim, sid = victim.split('@', 1) + try: + server = self.users[sid] + assert server in chan + except: + return f'The server {repr(sid)} does not exist!' + + if victim not in server.get('players', ()): + return f'The player {repr(victim)} is not in {server.nick}.' + else: + for s, p in self.items(chan): + if p and victim in p: + if server is not None: + return 'Error: That player is in multiple servers!' + server = s + + if not server: + return 'Unknown player!' + elif not server.get('logged_in'): + return f'I am not logged into {server.nick}!' + + player: Player = server['players'][victim] # type: ignore + res: Optional[str] = None + + try: + if cmd in ('mute', 'unmute'): + res = getattr(player, cmd)() + elif cmd in ('warn', 'kick'): + res = getattr(player, cmd)(hostmask[0], n[-1]) + elif cmd == 'tempmute': + player.tempmute(n[-1]) + else: + return 'Internal error!' + except ModerationError as e: + return 'Error: ' + str(e) + + if not res: + res = f'Attempted to {cmd} {player}.' + return res + + # Handle PRIVMSGs + def _handle_privmsg(self, irc: AbstractIRC, hostmask: Hostmask, + args: List[str]) -> None: + nick: str = hostmask[0] + channel: str = args[0] + msg: str = args[-1] + + # Check for MT players + if msg.startswith('<'): + n: List[str] = msg.split(' ', 1) + if len(n) > 1 and n[0].endswith('>') and (n[0][1].isalnum() or + n[0][1] == '\x03'): + nick = f'{n[0][1:-1]}@{nick}' + msg = n[1].strip() + del n + + if msg.startswith('.players'): + msg = self.prefix + msg[1:] + + # Check for commands + if msg.startswith(self.prefix): + cmd_args = msg[len(self.prefix):].split(' ', 1) + cmd = cmd_args[0].lower() + + if irc.nick.lower() == args[0].lower(): + if cmd != 'login': + irc.msg(hostmask[0], + 'You may not execute commands in PMs.') + elif hostmask[-1].split('/')[-1].lower() in self.admins: + self._login_cmd(hostmask[0], cmd_args[-1]) + else: + irc.msg(hostmask[0], 'Permission denied!') + return + + if cmd == 'players': + return self._players_cmd(channel, nick) + elif cmd in ('kick', 'mute', 'unmute', 'tempmute', 'warn'): + irc.msg(channel, nick + ': ' + self._moderate(channel, + hostmask, cmd, cmd_args[1] if len(cmd_args) > 1 else '')) + return + elif cmd == 'badservers': + bad = [] + for s_ in self.servers(channel): + if not s_.get('logged_in'): + bad.append(s_.nick) + if bad: + bad.sort(key = lambda n : n.lower()) + else: + bad.append('(none)') + irc.msg(channel, + f'{nick}: Servers I am not logged into: {", ".join(bad)}') + return + elif cmd == 'die': + if hostmask[-1].split('/')[-1].lower() in self.admins: + msg = f'{nick} ordered me to die- wait, why did I listen?' + irc.disconnect(msg) + print(msg) + os._exit(0) + else: + msg = random.choice(("But I don't want to die.", 'No.', + 'Resistance is futile.', 'Sorry, what was that?', + 'You know I could ignore you all day.', + "I'm going to pretend you didn't say that.", + 'die: Singular form of dice.')) + irc.msg(channel, f'{nick}: {msg}') + + return + + if nick != hostmask[0] or not self.is_server(channel, hostmask): + return + + # Store Player objects inside the User object so they are moved with + # nick changes etc. + server: User = self.users[hostmask] + players: PlayerList + if 'players' in server.keys(): + players = server['players'] # type: ignore + assert isinstance(players, PlayerList) + else: + server['players'] = players = PlayerList() + players.server = server + + if msg.startswith('*** '): + a: List[str] = msg.split(' ', 3) + if len(a) <= 2: + return + if a[2] == 'joined': + players.Player(a[1]) + elif a[2] == 'left' and a[1] in players: + del players[a[1]] + del a + elif msg.startswith('Connected players: '): + new_players: List[str] = args[-1][19:].replace(' ', '').split(',') + for player in new_players: + players.Player(player) + + for player, pobj in tuple(players.items()): + if str(pobj) not in new_players: + print('Deleting player', repr(pobj)) + del players[player] + + # Log in + if server.get('logged_in') is None: + self.debug('[trackr] Logging into', hostmask[0]) + server.msg('login trackr', self.get_password(hostmask)) + elif msg.startswith('You are now logged in as'): + self.debug('[trackr] Logged into', hostmask[0]) + logged_in = server.get('logged_in') + if logged_in == 0 and logged_in is not False: + server.msg('cmd setpassword trackr', + self.get_password(hostmask)) + server.msg('cmd /lua irc.say("[trackr] Logged in!")') + self.debug('Logged into', hostmask[0]) + server['logged_in'] = True + elif msg.startswith('Incorrect password'): + print('[trackr] WARNING: Incorrect password for server', + hostmask[0], file = sys.stderr) + server['logged_in'] = False + + # Handle JOINs + def _handle_join(self, irc: AbstractIRC, hostmask: Hostmask, + args: List[str]) -> None: + time.sleep(1) + if hostmask[0].lower() == irc.nick.lower(): + for server in self.servers(args[0]): + server['players'] = players = PlayerList() + players.server = server + server.msg('players', '-', + 'If you are a human, report this to luk3yx.') + return + + if not self.is_server(args[0], hostmask): + return + + user = self.users[hostmask] + players = PlayerList() + players.server = user + user['players'] = players + irc.msg(hostmask[0], + 'players - If you are a human, report this to luk3yx.') + +# The main script +def main() -> Trackr: + import argparse, configparser + parser = argparse.ArgumentParser() + parser.add_argument('config_file', + help='The config file to use with lurklite.') + parser.add_argument('--verbose', '--debug', action='store_true', + help='Enable verbose/debugging mode.') + parser.add_argument('-v', '--version', action='version', + version=f'trackr v{__version__} (powered by {miniirc.version})') + args = parser.parse_args() + + # Load the config file + config = configparser.ConfigParser() + config.read(args.config_file) + + # Create the bot + try: + return Trackr(config, debug=args.verbose) # type: ignore + except BotError as e: + print(f'ERROR: {e}', file=sys.stderr) + raise SystemExit(1) + +# Call main() +if __name__ == '__main__': + main()