commit d03f68e4e9151b5d958f9dd2aacfff66a38023e2 Author: qewc Date: Sun Dec 9 19:58:56 2018 +0000 Initial Commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d809e30 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +**/build +**/__pycache__ +.idea +*.c +*.so \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1a11868 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ +GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 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. + + +Copyright (C) + +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 . + +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 +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..336b04c --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +## yozora-python-common +Common Python code for Yozora + +- Please note that most yozora code is based upon the [ripple](https://github.com/osuripple) code + +## License +All code in this repository is licensed under the GNU AGPL 3 License. +See the "LICENSE" file for more information \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/agpl.py b/agpl.py new file mode 100644 index 0000000..4333d4b --- /dev/null +++ b/agpl.py @@ -0,0 +1,70 @@ +import os +from pathlib import Path + +PAGES = ( + """This is a friendly reminder that the GNU AGPL adds an additional clause to +the standard GNU GPL, which is that you MUST distribute the source code for the +software once you publish it on the web. + This is not to be considered professional legal advice. For further +information, refer to the LICENSE file which contains the whole license, or ask +your lawyer. If you did not receive a copy of the LICENSE file with this +software, you can refer to the online version: + https://www.gnu.org/licenses/agpl-3.0.html""", + """In order to comply with the license, should you have made any modification +to the original copy of the software, which should contain a link to the +source code, however minor it is, you are under the legal obligation to provide +the source code once you publish the software on the Web. + Another obligation is that of stating your changes. This is usually done by +cloning the original git repository of the project and stating your changes +through the creation of commits, which allow us to determine when a specific +change was done.""", + """Furthermore, all the original clauses of the GNU General Public License +are kept intact, which means you have the obligation to + * Keep the AGPL License, without possibility of sublicensing the software + or making it available under any other more liberal license. + * Keep the copyright notice of the original authors + Failure to do so will result in a request to follow the License, and +repeated violation of the license could result in a legal fight.""", + """For more information on the FSF and software freedom, refer to: + * What is free software? https://www.gnu.org/philosophy/free-sw.html + * Free Software Is Even More Important Now + https://www.gnu.org/philosophy/free-software-even-more-important.html + * The GNU operating system https://www.gnu.org + * The Free Software Foundation https://www.fsf.org + Thank you for reading this and following our license terms.""", +) + + +class LicenseError(Exception): + pass + + +def check_license(namespace, project_name): + license_folder_path = "{}/.config/".format(Path.home()) + if not os.path.isdir(license_folder_path): + try: + os.mkdir(license_folder_path, mode=0o755) + except OSError as e: + raise LicenseError("Cannot create .config dir: {}".format(e)) + agreed_file_name = "{}/{}_license_agreed".format(license_folder_path, namespace) + if os.path.isfile(agreed_file_name): + return + + print( + " {}, and most/all software related to {},\n" + "is licensed under the GNU Affero General Public License.\n".format(project_name, namespace) + ) + for page in PAGES: + print(" " * 4 + "\n" + page) + try: + input("\nPress Enter to continue") + except KeyboardInterrupt: + raise LicenseError("License not read. Quitting.") + + if input("\nPlease write 'I agree' to accept the terms of the license.\n").lower().strip() != "i agree": + raise LicenseError("License not agreed. Quitting.") + + try: + open(agreed_file_name, "a").close() + except IOError as e: + raise LicenseError("Couldn't save read status: {}".format(e)) diff --git a/constants/__init__.py b/constants/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/constants/actions.py b/constants/actions.py new file mode 100644 index 0000000..50e4bf8 --- /dev/null +++ b/constants/actions.py @@ -0,0 +1,16 @@ +"""Contains user actions""" +IDLE = 0 +AFK = 1 +PLAYING = 2 +EDITING = 3 +MODDING = 4 +MULTIPLAYER = 5 +WATCHING = 6 +UNKNOWN = 7 +TESTING = 8 +SUBMITTING = 9 +PAUSED = 10 +LOBBY = 11 +MULTIPLAYING= 12 +OSU_DIRECT = 13 +NONE = 14 diff --git a/constants/bcolors.py b/constants/bcolors.py new file mode 100644 index 0000000..b0514a3 --- /dev/null +++ b/constants/bcolors.py @@ -0,0 +1,9 @@ +"""Console colors""" +PINK = '\033[95m' +BLUE = '\033[94m' +GREEN = '\033[92m' +YELLOW = '\033[93m' +RED = '\033[91m' +ENDC = '\033[0m' +BOLD = '\033[1m' +UNDERLINE = '\033[4m' diff --git a/constants/gameModes.py b/constants/gameModes.py new file mode 100644 index 0000000..14c57c1 --- /dev/null +++ b/constants/gameModes.py @@ -0,0 +1,53 @@ +STD = 0 +TAIKO = 1 +CTB = 2 +MANIA = 3 + +def getGameModeForDB(gameMode): + """ + Convert a game mode number to string for database table/column + + :param gameMode: game mode number + :return: game mode readable string for db + """ + + if gameMode == STD: + return "std" + elif gameMode == TAIKO: + return "taiko" + elif gameMode == CTB: + return "ctb" + else: + return "mania" + +def getGamemodeFull(gameMode): + """ + Get game mode name from game mode number + + :param gameMode: game mode number + :return: game mode readable name + """ + if gameMode == STD: + return "osu!" + elif gameMode == TAIKO: + return "Taiko" + elif gameMode == CTB: + return "Catch The Beat" + else: + return "osu!mania" + +def getGameModeForPrinting(gameMode): + """ + Convert a gamemode number to string for showing to a user (e.g. !last) + + :param gameMode: gameMode int or variable (ex: gameMode.std) + :return: game mode readable string for a human + """ + if gameMode == STD: + return "osu!" + elif gameMode == TAIKO: + return "Taiko" + elif gameMode == CTB: + return "CatchTheBeat" + else: + return "osu!mania" \ No newline at end of file diff --git a/constants/mods.py b/constants/mods.py new file mode 100644 index 0000000..7e7c42e --- /dev/null +++ b/constants/mods.py @@ -0,0 +1,31 @@ +NOMOD = 0 +NOFAIL = 1 +EASY = 2 +TOUCHSCREEN = 4 +HIDDEN = 8 +HARDROCK = 16 +SUDDENDEATH = 32 +DOUBLETIME = 64 +RELAX = 128 +HALFTIME = 256 +NIGHTCORE = 512 +FLASHLIGHT = 1024 +AUTOPLAY = 2048 +SPUNOUT = 4096 +RELAX2 = 8192 +PERFECT = 16384 +KEY4 = 32768 +KEY5 = 65536 +KEY6 = 131072 +KEY7 = 262144 +KEY8 = 524288 +KEYMOD = 1015808 +FADEIN = 1048576 +RANDOM = 2097152 +LASTMOD = 4194304 +KEY9 = 16777216 +KEY10 = 33554432 +KEY1 = 67108864 +KEY3 = 134217728 +KEY2 = 268435456 +SCOREV2 = 536870912 diff --git a/constants/privileges.py b/constants/privileges.py new file mode 100644 index 0000000..82f7e56 --- /dev/null +++ b/constants/privileges.py @@ -0,0 +1,23 @@ +USER_PUBLIC = 1 +USER_NORMAL = 2 << 0 +USER_DONOR = 2 << 1 +ADMIN_ACCESS_RAP = 2 << 2 +ADMIN_MANAGE_USERS = 2 << 3 +ADMIN_BAN_USERS = 2 << 4 +ADMIN_SILENCE_USERS = 2 << 5 +ADMIN_WIPE_USERS = 2 << 6 +ADMIN_MANAGE_BEATMAPS = 2 << 7 +ADMIN_MANAGE_SERVERS = 2 << 8 +ADMIN_MANAGE_SETTINGS = 2 << 9 +ADMIN_MANAGE_BETAKEYS = 2 << 10 +ADMIN_MANAGE_REPORTS = 2 << 11 +ADMIN_MANAGE_DOCS = 2 << 12 +ADMIN_MANAGE_BADGES = 2 << 13 +ADMIN_VIEW_RAP_LOGS = 2 << 14 +ADMIN_MANAGE_PRIVILEGES = 2 << 15 +ADMIN_SEND_ALERTS = 2 << 16 +ADMIN_CHAT_MOD = 2 << 17 +ADMIN_KICK_USERS = 2 << 18 +USER_PENDING_VERIFICATION = 2 << 19 +USER_TOURNAMENT_STAFF = 2 << 20 +ADMIN_CAKER = 20 << 21 diff --git a/db/__init__.py b/db/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/db/dbConnector.pyx b/db/dbConnector.pyx new file mode 100644 index 0000000..6f8e39c --- /dev/null +++ b/db/dbConnector.pyx @@ -0,0 +1,237 @@ +import queue +import MySQLdb +import MySQLdb.cursors +import time +from objects import glob +from common.log import logUtils as log + +class worker: + """ + A single MySQL worker + """ + def __init__(self, connection, temporary=False): + """ + Initialize a MySQL worker + + :param connection: database connection object + :param temporary: if True, this worker will be flagged as temporary + """ + self.connection = connection + self.temporary = temporary + log.debug("Created MySQL worker. Temporary: {}".format(self.temporary)) + + def ping(self): + """ + Ping MySQL server using this worker. + + :return: True if connected, False if error occured. + """ + c = self.connection.cursor(MySQLdb.cursors.DictCursor) + try: + c.execute("SELECT 1+1") + return True + except MySQLdb.Error: + return False + finally: + c.close() + + def __del__(self): + """ + Close connection to the server + + :return: + """ + self.connection.close() + +class connectionsPool: + """ + A MySQL workers pool + """ + def __init__(self, host, username, password, database, size=128): + """ + Initialize a MySQL connections pool + + :param host: MySQL host + :param username: MySQL username + :param password: MySQL password + :param database: MySQL database name + :param size: pool max size + """ + self.config = (host, username, password, database) + self.maxSize = size + self.pool = queue.Queue(self.maxSize) + self.consecutiveEmptyPool = 0 + self.fillPool() + + def newWorker(self, temporary=False): + """ + Create a new worker. + + :param temporary: if True, flag the worker as temporary + :return: instance of worker class + """ + db = MySQLdb.connect( + *self.config, + autocommit=True, + charset="utf8", + use_unicode=True + ) + conn = worker(db, temporary) + return conn + + def fillPool(self, newConnections=0): + """ + Fill the queue with workers + + :param newConnections: number of new connections. If 0, the pool will be filled entirely. + :return: + """ + # If newConnections = 0, fill the whole pool + if newConnections == 0: + newConnections = self.maxSize + + # Fill the pool + for _ in range(0, newConnections): + if not self.pool.full(): + self.pool.put_nowait(self.newWorker()) + + def getWorker(self, level=0): + """ + Get a MySQL connection worker from the pool. + If the pool is empty, a new temporary worker is created. + + :param level: number of failed connection attempts. If > 50, return None + :return: instance of worker class + """ + # Make sure we below 50 retries + #log.info("Pool size: {}".format(self.pool.qsize())) + glob.dog.increment(glob.DATADOG_PREFIX+".mysql_pool.queries") + glob.dog.gauge(glob.DATADOG_PREFIX+".mysql_pool.size", self.pool.qsize()) + if level >= 50: + log.warning("Too many failed connection attempts. No MySQL connection available.") + return None + + try: + if self.pool.empty(): + # The pool is empty. Spawn a new temporary worker + log.warning("MySQL connections pool is empty. Using temporary worker.") + worker = self.newWorker(True) + + # Increment saturation + self.consecutiveEmptyPool += 1 + + # If the pool is usually empty, expand it + if self.consecutiveEmptyPool >= 10: + log.warning("MySQL connections pool is empty. Filling connections pool.") + self.fillPool() + else: + # The pool is not empty. Get worker from the pool + # and reset saturation counter + worker = self.pool.get() + self.consecutiveEmptyPool = 0 + except MySQLdb.OperationalError: + # Connection to server lost + # Wait 1 second and try again + log.warning("Can't connect to MySQL database. Retrying in 1 second...") + glob.dog.increment(glob.DATADOG_PREFIX+".mysql_pool.failed_connections") + time.sleep(1) + return self.getWorker(level=level+1) + + # Return the connection + return worker + + def putWorker(self, worker): + """ + Put the worker back in the pool. + If the worker is temporary, close the connection + and destroy the object + + :param worker: worker object + :return: + """ + if worker.temporary or self.pool.full(): + # Kill the worker if it's temporary or the queue + # is full and we can't put anything in it + del worker + else: + # Put the connection in the queue if there's space + self.pool.put_nowait(worker) + +class db: + """ + A MySQL helper with multiple workers + """ + def __init__(self, host, username, password, database, initialSize): + """ + Initialize a new MySQL database helper with multiple workers. + This class is thread safe. + + :param host: MySQL host + :param username: MySQL username + :param password: MySQL password + :param database: MySQL database name + :param initialSize: initial pool size + """ + self.pool = connectionsPool(host, username, password, database, initialSize) + + def execute(self, query, params = ()): + """ + Executes a query + + :param query: query to execute. You can bind parameters with %s + :param params: parameters list. First element replaces first %s and so on + """ + cursor = None + worker = self.pool.getWorker() + if worker is None: + return None + try: + # Create cursor, execute query and commit + cursor = worker.connection.cursor(MySQLdb.cursors.DictCursor) + cursor.execute(query, params) + log.debug(query) + return cursor.lastrowid + finally: + # Close the cursor and release worker's lock + if cursor is not None: + cursor.close() + if worker is not None: + self.pool.putWorker(worker) + + def fetch(self, query, params = (), _all = False): + """ + Fetch a single value from db that matches given query + + :param query: query to execute. You can bind parameters with %s + :param params: parameters list. First element replaces first %s and so on + :param _all: fetch one or all values. Used internally. Use fetchAll if you want to fetch all values + """ + cursor = None + worker = self.pool.getWorker() + if worker is None: + return None + try: + # Create cursor, execute the query and fetch one/all result(s) + cursor = worker.connection.cursor(MySQLdb.cursors.DictCursor) + cursor.execute(query, params) + log.debug(query) + if _all: + return cursor.fetchall() + else: + return cursor.fetchone() + finally: + # Close the cursor and release worker's lock + if cursor is not None: + cursor.close() + if worker is not None: + self.pool.putWorker(worker) + + def fetchAll(self, query, params = ()): + """ + Fetch all values from db that matche given query. + Calls self.fetch with all = True. + + :param query: query to execute. You can bind parameters with %s + :param params: parameters list. First element replaces first %s and so on + """ + return self.fetch(query, params, True) diff --git a/ddog/__init__.py b/ddog/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ddog/datadogClient.py b/ddog/datadogClient.py new file mode 100644 index 0000000..068652e --- /dev/null +++ b/ddog/datadogClient.py @@ -0,0 +1,73 @@ +import threading +import datadog +from objects import glob + +class periodicCheck: + def __init__(self, name, checkFunction): + """ + Initialize a periodic check object + + :param name: Datadog stat name, without prefix + :param checkFunction: Function that returns the data to report. Eg: `lambda: len(something)` + """ + self.name = glob.DATADOG_PREFIX+"."+name + self.checkFunction = checkFunction + +class datadogClient: + def __init__(self, apiKey=None, appKey=None, periodicChecks=None): + """ + Initialize a toggleable Datadog Client + + :param apiKey: Datadog api key. Leave empty to create a dummy (disabled) Datadog client. + :param appKey: Datadog app key. Leave empty to create a dummy (disabled) Datadog client. + :param periodicChecks: List of periodicCheck objects. Optional. Leave empty to disable periodic checks. + """ + if apiKey is not None and appKey is not None: + datadog.initialize(api_key=apiKey, app_key=appKey) + self.client = datadog.ThreadStats() + self.client.start() + self.periodicChecks = periodicChecks + if self.periodicChecks is not None: + threading.Thread(target=self.__periodicCheckLoop).start() + else: + self.client = None + + def increment(self, *args, **kwargs): + """ + Call self.client.increment(*args, **kwargs) if this client is not a dummy + + :param args: + :param kwargs: + :return: + """ + if self.client is not None: + self.client.increment(*args, **kwargs) + + def gauge(self, *args, **kwargs): + """ + Call self.client.gauge(*args, **kwargs) if this client is not a dummy + + :param args: + :param kwargs: + :return: + """ + if self.client is not None: + self.client.gauge(*args, **kwargs) + + def __periodicCheckLoop(self): + """ + Report periodic data to datadog. + Called every 5 seconds. + Call this function only once. + + :return: + """ + if self.periodicChecks is None: + return + + # Get data + for i in self.periodicChecks: + self.gauge(i.name, i.checkFunction()) + + # Schedule a new datadog update + threading.Timer(10, self.__periodicCheckLoop).start() \ No newline at end of file diff --git a/files/__init__.py b/files/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/files/fileBuffer.py b/files/fileBuffer.py new file mode 100644 index 0000000..6f7f066 --- /dev/null +++ b/files/fileBuffer.py @@ -0,0 +1,79 @@ +from objects import glob + +class buffer: + """ + A file buffer object. + This buffer caches data in memory and when it's full, it writes the content to a file. + """ + def __init__(self, fileName, writeType="a", maxLength=512): + """ + A file buffer object + + :param fileName: Path and name of file on disk . + :param writeType: File write type. Optional. Default: "a" . + :param maxLength: Max length before writing buffer to disk. Optional. Default: 512. + """ + self.content = "" + self.length = 0 + self.fileName = fileName + self.writeType = writeType + self.maxLength = maxLength + + def write(self, newData): + """ + Add data to buffer. + If the total length of the data in buffer is greater than or equal to self.maxLength, + the content is written on the disk and the buffer resets + + :param newData: Data to append to buffer + :return: + """ + self.content += newData + self.length += len(newData) + if self.length >= self.maxLength: + self.flush() + + def flush(self): + """ + Write buffer content to disk and reset its content + + :return: + """ + try: + glob.fLocks.lockFile(self.fileName) + with open(self.fileName, self.writeType) as f: + f.write(self.content) + finally: + glob.fLocks.unlockFile(self.fileName) + + self.content = "" + self.length = 0 + +class buffersList: + """ + A list of buffers + """ + def __init__(self): + self.buffers = {} + + def write(self, fileName, content): + """ + Write some data to an existing buffer in this list (or create a new one if it doesn't exist). + If the buffer is full, the data is written to the file and the buffer resets. + + :param fileName: Path of file/buffer + :param content: New content + :return: + """ + if fileName not in self.buffers: + self.buffers[fileName] = buffer(fileName) + self.buffers[fileName].write(content) + + def flushAll(self): + """ + Write all buffers to file and flush them + + :return: + """ + for _, value in self.buffers.items(): + value.flush() \ No newline at end of file diff --git a/files/fileLocks.py b/files/fileLocks.py new file mode 100644 index 0000000..b9ad586 --- /dev/null +++ b/files/fileLocks.py @@ -0,0 +1,32 @@ +import threading + +class fileLocks: + def __init__(self): + # Dictionary containing threading.Lock s + self.locks = {} + + def lockFile(self, fileName): + """ + Set a file as locked. + + :param fileName: file name + :return: + """ + if fileName in self.locks: + # Acquire existing lock + self.locks[fileName].acquire() + else: + # Create new lock and acquire it + self.locks[fileName] = threading.Lock() + self.locks[fileName].acquire() + + def unlockFile(self, fileName): + """ + Unlock a previously locked file + + :param fileName: file name + :return: + """ + if fileName in self.locks: + # Release lock if it exists + self.locks[fileName].release() diff --git a/generalUtils.py b/generalUtils.py new file mode 100644 index 0000000..c1a2289 --- /dev/null +++ b/generalUtils.py @@ -0,0 +1,181 @@ +import string +import random +import hashlib +from functools import partial +from common.log import logUtils as log + +import dill + +from common.constants import mods +from time import localtime, strftime + +def randomString(length = 8): + return ''.join(random.choice(string.ascii_uppercase + string.digits) for _ in range(length)) + +def stringToBool(s): + """ + Convert a string (True/true/1) to bool + + :param s: string/int value + :return: True/False + """ + return s == "True" or s == "true" or s == "1" or s == 1 + +def fileMd5(filename): + """ + Return filename's md5 + + :param filename: name of the file + :return: file md5 + """ + with open(filename, mode='rb') as f: + d = hashlib.md5() + for buf in iter(partial(f.read, 128), b''): + d.update(buf) + return d.hexdigest() + +def stringMd5(s): + """ + Return string's md5 + + :param s: input string + :return: `string`'s md5 + """ + d = hashlib.md5() + d.update(s.encode("utf-8")) + return d.hexdigest() + +def getRank(gameMode=None, __mods=None, acc=None, c300=None, c100=None, c50=None, cmiss=None, *, score_=None): + """ + Return a string with rank/grade for a given score. + Used mainly for tillerino + + :param gameMode: game mode number + :param __mods: mods value + :param acc: accuracy + :param c300: 300 hit count + :param c100: 100 hit count + :param c50: 50 hit count + :param cmiss: misses count + :param score_: score object. Optional. + :return: rank/grade string + """ + if score_ is not None: + return getRank(score_.gameMode, score_.mods, score_.accuracy, score_.c300, score_.c100, score_.c50, score_.cMiss) + total = c300 + c100 + c50 + cmiss + hdfl = (__mods & mods.HIDDEN > 0) or (__mods & mods.FLASHLIGHT > 0) + + def ss(): + return "XH" if hdfl else "X" + + def s(): + return "SH" if hdfl else "S" + + if gameMode == 0: + # osu!std + if acc == 100: + return ss() + if c300 / total > 0.90 and c50 / total < 0.1 and cmiss == 0: + return s() + if (c300 / total > 0.80 and cmiss == 0) or (c300 / total > 0.90): + return "A" + if (c300 / total > 0.70 and cmiss == 0) or (c300 / total > 0.80): + return "B" + if c300 / total > 0.60: + return "C" + return "D" + elif gameMode == 1: + # TODO: taiko rank + return "A" + elif gameMode == 2: + # CtB + if acc == 100: + return ss() + if 98.01 <= acc <= 99.99: + return s() + if 94.01 <= acc <= 98.00: + return "A" + if 90.01 <= acc <= 94.00: + return "B" + if 98.01 <= acc <= 90.00: + return "C" + return "D" + elif gameMode == 3: + # osu!mania + if acc == 100: + return ss() + if acc > 95: + return s() + if acc > 90: + return "A" + if acc > 80: + return "B" + if acc > 70: + return "C" + return "D" + + return "A" + +def getTimestamp(): + """ + Return current time in YYYY-MM-DD HH:MM:SS format. + Used in logs. + + :return: readable timestamp + """ + return strftime("%Y-%m-%d %H:%M:%S", localtime()) + +def hexString(s): + """ + Output `s`'s bytes in DEX + :param s: string + :return: string with HEX values + """ + return ":".join("{:02x}".format(ord(str(c))) for c in s) + +def readableMods(__mods): + # TODO: same as common.scoreUtils.readableMods. Remove this or the other one. + r = "" + if __mods == 0: + return r + if __mods & mods.NOFAIL > 0: + r += "NF" + if __mods & mods.EASY > 0: + r += "EZ" + if __mods & mods.HIDDEN > 0: + r += "HD" + if __mods & mods.HARDROCK > 0: + r += "HR" + if __mods & mods.DOUBLETIME > 0: + r += "DT" + if __mods & mods.HALFTIME > 0: + r += "HT" + if __mods & mods.FLASHLIGHT > 0: + r += "FL" + if __mods & mods.SPUNOUT > 0: + r += "SO" + + return r + +def strContains(s, w): + """ + Check if `w` is in `s` + + :param s: haystack + :param w: needle + :return: True if `w` is in `s`, otherwise False + """ + return (' ' + w + ' ') in (' ' + s + ' ') + +def getTotalSize(o): + """ + Get approximate object size using dill + + :param o: object + :return: approximate bytes size + """ + try: + return len(dill.dumps(o, recurse=True)) + except: + log.error("Error while getting total object size!") + return 0 \ No newline at end of file diff --git a/log/__init__.py b/log/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/log/logUtils.py b/log/logUtils.py new file mode 100644 index 0000000..3ea35c7 --- /dev/null +++ b/log/logUtils.py @@ -0,0 +1,151 @@ +from common.constants import bcolors +from common import generalUtils +from objects import glob +from common.ripple import userUtils +import time +import os + +ENDL = "\n" if os.name == "posix" else "\r\n" + +def logMessage(message, alertType = "INFO", messageColor = bcolors.ENDC, discord = None, alertDev = False, of = None, stdout = True): + """ + Log a message + + :param message: message to log + :param alertType: alert type string. Can be INFO, WARNING, ERROR or DEBUG. Default: INFO + :param messageColor: message console ANSI color. Default: no color + :param discord: Discord channel acronym for Schiavo. If None, don't log to Discord. Default: None + :param alertDev: if True, developers will be highlighted on Discord. + Obviously works only if the message will be logged to Discord. + Default: False + :param of: Output file name (inside .data folder). If None, don't log to file. Default: None + :param stdout: If True, log to stdout (print). Default: True + :return: + """ + # Get type color from alertType + if alertType == "INFO": + typeColor = bcolors.GREEN + elif alertType == "WARNING": + typeColor = bcolors.YELLOW + elif alertType == "ERROR": + typeColor = bcolors.RED + elif alertType == "CHAT": + typeColor = bcolors.BLUE + elif alertType == "DEBUG": + typeColor = bcolors.PINK + else: + typeColor = bcolors.ENDC + + # Message without colors + finalMessage = "[{time}] {type} - {message}".format(time=generalUtils.getTimestamp(), type=alertType, message=message) + + # Message with colors + finalMessageConsole = "{typeColor}[{time}] {type}{endc} - {messageColor}{message}{endc}".format( + time=generalUtils.getTimestamp(), + type=alertType, + message=message, + + typeColor=typeColor, + messageColor=messageColor, + endc=bcolors.ENDC) + + # Log to console + if stdout: + print(finalMessageConsole) + + # Log to discord if needed + if discord is not None: + if discord == "bunker": + glob.schiavo.sendConfidential(message, alertDev) + elif discord == "cm": + glob.schiavo.sendCM(message) + elif discord == "staff": + glob.schiavo.sendStaff(message) + elif discord == "general": + glob.schiavo.sendGeneral(message) + + # Log to file if needed + if of is not None: + glob.fileBuffers.write(".data/"+of, finalMessage+ENDL) + +def warning(message, discord = None, alertDev = False): + """ + Log a warning to stdout and optionally to Discord + + :param message: warning message + :param discord: Discord channel acronym for Schiavo. If None, don't log to Discord. Default: None + :param alertDev: if True, developers will be highlighted on Discord. + Obviously works only if the message will be logged to Discord. + Default: False + :return: + """ + logMessage(message, "WARNING", bcolors.YELLOW, discord, alertDev) + +def error(message, discord = None, alertDev = True): + """ + Log a warning message to stdout and optionally to Discord + + :param message: warning message + :param discord: Discord channel acronym for Schiavo. If None, don't log to Discord. Default: None + :param alertDev: if True, developers will be highlighted on Discord. + Obviously works only if the message will be logged to Discord. + Default: False + :return: + """ + logMessage(message, "ERROR", bcolors.RED, discord, alertDev) + +def info(message, discord = None, alertDev = False): + """ + Log an info message to stdout and optionally to Discord + + :param message: info message + :param discord: Discord channel acronym for Schiavo. If None, don't log to Discord. Default: None + :param alertDev: if True, developers will be highlighted on Discord. + Obviously works only if the message will be logged to Discord. + Default: False + :return: + """ + logMessage(message, "INFO", bcolors.ENDC, discord, alertDev) + +def debug(message): + """ + Log a debug message to stdout. + Works only if the server is running in debug mode. + + :param message: debug message + :return: + """ + if glob.debug: + logMessage(message, "DEBUG", bcolors.PINK) + +def chat(message): + """ + Log a public chat message to stdout and to chatlog_public.txt. + + :param message: message content + :return: + """ + logMessage(message, "CHAT", bcolors.BLUE, of="chatlog_public.txt") + +def pm(message): + """ + Log a private chat message to stdout. Currently not used. + + :param message: message content + :return: + """ + logMessage(message, "CHAT", bcolors.BLUE) + +def rap(userID, message, discord=False, through="FokaBot"): + """ + Log a message to Admin Logs. + + :param userID: admin user ID + :param message: message content, without username + :param discord: if True, send the message to discord + :param through: through string. Default: FokaBot + :return: + """ + glob.db.execute("INSERT INTO rap_logs (id, userid, text, datetime, through) VALUES (NULL, %s, %s, %s, %s)", [userID, message, int(time.time()), through]) + username = userUtils.getUsername(userID) + logMessage("{} {}".format(username, message), discord=True) diff --git a/redis/__init__.py b/redis/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/redis/generalPubSubHandler.py b/redis/generalPubSubHandler.py new file mode 100644 index 0000000..ebd2559 --- /dev/null +++ b/redis/generalPubSubHandler.py @@ -0,0 +1,42 @@ +import json + +def shape(d): + """ + Returns a shape of a dictionary. + Used to check if two dictionaries have the same structure + + :param d: dictionary + :return: `d`'s shape + """ + if isinstance(d, dict): + return {k: shape(d[k]) for k in d} + else: + return None + +class wrongStructureError(Exception): + pass + +class generalPubSubHandler: + def __init__(self): + self.structure = {} + self.type = "json" + self.strict = True + + def parseData(self, data): + """ + Parse received data + + :param data: received data, as bytes array + :return: parsed data or None if it's invalid + """ + if self.type == "json": + # Parse json + if type(data) == int: + return None + data = json.loads(data.decode("utf-8")) + if shape(data) != shape(self.structure) and self.strict: + raise wrongStructureError() + elif self.type == "int": + # Parse int + data = int(data.decode("utf-8")) + return data \ No newline at end of file diff --git a/redis/pubSub.py b/redis/pubSub.py new file mode 100644 index 0000000..4bd6751 --- /dev/null +++ b/redis/pubSub.py @@ -0,0 +1,68 @@ +import threading +from common.log import logUtils as log +from common.redis import generalPubSubHandler +from common.sentry import sentry + +class listener(threading.Thread): + def __init__(self, r, handlers): + """ + Initialize a set of redis pubSub listeners + + :param r: redis instance (usually glob.redis) + :param handlers: dictionary with the following structure: + ``` + { + "redis_channel_name": handler, + ... + } + ``` + Where handler is: + - An object of a class that inherits common.redis.generalPubSubHandler. + You can create custom behaviors for your handlers by overwriting the `handle(self, data)` method, + that will be called when that handler receives some data. + + - A function *object (not call)* that accepts one argument, that'll be the data received through the channel. + This is useful if you want to make some simple handlers through a lambda, without having to create a class. + """ + threading.Thread.__init__(self) + self.redis = r + self.pubSub = self.redis.pubsub() + self.handlers = handlers + channels = [] + for k, v in self.handlers.items(): + channels.append(k) + self.pubSub.subscribe(channels) + log.info("Subscribed to redis pubsub channels: {}".format(channels)) + + @sentry.capture() + def processItem(self, item): + """ + Processes a pubSub item by calling channel's handler + + :param item: incoming data + :return: + """ + if item["type"] == "message": + # Process the message only if the channel has received a message + # Decode the message + item["channel"] = item["channel"].decode("utf-8") + + # Make sure the handler exists + if item["channel"] in self.handlers: + log.info("Redis pubsub: {} <- {} ".format(item["channel"], item["data"])) + if isinstance(self.handlers[item["channel"]], generalPubSubHandler.generalPubSubHandler): + # Handler class + self.handlers[item["channel"]].handle(item["data"]) + else: + # Function + self.handlers[item["channel"]](item["data"]) + + def run(self): + """ + Listen for data on incoming channels and process it. + Runs forever. + + :return: + """ + for item in self.pubSub.listen(): + self.processItem(item) \ No newline at end of file diff --git a/ripple/__init__.py b/ripple/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ripple/passwordUtils.py b/ripple/passwordUtils.py new file mode 100644 index 0000000..2dfbee5 --- /dev/null +++ b/ripple/passwordUtils.py @@ -0,0 +1,39 @@ +#import crypt +#import base64 +import bcrypt + +def checkOldPassword(password, salt, rightPassword): + """ + Check if `password` + `salt` corresponds to `rightPassword` + NOT USED ANYMORE! RETURNS ALWAYS FALSE! + + :param password: input password + :param salt: password's salt + :param rightPassword: tight password + :return: True if the password is correct, otherwise False. + """ + return False + #return (rightPassword == crypt.crypt(password, "$2y$"+str(base64.b64decode(salt)))) + +def checkNewPassword(password, dbPassword): + """ + Check if a password (version 2) is right. + + :param password: input password + :param dbPassword: the password in the database + :return: True if the password is correct, otherwise False. + """ + if len(password) != 32: + return False + password = password.encode("utf-8") + dbPassword = dbPassword.encode("utf-8") + return bcrypt.checkpw(password, dbPassword) + +def genBcrypt(password): + """ + Bcrypts a password. + + :param password: the password to hash + :return: bytestring + """ + return bcrypt.hashpw(password.encode("utf8"), bcrypt.gensalt(10, b'2a')) diff --git a/ripple/scoreUtils.py b/ripple/scoreUtils.py new file mode 100644 index 0000000..4061d3f --- /dev/null +++ b/ripple/scoreUtils.py @@ -0,0 +1,64 @@ +from common.constants import mods + + +def isRankable(m): + """ + Checks if `m` contains unranked mods + + :param m: mods enum + :return: True if there are no unranked mods in `m`, else False + """ + # TODO: Check other modes unranked mods ...? + return not ((m & mods.RELAX2 > 0) or (m & mods.AUTOPLAY > 0) or (m & mods.SCOREV2 > 0)) + +def readableGameMode(gameMode): + """ + Convert numeric gameMode to a readable format. Can be used for db too. + + :param gameMode: + :return: + """ + # TODO: Same as common.constants.gameModes.getGameModeForDB, remove one + if gameMode == 0: + return "std" + elif gameMode == 1: + return "taiko" + elif gameMode == 2: + return "ctb" + else: + return "mania" + +def readableMods(m): + """ + Return a string with readable std mods. + Used to convert a mods number for oppai + + :param m: mods bitwise number + :return: readable mods string, eg HDDT + """ + r = "" + if m == 0: + return "nomod" + if m & mods.NOFAIL > 0: + r += "NF" + if m & mods.EASY > 0: + r += "EZ" + if m & mods.HIDDEN > 0: + r += "HD" + if m & mods.HARDROCK > 0: + r += "HR" + if m & mods.DOUBLETIME > 0: + r += "DT" + if m & mods.HALFTIME > 0: + r += "HT" + if m & mods.FLASHLIGHT > 0: + r += "FL" + if m & mods.SPUNOUT > 0: + r += "SO" + if m & mods.TOUCHSCREEN > 0: + r += "TD" + if m & mods.RELAX > 0: + r += "RX" + if m & mods.RELAX2 > 0: + r += "AP" + return r diff --git a/ripple/userUtils.py b/ripple/userUtils.py new file mode 100644 index 0000000..bb4ef68 --- /dev/null +++ b/ripple/userUtils.py @@ -0,0 +1,1273 @@ +import time +from _mysql import ProgrammingError + +from common import generalUtils +from common.constants import gameModes +from common.constants import privileges +from common.log import logUtils as log +from common.ripple import passwordUtils, scoreUtils +from objects import glob + + +def getUserStats(userID, gameMode): + """ + Get all user stats relative to `gameMode` + + :param userID: + :param gameMode: game mode number + :return: dictionary with result + """ + modeForDB = gameModes.getGameModeForDB(gameMode) + + # Get stats + stats = glob.db.fetch("""SELECT + ranked_score_{gm} AS rankedScore, + avg_accuracy_{gm} AS accuracy, + playcount_{gm} AS playcount, + total_score_{gm} AS totalScore, + pp_{gm} AS pp + FROM users_stats WHERE id = %s LIMIT 1""".format(gm=modeForDB), [userID]) + + # Get game rank + stats["gameRank"] = getGameRank(userID, gameMode) + + # Return stats + game rank + return stats + +def getUserStatsRx(userID, gameMode): + """ + Get all user stats relative to `gameMode` + + :param userID: + :param gameMode: game mode number + :return: dictionary with result + """ + modeForDB = gameModes.getGameModeForDB(gameMode) + + # Get stats + stats = glob.db.fetch("""SELECT + ranked_score_{gm} AS rankedScore, + avg_accuracy_{gm} AS accuracy, + playcount_{gm} AS playcount, + total_score_{gm} AS totalScore, + pp_{gm}_rx AS pp + FROM users_stats WHERE id = %s LIMIT 1""".format(gm=modeForDB), [userID]) + + # Get game rank + stats["gameRank"] = getGameRankRx(userID, gameMode) + + # Return stats + game rank + return stats + +def getIDSafe(_safeUsername): + """ + Get user ID from a safe username + :param _safeUsername: safe username + :return: None if the user doesn't exist, else user id + """ + result = glob.db.fetch("SELECT id FROM users WHERE username_safe = %s LIMIT 1", [_safeUsername]) + if result is not None: + return result["id"] + return None + +def getID(username): + """ + Get username's user ID from userID redis cache (if cache hit) + or from db (and cache it for other requests) if cache miss + + :param username: user + :return: user id or 0 if user doesn't exist + """ + # Get userID from redis + usernameSafe = safeUsername(username) + userID = glob.redis.get("ripple:userid_cache:{}".format(usernameSafe)) + + if userID is None: + # If it's not in redis, get it from mysql + userID = getIDSafe(usernameSafe) + + # If it's invalid, return 0 + if userID is None: + return 0 + + # Otherwise, save it in redis and return it + glob.redis.set("ripple:userid_cache:{}".format(usernameSafe), userID, 3600) # expires in 1 hour + return userID + + # Return userid from redis + return int(userID) + +def getUsername(userID): + """ + Get userID's username + + :param userID: user id + :return: username or None + """ + result = glob.db.fetch("SELECT username FROM users WHERE id = %s LIMIT 1", [userID]) + if result is None: + return None + return result["username"] + +def getSafeUsername(userID): + """ + Get userID's safe username + + :param userID: user id + :return: username or None + """ + result = glob.db.fetch("SELECT username_safe FROM users WHERE id = %s LIMIT 1", [userID]) + if result is None: + return None + return result["username_safe"] + +def exists(userID): + """ + Check if given userID exists + + :param userID: user id to check + :return: True if the user exists, else False + """ + return True if glob.db.fetch("SELECT id FROM users WHERE id = %s LIMIT 1", [userID]) is not None else False + +def checkLogin(userID, password, ip=""): + """ + Check userID's login with specified password + + :param userID: user id + :param password: md5 password + :param ip: request IP (used to check active bancho sessions). Optional. + :return: True if user id and password combination is valid, else False + """ + # Check cached bancho session + banchoSession = False + if ip != "": + banchoSession = checkBanchoSession(userID, ip) + + # Return True if there's a bancho session for this user from that ip + if banchoSession: + return True + + # Otherwise, check password + # Get password data + passwordData = glob.db.fetch("SELECT password_md5, salt, password_version FROM users WHERE id = %s LIMIT 1", [userID]) + + # Make sure the query returned something + if passwordData is None: + return False + + # Return valid/invalid based on the password version. + if passwordData["password_version"] == 2: + return passwordUtils.checkNewPassword(password, passwordData["password_md5"]) + if passwordData["password_version"] == 1: + ok = passwordUtils.checkOldPassword(password, passwordData["salt"], passwordData["password_md5"]) + if not ok: + return False + newpass = passwordUtils.genBcrypt(password) + glob.db.execute("UPDATE users SET password_md5=%s, salt='', password_version='2' WHERE id = %s LIMIT 1", [newpass, userID]) + +def getRequiredScoreForLevel(level): + """ + Return score required to reach a level + + :param level: level to reach + :return: required score + """ + if level <= 100: + if level >= 2: + return 5000 / 3 * (4 * (level ** 3) - 3 * (level ** 2) - level) + 1.25 * (1.8 ** (level - 60)) + elif level <= 0 or level == 1: + return 1 # Should be 0, but we get division by 0 below so set to 1 + elif level >= 101: + return 26931190829 + 100000000000 * (level - 100) + +def getLevel(totalScore): + """ + Return level from totalScore + + :param totalScore: total score + :return: level + """ + level = 1 + while True: + # if the level is > 8000, it's probably an endless loop. terminate it. + if level > 8000: + return level + + # Calculate required score + reqScore = getRequiredScoreForLevel(level) + + # Check if this is our level + if totalScore <= reqScore: + # Our level, return it and break + return level - 1 + else: + # Not our level, calculate score for next level + level += 1 + +def updateLevel(userID, gameMode=0, totalScore=0): + """ + Update level in DB for userID relative to gameMode + + :param userID: user id + :param gameMode: game mode number + :param totalScore: new total score + :return: + """ + # Make sure the user exists + # if not exists(userID): + # return + + # Get total score from db if not passed + mode = scoreUtils.readableGameMode(gameMode) + if totalScore == 0: + totalScore = glob.db.fetch( + "SELECT total_score_{m} as total_score FROM users_stats WHERE id = %s LIMIT 1".format(m=mode), [userID]) + if totalScore: + totalScore = totalScore["total_score"] + + # Calculate level from totalScore + level = getLevel(totalScore) + + # Save new level + glob.db.execute("UPDATE users_stats SET level_{m} = %s WHERE id = %s LIMIT 1".format(m=mode), [level, userID]) + +def calculateAccuracy(userID, gameMode): + """ + Calculate accuracy value for userID relative to gameMode + + :param userID: user id + :param gameMode: game mode number + :return: new accuracy + """ + # Select what to sort by + if gameMode == 0: + sortby = "pp" + else: + sortby = "accuracy" + # Get best accuracy scores + bestAccScores = glob.db.fetchAll( + "SELECT accuracy FROM scores WHERE userid = %s AND play_mode = %s AND completed = 3 ORDER BY " + sortby + " DESC LIMIT 500", + [userID, gameMode]) + + v = 0 + if bestAccScores is not None: + # Calculate weighted accuracy + totalAcc = 0 + divideTotal = 0 + k = 0 + for i in bestAccScores: + add = int((0.95 ** k) * 100) + totalAcc += i["accuracy"] * add + divideTotal += add + k += 1 + # echo "$add - $totalacc - $divideTotal\n" + if divideTotal != 0: + v = totalAcc / divideTotal + else: + v = 0 + return v + +def calculatePP(userID, gameMode): + """ + Calculate userID's total PP for gameMode + + :param userID: user id + :param gameMode: game mode number + :return: total PP + """ + # Get best pp scores + bestPPScores = glob.db.fetchAll( + "SELECT pp FROM scores WHERE userid = %s AND play_mode = %s AND completed = 3 ORDER BY pp DESC LIMIT 500", + [userID, gameMode]) + + # Calculate weighted PP + totalPP = 0 + if bestPPScores is not None: + k = 0 + for i in bestPPScores: + new = round(round(i["pp"]) * 0.95 ** k) + totalPP += new + k += 1 + + return totalPP + +def calculatePPRelax(userID, gameMode): + """ + Calculate userID's total PP for gameMode + + :param userID: user id + :param gameMode: game mode number + :return: total PP + """ + # Get best pp scores + bestPPScores = glob.db.fetchAll( + "SELECT pp FROM scores_relax WHERE userid = %s AND play_mode = %s AND completed = 3 ORDER BY pp DESC LIMIT 500", + [userID, gameMode]) + + # Calculate weighted PP + totalPP = 0 + if bestPPScores is not None: + k = 0 + for i in bestPPScores: + new = round(round(i["pp"]) * 0.95 ** k) + totalPP += new + k += 1 + + return totalPP +def updateAccuracy(userID, gameMode): + """ + Update accuracy value for userID relative to gameMode in DB + + :param userID: user id + :param gameMode: gameMode number + :return: + """ + newAcc = calculateAccuracy(userID, gameMode) + mode = scoreUtils.readableGameMode(gameMode) + glob.db.execute("UPDATE users_stats SET avg_accuracy_{m} = %s WHERE id = %s LIMIT 1".format(m=mode), + [newAcc, userID]) + +def updatePP(userID, gameMode): + """ + Update userID's pp with new value + + :param userID: user id + :param gameMode: game mode number + """ + # Make sure the user exists + # if not exists(userID): + # return + + # Get new total PP and update db + newPP = calculatePP(userID, gameMode) + mode = scoreUtils.readableGameMode(gameMode) + glob.db.execute("UPDATE users_stats SET pp_{}=%s WHERE id = %s LIMIT 1".format(mode), [newPP, userID]) + + +def updatePPRelax(userID, gameMode): + """ + Update userID's pp with new value + + :param userID: user id + :param gameMode: game mode number + """ + # Make sure the user exists + # if not exists(userID): + # return + + # Get new total PP and update db + newPP = calculatePPRelax(userID, gameMode) + mode = scoreUtils.readableGameMode(gameMode) + glob.db.execute("UPDATE users_stats SET pp_{}_rx=%s WHERE id = %s LIMIT 1".format(mode), [newPP, userID]) + +def updateStats(userID, __score): + """ + Update stats (playcount, total score, ranked score, level bla bla) + with data relative to a score object + + :param userID: + :param __score: score object + """ + + # Make sure the user exists + if not exists(userID): + log.warning("User {} doesn't exist.".format(userID)) + return + + # Get gamemode for db + mode = scoreUtils.readableGameMode(__score.gameMode) + + # Update total score and playcount + glob.db.execute( + "UPDATE users_stats SET total_score_{m}=total_score_{m}+%s, playcount_{m}=playcount_{m}+1 WHERE id = %s LIMIT 1".format( + m=mode), [__score.score, userID]) + + # Calculate new level and update it + updateLevel(userID, __score.gameMode) + + # Update level, accuracy and ranked score only if we have passed the song + if __score.passed: + # Update ranked score + glob.db.execute( + "UPDATE users_stats SET ranked_score_{m}=ranked_score_{m}+%s WHERE id = %s LIMIT 1".format(m=mode), + [__score.rankedScoreIncrease, userID]) + + # Update accuracy + updateAccuracy(userID, __score.gameMode) + + # Update pp + updatePP(userID, __score.gameMode) + +def updateStatsRx(userID, __score): + """ + Update stats (playcount, total score, ranked score, level bla bla) + with data relative to a score object + + :param userID: + :param __score: score object + """ + + # Make sure the user exists + if not exists(userID): + log.warning("User {} doesn't exist.".format(userID)) + return + + # Get gamemode for db + mode = scoreUtils.readableGameMode(__score.gameMode) + + # Update total score and playcount + glob.db.execute( + "UPDATE users_stats SET total_score_{m}=total_score_{m}+%s, playcount_{m}=playcount_{m}+1 WHERE id = %s LIMIT 1".format( + m=mode), [__score.score, userID]) + + # Calculate new level and update it + updateLevel(userID, __score.gameMode) + + # Update level, accuracy and ranked score only if we have passed the song + if __score.passed: + # Update ranked score + glob.db.execute( + "UPDATE users_stats SET ranked_score_{m}=ranked_score_{m}+%s WHERE id = %s LIMIT 1".format(m=mode), + [__score.rankedScoreIncrease, userID]) + + # Update accuracy + updateAccuracy(userID, __score.gameMode) + + # Update pp + updatePPRelax(userID, __score.gameMode) + +def updateLatestActivity(userID): + """ + Update userID's latest activity to current UNIX time + + :param userID: user id + :return: + """ + glob.db.execute("UPDATE users SET latest_activity = %s WHERE id = %s LIMIT 1", [int(time.time()), userID]) + +def getRankedScore(userID, gameMode): + """ + Get userID's ranked score relative to gameMode + + :param userID: user id + :param gameMode: game mode number + :return: ranked score + """ + mode = scoreUtils.readableGameMode(gameMode) + result = glob.db.fetch("SELECT ranked_score_{} FROM users_stats WHERE id = %s LIMIT 1".format(mode), [userID]) + if result is not None: + return result["ranked_score_{}".format(mode)] + else: + return 0 + +def getPP(userID, gameMode): + """ + Get userID's PP relative to gameMode + + :param userID: user id + :param gameMode: game mode number + :return: pp + """ + + mode = scoreUtils.readableGameMode(gameMode) + result = glob.db.fetch("SELECT pp_{} FROM users_stats WHERE id = %s LIMIT 1".format(mode), [userID]) + if result is not None: + return result["pp_{}".format(mode)] + else: + return 0 + +def incrementReplaysWatched(userID, gameMode): + """ + Increment userID's replays watched by others relative to gameMode + + :param userID: user id + :param gameMode: game mode number + :return: + """ + mode = scoreUtils.readableGameMode(gameMode) + glob.db.execute( + "UPDATE users_stats SET replays_watched_{mode}=replays_watched_{mode}+1 WHERE id = %s LIMIT 1".format( + mode=mode), [userID]) + +def getAqn(userID): + """ + Check if AQN folder was detected for userID + + :param userID: user + :return: True if hax, False if legit + """ + result = glob.db.fetch("SELECT aqn FROM users WHERE id = %s LIMIT 1", [userID]) + if result is not None: + return True if int(result["aqn"]) == 1 else False + else: + return False + +def setAqn(userID, value=1): + """ + Set AQN folder status for userID + + :param userID: user + :param value: new aqn value, default = 1 + :return: + """ + glob.db.fetch("UPDATE users SET aqn = %s WHERE id = %s LIMIT 1", [value, userID]) + +def IPLog(userID, ip): + """ + Log user IP + + :param userID: user id + :param ip: IP address + :return: + """ + glob.db.execute("""INSERT INTO ip_user (userid, ip, occurencies) VALUES (%s, %s, '1') + ON DUPLICATE KEY UPDATE occurencies = occurencies + 1""", [userID, ip]) + +def checkBanchoSession(userID, ip=""): + """ + Return True if there is a bancho session for `userID` from `ip` + If `ip` is an empty string, check if there's a bancho session for that user, from any IP. + + :param userID: user id + :param ip: ip address. Optional. Default: empty string + :return: True if there's an active bancho session, else False + """ + if ip != "": + return glob.redis.sismember("peppy:sessions:{}".format(userID), ip) + else: + return glob.redis.exists("peppy:sessions:{}".format(userID)) + +def is2FAEnabled(userID): + """ + Returns True if 2FA/Google auth 2FA is enable for `userID` + + :userID: user ID + :return: True if 2fa is enabled, else False + """ + return glob.db.fetch("SELECT 2fa_totp.userid FROM 2fa_totp WHERE userid = %(userid)s AND enabled = 1 LIMIT 1", { + "userid": userID + }) is not None + +def check2FA(userID, ip): + """ + Returns True if this IP is untrusted. + Returns always False if 2fa is not enabled on `userID` + + :param userID: user id + :param ip: IP address + :return: True if untrusted, False if trusted or 2fa is disabled. + """ + if not is2FAEnabled(userID): + return False + + result = glob.db.fetch("SELECT id FROM ip_user WHERE userid = %s AND ip = %s", [userID, ip]) + return True if result is None else False + +def isAllowed(userID): + """ + Check if userID is not banned or restricted + + :param userID: user id + :return: True if not banned or restricted, otherwise false. + """ + result = glob.db.fetch("SELECT privileges FROM users WHERE id = %s LIMIT 1", [userID]) + if result is not None: + return (result["privileges"] & privileges.USER_NORMAL) and (result["privileges"] & privileges.USER_PUBLIC) + else: + return False + +def isRestricted(userID): + """ + Check if userID is restricted + + :param userID: user id + :return: True if not restricted, otherwise false. + """ + result = glob.db.fetch("SELECT privileges FROM users WHERE id = %s LIMIT 1", [userID]) + if result is not None: + return (result["privileges"] & privileges.USER_NORMAL) and not (result["privileges"] & privileges.USER_PUBLIC) + else: + return False + +def isBanned(userID): + """ + Check if userID is banned + + :param userID: user id + :return: True if not banned, otherwise false. + """ + result = glob.db.fetch("SELECT privileges FROM users WHERE id = %s LIMIT 1", [userID]) + if result is not None: + return not (result["privileges"] & 3 > 0) + else: + return True + +def isLocked(userID): + """ + Check if userID is locked + + :param userID: user id + :return: True if not locked, otherwise false. + """ + result = glob.db.fetch("SELECT privileges FROM users WHERE id = %s LIMIT 1", [userID]) + if result is not None: + return ( + (result["privileges"] & privileges.USER_PUBLIC > 0) and (result["privileges"] & privileges.USER_NORMAL == 0)) + else: + return True + +def ban(userID): + """ + Ban userID + + :param userID: user id + :return: + """ + # Set user as banned in db + banDateTime = int(time.time()) + glob.db.execute("UPDATE users SET privileges = privileges & %s, ban_datetime = %s WHERE id = %s LIMIT 1", + [~(privileges.USER_NORMAL | privileges.USER_PUBLIC), banDateTime, userID]) + + # Notify bancho about the ban + glob.redis.publish("peppy:ban", userID) + + # Remove the user from global and country leaderboards + removeFromLeaderboard(userID) + +def unban(userID): + """ + Unban userID + + :param userID: user id + :return: + """ + glob.db.execute("UPDATE users SET privileges = privileges | %s, ban_datetime = 0 WHERE id = %s LIMIT 1", + [(privileges.USER_NORMAL | privileges.USER_PUBLIC), userID]) + glob.redis.publish("peppy:ban", userID) + +def restrict(userID): + """ + Restrict userID + + :param userID: user id + :return: + """ + if not isRestricted(userID): + # Set user as restricted in db + banDateTime = int(time.time()) + glob.db.execute("UPDATE users SET privileges = privileges & %s, ban_datetime = %s WHERE id = %s LIMIT 1", + [~privileges.USER_PUBLIC, banDateTime, userID]) + + # Notify bancho about this ban + glob.redis.publish("peppy:ban", userID) + + # Remove the user from global and country leaderboards + removeFromLeaderboard(userID) + +def unrestrict(userID): + """ + Unrestrict userID. + Same as unban(). + + :param userID: user id + :return: + """ + unban(userID) + +def appendNotes(userID, notes, addNl=True, trackDate=True): + """ + Append `notes` to `userID`'s "notes for CM" + + :param userID: user id + :param notes: text to append + :param addNl: if True, prepend \n to notes. Default: True. + :param trackDate: if True, prepend date and hour to the note. Default: True. + :return: + """ + if trackDate: + notes = "[{}] {}".format(generalUtils.getTimestamp(), notes) + if addNl: + notes = "\n{}".format(notes) + glob.db.execute("UPDATE users SET notes=CONCAT(COALESCE(notes, ''),%s) WHERE id = %s LIMIT 1", [notes, userID]) + +def getPrivileges(userID): + """ + Return `userID`'s privileges + + :param userID: user id + :return: privileges number + """ + result = glob.db.fetch("SELECT privileges FROM users WHERE id = %s LIMIT 1", [userID]) + if result is not None: + return result["privileges"] + else: + return 0 + +def getSilenceEnd(userID): + """ + Get userID's **ABSOLUTE** silence end UNIX time + Remember to subtract time.time() if you want to get the actual silence time + + :param userID: user id + :return: UNIX time + """ + return glob.db.fetch("SELECT silence_end FROM users WHERE id = %s LIMIT 1", [userID])["silence_end"] + +def silence(userID, seconds, silenceReason, author = 999): + """ + Silence someone + + :param userID: user id + :param seconds: silence length in seconds + :param silenceReason: silence reason shown on website + :param author: userID of who silenced the user. Default: 999 + :return: + """ + # db qurey + silenceEndTime = int(time.time())+seconds + glob.db.execute("UPDATE users SET silence_end = %s, silence_reason = %s WHERE id = %s LIMIT 1", [silenceEndTime, silenceReason, userID]) + + # Log + targetUsername = getUsername(userID) + # TODO: exists check im drunk rn i need to sleep (stampa piede ubriaco confirmed) + if seconds > 0: + log.rap(author, "has silenced {} for {} seconds for the following reason: \"{}\"".format(targetUsername, seconds, silenceReason), True) + else: + log.rap(author, "has removed {}'s silence".format(targetUsername), True) + +def getTotalScore(userID, gameMode): + """ + Get `userID`'s total score relative to `gameMode` + + :param userID: user id + :param gameMode: game mode number + :return: total score + """ + modeForDB = gameModes.getGameModeForDB(gameMode) + return glob.db.fetch("SELECT total_score_"+modeForDB+" FROM users_stats WHERE id = %s LIMIT 1", [userID])["total_score_"+modeForDB] + +def getAccuracy(userID, gameMode): + """ + Get `userID`'s average accuracy relative to `gameMode` + + :param userID: user id + :param gameMode: game mode number + :return: accuracy + """ + modeForDB = gameModes.getGameModeForDB(gameMode) + return glob.db.fetch("SELECT avg_accuracy_"+modeForDB+" FROM users_stats WHERE id = %s LIMIT 1", [userID])["avg_accuracy_"+modeForDB] + +def getGameRank(userID, gameMode): + """ + Get `userID`'s **in-game rank** (eg: #1337) relative to gameMode + + :param userID: user id + :param gameMode: game mode number + :return: game rank + """ + position = glob.redis.zrevrank("ripple:leaderboard:{}".format(gameModes.getGameModeForDB(gameMode)), userID) + if position is None: + return 0 + else: + return int(position) + 1 + +def getGameRankRx(userID, gameMode): + """ + Get `userID`'s **in-game rank** (eg: #1337) relative to gameMode + :param userID: user id + :param gameMode: game mode number + :return: game rank + """ + position = glob.redis.zrevrank("ripple:leaderboard_relax:{}".format(gameModes.getGameModeForDB(gameMode)), userID) + if position is None: + return 0 + else: + return int(position) + 1 + +def getPlaycount(userID, gameMode): + """ + Get `userID`'s playcount relative to `gameMode` + + :param userID: user id + :param gameMode: game mode number + :return: playcount + """ + modeForDB = gameModes.getGameModeForDB(gameMode) + return glob.db.fetch("SELECT playcount_"+modeForDB+" FROM users_stats WHERE id = %s LIMIT 1", [userID])["playcount_"+modeForDB] + +def getFriendList(userID): + """ + Get `userID`'s friendlist + + :param userID: user id + :return: list with friends userIDs. [0] if no friends. + """ + # Get friends from db + friends = glob.db.fetchAll("SELECT user2 FROM users_relationships WHERE user1 = %s", [userID]) + + if friends is None or len(friends) == 0: + # We have no friends, return 0 list + return [0] + else: + # Get only friends + friends = [i["user2"] for i in friends] + + # Return friend IDs + return friends + +def addFriend(userID, friendID): + """ + Add `friendID` to `userID`'s friend list + + :param userID: user id + :param friendID: new friend + :return: + """ + # Make sure we aren't adding us to our friends + if userID == friendID: + return + + # check user isn't already a friend of ours + if glob.db.fetch("SELECT id FROM users_relationships WHERE user1 = %s AND user2 = %s LIMIT 1", [userID, friendID]) is not None: + return + + # Set new value + glob.db.execute("INSERT INTO users_relationships (user1, user2) VALUES (%s, %s)", [userID, friendID]) + +def removeFriend(userID, friendID): + """ + Remove `friendID` from `userID`'s friend list + + :param userID: user id + :param friendID: old friend + :return: + """ + # Delete user relationship. We don't need to check if the relationship was there, because who gives a shit, + # if they were not friends and they don't want to be anymore, be it. ¯\_(ツ)_/¯ + # TODO: LIMIT 1 + glob.db.execute("DELETE FROM users_relationships WHERE user1 = %s AND user2 = %s", [userID, friendID]) + + +def getCountry(userID): + """ + Get `userID`'s country **(two letters)**. + + :param userID: user id + :return: country code (two letters) + """ + return glob.db.fetch("SELECT country FROM users_stats WHERE id = %s LIMIT 1", [userID])["country"] + +def setCountry(userID, country): + """ + Set userID's country + + :param userID: user id + :param country: country letters + :return: + """ + glob.db.execute("UPDATE users_stats SET country = %s WHERE id = %s LIMIT 1", [country, userID]) + +def logIP(userID, ip): + """ + User IP log + USED FOR MULTIACCOUNT DETECTION + + :param userID: user id + :param ip: IP address + :return: + """ + glob.db.execute("""INSERT INTO ip_user (userid, ip, occurencies) VALUES (%s, %s, 1) + ON DUPLICATE KEY UPDATE occurencies = occurencies + 1""", [userID, ip]) + +def saveBanchoSession(userID, ip): + """ + Save userid and ip of this token in redis + Used to cache logins on LETS requests + + :param userID: user ID + :param ip: IP address + :return: + """ + glob.redis.sadd("peppy:sessions:{}".format(userID), ip) + +def deleteBanchoSessions(userID, ip): + """ + Delete this bancho session from redis + + :param userID: user id + :param ip: IP address + :return: + """ + glob.redis.srem("peppy:sessions:{}".format(userID), ip) + +def setPrivileges(userID, priv): + """ + Set userID's privileges in db + + :param userID: user id + :param priv: privileges number + :return: + """ + glob.db.execute("UPDATE users SET privileges = %s WHERE id = %s LIMIT 1", [priv, userID]) + +def getGroupPrivileges(groupName): + """ + Returns the privileges number of a group, by its name + + :param groupName: name of the group + :return: privilege integer or `None` if the group doesn't exist + """ + groupPrivileges = glob.db.fetch("SELECT privileges FROM privileges_groups WHERE name = %s LIMIT 1", [groupName]) + if groupPrivileges is None: + return None + return groupPrivileges["privileges"] + +def isInPrivilegeGroup(userID, groupName): + """ + Check if `userID` is in a privilege group. + Donor privilege is ignored while checking for groups. + + :param userID: user id + :param groupName: privilege group name + :return: True if `userID` is in `groupName`, else False + """ + groupPrivileges = getGroupPrivileges(groupName) + if groupPrivileges is None: + return False + try: + userToken = glob.tokens.getTokenFromUserID(userID) + except AttributeError: + # LETS compatibility + userToken = None + + if userToken is not None: + userPrivileges = userToken.privileges + else: + userPrivileges = getPrivileges(userID) + return userPrivileges & groupPrivileges == groupPrivileges + +def isInAnyPrivilegeGroup(userID, groups): + """ + Checks if a user is in at least one of the specified groups + + :param userID: id of the user + :param groups: groups list or tuple + :return: `True` if `userID` is in at least one of the specified groups, otherwise `False` + """ + userPrivileges = getPrivileges(userID) + return any( + userPrivileges & x == x + for x in ( + getGroupPrivileges(y) for y in groups + ) if x is not None + ) + +def logHardware(userID, hashes, activation = False): + """ + Hardware log + USED FOR MULTIACCOUNT DETECTION + + + :param userID: user id + :param hashes: Peppy's botnet (client data) structure (new line = "|", already split) + [0] osu! version + [1] plain mac addressed, separated by "." + [2] mac addresses hash set + [3] unique ID + [4] disk ID + :param activation: if True, set this hash as used for activation. Default: False. + :return: True if hw is not banned, otherwise false + """ + # Make sure the strings are not empty + for i in hashes[2:5]: + if i == "": + log.warning("Invalid hash set ({}) for user {} in HWID check".format(hashes, userID), "bunk") + return False + + # Run some HWID checks on that user if he is not restricted + if not isRestricted(userID): + # Get username + username = getUsername(userID) + + # Get the list of banned or restricted users that have logged in from this or similar HWID hash set + if hashes[2] == "b4ec3c4334a0249dae95c284ec5983df": + # Running under wine, check by unique id + log.debug("Logging Linux/Mac hardware") + banned = glob.db.fetchAll("""SELECT users.id as userid, hw_user.occurencies, users.username FROM hw_user + LEFT JOIN users ON users.id = hw_user.userid + WHERE hw_user.userid != %(userid)s + AND hw_user.unique_id = %(uid)s + AND (users.privileges & 3 != 3)""", { + "userid": userID, + "uid": hashes[3], + }) + else: + # Running under windows, do all checks + log.debug("Logging Windows hardware") + banned = glob.db.fetchAll("""SELECT users.id as userid, hw_user.occurencies, users.username FROM hw_user + LEFT JOIN users ON users.id = hw_user.userid + WHERE hw_user.userid != %(userid)s + AND hw_user.mac = %(mac)s + AND hw_user.unique_id = %(uid)s + AND hw_user.disk_id = %(diskid)s + AND (users.privileges & 3 != 3)""", { + "userid": userID, + "mac": hashes[2], + "uid": hashes[3], + "diskid": hashes[4], + }) + + for i in banned: + # Get the total numbers of logins + total = glob.db.fetch("SELECT COUNT(*) AS count FROM hw_user WHERE userid = %s LIMIT 1", [userID]) + # and make sure it is valid + if total is None: + continue + total = total["count"] + + # Calculate 10% of total + perc = (total*10)/100 + + if i["occurencies"] >= perc: + # If the banned user has logged in more than 10% of the times from this user, restrict this user + restrict(userID) + appendNotes(userID, "Logged in from HWID ({hwid}) used more than 10% from user {banned} ({bannedUserID}), who is banned/restricted.".format( + hwid=hashes[2:5], + banned=i["username"], + bannedUserID=i["userid"] + )) + log.warning("**{user}** ({userID}) has been restricted because he has logged in from HWID _({hwid})_ used more than 10% from banned/restricted user **{banned}** ({bannedUserID}), **possible multiaccount**.".format( + user=username, + userID=userID, + hwid=hashes[2:5], + banned=i["username"], + bannedUserID=i["userid"] + ), "cm") + + # Update hash set occurencies + glob.db.execute(""" + INSERT INTO hw_user (id, userid, mac, unique_id, disk_id, occurencies) VALUES (NULL, %s, %s, %s, %s, 1) + ON DUPLICATE KEY UPDATE occurencies = occurencies + 1 + """, [userID, hashes[2], hashes[3], hashes[4]]) + + # Optionally, set this hash as 'used for activation' + if activation: + glob.db.execute("UPDATE hw_user SET activated = 1 WHERE userid = %s AND mac = %s AND unique_id = %s AND disk_id = %s", [userID, hashes[2], hashes[3], hashes[4]]) + + # Access granted, abbiamo impiegato 3 giorni + # We grant access even in case of login from banned HWID + # because we call restrict() above so there's no need to deny the access. + return True + + +def resetPendingFlag(userID, success=True): + """ + Remove pending flag from an user. + + :param userID: user id + :param success: if True, set USER_PUBLIC and USER_NORMAL flags too + """ + glob.db.execute("UPDATE users SET privileges = privileges & %s WHERE id = %s LIMIT 1", [~privileges.USER_PENDING_VERIFICATION, userID]) + if success: + glob.db.execute("UPDATE users SET privileges = privileges | %s WHERE id = %s LIMIT 1", [(privileges.USER_PUBLIC | privileges.USER_NORMAL), userID]) + +def verifyUser(userID, hashes): + """ + Activate `userID`'s account. + + :param userID: user id + :param hashes: Peppy's botnet (client data) structure (new line = "|", already split) + [0] osu! version + [1] plain mac addressed, separated by "." + [2] mac addresses hash set + [3] unique ID + [4] disk ID + :return: True if verified successfully, else False (multiaccount) + """ + # Check for valid hash set + for i in hashes[2:5]: + if i == "": + log.warning("Invalid hash set ({}) for user {} while verifying the account".format(str(hashes), userID), "bunk") + return False + + # Get username + username = getUsername(userID) + + # Make sure there are no other accounts activated with this exact mac/unique id/hwid + if hashes[2] == "b4ec3c4334a0249dae95c284ec5983df" or hashes[4] == "ffae06fb022871fe9beb58b005c5e21d": + # Running under wine, check only by uniqueid + log.info("{user} ({userID}) ha triggerato Sannino:\n**Full data:** {hashes}\n**Usual wine mac address hash:** b4ec3c4334a0249dae95c284ec5983df\n**Usual wine disk id:** ffae06fb022871fe9beb58b005c5e21d".format(user=username, userID=userID, hashes=hashes), "bunker") + log.debug("Veryfing with Linux/Mac hardware") + match = glob.db.fetchAll("SELECT userid FROM hw_user WHERE unique_id = %(uid)s AND userid != %(userid)s AND activated = 1 LIMIT 1", { + "uid": hashes[3], + "userid": userID + }) + else: + # Running under windows, full check + log.debug("Veryfing with Windows hardware") + match = glob.db.fetchAll("SELECT userid FROM hw_user WHERE mac = %(mac)s AND unique_id = %(uid)s AND disk_id = %(diskid)s AND userid != %(userid)s AND activated = 1 LIMIT 1", { + "mac": hashes[2], + "uid": hashes[3], + "diskid": hashes[4], + "userid": userID + }) + + if match: + # This is a multiaccount, restrict other account and ban this account + + # Get original userID and username (lowest ID) + originalUserID = match[0]["userid"] + originalUsername = getUsername(originalUserID) + + # Ban this user and append notes + ban(userID) # this removes the USER_PENDING_VERIFICATION flag too + appendNotes(userID, "{}'s multiaccount ({}), found HWID match while verifying account ({})".format(originalUsername, originalUserID, hashes[2:5])) + appendNotes(originalUserID, "Has created multiaccount {} ({})".format(username, userID)) + + # Restrict the original + restrict(originalUserID) + + # Discord message + log.warning("User **{originalUsername}** ({originalUserID}) has been restricted because he has created multiaccount **{username}** ({userID}). The multiaccount has been banned.".format( + originalUsername=originalUsername, + originalUserID=originalUserID, + username=username, + userID=userID + ), "cm") + + # Disallow login + return False + else: + # No matches found, set USER_PUBLIC and USER_NORMAL flags and reset USER_PENDING_VERIFICATION flag + resetPendingFlag(userID) + #log.info("User **{}** ({}) has verified his account with hash set _{}_".format(username, userID, hashes[2:5]), "cm") + + # Allow login + return True + +def hasVerifiedHardware(userID): + """ + Checks if `userID` has activated his account through HWID + + :param userID: user id + :return: True if hwid activation data is in db, otherwise False + """ + data = glob.db.fetch("SELECT id FROM hw_user WHERE userid = %s AND activated = 1 LIMIT 1", [userID]) + if data is not None: + return True + return False + +def getDonorExpire(userID): + """ + Return `userID`'s donor expiration UNIX timestamp + + :param userID: user id + :return: donor expiration UNIX timestamp + """ + data = glob.db.fetch("SELECT donor_expire FROM users WHERE id = %s LIMIT 1", [userID]) + if data is not None: + return data["donor_expire"] + return 0 + + +class invalidUsernameError(Exception): + pass + +class usernameAlreadyInUseError(Exception): + pass + +def safeUsername(username): + """ + Return `username`'s safe username + (all lowercase and underscores instead of spaces) + + :param username: unsafe username + :return: safe username + """ + return username.lower().strip().replace(" ", "_") + +def changeUsername(userID=0, oldUsername="", newUsername=""): + """ + Change `userID`'s username to `newUsername` in database + + :param userID: user id. Required only if `oldUsername` is not passed. + :param oldUsername: username. Required only if `userID` is not passed. + :param newUsername: new username. Can't contain spaces and underscores at the same time. + :raise: invalidUsernameError(), usernameAlreadyInUseError() + :return: + """ + # Make sure new username doesn't have mixed spaces and underscores + if " " in newUsername and "_" in newUsername: + raise invalidUsernameError() + + # Get safe username + newUsernameSafe = safeUsername(newUsername) + + # Make sure this username is not already in use + if getIDSafe(newUsernameSafe) is not None: + raise usernameAlreadyInUseError() + + # Get userID or oldUsername + if userID == 0: + userID = getID(oldUsername) + else: + oldUsername = getUsername(userID) + + # Change username + glob.db.execute("UPDATE users SET username = %s, username_safe = %s WHERE id = %s LIMIT 1", [newUsername, newUsernameSafe, userID]) + glob.db.execute("UPDATE users_stats SET username = %s WHERE id = %s LIMIT 1", [newUsername, userID]) + + # Empty redis username cache + # TODO: Le pipe woo woo + glob.redis.delete("ripple:userid_cache:{}".format(safeUsername(oldUsername))) + glob.redis.delete("ripple:change_username_pending:{}".format(userID)) + +def removeFromLeaderboard(userID): + """ + Removes userID from global and country leaderboards. + + :param userID: + :return: + """ + # Remove the user from global and country leaderboards, for every mode + country = getCountry(userID).lower() + for mode in ["std", "taiko", "ctb", "mania"]: + glob.redis.zrem("ripple:leaderboard:{}".format(mode), str(userID)) + if country is not None and len(country) > 0 and country != "xx": + glob.redis.zrem("ripple:leaderboard:{}:{}".format(mode, country), str(userID)) + +def deprecateTelegram2Fa(userID): + """ + Checks whether the user has enabled telegram 2fa on his account. + If so, disables 2fa and returns True. + If not, return False. + + :param userID: id of the user + :return: True if 2fa has been disabled from the account otherwise False + """ + try: + telegram2Fa = glob.db.fetch("SELECT id FROM 2fa_telegram WHERE userid = %s LIMIT 1", (userID,)) + except ProgrammingError: + # The table doesnt exist + return False + + if telegram2Fa is not None: + glob.db.execute("DELETE FROM 2fa_telegram WHERE userid = %s LIMIT 1", (userID,)) + return True + return False + +def unlockAchievement(userID, achievementID): + glob.db.execute("INSERT INTO users_achievements (user_id, achievement_id, `time`) VALUES" + "(%s, %s, %s)", [userID, achievementID, int(time.time())]) + +def getAchievementsVersion(userID): + result = glob.db.fetch("SELECT achievements_version FROM users WHERE id = %s LIMIT 1", [userID]) + if result is None: + return None + return result["achievements_version"] + +def updateAchievementsVersion(userID): + glob.db.execute("UPDATE users SET achievements_version = %s WHERE id = %s LIMIT 1", [ + glob.ACHIEVEMENTS_VERSION, userID + ]) diff --git a/sentry/__init__.py b/sentry/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/sentry/sentry.py b/sentry/sentry.py new file mode 100644 index 0000000..3125a53 --- /dev/null +++ b/sentry/sentry.py @@ -0,0 +1,58 @@ +import sys +import traceback + +import tornado.gen + +from common.log import logUtils as log +from objects import glob + +def capture(): + """ + Sentry capture decorator. Use like this to send all unhandled exceptions to Sentry: + ``` + @sentry.capture() + def blablabla(): + print("a a ben warem a ben ben) + ``` + When running `blablabla()`, the traceback will be print on screen and the + exception will be sent to Sentry, if enabled. + Requires tornado app in `glob.application` and sentry client in `glob.application.sentry_client` + + :return: + """ + def decorator(func): + def wrapper(*args, **kwargs): + try: + return func(*args, **kwargs) + except: + log.error("Unhandled exception!\n```\n{}\n{}```".format(sys.exc_info(), traceback.format_exc())) + if glob.sentry: + glob.application.sentry_client.captureException() + return wrapper + return decorator + + +def captureTornado(func): + """ + Capture an exception asynchronously in a tornado handler. + Use it with asyncGet/asyncPost, like this: + + ``` + @tornado.web.asynchronous + @tornado.gen.engine + @sentry.captureTornado + def asyncGet(self): + ... + ``` + + :param func: + :return: + """ + def wrapper(self, *args, **kwargs): + try: + return func(self, *args, **kwargs) + except: + log.error("Unhandled exception!\n```\n{}\n{}```".format(sys.exc_info(), traceback.format_exc())) + if glob.sentry: + yield tornado.gen.Task(self.captureException, exc_info=True) + return wrapper \ No newline at end of file diff --git a/web/__init__.py b/web/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/web/cheesegull.py b/web/cheesegull.py new file mode 100644 index 0000000..ebbee9e --- /dev/null +++ b/web/cheesegull.py @@ -0,0 +1,156 @@ +import requests +import json + +from constants import exceptions +from objects import glob +from common.log import logUtils as log +from objects import glob + +def cheesegullRequest(handler, requestType="GET", key="", params=None, mustHave=None, wants=None): + """ + Send a request to Cheesegull + + :param handler: name of the api handler (eg: `search` for `http://chesegu.ll/api/search`) + :param requestType: `GET` or `POST`. Default: `GET` + :param key: authorization key. Optional. + :param params: dictionary containing get/post form parameters. Optional. + :param mustHave: list or string containing the key(s) that must be contained in the json response. Optional. + :param wants: can be a single string, or a list of strings. + :return: returns None if the result was invalid or if the request failed. + if `wants` is a string, returns the key from the response. + if `wants` is a list of strings, return a dictionary containing the wanted keys. + """ + # Default values + if mustHave is None: + mustHave = [] + if wants is None: + wants = [] + if params is None: + params = {} + + # Params and function + postData = None + getParams = None + if requestType.lower() == "post": + f = requests.post + postData = params + else: + f = requests.get + getParams = params + result = f("{}/{}".format(glob.conf.config["cheesegull"]["apiurl"], handler), params=getParams, data=postData, headers= { + "Authorization": key + }) + + log.debug(result.url) + # log.debug(str(result.text)) + + try: + data = json.loads(result.text) + except (json.JSONDecodeError, ValueError, requests.RequestException, KeyError, exceptions.noAPIDataError): + return None + + # Params and status check + if result.status_code != 200: + return None + if mustHave is not None: + if type(mustHave) == str: + mustHave = [mustHave] + for i in mustHave: + if i not in data: + return None + + # Return what we want + if type(wants) == str: + if wants in data: + return data[wants] + return None + elif len(wants) == 0: + return data + else: + res = {} + for i in data: + if i in wants: + res[i] = data[i] + return res + +def getListing(rankedStatus, page, gameMode, query): + glob.dog.increment(glob.DATADOG_PREFIX + ".cheesegull_requests", tags=["cheesegull:listing"]) + params = { + "query": query, + "offset": page, + "amount": 100 + } + if rankedStatus is not None: + params["status"] = rankedStatus + if gameMode is not None: + params["mode"] = gameMode + return cheesegullRequest("search", params=params) + +def getBeatmapSet(id): + glob.dog.increment(glob.DATADOG_PREFIX + ".cheesegull_requests", tags=["cheesegull:set"]) + return cheesegullRequest("s/{}".format(id)) + +def getBeatmap(id): + glob.dog.increment(glob.DATADOG_PREFIX + ".cheesegull_requests", tags=["cheesegull:beatmap"]) + setID = cheesegullRequest("b/{}".format(id), wants="ParentSetID") + if setID is None or setID <= 0: + return None + return getBeatmapSet(setID) + +def updateBeatmap(setID): + # This has been deprecated + return + # data = cheesegullRequest("request", "POST", glob.conf.config["cheesegull"]["apikey"], params={ + # "set_id": setID + # }, mustHave="Ok") + # return (True, "") if data["Ok"] else (False, data["Message"]) + +def toDirect(data): + if "ChildrenBeatmaps" not in data or data["ChildrenBeatmaps"] is None: + raise ValueError("`data` doesn't contain a valid cheesegull response") + s = "{SetID}.osz|{Artist}|{Title}|{Creator}|{RankedStatus}|0.00|{LastUpdate}|{SetID}|" \ + "{SetID}|{HasVideoInt}|0|1337|{FileSizeNoVideo}|".format( + **data, + **{ + "HasVideoInt": int(data["HasVideo"]), + "FileSizeNoVideo": "7331" if data["HasVideo"] else "" + } + ) + if len(data["ChildrenBeatmaps"]) > 0: + for i in data["ChildrenBeatmaps"]: + s += "{DiffNameSanitized} ({DifficultyRating:.2f}★~{BPM}♫~AR{AR}~OD{OD}~CS{CS}~HP{HP}~{ReadableLength})" \ + "@{Mode},".format(**i, **{ + "DiffNameSanitized": i["DiffName"].replace("@", ""), + "ReadableLength": "{}m{}s".format(i["TotalLength"] // 60, i["TotalLength"] % 60) + }) + s = s.strip(",") + s += "|" + return s + +def toDirectNp(data): + return "{SetID}.osz|{Artist}|{Title}|{Creator}|{RankedStatus}|10.00|{LastUpdate}|{SetID}|" \ + "{SetID}|{HasVideoInt}|0|1337|{FileSizeNoVideo}".format( + **data, + **{ + "HasVideoInt": int(data["HasVideo"]), + "FileSizeNoVideo": "7331" if data["HasVideo"] else "" + } + ) + +def directToApiStatus(directStatus): + if directStatus is None: + return None + elif directStatus == 0 or directStatus == 7: + return [1, 2] + elif directStatus == 8: + return 4 + elif directStatus == 3: + return 3 + elif directStatus == 2: + return 0 + elif directStatus == 5: + return -2 + elif directStatus == 4: + return None + else: + return 1 \ No newline at end of file diff --git a/web/requestsManager.py b/web/requestsManager.py new file mode 100644 index 0000000..9fef80c --- /dev/null +++ b/web/requestsManager.py @@ -0,0 +1,96 @@ +import sys +import traceback + +import tornado +import tornado.web +import tornado.gen +from tornado.ioloop import IOLoop +from objects import glob +from common.log import logUtils as log +from raven.contrib.tornado import SentryMixin + +class asyncRequestHandler(SentryMixin, tornado.web.RequestHandler): + """ + Tornado asynchronous request handler + create a class that extends this one (requestHelper.asyncRequestHandler) + use asyncGet() and asyncPost() instead of get() and post(). + Done. I'm not kidding. + """ + @tornado.web.asynchronous + @tornado.gen.engine + def get(self, *args, **kwargs): + try: + yield tornado.gen.Task(runBackground, (self.asyncGet, tuple(args), dict(kwargs))) + finally: + if not self._finished: + self.finish() + + @tornado.web.asynchronous + @tornado.gen.engine + def post(self, *args, **kwargs): + try: + yield tornado.gen.Task(runBackground, (self.asyncPost, tuple(args), dict(kwargs))) + finally: + if not self._finished: + self.finish() + + def asyncGet(self, *args, **kwargs): + self.send_error(405) + + def asyncPost(self, *args, **kwargs): + self.send_error(405) + + def getRequestIP(self): + """ + Return CF-Connecting-IP (request IP when under cloudflare, you have to configure nginx to enable that) + If that fails, return X-Forwarded-For (request IP when not under Cloudflare) + if everything else fails, return remote IP + + :return: Client IP address + """ + if "CF-Connecting-IP" in self.request.headers: + return self.request.headers.get("CF-Connecting-IP") + elif "X-Forwarded-For" in self.request.headers: + return self.request.headers.get("X-Forwarded-For") + else: + return self.request.remote_ip + + +def runBackground(data, callback): + """ + Run a function in the background. + Used to handle multiple requests at the same time + + :param data: (func, args, kwargs) + :param callback: function to call when `func` (data[0]) returns + :return: + """ + func, args, kwargs = data + def _callback(result): + IOLoop.instance().add_callback(lambda: callback(result)) + glob.pool.apply_async(func, args, kwargs, _callback) + glob.dog.increment(glob.DATADOG_PREFIX + ".incoming_requests") + +def checkArguments(arguments, requiredArguments): + """ + Check that every requiredArguments elements are in arguments + + :param arguments: full argument list, from tornado + :param requiredArguments: required arguments list + :return: True if all arguments are passed, False if not + """ + for i in requiredArguments: + if i not in arguments: + return False + return True + +def printArguments(t): + """ + Print passed arguments, for debug purposes + + :param t: tornado object (self) + """ + msg = "ARGS::" + for i in t.request.arguments: + msg += "{}={}\r\n".format(i, t.get_argument(i)) + log.debug(msg) diff --git a/web/schiavo.py b/web/schiavo.py new file mode 100644 index 0000000..a5e28fd --- /dev/null +++ b/web/schiavo.py @@ -0,0 +1,87 @@ +import requests +from urllib.parse import urlencode + +class schiavo: + """ + Schiavo Bot class + """ + def __init__(self, botURL=None, prefix="", maxRetries=20): + """ + Initialize a new schiavo bot instance + + :param botURL: schiavo api url. + :param prefix: text to prepend in every message, can be empty. + :param maxRetries: max retries if api request fail. 0 = don't retry. + """ + self.botURL = botURL + self.maxRetries = maxRetries + self.prefix = prefix + + def sendMessage(self, channel, message, noPrefix=False): + """ + Send a generic message through schiavo api + + :param channel: api channel. + :param message: message content. + :param noPrefix: if True, don't prepend prefix to message. + :return: + """ + if self.botURL is None: + return + for _ in range(0, self.maxRetries): + try: + finalMsg = "{prefix} {message}".format(prefix=self.prefix if not noPrefix else "", message=message) + requests.get("{}/{}?{}".format(self.botURL, channel, urlencode({ "message": finalMsg }))) + break + except requests.RequestException: + continue + + def sendConfidential(self, message, noPrefix=False): + """ + Send a message to #bunk + + :param message: message content. + :param noPrefix: if True, don't prepend prefix to message. + :return: + """ + self.sendMessage("bunk", message, noPrefix) + + def sendStaff(self, message, noPrefix=False): + """ + Send a message to #staff + + :param message: message content. + :param noPrefix: if True, don't prepend prefix to message. + :return: + """ + self.sendMessage("staff", message, noPrefix) + + def sendGeneral(self, message, noPrefix=True): + """ + Send a message to #general + + :param message: message content. + :param noPrefix: if True, don't prepend prefix to message. + :return: + """ + self.sendMessage("general", message, noPrefix) + + def sendChatlog(self, message, noPrefix=True): + """ + Send a message to #chatlog. + + :param message: message content. + :param noPrefix: if True, don't prepend prefix to message. + :return: + """ + self.sendMessage("chatlog", message, noPrefix) + + def sendCM(self, message, noPrefix=False): + """ + Send a message to #communitymanagers + + :param message: message content. + :param noPrefix: if True, don't prepend prefix to message. + :return: + """ + self.sendMessage("cm", message, noPrefix) \ No newline at end of file