diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..dba13ed2 --- /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 +. diff --git a/README.md b/README.md index d017cb48..4334dabb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # MadelineProto [![StyleCI](https://styleci.io/repos/61838413/shield)](https://styleci.io/repos/61838413) +Licensed under AGPLv3. PHP implementation of MTProto, based on [telepy](https://github.com/griganton/telepy_old). diff --git a/src/danog/MadelineProto/API.php b/src/danog/MadelineProto/API.php index 681dae9e..b7ca3672 100644 --- a/src/danog/MadelineProto/API.php +++ b/src/danog/MadelineProto/API.php @@ -1,22 +1,33 @@ . +*/ namespace danog\MadelineProto; - -class API +class API extends Exception { public $session; - public function __construct($login, $params = []) + public function __construct($params = []) { + set_error_handler([$this, 'ExceptionErrorHandler']); $this->session = new Session($params); $this->session->create_auth_key(); $future_salts = $this->session->method_call('get_future_salts', 3); - pyjslib_printnl($future_salts); + Logging::log($future_salts, 3); } public function __destruct() { unset($this->session); + restore_error_handler(); } public function __call($name, $arguments) diff --git a/src/danog/MadelineProto/connection.php b/src/danog/MadelineProto/Connection.php similarity index 70% rename from src/danog/MadelineProto/connection.php rename to src/danog/MadelineProto/Connection.php index 928cf90d..5f983e3d 100644 --- a/src/danog/MadelineProto/connection.php +++ b/src/danog/MadelineProto/Connection.php @@ -1,14 +1,22 @@ . +*/ namespace danog\MadelineProto; - /** * Manages connection to telegram servers. */ -class connection +class Connection { - private $sock = null; - private $protocol = null; + public $sock = null; + public $protocol = null; public function __construct($ip, $port, $protocol = 'tcp') { @@ -41,7 +49,9 @@ class connection public function write($what, $length = null) { - $what = substr($what, 0, $length); + if ($length != null) { + $what = substr($what, 0, $length); + } switch ($this->protocol) { case 'tcp': if (!(get_resource_type($this->sock) == 'file' || get_resource_type($this->sock) == 'stream')) { diff --git a/src/danog/MadelineProto/crypt.php b/src/danog/MadelineProto/Crypt.php similarity index 75% rename from src/danog/MadelineProto/crypt.php rename to src/danog/MadelineProto/Crypt.php index 7e81b3b3..978d7bd5 100644 --- a/src/danog/MadelineProto/crypt.php +++ b/src/danog/MadelineProto/Crypt.php @@ -1,9 +1,16 @@ . +*/ +namespace danog\MadelineProto; +class Crypt { public function ige_encrypt($message, $key, $iv) { diff --git a/src/danog/MadelineProto/DebugFunctions.php b/src/danog/MadelineProto/DebugFunctions.php new file mode 100644 index 00000000..ef5e58a1 --- /dev/null +++ b/src/danog/MadelineProto/DebugFunctions.php @@ -0,0 +1,52 @@ +. +*/ +namespace danog\MadelineProto; + +class DebugFunctions { + /** + * Function to dump the hex version of a string. + * + * @param $what What to dump. + */ + public static function hex_dump(...$what) + { + foreach ($what as $w) { + var_dump(bin2hex($w)); + } + } + + /** + * Function to visualize byte streams. Split into bytes, print to console. + * :param bs: BYTE STRING. + */ + public static function vis($bs) + { + $bs = str_split($bs); + $symbols_in_one_line = 8; + $n = floor(len($bs) / $symbols_in_one_line); + $i = 0; + foreach (pyjslib_range($n) as $i) { + echo $i * $symbols_in_one_line.' | '.implode(' ', + array_map(function ($el) { + return bin2hex($el); + }, array_slice($bs, $i * $symbols_in_one_line, ($i + 1) * $symbols_in_one_line)) + ).PHP_EOL; + } + if (len($bs) % $symbols_in_one_line != 0) { + echo($i + 1) * $symbols_in_one_line.' | '.implode(' ', + array_map(function ($el) { + return bin2hex($el); + }, array_slice($bs, ($i + 1) * $symbols_in_one_line)) + ).PHP_EOL; + } + } +} \ No newline at end of file diff --git a/src/danog/MadelineProto/Exception.php b/src/danog/MadelineProto/Exception.php index a544a799..118f4d62 100644 --- a/src/danog/MadelineProto/Exception.php +++ b/src/danog/MadelineProto/Exception.php @@ -1,7 +1,15 @@ . +*/ namespace danog\MadelineProto; - class Exception extends \Exception { public function __construct($message, $code = 0, Exception $previous = null) @@ -13,4 +21,17 @@ class Exception extends \Exception // make sure everything is assigned properly parent::__construct($message, $code, $previous); } + /** + * ExceptionErrorHandler. + * + * Error handler + */ + public function ExceptionErrorHandler($errno = 0, $errstr = null, $errfile = null, $errline = null) + { + // If error is suppressed with @, don't throw an exception + if (error_reporting() === 0) { + return true; // return true to continue through the others error handlers + } + throw new Exception($errstr.' on line '.$errline.' of file '.$errfile, $errno); + } } diff --git a/src/danog/MadelineProto/Logging.php b/src/danog/MadelineProto/Logging.php new file mode 100644 index 00000000..edd7f9c3 --- /dev/null +++ b/src/danog/MadelineProto/Logging.php @@ -0,0 +1,70 @@ +. +*/ +/* + * Logging class + */ +namespace danog\MadelineProto; +class Logging { + public $mode = null; + public $optional = null; + /* + * Constructor function + * Accepts various logging modes: + * 0 - No logging + * 1 - Log to the default logging destination + * 2 - Log to file defined in second parameter + * 3 - Echo logs + */ + public function __construct($mode, $optional = null){ + $this->mode = (string)$mode; + $this->optional = $optional; + } + public function __invoke(...$params){ + foreach ($params as $param) { + switch ($this->mode) { + case '1': + error_log($param); + break; + case '2': + error_log($param, 3, $this->optional); + break; + case '3': + echo $param . PHP_EOL; + break; + default: + break; + } + } + } + public function log(...$params) { + if($this->mode == null) { + $mode = array_pop($params); + } else { + $mode = $this->mode; + } + foreach ($params as $param) { + switch ($mode) { + case '1': + error_log($param); + break; + case '2': + error_log($param, 3, $this->optional); + break; + case '3': + echo $param . PHP_EOL; + break; + default: + break; + } + } + } +} \ No newline at end of file diff --git a/src/danog/MadelineProto/prime.php b/src/danog/MadelineProto/PrimeModule.php similarity index 92% rename from src/danog/MadelineProto/prime.php rename to src/danog/MadelineProto/PrimeModule.php index 2a821de1..da4ee64e 100644 --- a/src/danog/MadelineProto/prime.php +++ b/src/danog/MadelineProto/PrimeModule.php @@ -1,10 +1,15 @@ . +*/ +namespace danog\MadelineProto; class PrimeModule { public function __construct() @@ -179,7 +184,7 @@ class PrimeModule if (function_exists('shell_exec')) { try { // Use the python version. - $res = explode(' ', shell_exec('python getpq.py '.$pq)); + $res = explode(' ', shell_exec('python '.__DIR__.'/getpq.py '.$pq)); if (count($res) == 2) { return $res; } diff --git a/src/danog/MadelineProto/RSA.php b/src/danog/MadelineProto/RSA.php index 1e4712fd..f6f6c090 100644 --- a/src/danog/MadelineProto/RSA.php +++ b/src/danog/MadelineProto/RSA.php @@ -1,26 +1,37 @@ . +*/ namespace danog\MadelineProto; - -class RSA extends TL +class RSA extends TL\TL { - public $key; - public $n; - public $e; - public $fp; + public $key; // phpseclib\Crypt\RSA class + public $n; // phpseclib\Math\BigInteger class + public $e; // phpseclib\Math\BigInteger class + public $fp; // phpseclib\Math\BigInteger class + public $fp_float; // float public function __construct($key) { - $this->key = new \phpseclib\Crypt\RSA($key); - $this->n = $key->modulus; - $this->e = $key->exponent; - $this->fp = new \phpseclib\Math\BigInteger(substr(sha1($this->serialize_param('bytes', $this->n->toBytes()).$this->serialize_param('bytes', $this->e->toBytes()), true), -8), 256); + $this->key = new \phpseclib\Crypt\RSA(); + $this->key->load($key); + $this->n = $this->key->modulus; + $this->e = $this->key->exponent; + + $this->fp = new \phpseclib\Math\BigInteger(strrev(substr(sha1($this->serialize_param('bytes', $this->n->toBytes()) . $this->serialize_param('bytes', $this->e->toBytes()), true), -8)), -256); + $this->fp_float = (float) $this->fp->toString(); } public function encrypt($data) { $bigintdata = new \phpseclib\Math\BigInteger($data, 256); - return $bigintdata->powMod($this->e, $this->n)->toBytes(); } } diff --git a/src/danog/MadelineProto/mtproto.php b/src/danog/MadelineProto/Session.php similarity index 78% rename from src/danog/MadelineProto/mtproto.php rename to src/danog/MadelineProto/Session.php index 4203dd0f..f5d8e711 100755 --- a/src/danog/MadelineProto/mtproto.php +++ b/src/danog/MadelineProto/Session.php @@ -1,31 +1,36 @@ . +*/ namespace danog\MadelineProto; - /** * Manages encryption and message frames. */ -class mtproto extends Tools +class Session extends Tools { public $settings = []; public function __construct($settings) { + // Set default settings $default_settings = [ - 'ip' => '149.154.167.50', - 'port' => '443', - 'protocol' => 'tcp', - 'auth_key' => null, - 'server_salt' => null, - 'api_id' => 25628, - 'api_hash' => '1fe17cda7d355166cdaa71f04122873c', - 'tl_schema' => 'https://core.telegram.org/schema/mtproto-json', - 'rsa_key' => '-----BEGIN RSA PUBLIC KEY----- + 'auth_key' => null, + 'server_salt' => null, + 'ip_address' => '149.154.167.50', + 'port' => '443', + 'protocol' => 'tcp', + 'api_id' => 25628, + 'api_hash' => '1fe17cda7d355166cdaa71f04122873c', + 'tl_schema' => 'https://core.telegram.org/schema/mtproto-json', + 'rsa_key' => '-----BEGIN RSA PUBLIC KEY----- MIIBCgKCAQEAwVACPi9w23mF3tBkdZz+zwrzKOaaQdr01vAbU4E1pvkfj4sqDsm6 lyDONS789sVoD/xCS9Y0hkkC3gtL1tSfTlgCMOOul9lcixlEKzwKENj1Yz/s7daS an9tqw3bfUV/nqgbhGX81v/+7RFAEd+RwFnK7a+XYl9sluzHRyVVaTTveB2GazTw @@ -33,6 +38,9 @@ Efzk2DWgkBluml8OREmvfraX3bkHZJTKX4EQSjBbbdJ2ZXIsRrYOXfaA+xayEGB+ 8hdlLmAjbCVfaigxX0CDqWeR1yFL9kwd9P0NsZRPsmoqVwMbMu7mStFai6aIhc3n Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB -----END RSA PUBLIC KEY-----', + 'logging' => 1, + 'logging_param' => '/tmp/MadelineProto.log', + 'logging' => 3 ]; foreach ($default_settings as $key => $param) { if (!isset($settings[$key])) { @@ -42,7 +50,7 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB $this->settings = $settings; // Connect to servers - $this->sock = new Connection($this->settings['ip_address'], $this->settings['ip_address'], $this->settings['protocol']); + $this->sock = new Connection($this->settings['ip_address'], $this->settings['port'], $this->settings['protocol']); // Load rsa key $this->key = new RSA($settings['rsa_key']); @@ -52,14 +60,14 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB $this->PrimeModule = new PrimeModule(); // Istantiate TL class try { - $this->tl = new TL($this->settings['tl_schema']); + $this->tl = new TL\TL($this->settings['tl_schema']); } catch (Exception $e) { - $this->tl = new TL(__DIR__.'/TL_schema.JSON'); + $this->tl = new TL\TL(__DIR__.'/TL_schema.JSON'); } - // Load rsa key - $this->settings['rsa_content'] = file_get_contents($this->rsa_pub); - + // Istantiate logging class + $this->log = new Logging($this->settings["logging"], $this->settings["logging_param"]); // Set some defaults + $this->auth_key = $this->settings["auth_key"]; $this->number = 0; $this->timedelta = 0; $this->session_id = \phpseclib\Crypt\Random::string(8); @@ -95,19 +103,19 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB $message_id = $this->struct->pack('timedelta) * pow(2, 30)) * 4); if (($this->auth_key == null) || ($this->server_salt == null)) { - $message = string2bin('\x00\x00\x00\x00\x00\x00\x00\x00').$message_id.$this->struct->pack('struct->pack('server_salt.$this->session_id.$message_id.$this->struct->pack('number, strlen($message_data)).$message_data; $message_key = substr(sha1($encrypted_data, true), -16); $padding = \phpseclib\Crypt\Random::string(posmod(-strlen($encrypted_data), 16)); - echo strlen($encrypted_data.$padding).PHP_EOL; + $this->log->log(strlen($encrypted_data.$padding)); list($aes_key, $aes_iv) = $this->aes_calculate($message_key); $message = $this->auth_key_id.$message_key.crypt::ige_encrypt($encrypted_data.$padding, $aes_key, $aes_iv); } $step1 = $this->struct->pack('number).$message; $step2 = $step1.$this->struct->pack('newcrc32($step1)); - fwrite($this->sock, $step2); + $this->sock->write($step2); $this->number += 1; } @@ -116,19 +124,18 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB */ public function recv_message() { - $packet_length_data = fread($this->sock, 4); + $packet_length_data = $this->sock->read(4); if (strlen($packet_length_data) < 4) { throw new Exception('Nothing in the socket!'); } $packet_length = $this->struct->unpack('sock, ($packet_length - 4)); + $packet = $this->sock->read($packet_length - 4); if (!($this->newcrc32($packet_length_data.substr($packet, 0, -4)) == $this->struct->unpack('struct->unpack('struct->unpack('<8sI', substr($packet, 12, 12)); $data = substr($packet, 24, (24 + $message_length) - 24); } elseif ($auth_key_id == $this->auth_key_id) { @@ -161,38 +168,39 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB $this->send_message($this->tl->serialize_method($method, $kwargs)); $server_answer = $this->recv_message(); } catch (Exception $e) { - echo 'An error occurred while calling method '.$method.': '.$e->getMessage().PHP_EOL.'Stack trace:'.$e->getTraceAsString().PHP_EOL.'Retrying to call method...'.PHP_EOL.PHP_EOL; + $this->log->log(PHP_EOL.'An error occurred while calling method '.$method.': '.$e->getMessage().PHP_EOL.'Stack trace:'.$e->getTraceAsString().PHP_EOL.'Retrying to call method...'.PHP_EOL); continue; } if ($server_answer == null) { throw new Exception('An error occurred while calling method '.$method.'.'); } - return $this->tl->deserialize(fopen_and_write('php://memory', 'rw+b', $server_answer)); + return $this->tl->deserialize(Tools::fopen_and_write('php://memory', 'rw+b', $server_answer)); } throw new Exception('An error occurred while calling method '.$method.'.'); } public function create_auth_key() { - // Load the RSA key - $key = new \phpseclib\Crypt\RSA(); - $key->load($settings['rsa_content']); // Make pq request $nonce = \phpseclib\Crypt\Random::string(16); - pyjslib_printnl('Requesting pq'); + $this->log->log('Handshake: Requesting pq'); $ResPQ = $this->method_call('req_pq', ['nonce' => $nonce]); $server_nonce = $ResPQ['server_nonce']; if ($ResPQ['nonce'] !== $nonce) { throw new Exception('Handshake: wrong nonce'); } - $public_key_fingerprint = (int) $ResPQ['server_public_key_fingerprints'][0]; $pq_bytes = $ResPQ['pq']; - var_dump( - (int) $this->struct->unpack('tl->serialize_param('bytes', $key->modulus->toBytes()).$this->tl->serialize_param('bytes', $key->exponent->toBytes()), true), -8))[0], - $public_key_fingerprint - ); + foreach ($ResPQ['server_public_key_fingerprints'] as $curfp) { + if($curfp === $this->key->fp_float) { + $public_key_fingerprint = $curfp; + break; + } + } + if(!isset($public_key_fingerprint)) { + throw new Exception("Handshake: couldn't find our key in the server_public_key_fingerprints vector."); + } // Compute p and q $pq = new \phpseclib\Math\BigInteger($pq_bytes, 256); @@ -207,7 +215,7 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB } - pyjslib_printnl(sprintf('Factorization %s = %s * %s', $pq, $p, $q)); + $this->log->log(sprintf('Factorization %s = %s * %s', $pq, $p, $q)); $p_bytes = $this->struct->pack('>Q', (string) $p); $q_bytes = $this->struct->pack('>Q', (string) $q); @@ -216,8 +224,8 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB $sha_digest = sha1($data, true); $random_bytes = \phpseclib\Crypt\Random::string(255 - strlen($data) - strlen($sha_digest)); $to_encrypt = $sha_digest.$data.$random_bytes; - $encrypted_data = $key->_raw_encrypt($to_encrypt); - pyjslib_printnl('Starting Diffie Hellman key exchange'); + $encrypted_data = $this->key->encrypt($to_encrypt); + $this->log->log('Starting Diffie Hellman key exchange'); $server_dh_params = $this->method_call('req_DH_params', ['nonce' => $nonce, 'server_nonce' => $server_nonce, 'p' => $p_bytes, 'q' => $q_bytes, 'public_key_fingerprint' => $public_key_fingerprint, 'encrypted_data' => $encrypted_data]); if ($nonce != $server_dh_params['nonce']) { throw new Exception('Handshake: wrong nonce.'); @@ -231,7 +239,7 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB $answer_with_hash = crypt::ige_decrypt($encrypted_answer, $tmp_aes_key, $tmp_aes_iv); $answer_hash = substr($answer_with_hash, 0, 20); $answer = substr($answer_with_hash, 20); - $server_DH_inner_data = deserialize(fopen_and_write('php://memory', 'rw+b', $answer)); + $server_DH_inner_data = deserialize(Tools::fopen_and_write('php://memory', 'rw+b', $answer)); if ($nonce != $server_DH_inner_data['nonce']) { throw new Exception('Handshake: wrong nonce'); } @@ -243,7 +251,7 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB $g_a_str = $server_DH_inner_data['g_a']; $server_time = $server_DH_inner_data['server_time']; $this->timedelta = ($server_time - time()); - pyjslib_printnl(sprintf('Server-client time delta = %.1f s', $this->timedelta)); + $this->log->log(sprintf('Server-client time delta = %.1f s', $this->timedelta)); $dh_prime = $this->struct->unpack('>Q', $dh_prime_str); $g_a = $this->struct->unpack('>Q', $g_a_str); if (!$this->PrimeModule->isprime($dh_prime)) { @@ -277,23 +285,23 @@ Slv8kg9qv1m6XHVQY3PnEw+QQtqSIXklHwIDAQAB if ($Set_client_DH_params_answer['new_nonce_hash1'] != $new_nonce_hash1) { throw new Exception('Handshake: wrong new_nonce_hash1'); } - pyjslib_printnl('Diffie Hellman key exchange processed successfully'); + $this->log->log('Diffie Hellman key exchange processed successfully'); $this->server_salt = new strxor(substr($new_nonce, 0, 8 - 0), substr($server_nonce, 0, 8 - 0)); $this->auth_key = $auth_key_str; $this->auth_key_id = substr($auth_key_sha, -8); - pyjslib_printnl('Auth key generated'); + $this->log->log('Auth key generated'); return 'Auth Ok'; } elseif ($Set_client_DH_params_answer->name == 'dh_gen_retry') { if ($Set_client_DH_params_answer['new_nonce_hash2'] != $new_nonce_hash2) { throw new Exception('Handshake: wrong new_nonce_hash_2'); } - pyjslib_printnl('Retry Auth'); + $this->log->log('Retry Auth'); } elseif ($Set_client_DH_params_answer->name == 'dh_gen_fail') { if ($Set_client_DH_params_answer['new_nonce_hash3'] != $new_nonce_hash3) { throw new Exception('Handshake: wrong new_nonce_hash_3'); } - pyjslib_printnl('Auth Failed'); + $this->log->log('Auth Failed'); throw new Exception('Auth Failed'); } else { throw new Exception('Response Error'); diff --git a/src/danog/MadelineProto/TL.php b/src/danog/MadelineProto/TL/TL.php similarity index 62% rename from src/danog/MadelineProto/TL.php rename to src/danog/MadelineProto/TL/TL.php index 3d6dbde7..9d1a1134 100644 --- a/src/danog/MadelineProto/TL.php +++ b/src/danog/MadelineProto/TL/TL.php @@ -1,55 +1,15 @@ id = (int) $json_dict['id']; - $this->type = $json_dict['type']; - $this->predicate = $json_dict['predicate']; - $this->params = []; - foreach ($json_dict['params'] as $param) { - if (($param['type'] == 'Vector')) { - $param['type'] = 'Vector t'; - $param['subtype'] = 'long'; - } elseif (($param['type'] == 'vector<%Message>')) { - $param['type'] = 'vector'; - $param['subtype'] = 'message'; - } elseif (($param['type'] == 'vector')) { - $param['type'] = 'vector'; - $param['subtype'] = 'future_salt'; - } else { - $param['subtype'] = null; - } - $this->params[] = $param; - } - } -} -class TlMethod -{ - public function __construct($json_dict) - { - $this->id = (int) $json_dict['id']; - $this->type = $json_dict['type']; - $this->method = $json_dict['method']; - $this->params = $json_dict['params']; - } -} -class TLObject extends ArrayObject -{ - public function __construct($tl_elem) - { - parent::__construct(); - $this->name = $tl_elem->predicate; - } -} +/* +Copyright 2016 Daniil Gentili +(https://daniil.it) +This file is part of MadelineProto. +MadelineProto 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. +The PWRTelegram API 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 General Public License along with the MadelineProto. +If not, see . +*/ +namespace danog\MadelineProto\TL; class TL { public function __construct($filename) @@ -59,7 +19,7 @@ class TL $this->constructor_id = []; $this->constructor_type = []; foreach ($this->constructors as $elem) { - $z = new TlConstructor($elem); + $z = new TLConstructor($elem); $this->constructor_id[$z->id] = $z; $this->constructor_type[$z->predicate] = $z; } @@ -67,11 +27,10 @@ class TL $this->method_id = []; $this->method_name = []; foreach ($this->methods as $elem) { - $z = new TlMethod($elem); + $z = new TLMethod($elem); $this->method_id[$z->id] = $z; $this->method_name[$z->method] = $z; } - $this->struct = new \danog\PHP\StructClass(); } public function serialize_obj($type_, $kwargs) @@ -80,9 +39,9 @@ class TL if (isset($this->constructor_type[$type_])) { $tl_constructor = $this->constructor_type[$type_]; } else { - throw new Exception(sprintf('Could not extract type: %s', $type_)); + throw new Exception('Could not extract type: ' . $type_); } - $bytes_io .= $this->struct->pack('id); + $bytes_io .= \danog\PHP\Struct::pack('id); foreach ($tl_constructor->params as $arg) { $bytes_io .= $this->serialize_param($arg['type'], $kwargs[$arg['name']]); } @@ -96,9 +55,9 @@ class TL if (isset($this->method_name[$type_])) { $tl_method = $this->method_name[$type_]; } else { - throw new Exception(sprintf('Could not extract type: %s', $type_)); + throw new Exception('Could not extract type: ' . $type_); } - $bytes_io .= $this->struct->pack('id); + $bytes_io .= \danog\PHP\Struct::pack('id); foreach ($tl_method->params as $arg) { $bytes_io .= $this->serialize_param($arg['type'], $kwargs[$arg['name']]); } @@ -117,14 +76,14 @@ class TL throw new Exception('Given value is too long.'); } - return $this->struct->pack('struct->pack('struct->pack('struct->pack('struct->unpack('struct->unpack('struct->unpack('struct->unpack('struct->unpack(' 254) { throw new Exception('Length is too big'); } if ($l == 254) { - $long_len = $this->struct->unpack('struct->unpack('deserialize($bytes_io, $subtype); } break; @@ -216,11 +175,11 @@ class TL $tl_elem = $this->constructor_type[$type_]; } else { $Idata = fread($bytes_io, 4); - $i = $this->struct->unpack('constructor_id[$i])) { $tl_elem = $this->constructor_id[$i]; } else { - throw new Exception(sprintf('Could not extract type: %s', $type_)); + throw new Exception('Could not extract type: ' . $type_); } } diff --git a/src/danog/MadelineProto/TL/TLConstructor.php b/src/danog/MadelineProto/TL/TLConstructor.php new file mode 100644 index 00000000..9c5cc043 --- /dev/null +++ b/src/danog/MadelineProto/TL/TLConstructor.php @@ -0,0 +1,37 @@ +. +*/ +namespace danog\MadelineProto\TL; +class TLConstructor +{ + public function __construct($json_dict) + { + $this->id = (int) $json_dict['id']; + $this->type = $json_dict['type']; + $this->predicate = $json_dict['predicate']; + $this->params = []; + foreach ($json_dict['params'] as $param) { + if (($param['type'] == 'Vector')) { + $param['type'] = 'Vector t'; + $param['subtype'] = 'long'; + } elseif (($param['type'] == 'vector<%Message>')) { + $param['type'] = 'vector'; + $param['subtype'] = 'message'; + } elseif (($param['type'] == 'vector')) { + $param['type'] = 'vector'; + $param['subtype'] = 'future_salt'; + } else { + $param['subtype'] = null; + } + $this->params[] = $param; + } + } +} diff --git a/src/danog/MadelineProto/TL/TLMethod.php b/src/danog/MadelineProto/TL/TLMethod.php new file mode 100644 index 00000000..d0e92d23 --- /dev/null +++ b/src/danog/MadelineProto/TL/TLMethod.php @@ -0,0 +1,22 @@ +. +*/ +namespace danog\MadelineProto\TL; +class TLMethod +{ + public function __construct($json_dict) + { + $this->id = (int) $json_dict['id']; + $this->type = $json_dict['type']; + $this->method = $json_dict['method']; + $this->params = $json_dict['params']; + } +} diff --git a/src/danog/MadelineProto/TL/TLObject.php b/src/danog/MadelineProto/TL/TLObject.php new file mode 100644 index 00000000..78b07d87 --- /dev/null +++ b/src/danog/MadelineProto/TL/TLObject.php @@ -0,0 +1,20 @@ +. +*/ +namespace danog\MadelineProto\TL; +class TLObject extends \ArrayObject +{ + public function __construct($tl_elem) + { + parent::__construct(); + $this->name = $tl_elem->predicate; + } +} \ No newline at end of file diff --git a/src/danog/MadelineProto/Tools.php b/src/danog/MadelineProto/Tools.php new file mode 100644 index 00000000..cb8dc401 --- /dev/null +++ b/src/danog/MadelineProto/Tools.php @@ -0,0 +1,85 @@ +. +*/ + +namespace danog\MadelineProto; +/** + * Some tools. + */ +class Tools +{ + /** + * posmod(numeric,numeric) : numeric + * Works just like the % (modulus) operator, only returns always a postive number. + */ + public static function posmod($a, $b) + { + $resto = $a % $b; + if ($resto < 0) { + $resto += abs($b); + } + + return $resto; + } + + public static function fread_all($handle) + { + $pos = ftell($handle); + fseek($handle, 0); + $content = fread($handle, fstat($handle)['size']); + fseek($handle, $pos); + + return $content; + } + + public static function fopen_and_write($filename, $mode, $data) + { + $handle = fopen($filename, $mode); + fwrite($handle, $data); + rewind($handle); + + return $handle; + } + + public static function string2bin($string) + { + $res = null; + foreach (explode('\\', $string) as $s) { + if ($s != null && strlen($s) == 3) { + $res .= hex2bin(substr($s, 1)); + } + } + + return $res; + } + // taken from mochikit: range( [start,] stop[, step] ) + public static function range($start, $stop = null, $step = 1) + { + if ($stop === null) { + $stop = $start; + $start = 0; + } + if ($stop <= $start && $step < 0) { + $arr = range($stop, $start, -$step); + array_pop($arr); + + return array_reverse($arr, false); + } + if ($step > 1 && $step > ($stop - $start)) { + $arr = [$start]; + } else { + $arr = range($start, $stop, $step); + array_pop($arr); + } + + return $arr; + } +} diff --git a/src/danog/MadelineProto/debug_functions.php b/src/danog/MadelineProto/debug_functions.php deleted file mode 100644 index 0c25a504..00000000 --- a/src/danog/MadelineProto/debug_functions.php +++ /dev/null @@ -1,39 +0,0 @@ -=6, Returns a list of primes, 2 <= p < N """ + correction = N % 6 > 1 + N = {0:N, 1:N-1, 2:N+4, 3:N+3, 4:N+2, 5:N+1}[N%6] + sieve = [True] * (N // 3) + sieve[0] = False + for i in range(int(N ** .5) // 3 + 1): + if sieve[i]: + k = (3 * i + 1) | 1 + sieve[k*k // 3::2*k] = [False] * ((N//6 - (k*k)//6 - 1)//k + 1) + sieve[(k*k + 4*k - 2*k*(i%2)) // 3::2*k] = [False] * ((N // 6 - (k*k + 4*k - 2*k*(i%2))//6 - 1) // k + 1) + return [2, 3] + [(3 * i + 1) | 1 for i in range(1, N//3 - correction) if sieve[i]] + +smallprimeset = set(primesbelow(100000)) +_smallprimeset = 100000 + +def isprime(n, precision=7): + # http://en.wikipedia.org/wiki/Miller-Rabin_primality_test#Algorithm_and_running_time + if n == 1 or n % 2 == 0: + return False + elif n < 1: + raise ValueError("Out of bounds, first argument must be > 0") + elif n < _smallprimeset: + return n in smallprimeset + + + d = n - 1 + s = 0 + while d % 2 == 0: + d //= 2 + s += 1 + + for repeat in range(precision): + a = random.randrange(2, n - 2) + x = pow(a, d, n) + + if x == 1 or x == n - 1: continue + + for r in range(s - 1): + x = pow(x, 2, n) + if x == 1: return False + if x == n - 1: break + else: return False + + return True + +# https://comeoncodeon.wordpress.com/2010/09/18/pollard-rho-brent-integer-factorization/ +def pollard_brent(n): + if n % 2 == 0: return 2 + if n % 3 == 0: return 3 + + y, c, m = 87552211475113995, 330422027228888537, 226866727920975483 + #random.randint(1, n-1), random.randint(1, n-1), random.randint(1, n-1) + + g, r, q = 1, 1, 1 + while g == 1: + x = y + for i in range(r): + y = (pow(y, 2, n) + c) % n + + k = 0 + while k < r and g==1: + ys = y + for i in range(min(m, r-k)): + y = (pow(y, 2, n) + c) % n + q = q * abs(x-y) % n + + g = gcd(q, n) + k += m + r *= 2 + if g == n: + while True: + ys = (pow(ys, 2, n) + c) % n + g = gcd(abs(x - ys), n) + if g > 1: + break + + return g + +smallprimes = primesbelow(10000) # might seem low, but 1000*1000 = 1000000, so this will fully factor every composite < 1000000 +def primefactors(n, sort=False): + factors = [] + + limit = int(n ** .5) + 1 + for checker in smallprimes: + if checker > limit: break + while n % checker == 0: + factors.append(checker) + n //= checker + limit = int(n ** .5) + 1 + if checker > limit: break + + if n < 2: return factors + + while n > 1: + if isprime(n): + factors.append(n) + break + factor = pollard_brent(n) # trial division did not fully factor, switch to pollard-brent + factors.extend(primefactors(factor)) # recurse to factor the not necessarily prime factor returned by pollard-brent + n //= factor + + if sort: factors.sort() + + return factors + +def factorization(n): + factors = {} + for p1 in primefactors(n): + try: + factors[p1] += 1 + except KeyError: + factors[p1] = 1 + return factors + +totients = {} +def totient(n): + if n == 0: return 1 + + try: return totients[n] + except KeyError: pass + + tot = 1 + for p, exp in factorization(n).items(): + tot *= (p - 1) * p ** (exp - 1) + + totients[n] = tot + return tot + +def gcd(a, b): + if a == b: return a + while b > 0: a, b = b, a % b + return a + +def lcm(a, b): + return abs(a * b) // gcd(a, b) + diff --git a/src/danog/MadelineProto/tools.php b/src/danog/MadelineProto/tools.php deleted file mode 100644 index 3d0cc600..00000000 --- a/src/danog/MadelineProto/tools.php +++ /dev/null @@ -1,54 +0,0 @@ -