diff --git a/.gitignore b/.gitignore index 510c73d..9b9d0a4 100644 --- a/.gitignore +++ b/.gitignore @@ -112,3 +112,6 @@ dmypy.json # Pyre type checker .pyre/ + +#session files +*.session \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index e20b431..0000000 --- a/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ -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 -. diff --git a/WebStreamer/__init__.py b/WebStreamer/__init__.py new file mode 100644 index 0000000..b7994f7 --- /dev/null +++ b/WebStreamer/__init__.py @@ -0,0 +1,2 @@ +# This file is a part of TG-FileStreamBot +# Coding : Jyothis Jayanth [@EverythingSuckz] \ No newline at end of file diff --git a/WebStreamer/__main__.py b/WebStreamer/__main__.py new file mode 100644 index 0000000..793d0bc --- /dev/null +++ b/WebStreamer/__main__.py @@ -0,0 +1,59 @@ +# This file is a part of TG-FileStreamBot +# Coding : Jyothis Jayanth [@EverythingSuckz] + +import os +import sys +import glob +import asyncio +import logging +import importlib +from pathlib import Path +from pyrogram import idle +from .bot import StreamBot +from .vars import Var +from aiohttp import web +from .server import web_server + +ppath = f"WebStreamer/bot/plugins/*.py" +files = glob.glob(ppath) + +loop = asyncio.get_event_loop() + + +async def start_services(): + print('\n') + print('------------------- Initalizing Telegram Bot -------------------') + await StreamBot.start() + print('\n') + print('---------------------- DONE ----------------------') + print('\n') + print('------------------- Importing -------------------') + for name in files: + with open(name) as a: + patt = Path(a.name) + plugin_name = patt.stem.replace(".py", "") + plugins_dir = Path(f"WebStreamer/bot/plugins/{plugin_name}.py") + import_path = ".plugins.{}".format(plugin_name) + spec = importlib.util.spec_from_file_location(import_path, plugins_dir) + load = importlib.util.module_from_spec(spec) + spec.loader.exec_module(load) + sys.modules["WebStreamer.bot.plugins." + plugin_name] = load + print("Imported => " + plugin_name) + print('\n') + print('------------------- Initalizing Web Server -------------------') + app = web.AppRunner(await web_server()) + await app.setup() + bind_address = "0.0.0.0" if Var.ENV else Var.FQDN + await web.TCPSite(app, bind_address, Var.PORT).start() + print('\n') + print('----------------------- Service Started -----------------------') + print(' bot =>> {}'.format((await StreamBot.get_me()).first_name)) + print(' server ip =>> {}:{}'.format(bind_address, Var.PORT)) + print('---------------------------------------------------------------') + await idle() + +if __name__ == '__main__': + try: + loop.run_until_complete(start_services()) + except KeyboardInterrupt: + print('----------------------- Service Stopped -----------------------') \ No newline at end of file diff --git a/WebStreamer/bot/__init__.py b/WebStreamer/bot/__init__.py new file mode 100644 index 0000000..1d39c78 --- /dev/null +++ b/WebStreamer/bot/__init__.py @@ -0,0 +1,14 @@ +# This file is a part of TG-FileStreamBot +# Coding : Jyothis Jayanth [@EverythingSuckz] + +from pyrogram import Client +from ..vars import Var + +StreamBot = Client( + session_name= 'Web Streamer', + api_id=Var.API_ID, + api_hash=Var.API_HASH, + bot_token=Var.BOT_TOKEN, + sleep_threshold=Var.SLEEP_THRESHOLD, + workers=Var.WORKERS +) \ No newline at end of file diff --git a/WebStreamer/bot/plugins/start.py b/WebStreamer/bot/plugins/start.py new file mode 100644 index 0000000..a2fc6de --- /dev/null +++ b/WebStreamer/bot/plugins/start.py @@ -0,0 +1,21 @@ +# This file is a part of TG-FileStreamBot +# Coding : Jyothis Jayanth [@EverythingSuckz] + +from WebStreamer.bot import StreamBot +from WebStreamer.vars import Var +from pyrogram import filters, emoji +from pyrogram.types import InlineKeyboardMarkup, InlineKeyboardButton + +@StreamBot.on_message(filters.command(['start', 'help'])) +async def start(b, m): + await m.reply('Hi, Send me a file to get an instant stream link.', + reply_markup=InlineKeyboardMarkup( + [ + [ + InlineKeyboardButton( + f'{emoji.STAR} Source {emoji.STAR}', + url='https://github.com/EverythingSuckz/TG-FileStreamBot' + ) + ] + ] + )) \ No newline at end of file diff --git a/WebStreamer/bot/plugins/stream.py b/WebStreamer/bot/plugins/stream.py new file mode 100644 index 0000000..05a941b --- /dev/null +++ b/WebStreamer/bot/plugins/stream.py @@ -0,0 +1,19 @@ +# This file is a part of TG-FileStreamBot +# Coding : Jyothis Jayanth [@EverythingSuckz] + +from WebStreamer.bot import StreamBot +from WebStreamer.vars import Var +from pyrogram import filters, Client, emoji +from pyrogram.types import Message, InlineKeyboardMarkup, InlineKeyboardButton + + +@StreamBot.on_message(filters.private & (filters.document | filters.video | filters.audio), group=4) +async def media_receive_handler(c: Client, m: Message): + log_msg = await m.copy(chat_id=Var.BIN_CHANNEL) + stream_link = "https://{}/{}".format(Var.FQDN, log_msg.message_id) if Var.ON_HEROKU else \ + "http://{}:{}/{}".format(Var.FQDN, + Var.PORT, + log_msg.message_id) + await m.reply_text( + text="`{}`".format(stream_link) + ) \ No newline at end of file diff --git a/WebStreamer/server/__init__.py b/WebStreamer/server/__init__.py new file mode 100644 index 0000000..2cc6edd --- /dev/null +++ b/WebStreamer/server/__init__.py @@ -0,0 +1,13 @@ +# Taken from megadlbot_oss +# Thanks to Eyaadh +# This file is a part of TG-FileStreamBot +# Coding : Jyothis Jayanth [@EverythingSuckz] + +from aiohttp import web +from .stream_routes import routes + + +async def web_server(): + web_app = web.Application(client_max_size=30000000) + web_app.add_routes(routes) + return web_app \ No newline at end of file diff --git a/WebStreamer/server/stream_routes.py b/WebStreamer/server/stream_routes.py new file mode 100644 index 0000000..31c0c9d --- /dev/null +++ b/WebStreamer/server/stream_routes.py @@ -0,0 +1,77 @@ +# Taken from megadlbot_oss +# Thanks to Eyaadh + +import math +import logging +import secrets +import mimetypes +from ..vars import Var +from aiohttp import web +from ..bot import StreamBot +from ..utils.custom_dl import TGCustomYield, chunk_size, offset_fix + +routes = web.RouteTableDef() + + +@routes.get("/") +async def root_route_handler(request): + bot_details = await StreamBot.get_me() + return web.json_response({"status": "running", + "server_permission": "Open", + "bot_associated_w": bot_details.username}) + + +@routes.get("/{message_id}") +async def stream_handler(request): + try: + message_id = int(request.match_info['message_id']) + return await media_streamer(request, message_id) + except ValueError as e: + logging.error(e) + raise web.HTTPNotFound + + +async def media_streamer(request, message_id: int): + range_header = request.headers.get('Range', 0) + media_msg = await StreamBot.get_messages(Var.BIN_CHANNEL, message_id) + file_properties = await TGCustomYield().generate_file_properties(media_msg) + file_size = file_properties.file_size + + if range_header: + from_bytes, until_bytes = range_header.replace('bytes=', '').split('-') + from_bytes = int(from_bytes) + until_bytes = int(until_bytes) if until_bytes else file_size - 1 + else: + from_bytes = request.http_range.start or 0 + until_bytes = request.http_range.stop or file_size - 1 + + req_length = until_bytes - from_bytes + + new_chunk_size = await chunk_size(req_length) + offset = await offset_fix(from_bytes, new_chunk_size) + first_part_cut = from_bytes - offset + last_part_cut = (until_bytes % new_chunk_size) + 1 + part_count = math.ceil(req_length / new_chunk_size) + body = TGCustomYield().yield_file(media_msg, offset, first_part_cut, last_part_cut, part_count, + new_chunk_size) + + file_name = file_properties.file_name if file_properties.file_name \ + else f"{secrets.token_hex(2)}.jpeg" + mime_type = file_properties.mime_type if file_properties.mime_type \ + else f"{mimetypes.guess_type(file_name)}" + + return_resp = web.Response( + status=206 if range_header else 200, + body=body, + headers={ + "Content-Type": mime_type, + "Content-Range": f"bytes {from_bytes}-{until_bytes}/{file_size}", + "Content-Disposition": f'attachment; filename="{file_name}"', + "Accept-Ranges": "bytes", + } + ) + + if return_resp.status == 200: + return_resp.headers.add("Content-Length", str(file_size)) + + return return_resp \ No newline at end of file diff --git a/WebStreamer/utils/__init__.py b/WebStreamer/utils/__init__.py new file mode 100644 index 0000000..b7994f7 --- /dev/null +++ b/WebStreamer/utils/__init__.py @@ -0,0 +1,2 @@ +# This file is a part of TG-FileStreamBot +# Coding : Jyothis Jayanth [@EverythingSuckz] \ No newline at end of file diff --git a/WebStreamer/utils/custom_dl.py b/WebStreamer/utils/custom_dl.py new file mode 100644 index 0000000..8bfe050 --- /dev/null +++ b/WebStreamer/utils/custom_dl.py @@ -0,0 +1,233 @@ +# Taken from megadlbot_oss +# Thanks to Eyaadh + +import math +from typing import Union +from pyrogram.types import Message +from ..bot import StreamBot +from pyrogram import Client, utils, raw +from pyrogram.session import Session, Auth +from pyrogram.errors import AuthBytesInvalid +from pyrogram.file_id import FileId, FileType, ThumbnailSource + + +async def chunk_size(length): + return 2 ** max(min(math.ceil(math.log2(length / 1024)), 10), 2) * 1024 + + +async def offset_fix(offset, chunksize): + offset -= offset % chunksize + return offset + + +class TGCustomYield: + def __init__(self): + """ A custom method to stream files from telegram. + functions: + generate_file_properties: returns the properties for a media on a specific message contained in FileId class. + generate_media_session: returns the media session for the DC that contains the media file on the message. + yield_file: yield a file from telegram servers for streaming. + """ + self.main_bot = StreamBot + + @staticmethod + async def generate_file_properties(msg: Message): + error_message = "This message doesn't contain any downloadable media" + available_media = ("audio", "document", "photo", "sticker", "animation", "video", "voice", "video_note") + + if isinstance(msg, Message): + for kind in available_media: + media = getattr(msg, kind, None) + + if media is not None: + break + else: + raise ValueError(error_message) + else: + media = msg + + if isinstance(media, str): + file_id_str = media + else: + file_id_str = media.file_id + + file_id_obj = FileId.decode(file_id_str) + + # The below lines are added to avoid a break in routes.py + setattr(file_id_obj, "file_size", getattr(media, "file_size", 0)) + setattr(file_id_obj, "mime_type", getattr(media, "mime_type", "")) + setattr(file_id_obj, "file_name", getattr(media, "file_name", "")) + + return file_id_obj + + async def generate_media_session(self, client: Client, msg: Message): + data = await self.generate_file_properties(msg) + + media_session = client.media_sessions.get(data.dc_id, None) + + if media_session is None: + if data.dc_id != await client.storage.dc_id(): + media_session = Session( + client, data.dc_id, await Auth(client, data.dc_id, await client.storage.test_mode()).create(), + await client.storage.test_mode(), is_media=True + ) + await media_session.start() + + for _ in range(3): + exported_auth = await client.send( + raw.functions.auth.ExportAuthorization( + dc_id=data.dc_id + ) + ) + + try: + await media_session.send( + raw.functions.auth.ImportAuthorization( + id=exported_auth.id, + bytes=exported_auth.bytes + ) + ) + except AuthBytesInvalid: + continue + else: + break + else: + await media_session.stop() + raise AuthBytesInvalid + else: + media_session = Session( + client, data.dc_id, await client.storage.auth_key(), + await client.storage.test_mode(), is_media=True + ) + await media_session.start() + + client.media_sessions[data.dc_id] = media_session + + return media_session + + @staticmethod + async def get_location(file_id: FileId): + file_type = file_id.file_type + + if file_type == FileType.CHAT_PHOTO: + if file_id.chat_id > 0: + peer = raw.types.InputPeerUser( + user_id=file_id.chat_id, + access_hash=file_id.chat_access_hash + ) + else: + if file_id.chat_access_hash == 0: + peer = raw.types.InputPeerChat( + chat_id=-file_id.chat_id + ) + else: + peer = raw.types.InputPeerChannel( + channel_id=utils.get_channel_id(file_id.chat_id), + access_hash=file_id.chat_access_hash + ) + + location = raw.types.InputPeerPhotoFileLocation( + peer=peer, + volume_id=file_id.volume_id, + local_id=file_id.local_id, + big=file_id.thumbnail_source == ThumbnailSource.CHAT_PHOTO_BIG + ) + elif file_type == FileType.PHOTO: + location = raw.types.InputPhotoFileLocation( + id=file_id.media_id, + access_hash=file_id.access_hash, + file_reference=file_id.file_reference, + thumb_size=file_id.thumbnail_size + ) + else: + location = raw.types.InputDocumentFileLocation( + id=file_id.media_id, + access_hash=file_id.access_hash, + file_reference=file_id.file_reference, + thumb_size=file_id.thumbnail_size + ) + + return location + + async def yield_file(self, media_msg: Message, offset: int, first_part_cut: int, + last_part_cut: int, part_count: int, chunk_size: int) -> Union[str, None]: #pylint: disable=unsubscriptable-object + client = self.main_bot + data = await self.generate_file_properties(media_msg) + media_session = await self.generate_media_session(client, media_msg) + + current_part = 1 + + location = await self.get_location(data) + + r = await media_session.send( + raw.functions.upload.GetFile( + location=location, + offset=offset, + limit=chunk_size + ), + ) + + if isinstance(r, raw.types.upload.File): + while current_part <= part_count: + chunk = r.bytes + if not chunk: + break + offset += chunk_size + if part_count == 1: + yield chunk[first_part_cut:last_part_cut] + break + if current_part == 1: + yield chunk[first_part_cut:] + if 1 < current_part <= part_count: + yield chunk + + r = await media_session.send( + raw.functions.upload.GetFile( + location=location, + offset=offset, + limit=chunk_size + ), + ) + + current_part += 1 + + async def download_as_bytesio(self, media_msg: Message): + client = self.main_bot + data = await self.generate_file_properties(media_msg) + media_session = await self.generate_media_session(client, media_msg) + + location = await self.get_location(data) + + limit = 1024 * 1024 + offset = 0 + + r = await media_session.send( + raw.functions.upload.GetFile( + location=location, + offset=offset, + limit=limit + ) + ) + + if isinstance(r, raw.types.upload.File): + m_file = [] + # m_file.name = file_name + while True: + chunk = r.bytes + + if not chunk: + break + + m_file.append(chunk) + + offset += limit + + r = await media_session.send( + raw.functions.upload.GetFile( + location=location, + offset=offset, + limit=limit + ) + ) + + return m_file \ No newline at end of file diff --git a/WebStreamer/vars.py b/WebStreamer/vars.py new file mode 100644 index 0000000..f61a32c --- /dev/null +++ b/WebStreamer/vars.py @@ -0,0 +1,25 @@ +# This file is a part of TG-FileStreamBot +# Coding : Jyothis Jayanth [@EverythingSuckz] + +from os import getenv, environ +from dotenv import load_dotenv + +load_dotenv() + +class Var(object): + ENV = bool(getenv('ENV', False)) + API_ID = int(getenv('API_ID')) + API_HASH = str(getenv('API_HASH')) + BOT_TOKEN = str(getenv('BOT_TOKEN')) + SLEEP_THRESHOLD = int(getenv('SLEEP_THRESHOLD', '300')) + WORKERS = int(getenv('WORKERS', '3')) + BIN_CHANNEL = int(getenv('BIN_CHANNEL', None)) + FQDN = str(getenv('FQDN', 'localhost')) + PORT = int(getenv('PORT', 8080)) + BIND_ADRESS = str(getenv('BIND_ADRESS', '0.0.0.0')) + CACHE_DIR = str(getenv('CACHE_DIR', 'WebStreamer/bot/cache')) + OWNER_ID = int(getenv('OWNER_ID')) + if 'DYNO' in environ: + ON_HEROKU = True + else: + ON_HEROKU = False \ No newline at end of file