diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..e066202 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,660 @@ +### GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU AGPL, see . \ No newline at end of file diff --git a/README.md b/README.md index 899fe7b..ae34a03 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ This is the MapGuesser Application project. -License: GNU GPL 3.0 +License: GNU AGPL 3.0 diff --git a/composer.json b/composer.json index 6325f0a..5b7d429 100644 --- a/composer.json +++ b/composer.json @@ -4,8 +4,7 @@ "description": "MapGuesser Application", "license": "GNU GPL 3.0", "require": { - "vlucas/phpdotenv": "^4.1", - "romanpitak/php-rest-client": "^1.2" + "vlucas/phpdotenv": "^4.1" }, "require-dev": {}, "autoload": { diff --git a/composer.lock b/composer.lock index fc6069d..4bbcd4f 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "3778b9431ef3d22705bdbf1653102a1a", + "content-hash": "29431cf83ee884f01ee954b1068c0ccc", "packages": [ { "name": "phpoption/phpoption", @@ -61,51 +61,6 @@ ], "time": "2020-03-21T18:07:53+00:00" }, - { - "name": "romanpitak/php-rest-client", - "version": "v1.2.1", - "source": { - "type": "git", - "url": "https://github.com/romanpitak/PHP-REST-Client.git", - "reference": "728b6c44040a13daeb8033953f5f3cdd3dde1980" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/romanpitak/PHP-REST-Client/zipball/728b6c44040a13daeb8033953f5f3cdd3dde1980", - "reference": "728b6c44040a13daeb8033953f5f3cdd3dde1980", - "shasum": "" - }, - "require": { - "ext-curl": "*", - "php": ">=5.3.3" - }, - "type": "library", - "autoload": { - "psr-4": { - "RestClient\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Roman Piták", - "email": "roman@pitak.net", - "homepage": "http://pitak.net", - "role": "Developer" - } - ], - "description": "REST client library.", - "homepage": "https://github.com/romanpitak/PHP-REST-Client", - "keywords": [ - "client", - "http", - "rest" - ], - "time": "2015-02-19T15:32:16+00:00" - }, { "name": "symfony/polyfill-ctype", "version": "v1.17.0", diff --git a/docker/Dockerfile b/docker/Dockerfile index f75e34b..2e68c87 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -23,7 +23,7 @@ RUN ./install-composer.sh # Install Node.js and required packages RUN curl -sL https://deb.nodesource.com/setup_14.x | bash - RUN apt install -y nodejs -RUN npm install -g uglify-js clean-css-cli html-minifier +RUN npm install -g uglify-js clean-css-cli svgo EXPOSE 80 VOLUME /var/www/mapguesser diff --git a/main.php b/main.php index b2468f9..75a9a94 100644 --- a/main.php +++ b/main.php @@ -15,4 +15,11 @@ if (!empty($_ENV['DEV'])) { ini_set('display_errors', '0'); } +class Container +{ + static MapGuesser\Interfaces\Database\IConnection $dbConnection; +} + +Container::$dbConnection = new MapGuesser\Database\Mysql\Connection($_ENV['DB_HOST'], $_ENV['DB_USER'], $_ENV['DB_PASSWORD'], $_ENV['DB_NAME']); + session_start(); diff --git a/public/static/img/loading.svg b/public/static/img/loading.svg index 06e021e..fbf1cfa 100644 --- a/public/static/img/loading.svg +++ b/public/static/img/loading.svg @@ -1,11 +1,23 @@ - - + - - + + - - + + diff --git a/scripts/minify.sh b/scripts/minify.sh index 79c1bb5..24b9398 100755 --- a/scripts/minify.sh +++ b/scripts/minify.sh @@ -6,4 +6,4 @@ ROOT_DIR=$(dirname $(readlink -f "$0"))/.. uglifyjs ${ROOT_DIR}/public/static/js/mapguesser.js -c -m -o ${ROOT_DIR}/public/static/js/mapguesser.js cleancss ${ROOT_DIR}/public/static/css/mapguesser.css -o ${ROOT_DIR}/public/static/css/mapguesser.css -html-minifier ${ROOT_DIR}/public/static/img/loading.svg --collapse-whitespace --remove-comments -o ${ROOT_DIR}/public/static/img/loading.svg +svgo ${ROOT_DIR}/public/static/img/loading.svg -o ${ROOT_DIR}/public/static/img/loading.svg diff --git a/src/Controller/ControllerInterface.php b/src/Controller/ControllerInterface.php deleted file mode 100644 index 22d2f8f..0000000 --- a/src/Controller/ControllerInterface.php +++ /dev/null @@ -1,8 +0,0 @@ -mysql = new mysqli($_ENV['DB_HOST'], $_ENV['DB_USER'], $_ENV['DB_PASSWORD'], $_ENV['DB_NAME']); - $this->jsonResponse = $jsonResponse; } - public function run(): ViewBase + public function run(): IView { $bounds = $this->getMapBounds(); @@ -45,10 +43,11 @@ class GameController implements ControllerInterface private function getMapBounds(): Bounds { - $stmt = $this->mysql->prepare('SELECT bound_south_lat, bound_west_lng, bound_north_lat, bound_east_lng FROM maps WHERE id=?'); - $stmt->bind_param("i", $this->mapId); - $stmt->execute(); - $map = $stmt->get_result()->fetch_assoc(); + $select = new Select(\Container::$dbConnection, 'maps'); + $select->columns(['bound_south_lat', 'bound_west_lng', 'bound_north_lat', 'bound_east_lng']); + $select->whereId($this->mapId); + + $map = $select->execute()->fetch(IResultSet::FETCH_ASSOC); $bounds = Bounds::createDirectly($map['bound_south_lat'], $map['bound_west_lng'], $map['bound_north_lat'], $map['bound_east_lng']); diff --git a/src/Controller/PositionController.php b/src/Controller/PositionController.php index 24d4b13..eca8311 100644 --- a/src/Controller/PositionController.php +++ b/src/Controller/PositionController.php @@ -1,27 +1,22 @@ mysql = new mysqli($_ENV['DB_HOST'], $_ENV['DB_USER'], $_ENV['DB_PASSWORD'], $_ENV['DB_NAME']); - } - - public function run(): ViewBase + public function run(): IView { if (!isset($_SESSION['state']) || $_SESSION['state']['mapId'] !== $this->mapId) { $data = ['error' => 'No valid session found!']; @@ -120,45 +115,34 @@ class PositionController implements ControllerInterface private function selectNewPlace(array $exclude): array { - $condition = ''; - $params = ['i', &$this->mapId]; - if (($numExcluded = count($exclude)) > 0) { - $condition .= ' AND id NOT IN (' . implode(',', array_fill(0, $numExcluded, '?')) . ')'; - $params[0] .= str_repeat('i', $numExcluded); - foreach ($exclude as &$placeId) { - $params[] = &$placeId; - } - } + $select = new Select(\Container::$dbConnection, 'places'); + $select->columns(['id', 'lat', 'lng']); + $select->where('id', 'NOT IN', $exclude); + $select->where('map_id', '=', $this->mapId); - $stmt = $this->mysql->prepare('SELECT COUNT(*) AS num FROM places WHERE map_id=? ' . $condition . ''); - call_user_func_array([$stmt, 'bind_param'], $params); - $stmt->execute(); - $numberOfPlaces = $stmt->get_result()->fetch_assoc()['num']; + $numberOfPlaces = $select->count(); $randomOffset = random_int(0, $numberOfPlaces - 1); - $params[0] .= 'i'; - $params[] = &$randomOffset; + $select->orderBy('id'); + $select->limit(1, $randomOffset); - $stmt = $this->mysql->prepare('SELECT id, lat, lng FROM places WHERE map_id=? ' . $condition . ' ORDER BY id LIMIT 1 OFFSET ?'); - call_user_func_array([$stmt, 'bind_param'], $params); - $stmt->execute(); + $place = $select->execute()->fetch(IResultSet::FETCH_ASSOC); - return $stmt->get_result()->fetch_assoc(); + return $place; } private function getPanorama(Position $position): ?string { - $query = [ + $request = new Request('https://maps.googleapis.com/maps/api/streetview/metadata', Request::HTTP_GET); + $request->setQuery([ 'key' => $_ENV['GOOGLE_MAPS_SERVER_API_KEY'], 'location' => $position->getLat() . ',' . $position->getLng(), 'source' => 'outdoor' - ]; + ]); - $client = new Client('https://maps.googleapis.com/maps/api/streetview'); - $request = $client->newRequest('metadata?' . http_build_query($query)); - $response = $request->getResponse(); + $response = $request->send(); - $panoData = json_decode($response->getParsedResponse(), true); + $panoData = json_decode($response->getBody(), true); if ($panoData['status'] !== 'OK') { return null; @@ -172,10 +156,10 @@ class PositionController implements ControllerInterface return $realPosition->calculateDistanceTo($guessPosition); } - private function calculateScore(float $distance, float $area) + private function calculateScore(float $distance, float $area): int { $goodness = 1.0 - ($distance / sqrt($area)); - return round(pow(static::MAX_SCORE, $goodness)); + return (int) round(pow(static::MAX_SCORE, $goodness)); } } diff --git a/src/Database/Mysql/Connection.php b/src/Database/Mysql/Connection.php new file mode 100644 index 0000000..42dcef6 --- /dev/null +++ b/src/Database/Mysql/Connection.php @@ -0,0 +1,114 @@ +connection = new mysqli($host, $user, $password, $db, $port, $socket); + + if ($this->connection->connect_error) { + throw new \Exception('Connection failed: ' . $this->connection->connect_error); + } + + if (!$this->connection->set_charset('utf8mb4')) { + throw new \Exception($this->connection->error); + } + } + + public function __destruct() + { + $this->connection->close(); + } + + public function startTransaction(): void + { + if (!$this->connection->autocommit(false)) { + throw new \Exception($this->connection->error); + } + } + + public function commit(): void + { + if (!$this->connection->commit() || !$this->connection->autocommit(true)) { + throw new \Exception($this->connection->error); + } + } + + public function rollback(): void + { + if (!$this->connection->rollback() || !$this->connection->autocommit(true)) { + throw new \Exception($this->connection->error); + } + } + + public function query(string $query): ?IResultSet + { + if (!($result = $this->connection->query($query))) { + throw new \Exception($this->connection->error . '. Query: ' . $query); + } + + if ($result !== true) { + return new ResultSet($result); + } + + return null; + } + + public function multiQuery(string $query): array + { + if (!$this->connection->multi_query($query)) { + throw new \Exception($this->connection->error . '. Query: ' . $query); + } + + $ret = []; + do { + if ($result = $this->connection->store_result()) { + $ret[] = new ResultSet($result); + } else { + $ret[] = null; + } + + $this->connection->more_results(); + } while ($this->connection->next_result()); + + if ($this->connection->error) { + throw new \Exception($this->connection->error . '. Query: ' . $query); + } + + return $ret; + } + + public function prepare(string $query): IStatement + { + if (!($stmt = $this->connection->prepare($query))) { + throw new \Exception($this->connection->error . '. Query: ' . $query); + } + + return new Statement($stmt); + } + + public function lastId(): int + { + return $this->connection->insert_id; + } + + public function getAffectedRows(): int + { + return $this->connection->affected_rows; + } +} diff --git a/src/Database/Mysql/ResultSet.php b/src/Database/Mysql/ResultSet.php new file mode 100644 index 0000000..adb7288 --- /dev/null +++ b/src/Database/Mysql/ResultSet.php @@ -0,0 +1,62 @@ +result = $result; + } + + public function fetch(int $type = IResultSet::FETCH_ASSOC): ?array + { + return $this->result->fetch_array($this->convertFetchType($type)); + } + + public function fetchAll(int $type = IResultSet::FETCH_ASSOC): array + { + return $this->result->fetch_all($this->convertFetchType($type)); + } + + public function fetchOneColumn(string $valueName, string $keyName = null): array + { + $array = []; + + while ($r = $this->fetch(IResultSet::FETCH_ASSOC)) { + if (isset($keyName)) { + $array[$r[$keyName]] = $r[$valueName]; + } else { + $array[] = $r[$valueName]; + } + } + + return $array; + } + + private function convertFetchType(int $type): int + { + switch ($type) { + case IResultSet::FETCH_ASSOC: + $internal_type = MYSQLI_ASSOC; + break; + + case IResultSet::FETCH_BOTH: + $internal_type = MYSQLI_BOTH; + break; + + case IResultSet::FETCH_NUM: + $internal_type = MYSQLI_NUM; + break; + + default: + $internal_type = MYSQLI_BOTH; + break; + } + + return $internal_type; + } +} diff --git a/src/Database/Mysql/Statement.php b/src/Database/Mysql/Statement.php new file mode 100644 index 0000000..c380d54 --- /dev/null +++ b/src/Database/Mysql/Statement.php @@ -0,0 +1,79 @@ +stmt = $stmt; + } + + public function __destruct() + { + $this->stmt->close(); + } + + public function execute(array $params = []): ?IResultSet + { + if ($params) { + $ref_params = ['']; + + foreach ($params as &$param) { + $type = gettype($param); + + switch ($type) { + case 'integer': + case 'double': + case 'string': + $t = $type[0]; + break; + + case 'NULL': + $t = 's'; + break; + + case 'boolean': + $param = (string) (int) $param; + $t = 's'; + break; + + case 'array': + $param = json_encode($param); + $t = 's'; + break; + } + + if (!isset($t)) { + throw new \Exception('Data type ' . $type . ' not supported!'); + } + + $ref_params[] = &$param; + $ref_params[0] .= $t; + } + + if (!call_user_func_array([$this->stmt, 'bind_param'], $ref_params)) { + throw new \Exception($this->stmt->error); + } + } + + if (!$this->stmt->execute()) { + throw new \Exception($this->stmt->error); + } + + if ($result_set = $this->stmt->get_result()) { + return new ResultSet($result_set); + } + + return null; + } + + public function getAffectedRows(): int + { + return $this->stmt->affected_rows; + } +} diff --git a/src/Database/Query/Modify.php b/src/Database/Query/Modify.php new file mode 100755 index 0000000..da74873 --- /dev/null +++ b/src/Database/Query/Modify.php @@ -0,0 +1,157 @@ +connection = $connection; + $this->table = $table; + } + + public function setIdName(string $idName): Modify + { + $this->idName = $idName; + + return $this; + } + + public function setAutoIncrement(bool $autoIncrement = true): Modify + { + $this->autoIncrement = $autoIncrement; + + return $this; + } + + public function fill(array $attributes): Modify + { + $this->attributes = array_merge($this->attributes, $attributes); + + return $this; + } + + public function set(string $name, $value): Modify + { + $this->attributes[$name] = $value; + + return $this; + } + + public function setId($id): Modify + { + $this->attributes[$this->idName] = $id; + + return $this; + } + + public function save(): void + { + if (isset($this->attributes[$this->idName])) { + $this->update(); + } else { + $this->insert(); + } + } + + public function delete(): void + { + if (!isset($this->attributes[$this->idName])) { + throw new \Exception('No primary key specified!'); + } + + $query = 'DELETE FROM ' . Utils::backtick($this->table) . ' WHERE ' . Utils::backtick($this->idName) . '=?'; + + $stmt = $this->connection->prepare($query); + $stmt->execute([$this->idName => $this->attributes[$this->idName]]); + } + + private function insert(): void + { + if (!$this->autoIncrement) { + $this->attributes[$this->idName] = $this->generateKey(); + } + + $set = $this->generateColumnsWithBinding(array_keys($this->attributes)); + + $query = 'INSERT INTO ' . Utils::backtick($this->table) . ' SET ' . $set; + + $stmt = $this->connection->prepare($query); + $stmt->execute($this->attributes); + + if ($this->autoIncrement) { + $this->attributes[$this->idName] = $this->connection->lastId(); + } + } + + private function update(): void + { + $diff = $this->generateDiff(); + + if (count($diff) === 0) { + return; + } + + $set = $this->generateColumnsWithBinding(array_keys($diff)); + + $query = 'UPDATE ' . Utils::backtick($this->table) . ' SET ' . $set . ' WHERE ' . Utils::backtick($this->idName) . '=?'; + + $stmt = $this->connection->prepare($query); + $stmt->execute(array_merge($diff, [$this->idName => $this->attributes[$this->idName]])); + } + + private function readFromDB(array $columns): void + { + $select = (new Select($this->connection, $this->table)) + ->setIdName($this->idName) + ->whereId($this->attributes[$this->idName]) + ->columns($columns); + + $this->original = $select->execute()->fetch(IResultSet::FETCH_ASSOC); + } + + private function generateDiff(): array + { + $this->readFromDB(array_keys($this->attributes)); + + $diff = []; + + foreach ($this->attributes as $name => $value) { + $original = $this->original[$name]; + + if ($original != $value) { + $diff[$name] = $value; + } + } + + return $diff; + } + + public static function generateColumnsWithBinding(array $columns): string + { + array_walk($columns, function(&$value, $key) { + $value = Utils::backtick($value) . '=?'; + }); + + return implode(',', $columns); + } + + private function generateKey(): string + { + return substr(hash('sha256', serialize($this->attributes) . random_bytes(10) . microtime()), 0, 7); + } +} diff --git a/src/Database/Query/Select.php b/src/Database/Query/Select.php new file mode 100644 index 0000000..a379728 --- /dev/null +++ b/src/Database/Query/Select.php @@ -0,0 +1,402 @@ + [], self::CONDITION_HAVING => []]; + + private array $groups = []; + + private array $orders = []; + + private array $limit; + + public function __construct(IConnection $connection, string $table) + { + $this->connection = $connection; + $this->table = $table; + } + + public function setIdName(string $idName): Select + { + $this->idName = $idName; + + return $this; + } + + public function setTableAliases(array $tableAliases): Select + { + $this->tableAliases = array_merge($this->tableAliases, $tableAliases); + + return $this; + } + + public function columns(array $columns): Select + { + $this->columns = array_merge($this->columns, $columns); + + return $this; + } + + public function innerJoin($table, $column1, string $relation, $column2): Select + { + $this->addJoin('INNER', $table, $column1, $relation, $column2); + + return $this; + } + + public function leftJoin($table, $column1, string $relation, $column2): Select + { + $this->addJoin('LEFT', $table, $column1, $relation, $column2); + + return $this; + } + + public function whereId($value): Select + { + $this->addWhereCondition('AND', $this->idName, '=', $value); + + return $this; + } + + public function where($column, string $relation = null, $value = null): Select + { + $this->addWhereCondition('AND', $column, $relation, $value); + + return $this; + } + + public function orWhere($column, string $relation = null, $value = null): Select + { + $this->addWhereCondition('OR', $column, $relation, $value); + + return $this; + } + + public function having($column, string $relation = null, $value = null): Select + { + $this->addHavingCondition('AND', $column, $relation, $value); + + return $this; + } + + public function orHaving($column, string $relation = null, $value = null): Select + { + $this->addHavingCondition('OR', $column, $relation, $value); + + return $this; + } + + public function groupBy($column): Select + { + $this->groups[] = $column; + + return $this; + } + + public function orderBy($column, string $type = 'ASC'): Select + { + $this->orders[] = [$column, $type]; + + return $this; + } + + public function limit(int $limit, int $offset = 0): Select + { + $this->limit = [$limit, $offset]; + + return $this; + } + + public function resetLimit(): void + { + $this->limit = null; + } + + public function paginate(int $page, int $itemsPerPage) + { + $this->limit($itemsPerPage, ($page - 1) * $itemsPerPage); + + return $this; + } + + public function execute(): IResultSet + { + list($query, $params) = $this->generateQuery(); + + return $this->connection->prepare($query)->execute($params); + } + + public function count(): int + { + if (count($this->groups) > 0 || count($this->conditions[self::CONDITION_HAVING]) > 0) { + $orders = $this->orders; + + $this->orders = []; + + list($query, $params) = $this->generateQuery(); + + $result = $this->connection->prepare('SELECT COUNT(*) num_rows FROM (' . $query . ') x') + ->execute($params) + ->fetch(IResultSet::FETCH_NUM); + + $this->orders = $orders; + + return $result[0]; + } else { + $columns = $this->columns; + $orders = $this->orders; + + $this->columns = [new RawExpression('COUNT(*) num_rows')]; + $this->orders = []; + + list($query, $params) = $this->generateQuery(); + + $result = $this->connection->prepare($query) + ->execute($params) + ->fetch(IResultSet::FETCH_NUM); + + $this->columns = $columns; + $this->orders = $orders; + + return $result[0]; + } + } + + private function addJoin(string $type, $table, $column1, string $relation, $column2): void + { + $this->joins[] = [$type, $table, $column1, $relation, $column2]; + } + + private function addWhereCondition(string $logic, $column, string $relation, $value): void + { + $this->conditions[self::CONDITION_WHERE][] = [$logic, $column, $relation, $value]; + } + + private function addHavingCondition(string $logic, $column, string $relation, $value): void + { + $this->conditions[self::CONDITION_HAVING][] = [$logic, $column, $relation, $value]; + } + + private function generateQuery(): array + { + $queryString = 'SELECT ' . $this->generateColumns() . ' FROM ' . $this->generateTable($this->table, true); + + if (count($this->joins) > 0) { + $queryString .= ' ' . $this->generateJoins(); + } + + if (count($this->conditions[self::CONDITION_WHERE]) > 0) { + list($wheres, $whereParams) = $this->generateConditions(self::CONDITION_WHERE); + + $queryString .= ' WHERE ' . $wheres; + } else { + $whereParams = []; + } + + if (count($this->groups) > 0) { + $queryString .= ' GROUP BY ' . $this->generateGroupBy(); + } + + if (count($this->conditions[self::CONDITION_HAVING]) > 0) { + list($havings, $havingParams) = $this->generateConditions(self::CONDITION_HAVING); + + $queryString .= ' HAVING ' . $havings; + } else { + $havingParams = []; + } + + if (count($this->orders) > 0) { + $queryString .= ' ORDER BY ' . $this->generateOrderBy(); + } + + if (isset($this->limit)) { + $queryString .= ' LIMIT ' . $this->limit[1] . ', ' . $this->limit[0]; + } + + return [$queryString, array_merge($whereParams, $havingParams)]; + } + + private function generateTable($table, bool $defineAlias = false): string + { + if ($table instanceof RawExpression) { + return (string) $table; + } + + if (isset($this->tableAliases[$table])) { + return ($defineAlias ? Utils::backtick($this->tableAliases[$table]) . ' ' . Utils::backtick($table) : Utils::backtick($table)); + } + + return Utils::backtick($table); + } + + private function generateColumn($column): string + { + if ($column instanceof RawExpression) { + return (string) $column; + } + + if (is_array($column)) { + $out = ''; + + if ($column[0]) { + $out .= $this->generateTable($column[0]) . '.'; + } + + $out .= Utils::backtick($column[1]); + + if (!empty($column[2])) { + $out .= ' ' . Utils::backtick($column[2]); + } + + return $out; + } else { + return Utils::backtick($column); + } + } + + private function generateColumns(): string + { + $columns = $this->columns; + + array_walk($columns, function (&$value, $key) { + $value = $this->generateColumn($value); + }); + + return implode(',', $columns); + } + + private function generateJoins(): string + { + $joins = $this->joins; + + array_walk($joins, function (&$value, $key) { + $value = $value[0] . ' JOIN ' . $this->generateTable($value[1], true) . ' ON ' . $this->generateColumn($value[2]) . ' ' . $value[3] . ' ' . $this->generateColumn($value[4]); + }); + + return implode(' ', $joins); + } + + private function generateConditions(string $type): array + { + $conditions = ''; + $params = []; + + foreach ($this->conditions[$type] as $condition) { + list($logic, $column, $relation, $value) = $condition; + + if ($column instanceof Closure) { + list($conditionsStringFragment, $paramsFragment) = $this->generateComplexConditionFragment($type, $column); + } else { + list($conditionsStringFragment, $paramsFragment) = $this->generateConditionFragment($condition); + } + + if ($conditions !== '') { + $conditions .= ' ' . $logic . ' '; + } + + $conditions .= $conditionsStringFragment; + $params = array_merge($params, $paramsFragment); + } + + return [$conditions, $params]; + } + + private function generateConditionFragment(array $condition): array + { + list($logic, $column, $relation, $value) = $condition; + + if ($column instanceof RawExpression) { + return [(string) $column, []]; + } + + $conditionsString = $this->generateColumn($column) . ' '; + + if ($value === null) { + return [$conditionsString . ($relation == '=' ? 'IS NULL' : 'IS NOT NULL'), []]; + } + + $conditionsString .= strtoupper($relation) . ' ';; + + switch ($relation = strtolower($relation)) { + case 'between': + $params = [$value[0], $value[1]]; + + $conditionsString .= '? AND ?'; + break; + + case 'in': + case 'not in': + $params = $value; + + if (count($value) > 0) { + $conditionsString .= '(' . implode(', ', array_fill(0, count($value), '?')) . ')'; + } else { + $conditionsString = $relation == 'in' ? '0' : '1'; + } + break; + + default: + $params = [$value]; + + $conditionsString .= '?'; + } + + return [$conditionsString, $params]; + } + + private function generateComplexConditionFragment(string $type, Closure $conditionCallback): array + { + $instance = new static($this->connection, $this->table); + $instance->tableAliases = $this->tableAliases; + + $conditionCallback($instance); + + list($conditions, $params) = $instance->generateConditions($type); + + return ['(' . $conditions . ')', $params]; + } + + private function generateGroupBy(): string + { + $groups = $this->groups; + + array_walk($groups, function (&$value, $key) { + $value = $this->generateColumn($value); + }); + + return implode(',', $groups); + } + + private function generateOrderBy(): string + { + $orders = $this->orders; + + array_walk($orders, function (&$value, $key) { + $value = $this->generateColumn($value[0]) . ' ' . strtoupper($value[1]); + }); + + return implode(',', $orders); + } +} diff --git a/src/Database/RawExpression.php b/src/Database/RawExpression.php new file mode 100644 index 0000000..e2b0328 --- /dev/null +++ b/src/Database/RawExpression.php @@ -0,0 +1,16 @@ +expression = $expression; + } + + public function __toString(): string + { + return $this->expression; + } +} diff --git a/src/Database/Utils.php b/src/Database/Utils.php new file mode 100644 index 0000000..3c4042e --- /dev/null +++ b/src/Database/Utils.php @@ -0,0 +1,7 @@ +url = $url; + $this->method = $method; + } + + public function setQuery($query) + { + if (is_string($query)) { + $this->query = $query; + } else { + $this->query = http_build_query($query); + } + } + + public function setHeaders(array $headers) + { + $this->headers = array_merge($this->headers, $headers); + } + + public function send(): Response + { + $ch = curl_init(); + + if ($this->method === self::HTTP_GET) { + $url = $this->url . '?' . $this->query; + } elseif ($this->method === self::HTTP_POST) { + $url = $this->url; + + curl_setopt($ch, CURLOPT_POST, 1); + curl_setopt($ch, CURLOPT_POSTFIELDS, $this->query); + } + + curl_setopt($ch, CURLOPT_URL, $url); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); + curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10); + curl_setopt($ch, CURLOPT_TIMEOUT, 20); + curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1); + curl_setopt($ch, CURLOPT_USERAGENT, 'MapGuesser cURL/1.0'); + + if (count($this->headers) > 0) { + curl_setopt($ch, CURLOPT_HTTPHEADER, $this->headers); + } + + $responseHeaders = []; + curl_setopt( + $ch, + CURLOPT_HEADERFUNCTION, + function ($ch, $header) use (&$responseHeaders) { + $len = strlen($header); + $header = explode(':', $header, 2); + + if (count($header) < 2) { + return $len; + } + + $responseHeaders[strtolower(trim($header[0]))][] = trim($header[1]); + + return $len; + } + ); + + $responseBody = curl_exec($ch); + + if ($responseBody === false) { + $error = curl_error($ch); + + curl_close($ch); + + throw new \Exception($error); + } + + curl_close($ch); + + return new Response($responseBody, $responseHeaders); + } +} diff --git a/src/Http/Response.php b/src/Http/Response.php new file mode 100644 index 0000000..9bee447 --- /dev/null +++ b/src/Http/Response.php @@ -0,0 +1,24 @@ +body = $body; + $this->headers = $headers; + } + + public function getBody() + { + return $this->body; + } + + public function getHeaders() + { + return $this->headers; + } +} diff --git a/src/Interfaces/Controller/IController.php b/src/Interfaces/Controller/IController.php new file mode 100644 index 0000000..07caeeb --- /dev/null +++ b/src/Interfaces/Controller/IController.php @@ -0,0 +1,8 @@ +