commit a061178ac162aadd1f0f0f88ebea49333b0710e2 Author: Anton Tarasenko Date: Thu Nov 18 12:27:39 2021 +0700 Initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/sources/AcediaAdmin.uc b/sources/AcediaAdmin.uc new file mode 100644 index 0000000..9ed71bb --- /dev/null +++ b/sources/AcediaAdmin.uc @@ -0,0 +1,40 @@ +/** + * Config object for `AcediaAdmin_Feature`. + * Copyright 2021 Anton Tarasenko + *------------------------------------------------------------------------------ + * This file is part of Acedia. + * + * Acedia is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, version 3 of the License, or + * (at your option) any later version. + * + * Acedia 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Acedia. If not, see . + */ +class AcediaAdmin extends FeatureConfig + perobjectconfig + config(AcediaAdmin); + +protected function AssociativeArray ToData() +{ + return _.collections.EmptyAssociativeArray(); +} + +protected function FromData(AssociativeArray source) +{ +} + +protected function DefaultIt() +{ +} + +defaultproperties +{ + configName = "AcediaAdmin" +} \ No newline at end of file diff --git a/sources/AcediaAdmin_Feature.uc b/sources/AcediaAdmin_Feature.uc new file mode 100644 index 0000000..258967f --- /dev/null +++ b/sources/AcediaAdmin_Feature.uc @@ -0,0 +1,59 @@ +/** + * This is the AcediaAdmin feature, whose main purpose is to register commands + * from its package. + * Copyright 2021 Anton Tarasenko + *------------------------------------------------------------------------------ + * This file is part of Acedia. + * + * Acedia is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, version 3 of the License, or + * (at your option) any later version. + * + * Acedia 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Acedia. If not, see . + */ +class AcediaAdmin_Feature extends Feature; + +var LoggerAPI.Definition errNoCommandsFeature; + +protected function OnEnabled() +{ + local Commands_Feature commandsFeature; + commandsFeature = + Commands_Feature(class'Commands_Feature'.static.GetInstance()); + if (commandsFeature == none) + { + _.logger.Auto(errNoCommandsFeature); + return; + } + commandsFeature.RegisterCommand(class'ACommandDosh'); + commandsFeature.RegisterCommand(class'ACommandNick'); + commandsFeature.RegisterCommand(class'ACommandTrader'); + commandsFeature.RegisterCommand(class'ACommandDB'); +} + +protected function OnDisabled() +{ + local Commands_Feature commandsFeature; + commandsFeature = + Commands_Feature(class'Commands_Feature'.static.GetInstance()); + if (commandsFeature != none) + { + commandsFeature.RemoveCommand(class'ACommandDosh'); + commandsFeature.RemoveCommand(class'ACommandNick'); + commandsFeature.RemoveCommand(class'ACommandTrader'); + commandsFeature.RemoveCommand(class'ACommandDB'); + } +} + +defaultproperties +{ + configClass = class'AcediaAdmin' + errNoCommandsFeature = (l=LOG_Error,m="`Commands_Feature` is not detected, \"AcediaAdmin\" will not be able to provide its functionality.") +} \ No newline at end of file diff --git a/sources/Commands/ACommandDB.uc b/sources/Commands/ACommandDB.uc new file mode 100644 index 0000000..b300717 --- /dev/null +++ b/sources/Commands/ACommandDB.uc @@ -0,0 +1,491 @@ +/** + * Command for working with databases. + * Copyright 2021 Anton Tarasenko + *------------------------------------------------------------------------------ + * This file is part of Acedia. + * + * Acedia is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, version 3 of the License, or + * (at your option) any later version. + * + * Acedia 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Acedia. If not, see . + */ +class ACommandDB extends Command + dependson(Database); + +/** + * This command provides a text user interface to databases. + * It can perform two types of tasks: + * 1. Tasks that have to do with managing set of databases as a whole: + * listing them, their creation and deletion. For currently implemented + * local databases they work synchronously and are just simple bindings + * to the Acedia's API. + * 2. Tasks that edit a particular database: these require us to send + * database a query and then wait for the response. With these we + * cannot give an immediate reply, so we have to remember player that + * requested these queries to then relay him database's reply. + * Main problem with remembering a player for 2nd-type tasks is that, + * while highly unlikely, several different players may make their own requests + * while we are still waiting for the reply to the previous query. + * We could simply remember a queue of several players and then return them in + * a FIFO order (since databases guarantee orderly replies to their queries), + * but requests can also be towards different databases and, therefore, + * completed in a random order. + * To solve this we fill-in the waiting queue of pairs player-database that + * link player that made a request and database he made this request to. + * Once reply from any database arrives - we simply search and return + * the first player in our queue that made a request to this database. + * Thanks to the fact that databases reply to their queries in order of + * arrival - this will let us fetch precisely the players that were responsible + * for these requests. This logic is implemented in `PushPlayer()` and + * `PopPlayer()` methods. + * The rest of the methods are mostly straightforward callbacks that + * transform `Database`'s reply into text message for the player. + */ + +// Array of pairs is represented by two arrays of single values. +// Arrays should be kept same length, elements with the same index +// correspond to the same pair. +var protected array queueWaitingListDatabases; +var protected array queueWaitingListPlayers; + +// Auxiliary structure that corresponds to database + JSON path from resolved +// database link. +struct DBPointerPair +{ + var public Database database; + var public JSONPointer pointer; +}; + +var protected const int TCREATE, TDELETE, TLIST, TREAD, TSIZE, TKEYS, TREMOVE; +var protected const int TWRITE, TWRITE_ARRAY, TWRITE_NULL, TWRITE_BOOLEAN; +var protected const int TWRITE_INTEGER, TWRITE_FLOAT, TWRITE_STRING, TINCREMENT; +var protected const int TDATABASE_NAME, TDATABASE_LINK, TJSON_VALUE; +var protected const int TOBJECT_KEYS_ARE, TOBJECT_SIZE_IS, TQUERY_COMPLETED; +var protected const int TQUERY_INVALID_POINTER, TQUERY_INVALID_DB; +var protected const int TQUERY_INVALID_DATA, TAVAILABLE_DATABASES, TDA_DELETED; +var protected const int TDB_DOESNT_EXIST, TDB_ALREADY_EXISTS, TDB_CREATED; +var protected const int TDB_CANNOT_BE_CREATED, TNO_DEFAULT_COMMAND, TBAD_DBLINK; + +protected function BuildData(CommandDataBuilder builder) +{ + builder.Name(P("db")).Summary(P("Read and edit data in your databases." + @ "Databases' values are addressed with links:" + @ "\":\"")); + builder.SubCommand(T(TCREATE)) + .ParamText(T(TDATABASE_NAME)) + .Describe(P("Creates new database with a specified name.")); + builder.SubCommand(T(TDELETE)) + .ParamText(T(TDATABASE_NAME)) + .Describe(P("Completely deletes specified database.")); + builder.SubCommand(T(TLIST)) + .Describe(P("Lists available databases.")); + builder.SubCommand(T(TREAD)) + .ParamText(T(TDATABASE_LINK)) + .Describe(P("Reads data from location given by the `databaseLink`.")); + builder.SubCommand(T(TSIZE)) + .ParamText(T(TDATABASE_LINK)) + .Describe(P("Gets amount of elements inside JSON array or object at" + @ "location given by the `databaseLink`.")); + builder.SubCommand(T(TKEYS)) + .ParamText(T(TDATABASE_LINK)) + .Describe(P("Lists keys of JSON object at location given by" + @ "the `databaseLink`.")); + builder.SubCommand(T(TREMOVE)) + .ParamText(T(TDATABASE_LINK)) + .Describe(P("Removes data from location given by the `databaseLink`.")); + builder.SubCommand(T(TWRITE)) + .ParamText(T(TDATABASE_LINK)) + .ParamObject(T(TJSON_VALUE)) + .Describe(P("Writes specified JSON object into location given by" + @ "the `databaseLink`.")); + builder.SubCommand(T(TWRITE_ARRAY)) + .ParamText(T(TDATABASE_LINK)) + .ParamArray(T(TJSON_VALUE)) + .Describe(P("Writes specified JSON array into location given by" + @ "the `databaseLink`.")); + builder.SubCommand(T(TWRITE_NULL)) + .ParamText(T(TDATABASE_LINK)) + .Describe(P("Writes specified null value into location given by" + @ "the `databaseLink`.")); + builder.SubCommand(T(TWRITE_BOOLEAN)) + .ParamText(T(TDATABASE_LINK)) + .ParamBoolean(T(TJSON_VALUE)) + .Describe(P("Writes specified JSON boolean into location given by" + @ "the `databaseLink`.")); + builder.SubCommand(T(TWRITE_INTEGER)) + .ParamText(T(TDATABASE_LINK)) + .ParamInteger(T(TJSON_VALUE)) + .Describe(P("Writes specified integer as JSON number into location" + @ "given by the `databaseLink`.")); + builder.SubCommand(T(TWRITE_FLOAT)) + .ParamText(T(TDATABASE_LINK)) + .ParamNumber(T(TJSON_VALUE)) + .Describe(P("Writes specified float as JSON number into location" + @ "given by the `databaseLink`.")); + builder.SubCommand(T(TWRITE_STRING)) + .ParamText(T(TDATABASE_LINK)) + .ParamText(T(TJSON_VALUE)) + .Describe(P("Writes specified JSON string into location given by" + @ "the `databaseLink`.")); + builder.Option(T(TINCREMENT)) + .Describe(F("Specifying this option for any of the" + @ "{$TextEmphasis 'write'} subcommands will cause them to append" + @ "data to the old one, instead of rewriting it.")); +} + +protected function PushPlayer(APlayer nextPlayer, Database callDatabase) +{ + queueWaitingListPlayers[queueWaitingListPlayers.length] = nextPlayer; + queueWaitingListDatabases[queueWaitingListDatabases.length] = callDatabase; +} + +protected function APlayer PopPlayer(Database relevantDatabase) +{ + local int i; + local APlayer result; + if (queueWaitingListPlayers.length <= 0) return none; + if (queueWaitingListDatabases.length <= 0) return none; + + while (i < queueWaitingListDatabases.length) + { + if (queueWaitingListDatabases[i] != relevantDatabase) + { + result = queueWaitingListPlayers[i]; + queueWaitingListPlayers.Remove(i, 1); + queueWaitingListDatabases.Remove(i, 1); + break; + } + i += 1; + } + if (result != none && result.IsConnected()) { + return result; + } + return none; +} + +protected function Executed(CommandCall result) +{ + local AcediaObject valueToWrite; + local DBPointerPair pair; + local Text subCommand; + subCommand = result.GetSubCommand(); + // Try executing on of the operation that manage multiple databases + if (TryAPICallCommands(subCommand, result)) { + return; + } + // If we have failed - it has got to be one of the operations on + // a single database + pair = TryLoadingDB(result.GetParameters().GetText(T(TDATABASE_LINK))); + if (pair.database == none) + { + result.GetCallerPlayer().Console().WriteLine(T(TBAD_DBLINK)); + return; + } + // Remember the last player we are making a query to and make that query + PushPlayer(result.GetCallerPlayer(), pair.database); + if (subCommand.StartsWith(T(TWRITE))) + { + valueToWrite = result.GetParameters().GetItem(T(TJSON_VALUE)); + if (result.GetOptions().HasKey(T(TINCREMENT))) + { + pair.database.IncrementData(pair.pointer, valueToWrite) + .connect = DisplayResponse; + } + else + { + pair.database.WriteData(pair.pointer, valueToWrite) + .connect = DisplayResponse; + } + } + else if (subCommand.Compare(T(TREAD))) { + pair.database.ReadData(pair.pointer).connect = DisplayData; + } + else if (subCommand.Compare(T(TSIZE))) { + pair.database.GetDataSize(pair.pointer).connect = DisplaySize; + } + else if (subCommand.Compare(T(TKEYS))) { + pair.database.GetDataKeys(pair.pointer).connect = DisplayKeys; + } + else if (subCommand.Compare(T(TREMOVE))) { + pair.database.RemoveData(pair.pointer).connect = DisplayResponse; + } + _.memory.Free(pair.pointer); +} + +// Simple API calls +private function bool TryAPICallCommands( + Text subCommand, + CommandCall result) +{ + local APlayer callerPlayer; + local AssociativeArray commandParameters; + callerPlayer = result.GetCallerPlayer(); + commandParameters = result.GetParameters(); + if (subCommand.IsEmpty()) + { + callerPlayer.Console().WriteLine(T(TNO_DEFAULT_COMMAND)); + return true; + } + else if (subCommand.Compare(T(TLIST))) + { + ListDatabases(callerPlayer); + return true; + } + else if (subCommand.Compare(T(TCREATE))) + { + CreateDatabase( callerPlayer, + commandParameters.GetText(T(TDATABASE_NAME))); + return true; + } + else if (subCommand.Compare(T(TDELETE))) + { + DeleteDatabase( callerPlayer, + commandParameters.GetText(T(TDATABASE_NAME))); + return true; + } + return false; +} + +// json pointer as `Text` -> `DBPointerPair` representation converter method +private function DBPointerPair TryLoadingDB(Text databaseLink) +{ + local DBPointerPair result; + if (databaseLink == none) { + return result; + } + result.database = _.db.Load(databaseLink); + if (result.database == none) { + return result; + } + result.pointer = _.db.GetPointer(databaseLink); + return result; +} + +protected function CreateDatabase(APlayer callerPlayer, Text databaseName) +{ + if (callerPlayer == none) { + return; + } + if (_.db.ExistsLocal(databaseName)) + { + callerPlayer.Console().WriteLine(T(TDB_ALREADY_EXISTS)); + return; + } + if (_.db.NewLocal(databaseName) != none) { + callerPlayer.Console().WriteLine(T(TDB_CREATED)); + } + else { + callerPlayer.Console().WriteLine(T(TDB_CANNOT_BE_CREATED)); + } +} + +protected function DeleteDatabase(APlayer callerPlayer, Text databaseName) +{ + if (callerPlayer == none) { + return; + } + if (_.db.DeleteLocal(databaseName)) { + callerPlayer.Console().WriteLine(T(TDA_DELETED)); + } + else { + callerPlayer.Console().WriteLine(T(TDB_DOESNT_EXIST)); + } +} + +protected function ListDatabases(APlayer callerPlayer) +{ + local int i; + local array availableDatabases; + local ConsoleWriter console; + if (callerPlayer == none) { + return; + } + availableDatabases = _.db.ListLocal(); + console = callerPlayer.Console(); + console.Write(T(TAVAILABLE_DATABASES)); + for (i = 0; i < availableDatabases.length; i += 1) + { + if (i > 0) { + console.ResetColor().Write(P(", ")); + } + console.UseColor(_.color.TextSubtle).Write(availableDatabases[i]); + } + console.ResetColor().Flush(); + _.memory.FreeMany(availableDatabases); +} + +protected function OutputStatus( + APlayer callerPlayer, + Database.DBQueryResult error) +{ + if (callerPlayer == none) { + return; + } + if (error == DBR_Success) { + callerPlayer.Console().WriteLine(T(TQUERY_COMPLETED)); + } + if (error == DBR_InvalidPointer) { + callerPlayer.Console().WriteLine(T(TQUERY_INVALID_POINTER)); + } + if (error == DBR_InvalidDatabase) { + callerPlayer.Console().WriteLine(T(TQUERY_INVALID_DB)); + } + if (error == DBR_InvalidData) { + callerPlayer.Console().WriteLine(T(TQUERY_INVALID_DATA)); + } +} + +protected function DisplayData( + Database.DBQueryResult result, + AcediaObject data, + Database source) +{ + local Text printedJSON; + local APlayer callerPlayer; + local Collection dataAsCollection; + callerPlayer = PopPlayer(source); + OutputStatus(callerPlayer, result); + if (callerPlayer != none && result == DBR_Success) + { + printedJSON = _.json.PrettyPrint(data); + callerPlayer.Console().Write(printedJSON).Flush(); + _.memory.Free(printedJSON); + } + dataAsCollection = Collection(data); + if (dataAsCollection != none) { + dataAsCollection.Empty(true); + } + _.memory.Free(data); +} + +protected function DisplaySize( + Database.DBQueryResult result, + int size, + Database source) +{ + local Text sizeAsText; + local APlayer callerPlayer; + callerPlayer = PopPlayer(source); + OutputStatus(callerPlayer, result); + if (callerPlayer != none && result == DBR_Success) + { + sizeAsText = _.text.FromInt(size); + callerPlayer.Console() + .Write(T(TOBJECT_SIZE_IS)) + .Write(sizeAsText) + .Flush(); + _.memory.Free(sizeAsText); + } +} + +protected function DisplayKeys( + Database.DBQueryResult result, + DynamicArray keys, + Database source) +{ + local int i; + local APlayer callerPlayer; + local ConsoleWriter console; + callerPlayer = PopPlayer(source); + OutputStatus(callerPlayer, result); + if (keys == none) { + return; + } + if (callerPlayer != none && result == DBR_Success) + { + console = callerPlayer.Console(); + console.Write(T(TOBJECT_KEYS_ARE)); + for (i = 0; i < keys.GetLength(); i += 1) + { + if (i > 0) { + console.ResetColor().Write(P(", ")); + } + console.UseColor(_.color.jPropertyName).Write(keys.GetText(i)); + } + console.Flush(); + } + _.memory.Free(keys); +} + +protected function DisplayResponse( + Database.DBQueryResult result, + Database source) +{ + OutputStatus(PopPlayer(source), result); +} + +defaultproperties +{ + TCREATE = 0 + stringConstants(0) = "create" + TDELETE = 1 + stringConstants(1) = "delete" + TLIST = 2 + stringConstants(2) = "list" + TREAD = 3 + stringConstants(3) = "read" + TSIZE = 4 + stringConstants(4) = "size" + TKEYS = 5 + stringConstants(5) = "keys" + TREMOVE = 6 + stringConstants(6) = "remove" + TWRITE = 7 + stringConstants(7) = "write" + TWRITE_ARRAY = 8 + stringConstants(8) = "write_array" + TWRITE_NULL = 9 + stringConstants(9) = "write_null" + TWRITE_BOOLEAN = 10 + stringConstants(10) = "write_boolean" + TWRITE_INTEGER = 11 + stringConstants(11) = "write_integer" + TWRITE_FLOAT = 12 + stringConstants(12) = "write_float" + TWRITE_STRING = 13 + stringConstants(13) = "write_string" + TINCREMENT = 14 + stringConstants(14) = "increment" + TDATABASE_NAME = 15 + stringConstants(15) = "databaseName" + TDATABASE_LINK = 16 + stringConstants(16) = "databaseLink" + TJSON_VALUE = 17 + stringConstants(17) = "jsonValue" + TOBJECT_KEYS_ARE = 18 + stringConstants(18) = "{$TextEmphasis Object keys are:} " + TOBJECT_SIZE_IS = 19 + stringConstants(19) = "{$TextEmphasis Object size is:} " + TQUERY_COMPLETED = 20 + stringConstants(20) = "{$TextPositive Database query was completed!}" + TQUERY_INVALID_POINTER = 21 + stringConstants(21) = "{$TextNegative Query was provided with an invalid JSON pointer.}" + TQUERY_INVALID_DB = 22 + stringConstants(22) = "{$TextNegative Operation could not finish because database is damaged and unusable.}" + TQUERY_INVALID_DATA = 23 + stringConstants(23) = "{$TextNegative Query data is invalid.}" + TAVAILABLE_DATABASES = 24 + stringConstants(24) = "{$TextEmphasis Available databases:} " + TDA_DELETED = 25 + stringConstants(25) = "{$TextPositive Database was deleted.}" + TDB_DOESNT_EXIST = 26 + stringConstants(26) = "{$TextNegative Database with specified name does not exist.}" + TDB_ALREADY_EXISTS = 27 + stringConstants(27) = "{$TextNegative Database with specified name already exists.}" + TDB_CREATED = 28 + stringConstants(28) = "{$TextPositive Database was created.}" + TDB_CANNOT_BE_CREATED = 29 + stringConstants(29) = "{$TextNegative Database cannot be created.}" + TNO_DEFAULT_COMMAND = 30 + stringConstants(30) = "{$TextNegative Default command does nothing. Use on of the sub-commands.}" + TBAD_DBLINK = 31 + stringConstants(31) = "{$TextNegative Database could not be read for the specified link.}" +} \ No newline at end of file diff --git a/sources/Commands/ACommandDosh.uc b/sources/Commands/ACommandDosh.uc new file mode 100644 index 0000000..8c0fb8f --- /dev/null +++ b/sources/Commands/ACommandDosh.uc @@ -0,0 +1,110 @@ +/** + * Command for changing amount of money players have. + * Copyright 2021 Anton Tarasenko + *------------------------------------------------------------------------------ + * This file is part of Acedia. + * + * Acedia is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, version 3 of the License, or + * (at your option) any later version. + * + * Acedia 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Acedia. If not, see . + */ +class ACommandDosh extends Command; + +var protected const int TGOTTEN, TLOST, TDOSH; + +protected function BuildData(CommandDataBuilder builder) +{ + builder.Name(P("dosh")).Summary(P("Changes amount of money.")); + builder.RequireTarget(); + builder.ParamInteger(P("amount")) + .Describe(P("Gives (or takes if negative) players a specified " + @ "of money.")); + builder.SubCommand(P("set")) + .ParamInteger(P("amount")) + .Describe(P("Sets player's money to a specified .")); + builder.Option(P("silent")) + .Describe(P("If specified - players won't receive a notification about" + @ "obtaining/losing dosh.")); + builder.Option(P("min")) + .ParamInteger(P("minValue")) + .Describe(F("Players will retain at least this amount of dosh after" + @ "the command's execution. In case of conflict, overrides" + @ "'{$TextEmphasis --max}' option. `0` is assumed by default.")); + builder.Option(P("max"), P("M")) + .ParamInteger(P("maxValue")) + .Describe(F("Players will have at most this amount of dosh after" + @ "the command's execution. In case of conflict, it is overridden" + @ "by '{$TextEmphasis --min}' option.")); +} + +protected function ExecutedFor(APlayer player, CommandCall result) +{ + local int oldAmount, newAmount; + local int amount, minValue, maxValue; + local AssociativeArray commandOptions; + // Find min and max value boundaries + commandOptions = result.GetOptions(); + minValue = commandOptions.GetIntBy(P("/min/minValue"), 0); + maxValue = commandOptions.GetIntBy(P("/max/maxValue"), MaxInt); + if (minValue > maxValue) { + maxValue = minValue; + } + // Change dosh + oldAmount = player.GetDosh(); + amount = result.GetParameters().GetInt(P("amount")); + if (result.GetSubCommand().IsEmpty()) { + newAmount = oldAmount + amount; + } + else { + // This has to be "dosh set" + newAmount = amount; + } + newAmount = Clamp(newAmount, minValue, maxValue); + // Announce dosh change, if necessary + if (!commandOptions.HasKey(P("silent"))) { + AnnounceDoshChange(player.Console(), oldAmount, newAmount); + } + player.SetDosh(newAmount); +} + +protected function AnnounceDoshChange( + ConsoleWriter console, + int oldAmount, + int newAmount) +{ + local Text amountDeltaAsText; + if (newAmount > oldAmount) + { + amountDeltaAsText = _.text.FromInt(newAmount - oldAmount); + console.Write(T(TGOTTEN)) + .Write(amountDeltaAsText) + .WriteLine(T(TDOSH)); + } + if (newAmount < oldAmount) + { + amountDeltaAsText = _.text.FromInt(oldAmount - newAmount); + console.Write(T(TLOST)) + .Write(amountDeltaAsText) + .WriteLine(T(TDOSH)); + } + _.memory.Free(amountDeltaAsText); +} + +defaultproperties +{ + TGOTTEN = 0 + stringConstants(0) = "You've {$TextPositive gotten} " + TLOST = 1 + stringConstants(1) = "You've {$TextNegative lost} " + TDOSH = 2 + stringConstants(2) = " dosh!" +} \ No newline at end of file diff --git a/sources/Commands/ACommandNick.uc b/sources/Commands/ACommandNick.uc new file mode 100644 index 0000000..7ddf8d4 --- /dev/null +++ b/sources/Commands/ACommandNick.uc @@ -0,0 +1,37 @@ +/** + * Command for changing nickname of the player. + * Copyright 2021 Anton Tarasenko + *------------------------------------------------------------------------------ + * This file is part of Acedia. + * + * Acedia is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, version 3 of the License, or + * (at your option) any later version. + * + * Acedia 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Acedia. If not, see . + */ +class ACommandNick extends Command; + +protected function BuildData(CommandDataBuilder builder) +{ + builder.Name(P("nick")).Summary(P("Changes nickname.")); + builder.RequireTarget(); + builder.ParamRemainder(P("nick")) + .Describe(P("Changes nickname of targeted players to .")); +} + +protected function ExecutedFor(APlayer player, CommandCall result) +{ + player.SetName(result.GetParameters().GetText(P("nick"))); +} + +defaultproperties +{ +} \ No newline at end of file diff --git a/sources/Commands/ACommandTrader.uc b/sources/Commands/ACommandTrader.uc new file mode 100644 index 0000000..2604dfb --- /dev/null +++ b/sources/Commands/ACommandTrader.uc @@ -0,0 +1,570 @@ +/** + * Command for managing trader time and traders. + * Copyright 2021 Anton Tarasenko + *------------------------------------------------------------------------------ + * This file is part of Acedia. + * + * Acedia is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, version 3 of the License, or + * (at your option) any later version. + * + * Acedia 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Acedia. If not, see . + */ +class ACommandTrader extends Command; + +var protected const int TLIST, TOPEN, TCLOSE, TENABLE, TDISABLE, TAUTO_OPEN; +var protected const int TTRADER, TTRADERS, TALL, TAUTO_OPEN_QUESTION, TQUOTE; +var protected const int TAUTO_OPEN_FLAG, TDISABLED_FLAG, TUNKNOWN_TRADERS; +var protected const int TLIST_TRADERS, TCOMMA_SPACE, TSELECTED_FLAG; +var protected const int TPARENTHESIS_OPEN, TPARENTHESIS_CLOSE; +var protected const int TSELECT, TIGNORE_DOORS, TBOOT, TTRADER_TIME, TTIME; +var protected const int TIGNORE_PLAYERS, TPAUSE, TUNPAUSE, TCANNOT_PARSE_PARAM; +var protected const int TCLOSEST, TSPACE; + +protected function BuildData(CommandDataBuilder builder) +{ + builder.Name(T(TTRADER)) + .Summary(P("Manages trader time and available traders.")) + .Describe(P("Enables of disables trading.")) + .ParamBoolean(T(TENABLE)); + builder.SubCommand(T(TTIME)) + .Describe(F("Changes current trader time if numeric value is specified." + @ "You can also pause trader countdown by specifying" + @ "{$TextEmphasis pause} or turn it back on with" + @ "{$TextEmphasis unpause}.")) + .ParamText(T(TTRADER_TIME)); + builder.SubCommand(T(TLIST)) + .Describe(P("Lists names of all available traders and" + @ "marks closest one to the caller.")); + builder.SubCommand(T(TOPEN)) + .Describe(P("Opens specified traders.")) + .OptionalParams() + .ParamTextList(T(TTRADERS)); + builder.SubCommand(T(TCLOSE)) + .Describe(P("Closes specified traders.")) + .OptionalParams() + .ParamTextList(T(TTRADERS)); + builder.SubCommand(T(TAUTO_OPEN)) + .Describe(P("Sets whether specified traders are open automatically.")) + .ParamBoolean(T(TAUTO_OPEN_QUESTION)) + .OptionalParams() + .ParamTextList(T(TTRADERS)); + builder.SubCommand(T(TSELECT)) + .Describe(P("Selects specified trader.")) + .OptionalParams() + .ParamText(T(TTRADER)); + builder.SubCommand(T(TBOOT)) + .Describe(P("Boots all players from specified traders. If no traders" + @ "were specified - assumes that all of them should be affected.")) + .OptionalParams() + .ParamTextList(T(TTRADERS)); + builder.SubCommand(T(TENABLE)) + .Describe(P("Enables specified traders.")) + .OptionalParams() + .ParamTextList(T(TTRADERS)); + builder.SubCommand(T(TDISABLE)) + .Describe(P("Disables specified traders.")) + .OptionalParams() + .ParamTextList(T(TTRADERS)); + builder.Option(T(TALL)) + .Describe(P("If sub-command targets shops, this flag will make it" + @ "target all the available shops.")); + builder.Option(T(TCLOSEST)) + .Describe(P("If sub-command targets shops, this flag will make it also" + @ "target closest shop to the caller.")); + builder.Option(T(TIGNORE_DOORS)) + .Describe(F("When used with {$TextEmphasis select} sub-command, it will" + @ "neither open or close doors.")); + builder.Option(T(TIGNORE_PLAYERS), P("I")) + .Describe(P("Normally commands that close doors will automatically boot" + @ "players from inside to prevent locking them in. This flag forces" + @ "this command to leave players inside. However they can still be" + @ "booted out at the end of trading time. Also it is impossible to" + @ "disable the trader and not boot players inside it.")); +} + +protected function Executed(CommandCall result) +{ + local Text subCommand; + local AssociativeArray commandParameters, commandOptions; + subCommand = result.GetSubCommand(); + commandParameters = result.GetParameters(); + commandOptions = result.GetOptions(); + if (subCommand.IsEmpty()) { + _.kf.trading.SetTradingStatus(commandParameters.GetBool(T(TENABLE))); + } + else if (subCommand.Compare(T(TLIST))) { + ListTradersFor(result.GetCallerPlayer()); + } + else if (subCommand.Compare(T(TTIME), SCASE_INSENSITIVE)) { + HandleTraderTime(result); + } + else if (subCommand.Compare(T(TOPEN), SCASE_INSENSITIVE)) { + SetTradersOpen(true, result); + } + else if (subCommand.Compare(T(TCLOSE), SCASE_INSENSITIVE)) { + SetTradersOpen(false, result); + } + else if (subCommand.Compare(T(TSELECT), SCASE_INSENSITIVE)) { + SelectTrader(result); + } + else if (subCommand.Compare(T(TBOOT), SCASE_INSENSITIVE)) { + BootFromTraders(result); + } + else if (subCommand.Compare(T(TENABLE), SCASE_INSENSITIVE)) { + SetTradersEnabled(true, result); + } + else if (subCommand.Compare(T(TDISABLE), SCASE_INSENSITIVE)) { + SetTradersEnabled(false, result); + } + else if (subCommand.Compare(T(TAUTO_OPEN), SCASE_INSENSITIVE)) { + SetTradersAutoOpen(result); + } + subCommand.FreeSelf(); +} + +protected function ListTradersFor(APlayer target) +{ + local int i; + local ATrader closestTrader; + local ConsoleWriter console; + local array availableTraders; + if (target == none) { + return; + } + availableTraders = _.kf.trading.GetTraders(); + console = target.Console(); + console.Flush() + .UseColor(_.color.TextEmphasis) + .Write(T(TLIST_TRADERS)) + .ResetColor(); + closestTrader = FindClosestTrader(target); + for (i = 0; i < availableTraders.length; i += 1) + { + WriteTrader(availableTraders[i], availableTraders[i] == closestTrader, + console); + if (i != availableTraders.length - 1) { + console.Write(T(TCOMMA_SPACE)); + } + } + console.Flush(); +} + +protected function HandleTraderTime(CommandCall result) +{ + local int countDownValue; + local Text parameter; + local Parser parser; + local APlayer callerPlayer; + parameter = result.GetParameters().GetText(T(TTRADER_TIME)); + if (parameter.Compare(T(TPAUSE), SCASE_INSENSITIVE)) + { + _.kf.trading.SetCountDownPause(true); + return; + } + else if (parameter.Compare(T(TUNPAUSE), SCASE_INSENSITIVE)) + { + _.kf.trading.SetCountDownPause(false); + return; + } + parser = _.text.Parse(parameter); + if (parser.MInteger(countDownValue).Ok()) { + _.kf.trading.SetCountDown(countDownValue); + } + else + { + callerPlayer = result.GetCallerPlayer(); + if (callerPlayer != none) + { + callerPlayer.Console() + .UseColor(_.color.TextFailure) + .Write(T(TCANNOT_PARSE_PARAM)) + .WriteLine(parameter) + .ResetColor(); + } + } + parser.FreeSelf(); + +} + +protected function SetTradersOpen(bool doOpen, CommandCall result) +{ + local int i; + local bool needToBootPlayers; + local array selectedTraders; + selectedTraders = GetTradersArray(result); + needToBootPlayers = !doOpen + && !result.GetOptions().HasKey(T(TIGNORE_PLAYERS)); + for (i = 0; i < selectedTraders.length; i += 1) + { + selectedTraders[i].SetOpen(doOpen); + if (needToBootPlayers) { + selectedTraders[i].BootPlayers(); + } + } +} + +protected function SelectTrader(CommandCall result) +{ + local int i; + local APlayer callerPlayer; + local ConsoleWriter console; + local Text selectedTraderName, nextTraderName; + local ATrader previouslySelectedTrader; + local array availableTraders; + selectedTraderName = result.GetParameters().GetText(T(TTRADER)); + previouslySelectedTrader = _.kf.trading.GetSelectedTrader(); + // Corner case: no new trader + if (selectedTraderName == none) + { + _.kf.trading.SelectTrader(none); + HandleTraderSwap(result, none, availableTraders[i]); + return; + } + // Find new trader among available ones + availableTraders = _.kf.trading.GetTraders(); + for (i = 0; i < availableTraders.length; i += 1) + { + nextTraderName = availableTraders[i].GetName(); + if (selectedTraderName.Compare(nextTraderName)) + { + availableTraders[i].Select(); + HandleTraderSwap( result, previouslySelectedTrader, + availableTraders[i]); + nextTraderName.FreeSelf(); + return; + } + nextTraderName.FreeSelf(); + } + // If we have reached here: given trader name was invalid. + callerPlayer = result.GetCallerPlayer(); + if (callerPlayer != none) { + console = callerPlayer.Console(); + } + if (console != none) + { + console.Flush() + .UseColor(_.color.TextNegative).Write(T(TUNKNOWN_TRADERS)) + .ResetColor().WriteLine(selectedTraderName); + } +} + +// Boot players from the old trader iff +// 1. It's different from the new one (otherwise swapping means nothing); +// 2. Option "ignore-players" was not specified. +protected function HandleTraderSwap( + CommandCall result, + ATrader oldTrader, + ATrader newTrader) +{ + if (oldTrader == none) return; + if (oldTrader == newTrader) return; + if (result.GetOptions().HasKey(T(TIGNORE_DOORS))) return; + if (result.GetOptions().HasKey(T(TIGNORE_PLAYERS))) return; + + oldTrader.Close().BootPlayers(); + if (newTrader != none) { + newTrader.Open(); + } +} + +protected function BootFromTraders(CommandCall result) +{ + local int i; + local array selectedTraders; + selectedTraders = GetTradersArray(result); + if (selectedTraders.length <= 0) { + selectedTraders = _.kf.trading.GetTraders(); + } + for (i = 0; i < selectedTraders.length; i += 1) { + selectedTraders[i].BootPlayers(); + } +} + +protected function SetTradersEnabled(bool doEnable, CommandCall result) +{ + local int i; + local array selectedTraders; + selectedTraders = GetTradersArray(result); + for (i = 0; i < selectedTraders.length; i += 1) { + selectedTraders[i].SetEnabled(doEnable); + } +} + +protected function SetTradersAutoOpen(CommandCall result) +{ + local int i; + local bool doAutoOpen; + local array selectedTraders; + doAutoOpen = result.GetParameters().GetBool(T(TAUTO_OPEN_QUESTION)); + selectedTraders = GetTradersArray(result); + for (i = 0; i < selectedTraders.length; i += 1) { + selectedTraders[i].SetAutoOpen(doAutoOpen); + } +} + +// Reads traders specified for the command (if any). +// Assumes `result != none`. +protected function array GetTradersArray(CommandCall result) +{ + local int i, j; + local APLayer callerPlayer; + local Text nextTraderName; + local DynamicArray specifiedTrades; + local array resultTraders; + local array availableTraders; + // Boundary cases: all traders and no traders at all + availableTraders = _.kf.trading.GetTraders(); + if (result.GetOptions().HasKey(T(TALL))) { + return availableTraders; + } + // Add closest one, if flag tells us to + callerPlayer = result.GetCallerPlayer(); + if (result.GetOptions().HasKey(T(TCLOSEST))) + { + resultTraders = + InsertTrader(resultTraders, FindClosestTrader(callerPlayer)); + } + specifiedTrades = result.GetParameters().GetDynamicArray(T(TTRADERS)); + if (specifiedTrades == none) { + return resultTraders; + } + // We iterate over `availableTraders` in the outer loop because: + // 1. Each `ATrader` from `availableTraders` will be matched only once, + // ensuring that result will not contain duplicate instances; + // 2. `availableTraders.GetName()` creates a new `Text` copy and + // `specifiedTrades.GetText()` does not. + for (i = 0; i < availableTraders.length; i += 1) + { + nextTraderName = availableTraders[i].GetName(); + for (j = 0; j < specifiedTrades.GetLength(); j += 1) + { + if (nextTraderName.Compare(specifiedTrades.GetText(j))) + { + resultTraders = + InsertTrader(resultTraders, availableTraders[i]); + specifiedTrades.Remove(j, 1); + break; + } + } + nextTraderName.FreeSelf(); + if (specifiedTrades.GetLength() <= 0) { + break; + } + } + // Some of the remaining trader names inside `specifiedTrades` do not + // match any actual traders. Report it. + if (callerPlayer != none && specifiedTrades.GetLength() > 0) { + ReportUnknowTraders(specifiedTrades, callerPlayer.Console()); + } + return resultTraders; +} + +// Auxiliary method that adds `newTrader` into existing array of traders +// if it is still missing. +protected function array InsertTrader( + array traders, + ATrader newTrader) +{ + local int i; + if (newTrader == none) { + return traders; + } + for (i = 0; i < traders.length; i += 1) + { + if (traders[i] == newTrader) { + return traders; + } + } + traders[traders.length] = newTrader; + return traders; +} + +protected function ReportUnknowTraders( + DynamicArray specifiedTrades, + ConsoleWriter console) +{ + local int i; + if (console == none) return; + if (specifiedTrades == none) return; + + console.Flush() + .UseColor(_.color.TextNegative) + .Write(T(TUNKNOWN_TRADERS)) + .ResetColor(); + for (i = 0; i < specifiedTrades.GetLength(); i += 1) + { + console.Write(specifiedTrades.GetText(i)); + if (i != specifiedTrades.GetLength() - 1) { + console.Write(T(TCOMMA_SPACE)); + } + } + console.Flush(); +} + +// Find closest trader to the `target` player +protected function ATrader FindClosestTrader(APlayer target) +{ + local int i; + local float newDistance, bestDistance; + local ATrader bestTrader; + local array availableTraders; + local Vector targetLocation; + if (target == none) { + return none; + } + targetLocation = target.GetLocation(); + availableTraders = _.kf.trading.GetTraders(); + for (i = 0; i < availableTraders.length; i += 1) + { + newDistance = + VSizeSquared(availableTraders[i].GetLocation() - targetLocation); + if (bestTrader == none || newDistance < bestDistance) + { + bestTrader = availableTraders[i]; + bestDistance = newDistance; + } + } + return bestTrader; +} + +// Writes a trader name along with information on whether it's +// disabled / auto-open +protected function WriteTrader( + ATrader traderToWrite, + bool isClosestTrader, + ConsoleWriter console) +{ + local Text traderName; + if (traderToWrite == none) return; + if (console == none) return; + + console.Write(T(TQUOTE)); + if (traderToWrite.IsOpen()) { + console.UseColor(_.color.TextPositive); + } + else { + console.UseColor(_.color.TextNegative); + } + traderName = traderToWrite.GetName(); + console.Write(traderName) + .ResetColor() + .Write(T(TQUOTE)); + traderName.FreeSelf(); + WriteTraderTags(traderToWrite, isClosestTrader, console); +} + +protected function WriteTraderTags( + ATrader traderToWrite, + bool isClosest, + ConsoleWriter console) +{ + local bool hasTagsInFront; + local bool isAutoOpen, isSelected; + if (traderToWrite == none) { + return; + } + if (!traderToWrite.IsEnabled()) + { + console.Write(T(TDISABLED_FLAG)); + return; + } + isAutoOpen = traderToWrite.IsAutoOpen(); + isSelected = traderToWrite.IsSelected(); + if (!isAutoOpen && !isSelected && !isClosest) { + return; + } + console.Write(T(TSPACE)).Write(T(TPARENTHESIS_OPEN)); + if (isClosest) + { + console.Write(T(TCLOSEST)); + hasTagsInFront = true; + } + if (isAutoOpen) + { + if (hasTagsInFront) { + console.Write(T(TCOMMA_SPACE)); + } + console.Write(T(TAUTO_OPEN_FLAG)); + hasTagsInFront = true; + } + if (isSelected) + { + if (hasTagsInFront) { + console.Write(T(TCOMMA_SPACE)); + } + console.Write(T(TSELECTED_FLAG)); + } + console.Write(T(TPARENTHESIS_CLOSE)); +} + +defaultproperties +{ + TLIST = 0 + stringConstants(0) = "list" + TOPEN = 1 + stringConstants(1) = "open" + TCLOSE = 2 + stringConstants(2) = "close" + TENABLE = 3 + stringConstants(3) = "enable" + TDISABLE = 4 + stringConstants(4) = "disable" + TAUTO_OPEN = 5 + stringConstants(5) = "autoopen" + TTRADER = 6 + stringConstants(6) = "trader" + TTRADERS = 7 + stringConstants(7) = "traders" + TALL = 8 + stringConstants(8) = "all" + TAUTO_OPEN_QUESTION = 9 + stringConstants(9) = "autoOpen?" + TQUOTE = 10 + stringConstants(10) = "\"" + TAUTO_OPEN_FLAG = 11 + stringConstants(11) = "auto-open" + TDISABLED_FLAG = 12 + stringConstants(12) = " (disabled)" + TUNKNOWN_TRADERS = 13 + stringConstants(13) = "Could not find some of the traders: " + TLIST_TRADERS = 14 + stringConstants(14) = "List of available traders: " + TCOMMA_SPACE = 15 + stringConstants(15) = ", " + TPARENTHESIS_OPEN = 16 + stringConstants(16) = "(" + TPARENTHESIS_CLOSE = 17 + stringConstants(17) = ")" + TSELECTED_FLAG = 18 + stringConstants(18) = "selected" + TSELECT = 19 + stringConstants(19) = "select" + TIGNORE_DOORS = 20 + stringConstants(20) = "ignore-doors" + TBOOT = 21 + stringConstants(21) = "boot" + TTIME = 22 + stringConstants(22) = "time" + TTRADER_TIME = 23 + stringConstants(23) = "traderTime" + TIGNORE_PLAYERS = 24 + stringConstants(24) = "ignore-players" + TPAUSE = 25 + stringConstants(25) = "pause" + TUNPAUSE = 26 + stringConstants(26) = "unpause" + TCANNOT_PARSE_PARAM = 27 + stringConstants(27) = "Cannot parse parameter: " + TCLOSEST = 28 + stringConstants(28) = "closest" + TSPACE = 29 + stringConstants(29) = " " +} \ No newline at end of file diff --git a/sources/Manifest.uc b/sources/Manifest.uc new file mode 100644 index 0000000..2c1ce67 --- /dev/null +++ b/sources/Manifest.uc @@ -0,0 +1,26 @@ +/** + * Manifest is meant to describe contents of the Acedia's package. + * Copyright 2021 Anton Tarasenko + *------------------------------------------------------------------------------ + * This file is part of Acedia. + * + * Acedia is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, version 3 of the License, or + * (at your option) any later version. + * + * Acedia 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Acedia. If not, see . + */ + class Manifest extends _manifest + abstract; + +defaultproperties +{ + features(0) = class'AcediaAdmin_Feature' +} \ No newline at end of file