commit ad9463728e2d36404a9a0fd75127c7caff0bc3ff Author: Daniil Gentili Date: Sun Mar 17 20:20:00 2024 +0100 First commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4ef8091 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/vendor/ +*.cache +composer.lock diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 0000000..237e0d9 --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,14 @@ +getFinder() + ->in(__DIR__ . '/src') + ->in(__DIR__ . '/tests') + ->in(__DIR__ . '/examples'); + +$cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__; + +$config->setCacheFile($cacheDir . '/.php_cs.cache'); + +return $config; diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dba13ed --- /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/composer.json b/composer.json new file mode 100644 index 0000000..9a7fb6f --- /dev/null +++ b/composer.json @@ -0,0 +1,42 @@ +{ + "name": "danog/async-orm", + "description": "Async ORM based on AMPHP v3 and fibers.", + "type": "library", + "license": "AGPL-3.0-only", + "autoload": { + "psr-4": { + "danog\\AsyncOrm\\": "src/" + } + }, + "authors": [ + { + "name": "Alexander Pankratov", + "email": "alexander@i-c-a.su" + }, + { + "name": "Daniil Gentili", + "email": "daniil@daniil.it" + } + ], + "require": { + "amphp/mysql": "^3.0", + "amphp/postgres": "^2.0", + "amphp/redis": "^2.0", + "amphp/sync": "^2.2", + "revolt/event-loop": "^1.0.6" + }, + "require-dev": { + "vimeo/psalm": "dev-master", + "phpunit/phpunit": "^11.0.6", + "amphp/php-cs-fixer-config": "^2.0.1", + "friendsofphp/php-cs-fixer": "^3.51" + }, + "scripts": { + "cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 php -d pcre.jit=0 vendor/bin/php-cs-fixer fix -v" + }, + "config": { + "allow-plugins": { + "dealerdirect/phpcodesniffer-composer-installer": true + } + } +} diff --git a/src/Annotations/OrmMappedArray.php b/src/Annotations/OrmMappedArray.php new file mode 100644 index 0000000..669638f --- /dev/null +++ b/src/Annotations/OrmMappedArray.php @@ -0,0 +1,59 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://docs.AsyncOrm.xyz AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Annotations; + +use Attribute; +use danog\AsyncOrm\KeyType; +use danog\AsyncOrm\ValueType; + +#[Attribute(Attribute::TARGET_PROPERTY)] +final class OrmMappedArray +{ + public function __construct( + /** + * Key type. + */ + public readonly KeyType $keyType, + /** + * Value type. + */ + public readonly ValueType $valueType, + /** + * Whether to enable cache. + */ + public readonly bool $enableCache = true, + /** + * TTL of the cache, if null defaults to the value specified in the settings. + * + * @var int<0, max>|null + */ + public readonly ?int $cacheTtl = null, + /** + * Custom table name, if null is autogenerated. + */ + public readonly ?string $table = null, + /** + * Optimize table if more than this many megabytes are wasted, if null defaults to the value specified in the settings. + * + * @var int<1, max>|null + */ + public readonly ?int $optimizeIfWastedGtMb = null, + ) { + } +} diff --git a/src/DbArray.php b/src/DbArray.php new file mode 100644 index 0000000..4e9758b --- /dev/null +++ b/src/DbArray.php @@ -0,0 +1,95 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm; + +use ArrayAccess; +use Countable; +use IteratorAggregate; +use Traversable; + +/** + * DB array interface. + * + * @template TKey as array-key + * @template TValue + * + * @implements ArrayAccess + * @implements Traversable + * @implements IteratorAggregate + */ +abstract class DbArray implements Countable, ArrayAccess, Traversable, IteratorAggregate +{ + final public function isset(string|int $key): bool + { + return $this->get($key) !== null; + } + + final public function offsetGet(mixed $offset): mixed + { + return $this->get($offset); + } + + final public function offsetExists(mixed $index): bool + { + return $this->isset($index); + } + + final public function offsetSet(mixed $index, mixed $value): void + { + $this->set($index, $value); + } + + final public function offsetUnset(mixed $index): void + { + $this->unset($index); + } + + public function getArrayCopy(): array + { + return \iterator_to_array($this->getIterator()); + } + + /** + * Unset element. + * + * @param TKey $key + */ + abstract public function unset(string|int $key): void; + /** + * Set element. + * + * @param TKey $key + * @param TValue $value + */ + abstract public function set(string|int $key, mixed $value): void; + /** + * Get element. + * + * @param TKey $key + * @return TValue + */ + abstract public function get(string|int $key): mixed; + /** + * Clear all elements. + */ + abstract public function clear(): void; + + /** + * Get instance. + */ + abstract public static function getInstance(FieldConfig $config, self|null $previous): self; +} diff --git a/src/DbPropertiesTrait.php b/src/DbPropertiesTrait.php new file mode 100644 index 0000000..fe1cc96 --- /dev/null +++ b/src/DbPropertiesTrait.php @@ -0,0 +1,69 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm; + +use danog\AsyncOrm\Annotations\OrmMappedArray; +use danog\AsyncOrm\Internal\DbPropertiesFactory; +use ReflectionClass; + +use function Amp\async; +use function Amp\Future\await; + +/** + * Include this trait and call DbPropertiesTrait::initDb to use AsyncOrm's database backend for properties marked by the OrmMappedArray property. + */ +trait DbPropertiesTrait +{ + /** + * Initialize database instance. + * + * @internal + */ + public function initDb(Settings $dbSettings): void + { + $prefix = $this->getDbPrefix(); + + $className = \explode('\\', static::class); + $className = \end($className); + + $promises = []; + foreach ((new ReflectionClass(static::class))->getProperties() as $property) { + $attr = $property->getAttributes(OrmMappedArray::class); + if (!$attr) { + continue; + } + $attr = $attr[0]->newInstance(); + $table = $prefix.'_'; + $table .= $attr->table ?? "{$className}_{$property}"; + $promises[$property] = async(DbPropertiesFactory::get(...), $dbSettings, $table, $attr, $this->{$property} ?? null); + } + $promises = await($promises); + foreach ($promises as $key => $data) { + $this->{$key} = $data; + } + } + + /** + * Returns the prefix to use for table names. + */ + protected function getTablePrefix(): string + { + return ''; + } +} diff --git a/src/Driver/DriverArray.php b/src/Driver/DriverArray.php new file mode 100644 index 0000000..64c4ca5 --- /dev/null +++ b/src/Driver/DriverArray.php @@ -0,0 +1,97 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Driver; + +use danog\AsyncOrm\DbArray; +use danog\AsyncOrm\FieldConfig; +use danog\AsyncOrm\Serializer; +use danog\AsyncOrm\Serializer\Igbinary; +use danog\AsyncOrm\Serializer\Native; +use danog\AsyncOrm\Serializer\Passthrough; +use danog\AsyncOrm\ValueType; + +use function Amp\async; +use function Amp\Future\await; + +/** + * Base class for driver-based arrays. + * + * @template TKey as array-key + * @template TValue + * + * @consistent-constructor + * + * @extends DbArray + */ +abstract class DriverArray extends DbArray +{ + protected function __construct(protected readonly FieldConfig $config, protected readonly Serializer $serializer) + { + } + + public static function getInstance(FieldConfig $config, DbArray|null $previous): DbArray + { + if ($previous::class === static::class + && $previous->config == $config + ) { + return $previous; + } + + $instance = new static($config, match ($config->annotation->valueType) { + ValueType::BEST => \extension_loaded('igbinary') ? new Igbinary : new Native, + ValueType::IGBINARY => new Igbinary, + ValueType::SERIALIZE => new Native, + default => new Passthrough + }); + + if ($previous === null) { + return $instance; + } + + if ($previous instanceof SqlArray + && $instance instanceof SqlArray + && $previous::class === $instance::class + ) { + $instance->importFromTable($previous->config->table); + } else { + $promises = []; + foreach ($previous->getIterator() as $key => $value) { + $promises []= async($instance->set(...), $key, $value); + if (\count($promises) % 500 === 0) { + await($promises); + $promises = []; + } + } + if ($promises) { + await($promises); + } + $previous->clear(); + } + + return $instance; + } + + /** + * Sleep function. + */ + public function __sleep(): array + { + return ['config']; + } +} diff --git a/src/Driver/MemoryArray.php b/src/Driver/MemoryArray.php new file mode 100644 index 0000000..7ded4ca --- /dev/null +++ b/src/Driver/MemoryArray.php @@ -0,0 +1,87 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Driver; + +use ArrayObject; +use danog\AsyncOrm\DbArray; +use danog\AsyncOrm\FieldConfig; +use danog\AsyncOrm\Settings\Database\Memory; + +/** + * Memory database backend. + * + * @template TKey as array-key + * @template TValue + * @DbArray DbArray + */ +final class MemoryArray extends DbArray +{ + public function __construct( + private array $data + ) { + } + + public static function getInstance(FieldConfig $settings, DbArray|null $previous): DbArray + { + if ($previous instanceof self) { + return $previous; + } + if ($previous instanceof DbArray) { + $temp = $previous->getArrayCopy(); + $previous->clear(); + $previous = $temp; + } else { + $previous = []; + } + return new self($previous); + } + + public function set(string|int $key, mixed $value): void + { + $this->data[$key] = $value; + } + public function get(string|int $key): mixed + { + return $this->data[$key] ?? null; + } + public function unset(string|int $key): void + { + unset($this->data[$key]); + } + + public function clear(): void + { + $this->data = []; + } + + public function count(): int + { + return \count($this->data); + } + + public function getIterator(): \Traversable + { + return new ArrayObject($this); + } + + public function getArrayCopy(): array + { + return $this->data; + } +} diff --git a/src/Driver/SqlArray.php b/src/Driver/SqlArray.php new file mode 100644 index 0000000..b2dbe5e --- /dev/null +++ b/src/Driver/SqlArray.php @@ -0,0 +1,138 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Driver; + +use Amp\Sql\SqlConnectionPool; +use Amp\Sql\SqlResult; +use danog\AsyncOrm\FieldConfig; +use danog\AsyncOrm\Serializer; + +/** + * Generic SQL database backend. + * + * @template TKey as array-key + * @template TValue + * @extends DriverArray + */ +abstract class SqlArray extends DriverArray +{ + protected function __construct( + FieldConfig $config, + Serializer $serializer, + protected readonly SqlConnectionPool $db, + private readonly string $get, + private readonly string $set, + private readonly string $unset, + private readonly string $count, + private readonly string $iterate, + private readonly string $clear, + ) { + parent::__construct($config, $serializer); + } + + /** + * Get iterator. + * + * @return \Traversable + */ + public function getIterator(): \Traversable + { + foreach ($this->execute($this->iterate) as ['key' => $key, 'value' => $value]) { + yield $key => $this->serializer->deserialize($value); + } + } + + public function get(mixed $key): mixed + { + $key = (string) $key; + + $row = $this->execute($this->get, ['index' => $key])->fetchRow(); + if ($row === null) { + return null; + } + + $value = $this->serializer->deserialize($row['value']); + + return $value; + } + + public function set(string|int $key, mixed $value): void + { + $key = (string) $key; + + $this->execute( + $this->set, + [ + 'index' => $key, + 'value' => $this->serializer->serialize($value), + ], + ); + } + + /** + * Unset value for an offset. + * + * @link https://php.net/manual/en/arrayiterator.offsetunset.php + */ + public function unset(string|int $key): void + { + $key = (string) $key; + + $this->execute( + $this->unset, + ['index' => $key], + ); + } + + /** + * Count elements. + * + * @link https://php.net/manual/en/arrayiterator.count.php + * @return int The number of elements or public properties in the associated + * array or object, respectively. + */ + public function count(): int + { + $row = $this->execute($this->count); + /** @var int */ + return $row->fetchRow()['count']; + } + + /** + * Clear all elements. + */ + public function clear(): void + { + $this->execute($this->clear); + } + + /** + * Perform async request to db. + * + */ + protected function execute(string $sql, array $params = []): SqlResult + { + return $this->db->prepare($sql)->execute($params); + } + + /** + * Import data from existing table. + */ + abstract protected function importFromTable(string $fromTable): void; +} diff --git a/src/FieldConfig.php b/src/FieldConfig.php new file mode 100644 index 0000000..08b4aed --- /dev/null +++ b/src/FieldConfig.php @@ -0,0 +1,18 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Internal; + +use danog\AsyncOrm\Annotations\OrmMappedArray; +use danog\AsyncOrm\DbArray; +use danog\AsyncOrm\FieldConfig; +use danog\AsyncOrm\Internal\Driver\CachedArray; +use danog\AsyncOrm\Settings; +use danog\AsyncOrm\Settings\DriverSettings; +use danog\AsyncOrm\Settings\Mysql; + +/** + * This factory class initializes the correct database backend for AsyncOrm. + * + * @internal + */ +final class DbPropertiesFactory +{ + public static function get(Settings $dbSettings, string $table, OrmMappedArray $config, ?DbArray $previous = null): DbArray + { + $dbSettings = clone $dbSettings; + + $ttl = $config->cacheTtl; + $optimize = $config->optimizeIfWastedGtMb; + if ($dbSettings instanceof DriverSettings) { + $ttl ??= $dbSettings->cacheTtl; + + if ($dbSettings instanceof Mysql) { + $optimize ??= $config->optimizeIfWastedGtMb; + } + + $config = new OrmMappedArray( + $config->keyType, + $config->valueType, + $ttl === 0 ? false : $config->enableCache, + $ttl, + $config->table, + $optimize + ); + } + + $config = new FieldConfig( + $table, + $config, + $dbSettings, + ); + + if (!$config->annotation->enableCache) { + return $config->settings->getDriverClass()::getInstance($config, $previous); + } + + return CachedArray::getInstance($config, $previous); + } +} diff --git a/src/Internal/Driver/CacheContainer.php b/src/Internal/Driver/CacheContainer.php new file mode 100644 index 0000000..4da2278 --- /dev/null +++ b/src/Internal/Driver/CacheContainer.php @@ -0,0 +1,168 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Internal\Driver; + +use Amp\Sync\LocalMutex; +use danog\AsyncOrm\DbArray; +use Revolt\EventLoop; +use Traversable; + +/** @internal */ +final class CacheContainer +{ + /** + * @var array + */ + private array $cache = []; + /** + * @var array + */ + private array $ttl = []; + + private int $cacheTtl; + + /** + * Cache cleanup watcher ID. + */ + private ?string $cacheCleanupId = null; + + private LocalMutex $mutex; + + public function __construct( + public DbArray $inner + ) { + $this->mutex = new LocalMutex; + } + public function __sleep() + { + $this->flushCache(); + return ['cache', 'ttl', 'inner']; + } + public function __wakeup(): void + { + $this->mutex = new LocalMutex; + } + + public function startCacheCleanupLoop(int $cacheTtl): void + { + $this->cacheTtl = $cacheTtl; + if ($this->cacheCleanupId) { + EventLoop::cancel($this->cacheCleanupId); + } + $this->cacheCleanupId = EventLoop::repeat( + \max(1, $this->cacheTtl / 5), + fn () => $this->flushCache(), + ); + } + public function stopCacheCleanupLoop(): void + { + if ($this->cacheCleanupId) { + EventLoop::cancel($this->cacheCleanupId); + $this->cacheCleanupId = null; + } + } + + public function get(string|int $index): mixed + { + if (isset($this->ttl[$index])) { + $this->ttl[$index] = \time() + $this->cacheTtl; + return $this->cache[$index]; + } + + $result = $this->inner->offsetGet($index); + if (isset($this->ttl[$index])) { + $this->ttl[$index] = \time() + $this->cacheTtl; + return $this->cache[$index]; + } + + $this->ttl[$index] = \time() + $this->cacheTtl; + $this->cache[$index] = $result; + + return $result; + } + + public function set(string|int $key, mixed $value): void + { + if (isset($this->ttl[$key]) && $this->cache[$key] === $value) { + return; + } + $this->cache[$key] = $value; + $this->ttl[$key] = true; + } + + public function getIterator(): Traversable + { + $this->flushCache(); + return $this->inner->getIterator(); + } + + public function count(): int + { + $this->flushCache(); + return $this->inner->count(); + } + + public function clear(): void + { + $lock = $this->mutex->acquire(); + $this->cache = []; + $this->ttl = []; + $lock->release(); + + $this->inner->clear(); + } + + /** + * Flush all flushable keys. + */ + public function flushCache(): void + { + $lock = $this->mutex->acquire(); + try { + $updatedValues = []; + $newValues = []; + $newTtl = []; + $now = \time(); + foreach ($this->ttl as $key => $ttl) { + if ($ttl === true) { + $updatedValues[$key] = $this->cache[$key]; + if ($this->cache[$key] === null) { + $this->inner->unset($key); + } else { + $this->inner->set($key, $this->cache[$key]); + } + } elseif ($ttl > $now) { + $newTtl[$key] = $ttl; + $newValues[$key] = $this->cache[$key]; + } + } + foreach ($updatedValues as $key => $value) { + if (($newValues[$key] = $this->cache[$key]) === $value) { + $newTtl[$key] = \time() + $this->cacheTtl; + } else { + $newTtl[$key] = $this->ttl[$key]; + } + } + $this->ttl = $newTtl; + $this->cache = $newValues; + } finally { + EventLoop::queue($lock->release(...)); + } + } +} diff --git a/src/Internal/Driver/CachedArray.php b/src/Internal/Driver/CachedArray.php new file mode 100644 index 0000000..77b5dd3 --- /dev/null +++ b/src/Internal/Driver/CachedArray.php @@ -0,0 +1,100 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Internal\Driver; + +use danog\AsyncOrm\DbArray; +use danog\AsyncOrm\Driver\MemoryArray; +use danog\AsyncOrm\FieldConfig; +use Traversable; + +/** + * Array caching proxy. + * + * @internal + * + * @template TKey as array-key + * @template TValue + * + * @extends DbArray + */ +final class CachedArray extends DbArray +{ + private readonly CacheContainer $cache; + + /** + * Get instance. + */ + public static function getInstance(FieldConfig $config, DbArray|null $previous): DbArray + { + $new = $config->settings->getDriverClass(); + if ($previous === null) { + $previous = new self($new::getInstance($config, null)); + } elseif ($previous instanceof self) { + $previous->cache->inner = $new::getInstance($config, $previous->cache->inner); + } else { + $previous = new self($new::getInstance($config, $previous)); + } + if ($previous->cache->inner instanceof MemoryArray) { + $previous->cache->flushCache(); + return $previous->cache->inner; + } + $previous->cache->startCacheCleanupLoop($config->annotation->cacheTtl); + return $previous; + } + + public function __construct(DbArray $inner) + { + $this->cache = new CacheContainer($inner); + } + + public function __destruct() + { + $this->cache->stopCacheCleanupLoop(); + } + + public function count(): int + { + return $this->cache->count(); + } + + public function clear(): void + { + $this->cache->clear(); + } + + public function get(mixed $index): mixed + { + return $this->cache->get($index); + } + + public function set(string|int $key, mixed $value): void + { + $this->cache->set($key, $value); + } + + public function unset(string|int $key): void + { + $this->cache->set($key, null); + } + + public function getIterator(): Traversable + { + return $this->cache->getIterator(); + } +} diff --git a/src/Internal/Driver/MysqlArray.php b/src/Internal/Driver/MysqlArray.php new file mode 100644 index 0000000..af2388e --- /dev/null +++ b/src/Internal/Driver/MysqlArray.php @@ -0,0 +1,286 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Internal\Driver; + +use Amp\Sql\SqlResult; +use Amp\Sync\LocalKeyedMutex; +use danog\AsyncOrm\Driver\Mysql; +use danog\AsyncOrm\Driver\SqlArray; +use danog\AsyncOrm\Exception; +use danog\AsyncOrm\Logger; +use danog\AsyncOrm\Settings\Database\Mysql as DatabaseMysql; +use PDO; +use Webmozart\Assert\Assert; + +/** + * MySQL database backend. + * + * @internal + * + * @template TKey as array-key + * @template TValue + * @extends SqlArray + */ +final class MysqlArray extends SqlArray +{ + // We're forced to use quoting (just like PDO does internally when using prepares) because native MySQL prepares are extremely slow. + protected PDO $pdo; + + /** + * Initialize on startup. + */ + public function initStartup(): void + { + $this->setTable($this->table); + $this->initConnection($this->dbSettings); + } + + /** + * Prepare statements. + * + * @param SqlArray::SQL_* $type + */ + protected function getSqlQuery(int $type): string + { + switch ($type) { + case SqlArray::SQL_GET: + return "SELECT `value` FROM `{$this->table}` WHERE `key` = :index LIMIT 1"; + case SqlArray::SQL_SET: + return " + REPLACE INTO `{$this->table}` + SET `key` = :index, `value` = :value + "; + case SqlArray::SQL_UNSET: + return " + DELETE FROM `{$this->table}` + WHERE `key` = :index + "; + case SqlArray::SQL_COUNT: + return " + SELECT count(`key`) as `count` FROM `{$this->table}` + "; + case SqlArray::SQL_ITERATE: + return " + SELECT `key`, `value` FROM `{$this->table}` + "; + case SqlArray::SQL_CLEAR: + return " + DELETE FROM `{$this->table}` + "; + } + throw new Exception("An invalid statement type $type was provided!"); + } + + /** + * Perform async request to db. + * + */ + protected function execute(string $sql, array $params = []): SqlResult + { + foreach ($params as $key => $value) { + $value = $this->pdo->quote($value); + $sql = \str_replace(":$key", $value, $sql); + } + + return $this->db->query($sql); + } + + /** @var array */ + private static array $connections = []; + + private static ?LocalKeyedMutex $mutex = null; + /** @return list{MysqlConnectionPool, \PDO} */ + public static function getConnection(DatabaseMysql $settings): array + { + self::$mutex ??= new LocalKeyedMutex; + $dbKey = $settings->getDbIdentifier(); + $lock = self::$mutex->acquire($dbKey); + + try { + if (!isset(self::$connections[$dbKey])) { + $host = \str_replace(['tcp://', 'unix://'], '', $settings->getUri()); + if ($host[0] === '/') { + $port = 0; + } else { + $host = \explode(':', $host, 2); + if (\count($host) === 2) { + [$host, $port] = $host; + } else { + $host = $host[0]; + $port = MysqlConfig::DEFAULT_PORT; + } + } + $config = new MysqlConfig( + host: $host, + port: (int) $port, + user: $settings->getUsername(), + password: $settings->getPassword(), + database: $settings->getDatabase() + ); + + self::createDb($config); + + $host = $config->getHost(); + $port = $config->getPort(); + if (!\extension_loaded('pdo_mysql')) { + throw Exception::extension('pdo_mysql'); + } + + try { + $pdo = new PDO( + $host[0] === '/' + ? "mysql:unix_socket={$host};charset=UTF8" + : "mysql:host={$host};port={$port};charset=UTF8", + $settings->getUsername(), + $settings->getPassword(), + ); + } catch (PDOException $e) { + $config = $config->withPassword(null); + try { + $pdo = new PDO( + $host[0] === '/' + ? "mysql:unix_socket={$host};charset=UTF8" + : "mysql:host={$host};port={$port};charset=UTF8", + $settings->getUsername(), + ); + } catch (\Throwable) { + throw $e; + } + } + + self::$connections[$dbKey] = [ + new MysqlConnectionPool($config, $settings->getMaxConnections(), $settings->getIdleTimeout()), + $pdo, + ]; + } + } finally { + EventLoop::queue($lock->release(...)); + } + + return self::$connections[$dbKey]; + } + + private static function createDb(MysqlConfig $config): void + { + try { + $db = $config->getDatabase(); + $connection = new MysqlConnectionPool($config->withDatabase(null)); + $connection->query(" + CREATE DATABASE IF NOT EXISTS `{$db}` + CHARACTER SET 'utf8mb4' + COLLATE 'utf8mb4_general_ci' + "); + try { + $max = (int) $connection->query("SHOW VARIABLES LIKE 'max_connections'")->fetchRow()['Value']; + if ($max < 100000) { + $connection->query("SET GLOBAL max_connections = 100000"); + } + } catch (Throwable) { + } + $connection->close(); + } catch (Throwable $e) { + Logger::log("An error occurred while trying to create the database: ".$e->getMessage(), Logger::ERROR); + } + } + + /** + * Initialize connection. + */ + public function initConnection(DatabaseMysql $settings): void + { + if (isset($this->db)) { + return; + } + [$this->db, $this->pdo] = self::getConnection($settings); + } + + /** + * Create table for property. + */ + protected function prepareTable(): void + { + //Logger::log("Creating/checking table {$this->table}", Logger::WARNING); + \assert($this->dbSettings instanceof DatabaseMysql); + $keyType = $this->dbSettings->keyType; + $valueType = $this->dbSettings->valueType; + + $this->db->query(" + CREATE TABLE IF NOT EXISTS mgmt + ( + `tableName` VARCHAR(255) NOT NULL, + `versionInfo` LONGBLOB NOT NULL, + PRIMARY KEY (`tableName`) + ) + ENGINE = InnoDB + CHARACTER SET 'utf8mb4' + COLLATE 'utf8mb4_general_ci' + "); + + $version = $this->db->prepare("SELECT version FROM mgmt WHERE tableName=?")->execute([$this->table])->fetchRow()['versionInfo'] ?? null; + + if ($version === null) { + $this->db->query(" + CREATE TABLE IF NOT EXISTS `{$this->table}` + ( + `key` $keyType NOT NULL, + `value` LONGBLOB NOT NULL, + PRIMARY KEY (`key`) + ) + ENGINE = InnoDB + CHARACTER SET 'utf8mb4' + COLLATE 'utf8mb4_general_ci' + "); + } + if ($version < 1) { + } + if ($version < 2) { + $this->db->query("ALTER TABLE `{$this->table}` MODIFY `key` BIGINT"); + $this->db->query("ALTER TABLE `{$this->table}` DROP `ts`"); + } + $this->db->prepare("REPLACE INTO mgmt SET version=? WHERE tableName=?")->execute([self::V, $this->table]); + + if ($this->dbSettings->getOptimizeIfWastedGtMb() !== null) { + try { + $database = $this->dbSettings->getDatabase(); + $result = $this->db->prepare("SELECT data_free FROM information_schema.tables WHERE table_schema=? AND table_name=?") + ->execute([$database, $this->table]) + ->fetchRow(); + Assert::notNull($result); + $result = $result['data_free'] ?? $result['DATA_FREE']; + if (($result >> 20) > $this->dbSettings->getOptimizeIfWastedGtMb()) { + $this->db->query("OPTIMIZE TABLE `{$this->table}`"); + } + } catch (\Throwable $e) { + Logger::log("An error occurred while optimizing the table: $e", Logger::ERROR); + } + } + } + + protected function importFromTable(string $fromTable): void + { + $this->db->query(" + REPLACE INTO `{$this->config->table}` + SELECT * FROM `{$fromTable}`; + "); + + $this->db->query(" + DROP TABLE `{$fromTable}`; + "); + } +} diff --git a/src/Internal/Driver/PostgresArray.php b/src/Internal/Driver/PostgresArray.php new file mode 100644 index 0000000..c0757c1 --- /dev/null +++ b/src/Internal/Driver/PostgresArray.php @@ -0,0 +1,155 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Internal\Driver; + +use Amp\Postgres\PostgresConfig; +use Amp\Postgres\PostgresConnectionPool; +use Amp\Sync\LocalKeyedMutex; +use danog\AsyncOrm\Driver\SqlArray; +use danog\AsyncOrm\FieldConfig; +use danog\AsyncOrm\KeyType; +use danog\AsyncOrm\Serializer; +use danog\AsyncOrm\Serializer\ByteaSerializer; +use danog\AsyncOrm\Settings\Postgres; +use danog\AsyncOrm\ValueType; +use Revolt\EventLoop; + +/** + * Postgres database backend. + * + * @internal + * @template TKey as array-key + * @template TValue + * @extends SqlArray + */ +class PostgresArray extends SqlArray +{ + /** @var array */ + private static array $connections = []; + + private static ?LocalKeyedMutex $mutex = null; + public function __construct(FieldConfig $config, Serializer $serializer) + { + self::$mutex ??= new LocalKeyedMutex; + $settings = $config->settings; + \assert($settings instanceof Postgres); + + $dbKey = $settings->getDbIdentifier(); + $lock = self::$mutex->acquire($dbKey); + + try { + if (!isset(self::$connections[$dbKey])) { + $host = \str_replace(['tcp://', 'unix://'], '', $settings->uri); + if ($host[0] === '/') { + $port = 0; + } else { + $host = \explode(':', $host, 2); + if (\count($host) === 2) { + [$host, $port] = $host; + } else { + $host = $host[0]; + $port = PostgresConfig::DEFAULT_PORT; + } + } + $config = new PostgresConfig( + host: $host, + port: (int) $port, + user: $settings->username, + password: $settings->password, + database: $settings->database + ); + + $db = $config->getDatabase(); + $user = $config->getUser(); + $connection = new PostgresConnectionPool($config->withDatabase(null)); + + $result = $connection->query("SELECT * FROM pg_database WHERE datname = '{$db}'"); + + // Replace with getRowCount once it gets fixed + if (!\iterator_count($result)) { + $connection->query(" + CREATE DATABASE {$db} + OWNER {$user} + ENCODING utf8 + "); + } + $connection->close(); + + self::$connections[$dbKey] = new PostgresConnectionPool($config, $settings->maxConnections, $settings->idleTimeoutgetIdleTimeout()); + } + } finally { + EventLoop::queue($lock->release(...)); + } + + $connection = self::$connections[$dbKey]; + + $keyType = match ($config->annotation->keyType) { + KeyType::STRING_OR_INT => "VARCHAR(255)", + KeyType::STRING => "VARCHAR(255)", + KeyType::INT => "BIGINT", + }; + $valueType = match ($config->annotation->valueType) { + ValueType::INT => "BIGINT", + ValueType::STRING => "VARCHAR(255)", + default => "BYTEA", + }; + $serializer = match ($config->annotation->valueType) { + ValueType::INT, ValueType::STRING => $serializer, + default => new ByteaSerializer($serializer) + }; + + $connection->query(" + CREATE TABLE IF NOT EXISTS \"bytea_{$config->table}\" + ( + \"key\" $keyType PRIMARY KEY NOT NULL, + \"value\" $valueType NOT NULL + ); + "); + + parent::__construct( + $config, + $serializer, + $connection, + "SELECT value FROM \"bytea_{$config->table}\" WHERE key = :index", + " + INSERT INTO \"bytea_{$config->table}\" + (key,value) + VALUES (:index, :value) + ON CONFLICT (key) DO UPDATE SET value = :value + ", + " + DELETE FROM \"bytea_{$config->table}\" + WHERE key = :index + ", + "SELECT count(key) as count FROM \"bytea_{$config->table}\"", + "SELECT key, value FROM \"bytea_{$config->table}\"", + "DELETE FROM \"bytea_{$config->table}\"" + ); + } + + protected function importFromTable(string $fromTable): void + { + $this->db->query(/** @lang PostgreSQL */ " + DROP TABLE \"bytea_{$this->config->table}\"; + "); + $this->db->query(/** @lang PostgreSQL */ " + ALTER TABLE \"bytea_$fromTable\" RENAME TO \"bytea_{$this->config->table}\"; + "); + } +} diff --git a/src/Internal/Driver/RedisArray.php b/src/Internal/Driver/RedisArray.php new file mode 100644 index 0000000..84999ac --- /dev/null +++ b/src/Internal/Driver/RedisArray.php @@ -0,0 +1,182 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Internal\Driver; + +use Amp\Redis\Connection\ReconnectingRedisLink; +use Amp\Redis\RedisClient; +use Amp\Redis\RedisConfig; +use Amp\Serialization\PassthroughSerializer; +use Amp\Sync\LocalKeyedMutex; +use danog\AsyncOrm\Driver\DriverArray; +use danog\AsyncOrm\FieldConfig; +use danog\AsyncOrm\Serializer; +use danog\AsyncOrm\Serializer\IntString; +use danog\AsyncOrm\Serializer\Passthrough; +use danog\AsyncOrm\Settings\Redis; +use danog\AsyncOrm\ValueType; +use Revolt\EventLoop; + +use function Amp\Redis\createRedisConnector; + +/** + * Redis database backend. + * + * @internal + * + * @template TKey as array-key + * @template TValue + * @extends DriverArray + */ +final class RedisArray extends DriverArray +{ + /** @var array */ + private static array $connections = []; + private static ?LocalKeyedMutex $mutex = null; + + private readonly RedisClient $db; + + public function __construct(FieldConfig $config, Serializer $serializer) + { + if ($serializer instanceof Passthrough && $config->annotation->valueType === ValueType::INT) { + $serializer = new IntString; + } + parent::__construct($config, $serializer); + + self::$mutex ??= new LocalKeyedMutex; + \assert($config->settings instanceof Redis); + $dbKey = $config->settings->getDbIdentifier(); + $lock = self::$mutex->acquire($dbKey); + + try { + if (!isset(self::$connections[$dbKey])) { + $config = RedisConfig::fromUri($config->settings->uri) + ->withPassword($config->settings->password) + ->withDatabase($config->settings->database); + + self::$connections[$dbKey] = new RedisClient(new ReconnectingRedisLink(createRedisConnector($config))); + self::$connections[$dbKey]->ping(); + } + } finally { + EventLoop::queue($lock->release(...)); + } + $this->db = self::$connections[$dbKey]; + } + + protected function moveDataFromTableToTable(string $from, string $to): void + { + $from = "va:$from"; + $to = "va:$to"; + + $request = $this->db->scan($from.'*'); + + $lenK = \strlen($from); + foreach ($request as $oldKey) { + $newKey = $to.\substr($oldKey, $lenK); + $value = $this->db->get($oldKey); + $this->db->set($newKey, $value); + $this->db->delete($oldKey); + } + } + + /** + * Get redis key name. + */ + private function rKey(string $key): string + { + return 'va:'.$this->config->table.':'.$key; + } + + /** + * Get iterator key. + */ + private function itKey(): string + { + return 'va:'.$this->config->table.'*'; + } + + public function set(string|int $key, mixed $value): void + { + $this->db->set($this->rKey((string) $key), $this->serializer->serialize($value)); + } + + public function get(mixed $offset): mixed + { + $offset = (string) $offset; + + $value = $this->db->get($this->rKey($offset)); + + if ($value !== null) { + $value = $this->serializer->deserialize($value); + } + + return $value; + } + + public function unset(string|int $key): void + { + $this->db->delete($this->rkey((string) $key)); + } + + /** + * Get iterator. + * + * @return \Traversable + */ + public function getIterator(): \Traversable + { + $request = $this->db->scan($this->itKey()); + + $len = \strlen($this->rKey('')); + foreach ($request as $key) { + yield \substr($key, $len) => $this->serializer->deserialize($this->db->get($key)); + } + } + + /** + * Count elements. + * + * @link https://php.net/manual/en/arrayiterator.count.php + * @return int The number of elements or public properties in the associated + * array or object, respectively. + */ + public function count(): int + { + return \iterator_count($this->db->scan($this->itKey())); + } + + /** + * Clear all elements. + */ + public function clear(): void + { + $request = $this->db->scan($this->itKey()); + + $keys = []; + foreach ($request as $key) { + $keys[] = $key; + if (\count($keys) === 10) { + $this->db->delete(...$keys); + $keys = []; + } + } + if ($keys) { + $this->db->delete(...$keys); + } + } +} diff --git a/src/KeyType.php b/src/KeyType.php new file mode 100644 index 0000000..a41617d --- /dev/null +++ b/src/KeyType.php @@ -0,0 +1,36 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm; + +/** + * Specifies the type of keys. + */ +enum KeyType: string +{ + /** + * Strings or integers. + */ + case STRING_OR_INT = 'string_or_int'; + /** + * Only strings. + */ + case STRING = 'string'; + /** + * Only integers. + */ + case INT = 'int'; +} diff --git a/src/Serializer.php b/src/Serializer.php new file mode 100644 index 0000000..798a92a --- /dev/null +++ b/src/Serializer.php @@ -0,0 +1,28 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm; + +/** + * Serializer interface. + */ +interface Serializer +{ + public function serialize(mixed $value): mixed; + public function deserialize(mixed $value): mixed; +} diff --git a/src/Serializer/ByteaSerializer.php b/src/Serializer/ByteaSerializer.php new file mode 100644 index 0000000..5739a74 --- /dev/null +++ b/src/Serializer/ByteaSerializer.php @@ -0,0 +1,40 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Serializer; + +use Amp\Postgres\PostgresByteA; +use danog\AsyncOrm\Serializer; + +/** @internal BYTEA serializer */ +final class ByteaSerializer implements Serializer +{ + public function __construct( + private readonly Serializer $inner + ) + { + } + public function serialize(mixed $value): mixed + { + return new PostgresByteA($this->inner->serialize($value)); + } + public function deserialize(mixed $value): mixed + { + return $this->inner->deserialize($value); + } +} diff --git a/src/Serializer/Igbinary.php b/src/Serializer/Igbinary.php new file mode 100644 index 0000000..f07a130 --- /dev/null +++ b/src/Serializer/Igbinary.php @@ -0,0 +1,34 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Serializer; + +use danog\AsyncOrm\Serializer; + +/** Igbinary serializer. */ +final class Igbinary implements Serializer +{ + public function serialize(mixed $value): mixed + { + return \igbinary_serialize($value); + } + public function deserialize(mixed $value): mixed + { + return \igbinary_unserialize($value); + } +} diff --git a/src/Serializer/IntString.php b/src/Serializer/IntString.php new file mode 100644 index 0000000..a6ecd6c --- /dev/null +++ b/src/Serializer/IntString.php @@ -0,0 +1,34 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Serializer; + +use danog\AsyncOrm\Serializer; + +/** Integer casting serializer */ +final class IntString implements Serializer +{ + public function serialize(mixed $value): mixed + { + return (string) $value; + } + public function deserialize(mixed $value): mixed + { + return (int) $value; + } +} diff --git a/src/Serializer/Json.php b/src/Serializer/Json.php new file mode 100644 index 0000000..f696933 --- /dev/null +++ b/src/Serializer/Json.php @@ -0,0 +1,34 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Serializer; + +use danog\AsyncOrm\Serializer; + +/** JSON serializer */ +final class Json implements Serializer +{ + public function serialize(mixed $value): mixed + { + return \json_encode($value, flags: JSON_THROW_ON_ERROR|JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES); + } + public function deserialize(mixed $value): mixed + { + return \json_decode($value, true, flags: JSON_THROW_ON_ERROR); + } +} diff --git a/src/Serializer/Native.php b/src/Serializer/Native.php new file mode 100644 index 0000000..3099c6b --- /dev/null +++ b/src/Serializer/Native.php @@ -0,0 +1,34 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Serializer; + +use danog\AsyncOrm\Serializer; + +/** Native serializer */ +final class Native implements Serializer +{ + public function serialize(mixed $value): mixed + { + return \serialize($value); + } + public function deserialize(mixed $value): mixed + { + return \unserialize($value); + } +} diff --git a/src/Serializer/Passthrough.php b/src/Serializer/Passthrough.php new file mode 100644 index 0000000..75fb420 --- /dev/null +++ b/src/Serializer/Passthrough.php @@ -0,0 +1,34 @@ +. + * + * @author Daniil Gentili + * @author Alexander Pankratov + * @copyright 2016-2024 Daniil Gentili + * @copyright 2016-2024 Alexander Pankratov + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Serializer; + +use danog\AsyncOrm\Serializer; + +/** Passthrough serializer */ +final class Passthrough implements Serializer +{ + public function serialize(mixed $value): mixed + { + return $value; + } + public function deserialize(mixed $value): mixed + { + return $value; + } +} diff --git a/src/Settings.php b/src/Settings.php new file mode 100644 index 0000000..b002580 --- /dev/null +++ b/src/Settings.php @@ -0,0 +1,26 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm; + +/** + * Base interface for ORM settings. + */ +interface Settings +{ + /** @return class-string */ + public function getDriverClass(): string; +} diff --git a/src/Settings/DriverSettings.php b/src/Settings/DriverSettings.php new file mode 100644 index 0000000..cf012e8 --- /dev/null +++ b/src/Settings/DriverSettings.php @@ -0,0 +1,44 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Settings; + +use danog\AsyncOrm\Serializer; +use danog\AsyncOrm\Settings; + +/** + * Base class for database backends. + */ +abstract readonly class DriverSettings implements Settings +{ + final public const DEFAULT_CACHE_TTL = 5*60; + public function __construct( + /** Serializer to use for object and mixed type values. */ + public Serializer $serializer, + /** + * @var int<0, max> $cacheTtl For how long to keep records in memory after last read. + */ + public int $cacheTtl = self::DEFAULT_CACHE_TTL, + ) { + } + + /** + * Get the DB's unique ID. + * + * @internal + */ + abstract public function getDbIdentifier(): string; +} diff --git a/src/Settings/Memory.php b/src/Settings/Memory.php new file mode 100644 index 0000000..1ebebcd --- /dev/null +++ b/src/Settings/Memory.php @@ -0,0 +1,31 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Settings; + +use danog\AsyncOrm\Driver\MemoryArray; +use danog\AsyncOrm\Settings; + +/** + * Memory backend settings. + */ +final readonly class Memory implements Settings +{ + public function getDriverClass(): string + { + return MemoryArray::class; + } +} diff --git a/src/Settings/Mysql.php b/src/Settings/Mysql.php new file mode 100644 index 0000000..f9df81f --- /dev/null +++ b/src/Settings/Mysql.php @@ -0,0 +1,61 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Settings; + +use Amp\Mysql\MysqlConfig; +use danog\AsyncOrm\Internal\Driver\MysqlArray; +use danog\AsyncOrm\Serializer; + +/** + * MySQL backend settings. + * + * MariaDb 10.2+ or Mysql 5.6+ required. + */ +final readonly class Mysql extends SqlSettings +{ + /** + * @param Serializer $serializer to use for object and mixed type values. + * @param int<0, max> $cacheTtl Cache TTL in seconds + * @param int<1, max> $maxConnections Maximum connection limit + * @param int<1, max> $idleTimeout Idle timeout + */ + public function __construct( + MysqlConfig $config, + Serializer $serializer, + int $cacheTtl = self::DEFAULT_CACHE_TTL, + int $maxConnections = self::DEFAULT_SQL_MAX_CONNECTIONS, + int $idleTimeout = self::DEFAULT_SQL_IDLE_TIMEOUT, + /** + * + * Whether to optimize MySQL tables automatically if more than the specified amount of megabytes is wasted by the MySQL engine. + * + * Be careful when tweaking this setting as it may lead to slowdowns on startup. + * + * A good setting is 10mb. + * + * @var int<1, max>|null $optimizeIfWastedGtMb + */ + public ?int $optimizeIfWastedGtMb = null, + ) { + parent::__construct($config, $serializer, $cacheTtl, $maxConnections, $idleTimeout); + } + + public function getDriverClass(): string + { + return MysqlArray::class; + } +} diff --git a/src/Settings/Postgres.php b/src/Settings/Postgres.php new file mode 100644 index 0000000..96c7ba1 --- /dev/null +++ b/src/Settings/Postgres.php @@ -0,0 +1,48 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Settings; + +use Amp\Postgres\PostgresConfig; +use Amp\Serialization\Serializer; +use danog\AsyncOrm\Internal\Driver\PostgresArray; + +/** + * Postgres backend settings. + */ +final readonly class Postgres extends SqlSettings +{ + /** + * @param Serializer $serializer to use for object and mixed type values. + * @param int<0, max> $cacheTtl Cache TTL in seconds + * @param int<1, max> $maxConnections Maximum connection limit + * @param int<1, max> $idleTimeout Idle timeout + */ + public function __construct( + PostgresConfig $config, + Serializer $serializer, + int $cacheTtl = self::DEFAULT_CACHE_TTL, + int $maxConnections = self::DEFAULT_SQL_MAX_CONNECTIONS, + int $idleTimeout = self::DEFAULT_SQL_IDLE_TIMEOUT, + ) { + parent::__construct($config, $serializer, $cacheTtl, $maxConnections, $idleTimeout); + } + + public function getDriverClass(): string + { + return PostgresArray::class; + } +} diff --git a/src/Settings/Redis.php b/src/Settings/Redis.php new file mode 100644 index 0000000..3c29db9 --- /dev/null +++ b/src/Settings/Redis.php @@ -0,0 +1,49 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Settings; + +use Amp\Redis\RedisConfig; +use danog\AsyncOrm\Internal\Driver\RedisArray; +use danog\AsyncOrm\Serializer; + +/** + * Redis backend settings. + */ +final readonly class Redis extends DriverSettings +{ + /** + * @param Serializer $serializer to use for object and mixed type values. + * @param int<0, max> $cacheTtl Cache TTL in seconds + */ + public function __construct( + public readonly RedisConfig $config, + Serializer $serializer, + int $cacheTtl = self::DEFAULT_CACHE_TTL, + ) { + parent::__construct($cacheTtl, $serializer); + } + /** @internal */ + public function getDbIdentifier(): string + { + $host = $this->config->getConnectUri(); + return "$host\0".$this->config->getDatabase(); + } + public function getDriverClass(): string + { + return RedisArray::class; + } +} diff --git a/src/Settings/SqlSettings.php b/src/Settings/SqlSettings.php new file mode 100644 index 0000000..dae15bb --- /dev/null +++ b/src/Settings/SqlSettings.php @@ -0,0 +1,78 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm\Settings; + +use Amp\Sql\SqlConfig; +use danog\AsyncOrm\Serializer; + +/** + * Generic SQL db backend settings. + */ +abstract readonly class SqlSettings extends DriverSettings +{ + final public const DEFAULT_SQL_MAX_CONNECTIONS = 100; + final public const DEFAULT_SQL_IDLE_TIMEOUT = 60; + /** + * Database password. + */ + public string $database; + /** + * Database username. + */ + public string $username; + /** + * Database password. + */ + public string $password; + /** + * Maximum connection limit. + * + * @var positive-int + */ + public int $maxConnections; + /** + * Idle timeout. + * + * @var positive-int + */ + public int $idleTimeout; + + /** + * @param Serializer $serializer to use for object and mixed type values. + * @param int<0, max> $cacheTtl Cache TTL in seconds + * @param int<1, max> $maxConnections Maximum connection limit + * @param int<1, max> $idleTimeout Idle timeout + */ + public function __construct( + public readonly SqlConfig $config, + Serializer $serializer, + int $cacheTtl = self::DEFAULT_CACHE_TTL, + int $maxConnections = self::DEFAULT_SQL_MAX_CONNECTIONS, + int $idleTimeout = self::DEFAULT_SQL_IDLE_TIMEOUT, + ) { + parent::__construct($serializer, $cacheTtl); + $this->maxConnections = $maxConnections; + $this->idleTimeout = $idleTimeout; + } + /** @internal */ + public function getDbIdentifier(): string + { + $host = $this->config->getHost(); + $port = $this->config->getPort(); + return "$host:$port:".$this->config->getDatabase(); + } +} diff --git a/src/ValueType.php b/src/ValueType.php new file mode 100644 index 0000000..e591936 --- /dev/null +++ b/src/ValueType.php @@ -0,0 +1,42 @@ +. + * + * @author Daniil Gentili + * @copyright 2016-2023 Daniil Gentili + * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 + * @link https://daniil.it/AsyncOrm AsyncOrm documentation + */ + +namespace danog\AsyncOrm; + +/** + * Specifies the serializer to use when saving values. + */ +enum ValueType: string +{ + /** + * Direct storage of UTF-8 string values. + */ + case STRING = 'string'; + /** + * Direct storage of integer values. + */ + case INT = 'int'; + /** + * Objects, serialized as specified in the settings. + */ + case OBJECT = 'object'; + /** + * Values of any type, serialized as specified in the settings. + * + * Using MIXED worsens performances, please use STRING, INT or OBJECT whenever possible. + */ + case MIXED = 'object'; +}