diff --git a/.gitignore b/.gitignore index 6f4c8a6..27b10bd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ *.swp +include/ +.vscode +sourcemod/ *.bak *.smx 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/README.md b/README.md index 8a27216..85d0b38 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -This plugin was written to output information on Source-server (primarily Insurgency) that can be interpreted by the [Skillbird-framework](https://gitlab.com/Sheppy_/skillbird) and in turn be queried as useful information to display back the players or use for team-balancing. +This plugin was written to output information on Source-server (primarily Insurgency) that can be interpreted by the [Skillbird-framework](https://github.com/FAUSheppy/skillbird) and in turn be queried as useful information to display back the players or use for team-balancing. # Setup ## Install Insurgency Server @@ -19,6 +19,9 @@ Start CMD and install the [Insurgency Server](https://developer.valvesoftware.co ## Compile Plugin Download and unpack [Sourcemod](http://www.sourcemod.net/downloads.php), after unpacking, there should be two directories, *addons* and *cfg*. Execute *build.sh* with the addons dir as argument. +Download and unpack the extensions [json](https://github.com/FAUSheppy/sm-json) and and move all files into the *scriping/include/* directory. +Download and upack the [system2](https://forums.alliedmods.net/showthread.php?t=146019) and and move all files into the *scriping/include/* and *extensions* directory respectively. + ./build.sh /path/to/addons/dir/ ## Add Sourcemod/Plugins to Insurgency Server @@ -45,23 +48,10 @@ In the Server console (or via rcon). It is normal for the console to be laggy. sm plugins refresh sm plugins unload_all - sm plugins load TrueSkillLoggingMain - sm plugins load TrueSkillQueryMain + sm plugins load Skillbird -## Data Output for skillbird -The output must be written to a file from which the skillbird-framework can read it. As a simple solution you can just write it to a file using a pipe: +# Why include system2 as binaries? +Because I'm a lazy cheat. I don't it's against the GPL as long as I tell you the source-code is [here](https://github.com/dordnung/System2). - ./start_server.sh > output.log - -Or if you still want to see the output as it is printed: - - ./start_server.sh | tee output.log - -What I am personally doing is starting Insurgency with systemd and then: - - journalctl -fu insurgency.service > output.log - -Set sv\_logflush to 1 in the server.cfg to write out the information in shorter intervals, the performance impact is negligible. - -# Why include sm-socket as binaries? -Because building Sourcemod extensions is annoying to do for the average user. I know it's not a perfect solution, but it's the best I could come up with. In compliance with the terms of the GPL (the license of Sourcemod), you may find the source code of those binaries [here](https://github.com/nefarius/sm-ext-socket). +# Why do you have the json dependency in your repro +Because I'm a lazy cheat, please leave [this guy](https://github.com/clugg/sm-json/) a star. diff --git a/build.sh b/build.sh index 729ffe8..a133b80 100755 --- a/build.sh +++ b/build.sh @@ -11,18 +11,11 @@ sourcemod_addons_dir=$1 plugin_dir=$sourcemod_addons_dir/sourcemod/scripting ext_dir=$sourcemod_addons_dir/sourcemod/extensions -cp scripting/TrueSkillLoggingMain.sp \ - scripting/TrueSkillQueryMain.sp \ - scripting/client.sp \ - scripting/utils.sp \ - scripting/query.sp \ - $plugin_dir/ - -cp scripting/include/* $plugin_dir/include/ - +cp scripting/*.sp $plugin_dir/ +cp -r scripting/include/* $plugin_dir/include/ cp extensions/* $ext_dir/ originDir=$(pwd) cd $plugin_dir -./compile.sh TrueSkillLoggingMain.sp TrueSkillQueryMain.sp -cp compiled/TrueSkill* $originDir/ +./compile.sh Skillbird.sp +cp compiled/Skillbird* $originDir/ diff --git a/extensions/socket.ext.dll b/extensions/socket.ext.dll deleted file mode 100644 index cbefa52..0000000 Binary files a/extensions/socket.ext.dll and /dev/null differ diff --git a/extensions/socket.ext.so b/extensions/socket.ext.so deleted file mode 100755 index 25d8252..0000000 Binary files a/extensions/socket.ext.so and /dev/null differ diff --git a/extensions/system2.ext.dll b/extensions/system2.ext.dll new file mode 100644 index 0000000..118bdf3 Binary files /dev/null and b/extensions/system2.ext.dll differ diff --git a/extensions/system2.ext.so b/extensions/system2.ext.so new file mode 100644 index 0000000..9dad877 Binary files /dev/null and b/extensions/system2.ext.so differ diff --git a/scripting/EventHandlers.sp b/scripting/EventHandlers.sp new file mode 100644 index 0000000..3128259 --- /dev/null +++ b/scripting/EventHandlers.sp @@ -0,0 +1,29 @@ +#include "Interfaces.sp" + +public Action:Event_RoundStart(Handle:event, const String:name[], bool:dontBroadcast){ + + SubmittEventActiveClients(); + SubmittEventMapInformation(); + + /* generate session id for this round */ + SetConVarInt(FindConVar("session-id"), GetRandomInt(0, 200000)); + return Plugin_Continue; +} + +public Action:Event_RoundEnd(Handle:event, const String:name[], bool:dontBroadcast){ + SubmittEventActiveClients(); + new team_id = GetEventInt(event, "winner"); + SubmittEventWinnerTeam(team_id); + SubmittEventRoundEnd(); + return Plugin_Continue; +} + +public Action:Event_PlayerDisconnect(Handle:event, const String:name[], bool:dontBroadcast){ + SubmittEventActiveClients(); + return Plugin_Continue; +} + +public Action:Event_PlayerChangedTeam(Handle:event, const String:name[], bool:dontBroadcast){ + SubmittEventActiveClients(); + return Plugin_Continue; +} diff --git a/scripting/IngameMessages.sp b/scripting/IngameMessages.sp new file mode 100644 index 0000000..bb2559b --- /dev/null +++ b/scripting/IngameMessages.sp @@ -0,0 +1,44 @@ +#include +#include +#include + +#define DEFAULT_LEN 64 +#define SNAME_LEN 256 + +#define VAR_TARGET_PORT "skillbird_target_port" + + +public void PrintHttpResponse(bool success, const char[] error, System2HTTPRequest request, System2HTTPResponse response, HTTPRequestMethod method) { + if (success) { + if(response.StatusCode == 204 || response.StatusCode == 200){ + char[] content = new char[response.ContentLength + 1]; + response.GetContent(content, response.ContentLength + 1); + PrintToChatAll("%s", content); + }else if(response.StatusCode == 404){ + PrintToChatAll("skillbird:error:player_not_in_db"); + }else{ + PrintToChatAll("skillbird:error:scheduled_downtime:database_backup"); + } + } else { + PrintToChatAll("skillbird:error: backend unavailiable"); + } + } + +public void DisplayRating(int client){ + new String:url[SNAME_LEN]; + new String:clientId[DEFAULT_LEN]; + GetClientAuthId(client, AuthId_SteamID64, clientId, DEFAULT_LEN); + Format(url, sizeof(url), "http://localhost:%d/get-player-rating-msg?id=%s", GetConVarInt(FindConVar(VAR_TARGET_PORT)), clientId); + System2HTTPRequest httpRequest = new System2HTTPRequest(PrintHttpResponse, url); + httpRequest.GET(); +} + +public Action Timer_ConnectMessage(Handle timer, int client){ + DisplayRating(client); + return Plugin_Continue; +} + +public Action CommandRating(int client, int args){ + DisplayRating(client); + return Plugin_Continue; +} diff --git a/scripting/Interfaces.sp b/scripting/Interfaces.sp new file mode 100644 index 0000000..a39ba7a --- /dev/null +++ b/scripting/Interfaces.sp @@ -0,0 +1,99 @@ +#pragma tabsize 0 + +#include +#include +#include +#include +#include + +#define DEFAULT_LEN 64 +#define SNAME_LEN 256 +#define ACTIVE_CLIENTS_LENGTH 8192 +#define VAR_TARGET_PORT "skillbird_target_port" +#define VAR_SESSION_ID "session_id" + +public void HttpResponseCallback(bool success, const char[] error, System2HTTPRequest request, System2HTTPResponse response, HTTPRequestMethod method) { +} + +public void SubmittViaHTTP(char[] jsonString){ + + new String:url[SNAME_LEN]; + Format(url, sizeof(url), "http://localhost:%d/single-event?session=%d", GetConVarInt(FindConVar(VAR_TARGET_PORT)), GetConVarInt(FindConVar(VAR_SESSION_ID)) ); + + System2HTTPRequest httpRequest = new System2HTTPRequest(HttpResponseCallback, url); + httpRequest.SetHeader("Content-Type", "application/json"); + httpRequest.SetData(jsonString); + httpRequest.POST(); +} + +public void SubmittEventActiveClients(){ + + /* primary json */ + JSON_Object obj = new JSON_Object(); + obj.SetString("etype", "active_players"); + obj.SetInt("timestamp", GetTime()); + + /* generate players */ + JSON_Array players = new JSON_Array(); + + for(new i = 1; i <= MaxClients;i++){ + if(!IsClientConnected(i)){ + continue; + } + + JSON_Object player = new JSON_Object(); + + new String:clientId[DEFAULT_LEN]; + new String:clientName[SNAME_LEN]; + GetClientAuthId(i, AuthId_SteamID64, clientId, DEFAULT_LEN, true); + GetClientName(i, clientName, SNAME_LEN); + + player.SetString("id", clientId); + player.SetString("name", clientName); + player.SetInt("team", GetClientTeam(i)); + players.PushObject(player); + } + + /* add players array to primary object */ + obj.SetObject("players", players); + + char output[2048]; + obj.Encode(output, sizeof(output)); + SubmittViaHTTP(output); +} + +public void SubmittEventMapInformation(){ + new String:mapname[DEFAULT_LEN]; + GetCurrentMap(mapname, sizeof(mapname)); + + JSON_Object obj = new JSON_Object(); + obj.SetString("etype", "map"); + obj.SetInt("timestamp", GetTime()); + obj.SetString("map", mapname); + + char output[2048]; + obj.Encode(output, sizeof(output)); + SubmittViaHTTP(output); +} + +public void SubmittEventWinnerTeam(int team_id){ + + JSON_Object obj = new JSON_Object(); + obj.SetString("etype", "winner"); + obj.SetInt("timestamp", GetTime()); + obj.SetInt("winnerTeam", team_id); + + char output[2048]; + obj.Encode(output, sizeof(output)); + SubmittViaHTTP(output); +} + +public void SubmittEventRoundEnd(){ + JSON_Object obj = new JSON_Object(); + obj.SetString("etype", "round_end"); + obj.SetInt("timestamp", GetTime()); + + char output[2048]; + obj.Encode(output, sizeof(output)); + SubmittViaHTTP(output); +} diff --git a/scripting/Skillbird.sp b/scripting/Skillbird.sp new file mode 100644 index 0000000..6154677 --- /dev/null +++ b/scripting/Skillbird.sp @@ -0,0 +1,46 @@ +#pragma tabsize 0 + +#include +#include +#include "IngameMessages.sp" +#include "EventHandlers.sp" + +#define DEFAULT_LEN 64 +#define SNAME_LEN 256 + +#define VAR_SESSION_ID "session_id" +#define VAR_TARGET_PORT "skillbird_target_port" + +/* ---------------------- Plugin ---------------------- */ +public Plugin:myinfo = { + name = "Skillbird", + author = "FAUSheppy", + description = "Module to interact with the skillbird framework", + version = "3.0", + url = "https://github.com/FAUSheppy/skillbird-sourcemod" +}; + +public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max){ + return APLRes_Success; +} + +public OnPluginStart(){ + + /* Hook Events */ + HookEvent("round_end", Event_RoundEnd); + HookEvent("player_team", Event_PlayerChangedTeam); + HookEvent("player_disconnect", Event_PlayerDisconnect); + + CreateConVar(VAR_SESSION_ID, "0", "Session in for this round"); + CreateConVar(VAR_TARGET_PORT, "6200", "Skillbird backend target port", FCVAR_PROTECTED); + + RegConsoleCmd("rating", CommandRating); +} + +public OnClientAuthorized(client, const String:auth[]){ + CreateTimer(5.0, Timer_ConnectMessage, client); +} + +public OnMapStart(){ + SetConVarInt(FindConVar(VAR_SESSION_ID), GetRandomInt(1, 200000)); +} diff --git a/scripting/TrueSkillLoggingMain.sp b/scripting/TrueSkillLoggingMain.sp deleted file mode 100644 index 6f0ed04..0000000 --- a/scripting/TrueSkillLoggingMain.sp +++ /dev/null @@ -1,92 +0,0 @@ -#pragma tabsize 0 -#include -#include -#include -#include "client.sp" -#include "utils.sp" -#include "query.sp" -#define DEFAULT_LEN 64 -#define SNAME_LEN 256 - -/* ---------------------- Globals ---------------------- */ -static Handle:logfile; - -/* ---------------------- Timers ---------------------- */ -public Action:Timer_MapStart(Handle:timer){ - LogActiveClients(logfile, "0x42,map_start_active,"); - return Plugin_Continue; -} - -public Action:Timer_RoundStart(Handle:timer){ - LogActiveClients(logfile, "0x42,round_start_active,"); - char map[SNAME_LEN]; - MapName("0x42,mapname,", map, sizeof(map)); - LogToOpenFile(logfile, map); - return Plugin_Continue; -} - -/* ---------------------- Events ---------------------- */ -public Action:Event_RoundStart(Handle:event, const String:name[], bool:dontBroadcast){ - LogActiveClients(logfile, "0x42,round_start_active,"); - return Plugin_Continue; -} - -public Action:Event_RoundEnd(Handle:event, const String:name[], bool:dontBroadcast){ - char eventWTeam[SNAME_LEN]; - EventWinnerTeam(event, "0x42,winner,", eventWTeam, sizeof(eventWTeam)); - LogToOpenFile(logfile, eventWTeam); - LogActiveClients(logfile, "0x42,round_end_active,"); - return Plugin_Continue; -} - -public Action:Event_PlayerDisconnect(Handle:event, const String:name[], bool:dontBroadcast){ - LogClientEventFormat(logfile, event, "0x42,disconnect,"); - LogActiveClients(logfile, "0x42,dc,"); - return Plugin_Continue; -} - -public Action:Event_PlayerChangedTeam(Handle:event, const String:name[], bool:dontBroadcast){ - LogActiveClients(logfile, "0x42,tc,"); - LogClientEventFormat(logfile, event, "0x42,teamchange,"); - return Plugin_Continue; -} - -public OnMapStart(){ - CreateTimer(5.0, Timer_MapStart); -} - -/* ---------------------- Plugin ---------------------- */ -public Plugin:myinfo = { - name = "skillbird-data-collection, - author = "FAUSheppy", - description = "Module to collect data for the skillbird framework", - version = "2.0", - url = "https://github.com/FAUSheppy/skillbird-sourcemod" -}; - -public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max){ - return APLRes_Success; -} - -public OnPluginStart(){ - - /* get and verify server name for output file */ - char server[SNAME_LEN]; - ServerName(server, sizeof(server)); - logfile = OpenFile(server, "at", false, NULL_STRING); - if strlen(server) < 1: - return ThrowNativeError(SP_ERROR_NATIVE, "Computed Invalid Servername '%s'", server) - - /* inial line */ - LogToOpenFile(logfile, "0x42,start"); - - /* Hook Events */ - HookEvent("round_end", Event_RoundEnd); - HookEvent("player_team", Event_PlayerChangedTeam); - HookEvent("player_disconnect", Event_PlayerDisconnect); -} - -public OnPluginEnd(){ - LogToOpenFile(logfile, "0x42,plugin unloaded"); - CloseHandle(logfile); -} diff --git a/scripting/TrueSkillQueryMain.sp b/scripting/TrueSkillQueryMain.sp deleted file mode 100644 index b30d4a0..0000000 --- a/scripting/TrueSkillQueryMain.sp +++ /dev/null @@ -1,61 +0,0 @@ -/* no idea, but removes warnings */ -#pragma tabsize 0 - -#include -#include -#include -#include "query.sp" -#include "client.sp" -#include "utils.sp" - -#define DEFAULT_LEN 64 -#define INVALID 0 - -#define REBUILD_TEAM true -#define NO_REBUILD_TEAM false - -/* ---------------------- Hooks ---------------------- */ -public OnClientAuthorized(client,const String:auth[]){ - CreateTimer(5.0, Timer_ConnectMessage, client); - CreateTimer(5.0, Timer_QueryTeam, client); -} -public OnScrambleTeams(){ - QueryTeam(GetSocket(), "NONE", REBUILD_TEAM); -} - -/* ---------------------- Timers ---------------------- */ -public Action Timer_ConnectMessage(Handle timer, int client){ - QueryRating(client); - return Plugin_Continue; -} - -public Action Timer_QueryTeam(Handle timer, int client){ - char clientIDString[DEFAULT_LEN]; - ClientID(client, clientIDString, DEFAULT_LEN); - QueryTeam(GetSocket(), clientIDString, false); - return Plugin_Continue; -} - -/* ---------------------- Plugin ---------------------- */ -public Plugin:myinfo = { - name = "skillbird-query", - author = "FAUSheppy", - description = "Module for interaction with the skillbird API", - version = "2.0", - url = "https://github.com/FAUSheppy/skillbird-sourcemod" -}; - -public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max){ - return APLRes_Success; -} - -public OnPluginStart(){ - CreateQuerySocket(7040); -} - -public OnPluginEnd(){ - if (GetSocket() == INVALID_HANDLE){ - return; - } - CloseHandle(GetSocket()); -} diff --git a/scripting/client.sp b/scripting/client.sp deleted file mode 100644 index 50ffb4a..0000000 --- a/scripting/client.sp +++ /dev/null @@ -1,63 +0,0 @@ -#pragma tabsize 0 - -#include -#include -#include - -#define DEFAULT_LEN 64 -#define SNAME_LEN 256 -#define ACTIVE_CLIENTS_LENGTH 8192 - -public void ClientName(const client,char[] buf,buflen){ - new String:name[DEFAULT_LEN]; - if(IsClientConnected(client)){ - GetClientName(client, name, DEFAULT_LEN); - - /* get fucked if you use my seperators in your name */ - ReplaceString(name, DEFAULT_LEN,",","$"); - ReplaceString(name, DEFAULT_LEN,"|","&"); - ReplaceString(name, DEFAULT_LEN,"0x42","0x21"); - } -} - -public void ClientID(int client, char[] buf, int buflen){ - if(IsClientConnected(client)){ - GetClientAuthId(client, AuthId_SteamID64, buf, DEFAULT_LEN, true); - } -} - -public void ActiveClients(char[] prefix, char[] buf, buflen){ - new String:str_tmp[ACTIVE_CLIENTS_LENGTH]; - for(new i = 1; i <= MaxClients;i++){ - new String:strCliID[DEFAULT_LEN]; - new String:strCliName[DEFAULT_LEN]; - ClientID(i, strCliID, DEFAULT_LEN); - ClientName(i, strCliName, DEFAULT_LEN); - Format(str_tmp, ACTIVE_CLIENTS_LENGTH, - "%s|%s|%s|%d,", str_tmp, strCliID, strCliName, GetClientTeam(i)); - } - Format(str_tmp, ACTIVE_CLIENTS_LENGTH, "%s%s", prefix,str_tmp); -} - -public void LogActiveClients(Handle:logfile, char[] prefix){ - char strActiveClients[ACTIVE_CLIENTS_LENGTH]; - ActiveClients(prefix, strActiveClients, ACTIVE_CLIENTS_LENGTH); - LogToOpenFile(logfile, strActiveClients); -} - -public void LogClientEventFormat(Handle:logfile, Handle:event, char[] prefix){ - char strClientEvent[2*DEFAULT_LEN]; - ClientEventFormat(event, prefix, strClientEvent, 2*DEFAULT_LEN); - LogToOpenFile(logfile, strClientEvent); - -} - -public void ClientEventFormat(Handle:event, char[] prefix, char[] buf, buflen){ - new client = GetClientOfUserId(GetEventInt(event, "userid")); - char team[4]; - Format(team, sizeof(team), "%d", GetClientTeam(client)); - char tmp[DEFAULT_LEN*2]; - char strCliID[DEFAULT_LEN]; - ClientID(client, strCliID, DEFAULT_LEN); - Format(tmp, 2*DEFAULT_LEN, "%s%s,%s", prefix, strCliID, team); -} diff --git a/scripting/include/socket.inc b/scripting/include/socket.inc deleted file mode 100644 index f3a58d2..0000000 --- a/scripting/include/socket.inc +++ /dev/null @@ -1,487 +0,0 @@ -// socket extension include file - -#if defined _socket_included - #endinput -#endif -#define _socket_included -#include - -enum SocketType { - SOCKET_TCP = 1, - SOCKET_UDP, - SOCKET_RAW -} - -#define EMPTY_HOST 1 -#define NO_HOST 2 -#define CONNECT_ERROR 3 -#define SEND_ERROR 4 -#define BIND_ERROR 5 -#define RECV_ERROR 6 -#define LISTEN_ERROR 7 - - -/*************************************************************************************************/ -/******************************************** options ********************************************/ -/*************************************************************************************************/ - - -/** - * Options available for SocketSetOption() - * - * @note modifying these options is not required for normal operation, you can skip the whole - * section in most cases. - */ -enum SocketOption { -/** - * If this option is set the socket extension will try to concatenate SocketReceive callbacks. - * - * This will possibly lower the amount of callbacks passed to SourceMod plugins and improve the - * performance. The socket extension will preserve the packet order. - * - * @note this doesn't prevent multiple callbacks, it only reduces them for high load. - * @note this will not truncate packets below 4096 bytes, setting it lower will be ignored - * @note set this option if you expect lots of data in a short timeframe - * @note don't forget to set your buffer sizes at least to the value passed to this function, but - * always at least to 4096 - * - * @param cell_t 0(=default) to disable or max. chunk size including \0 terminator in bytes - * @return bool true on success - */ - ConcatenateCallbacks = 1, -/** - * If this option is set the socket extension will enforce a mutex lock in the GameFrame() hook. - * - * This will ensure that callbacks will be processed every gameframe as fast as possible with the - * drawback of potentially creating lag. It's not recommended to set this option for most cases. - * If this option is not set the gameframe will be skipped if quietly obtaining a lock fails. - * - * @note combine this with CallbacksPerFrame for best performance - * @note this option will affect all sockets from all plugins, use it with caution! - * - * @param bool whether to force locking or not - * @return bool true on success - */ - ForceFrameLock, -/** - * This will specify the maximum amount of callbacks processed in every gameframe. - * - * The default value for this option is 1, setting it higher will possibly increase networking - * performance but may cause lag if it's set too high. - * The amount of callbacks actually being processed is limited by not being able to quietly obtain - * a lock (see ForceFrameLock) and the amount of callbacks in the queue. - * - * @note this option will affect all sockets from all plugins, use it with caution! - * - * @param cell_t maximum amount of callbacks per gameframe - * @return bool true on success - */ - CallbacksPerFrame, -/** - * If this option is set the socket will be allowed to send broadcast messages in case the protocol - * supports it. This is a wrapper for setting SO_BROADCAST. - * - * @param bool whether to allow broadcasting or not - * @return bool true on success - */ - SocketBroadcast, -/** - * If this option is set SocketBind() will allow reusing local adresses in case the protocol - * supports it. This is a wrapper for setting SO_REUSEADDR. - * - * @param bool whether to allow broadcasting or not - * @return bool true on success - */ - SocketReuseAddr, -/** - * If this option is set the socket will try to keep the connection alive by periodically sending - * messages if the protocol supports it. This is a wrapper for setting SO_KEEPALIVE. - * - * @param bool whether to allow broadcasting or not - * @return bool true on success - */ - SocketKeepAlive, -/** - * This option specifies how long a socket will wait if it's being closed and its send buffer is - * still filled. This is a wrapper for setting SO_LINGER. - * - * @param cell_t 0 (=default) to disable or time in s - * @return bool true on success - */ - SocketLinger, -/** - * If this option is set out-of-band data will be inlined into the normal receive stream. This is a - * wrapper for setting SO_OOBINLINE. - * - * @param bool whether to inline out-of-band data or not - * @return bool true on success - */ - SocketOOBInline, -/** - * This option specifies how large the send buffer will be. This is a wrapper for setting - * SO_SNDBUF. - * - * @param cell_t size in bytes - * @return bool true on success - */ - SocketSendBuffer, -/** - * This option specifies how large the receive buffer will be. This is a wrapper for setting - * SO_RCVBUF. - * - * @param cell_t size in bytes - * @return bool true on success - */ - SocketReceiveBuffer, -/** - * If this option is set outgoing messages will ignore the default routing facilities if the - * protocol implementation supports it. The remote site should be directly connected to the sender. - * This is a wrapper for setting SO_DONTROUTE. - * - * @param bool whether to skip default routing or not - * @return bool true on success - */ - SocketDontRoute, -/** - * This option specifies the minimum amount of data to receive before processing it. This is a - * wrapper for setting SO_RCVLOWAT. - * - * @note this can probably block the extension, use it with caution! - * - * @param cell_t size in bytes - * @return bool true on success - */ - SocketReceiveLowWatermark, -/** - * This option specifies how long a socket will try to receive data before it times out and - * processes the data. This is a wrapper for setting SO_RCVTIMEO. - * - * @param cell_t 0 (=default) to disable or time in ms - * @return bool true on success - */ - SocketReceiveTimeout, -/** - * This option specifies the minimum amount of data required in the send buffer before starting to - * send it. This is a wrapper for setting SO_SNDLOWAT. - * - * @note this can probably block the extension, use it with caution! - * - * @param cell_t size in bytes - * @return bool true on success - */ - SocketSendLowWatermark, -/** - * This option specifies how long a socket will try to send data before it times out and - * retries it later. This is a wrapper for setting SO_SNDTIMEO. - * - * @param cell_t 0 (=default) to disable or time in ms - * @return bool true on success - */ - SocketSendTimeout, -/** - * If this option is set the socket extension will display debugging messages in the server console/logs. - * - * @param bool whether to enable debugging or not - * @return bool true on success - */ - DebugMode -} - - -/*************************************************************************************************/ -/******************************************* callbacks *******************************************/ -/*************************************************************************************************/ - - -/** - * triggered if a normal sockets finished connecting and is ready to be used - * - * @param socket The socket handle pointing to the calling socket - * @param arg The argument set by SocketSetArg() - * @noreturn - */ -//funcenum SocketConnectCB -//{ -// public(Handle:socket, any:arg) -//}; - -typeset SocketConnectCB -{ - function void (Handle socket, any arg); -}; - -/** - * triggered if a listening socket received an incoming connection and is ready to be used - * - * @note The child-socket won't work until receive-, disconnect-, and errorcallback for it are set. - * - * @param Handle socket The socket handle pointing to the calling listen-socket - * @param Handle newSocket The socket handle to the newly spawned child socket - * @param String remoteIP The remote IP - * @param any arg The argument set by SocketSetArg() for the listen-socket - * @noreturn - */ -typeset SocketIncomingCB -{ - function void (Handle socket, Handle newSocket, const char remoteIP[], int remotePort, any arg) -}; - -/** - * triggered if a socket receives data - * - * @note This is binary safe if you always use dataSize for operations on receiveData[] - * @note packets may be split up into multiple chunks -> multiple calls to the receive callback - * @note if not set otherwise by SocketSetOption(..., ConcatenateCallbacks, ...) receiveData will - * never be longer than 4096 characters including \0 terminator - * - * @param Handle socket The socket handle pointing to the calling socket - * @param String receiveData The data which arrived, 0-terminated at receiveData[dataSize] - * @param cell_t dataSize The length of the arrived data excluding the 0-termination - * @param any arg The argument set by SocketSetArg() for the socket - * @noreturn - */ -typeset SocketReceiveCB -{ - function void (Handle socket, const char receiveData[], const int dataSize, any arg) -}; - -/** - * called after a socket sent all items in its send queue successfully - * - * @param Handle socket The socket handle pointing to the calling socket - * @param any arg The argument set by SocketSetArg() for the socket - * @noreturn - */ -typeset SocketSendqueueEmptyCB -{ - function void (Handle socket, any arg) -}; - -/** - * called if a socket has been properly disconnected by the remote side - * - * @note You should call CloseHandle(socket) or reuse the socket before this function ends - * - * @param Handle socket The socket handle pointing to the calling socket - * @param any arg The argument set by SocketSetArg() for the socket - * @noreturn - */ -typeset SocketDisconnectCB -{ - function void (Handle socket, any arg) -}; - -/** - * called if an unrecoverable error occured, close the socket without an additional call to a disconnect callback - * - * @note You should call CloseHandle(socket) or reuse the socket before this function ends - * - * @param Handle socket The socket handle pointing to the calling socket - * @param cell_t errorType The error type, see defines above - * @param cell_t errorNum The errno, see errno.h for details - * @param any arg The argument set by SocketSetArg() for the socket - * @noreturn - */ -typeset SocketErrorCB -{ - function void (Handle socket, const int errorType, const int errorNum, any arg) -}; - - -/*************************************************************************************************/ -/******************************************** natives ********************************************/ -/*************************************************************************************************/ - - -/** - * Returns whether a socket is connected or not. - * - * @param socket Socket handle to check - * @return bool The connection status - */ -native bool:SocketIsConnected(Handle:socket); - - -/** - * Creates a new socket. - * - * @note this function may be relatively expensive, reuse sockets if possible - * - * @param SocketType protocol The protocol to use, SOCKET_TCP is default - * @param SocketErrorCB efunc The error callback - * @return Handle The socket handle. Returns INVALID_HANDLE on failure - */ -native Handle:SocketCreate(SocketType:protocol=SOCKET_TCP, SocketErrorCB:efunc); - -/** - * Binds the socket to a local address - * - * @param Handle socket The handle of the socket to be used. * @param String hostname The hostname (or IP) to bind the socket to. - * @param cell_t port The port to bind the socket to. - * @return bool true on success - */ -native bool:SocketBind(Handle:socket, const String:hostname[], port); - -/** - * Connects a socket - * - * @note this native is threaded, it may be still running after it executed, use the connect callback - * @note invokes the SocketError callback with errorType = CONNECT_ERROR or EMPTY_HOST if it fails - * @note invokes the SocketConnect callback if it succeeds - * - * @param Handle socket The handle of the socket to be used. - * @param SocketConnectCB cfunc The connect callback - * @param SocketReceiveCB rfunc The receive callback - * @param SocketDisconnectCB dfunc The disconnect callback * @param String hostname The hostname (or IP) to connect to. - * @param cell_t port The port to connect to. - * @noreturn - */ -native SocketConnect(Handle:socket, SocketConnectCB:cfunc, SocketReceiveCB:rfunc, SocketDisconnectCB:dfunc, const String:hostname[], port); - -/** - * Disconnects a socket - * - * @note this will not close the handle, the socket will be reset to a state similar to after SocketCreate() - * @note this won't trigger any disconnect/error callbacks - * - * @noreturn - */ -native bool:SocketDisconnect(Handle:socket); - -/** - * Makes a socket listen for incoming connections - * - * @param Handle socket The handle of the socket to be used. - * @param SocketIncomingCB ifunc The callback for incoming connections - * @return bool true on success - */ -native bool:SocketListen(Handle:socket, SocketIncomingCB:ifunc); - -/** - * Sends data through the socket. - * - * @note specify size for binary safe operation - * @note if size is not specified the \0 terminator will not be included - * @note This native is threaded, it may be still running after it executed (not atomic). - * @note Use the SendqueueEmpty callback to determine when all data has been successfully sent. - * @note The socket extension will ensure that the data will be send in the correct order and split - * the data if required. - * - * @param Handle socket The handle of the socket to be used. - * @param String data The data to send. - * @noreturn */ -native SocketSend(Handle:socket, const String:data[], size=-1); - -/** * Sends UDP data through the socket to a specific destination. - * - * @note specify size for binary safe operation - * @note if size is not specified the \0 terminator will not be included - * @note This native is threaded, it may be still running after it executed (not atomic). - * @note Use the SendqueueEmpty callback to determine when all data has been successfully sent. - * @note The socket extension will ensure that the data will be send in the correct order and split - * the data if required. - * - * @param Handle socket The handle of the socket to be used. - * @param String data The data to send. - * @param String hostname The hostname (or IP) to send to. - * @param cell_t port The port to send to. - * @noreturn */ -native SocketSendTo(Handle:socket, const String:data[], size=-1, const String:hostname[], port); - -/** - * Set a socket option. - * - * @param Handle socket The handle of the socket to be used. May be INVALID_HANDLE if not essential. - * @param SocketOption option The option to modify (see enum SocketOption for details). - * @param cellt_ value The value to set the option to. - * @return cell_t 1 on success. */ -native SocketSetOption(Handle:socket, SocketOption:option, value); - - -/** - * Defines the callback function for when the socket receives data - * - * @note this is only useful and required for child-sockets spawned by listen-sockets - * (otherwise you already set it in SocketConnect()) - * - * @param Handle socket The handle of the socket to be used. - * @param SocketReceiveCB rfunc The receive callback - * @noreturn - */ -native SocketSetReceiveCallback(Handle:socket, SocketReceiveCB:rfunc); - -/** - * Defines the callback function for when the socket sent all items in its send queue - * - * @note this must be called AFTER sending (queueing) the data - * @note if no send-data is queued this will fire the callback itself - * @note the callback is guaranteed to fire - * - * @param Handle socket The handle of the socket to be used. - * @param SocketDisconnectCB dfunc The disconnect callback - * @noreturn - */ -native SocketSetSendqueueEmptyCallback(Handle:socket, SocketSendqueueEmptyCB:sfunc); - -/** - * Defines the callback function for when the socket was properly disconnected by the remote side - * - * @note this is only useful and required for child-sockets spawned by listen-sockets - * (otherwise you already set it in SocketConnect()) - * - * @param Handle socket The handle of the socket to be used. - * @param SocketDisconnectCB dfunc The disconnect callback - * @noreturn - */ -native SocketSetDisconnectCallback(Handle:socket, SocketDisconnectCB:dfunc); - -/** - * Defines the callback function for when the socket triggered an error - * - * @note this is only useful and required for child-sockets spawned by listen-sockets - * (otherwise you already set it in SocketCreate()) - * - * @param Handle socket The handle of the socket to be used. - * @param SocketErrorCB efunc The error callback - * @noreturn - */ -native SocketSetErrorCallback(Handle:socket, SocketErrorCB:efunc); - - -/** - * Sets the argument being passed to callbacks - * - * @param Handle socket The handle of the socket to be used. - * @param any arg The argument to set - * @noreturn - */ -native SocketSetArg(Handle:socket, any:arg); - -/** - * Retrieve the local system's hostname as the command "hostname" does. - * - * @param dest Destination string buffer to copy to. - * @param destLen Destination buffer length (includes null terminator). - * - * @return 1 on success - */ -native SocketGetHostName(String:dest[], destLen); - -/** - * _________________Do not edit below this line!_______________________ - */ -public Extension:__ext_smsock = -{ - name = "Socket", - file = "socket.ext", -#if defined AUTOLOAD_EXTENSIONS - autoload = 1, -#else - autoload = 0, -#endif -#if defined REQUIRE_EXTENSIONS - required = 1, -#else - required = 0, -#endif -}; diff --git a/scripting/query.sp b/scripting/query.sp deleted file mode 100644 index bf2799f..0000000 --- a/scripting/query.sp +++ /dev/null @@ -1,101 +0,0 @@ -/* no idea, but removes warnings */ -#pragma tabsize 0 - -#include -#include -#include - -#define DEFAULT_LEN 64 -#define TAG_LEN 64 -#define INDEX_SEP "," -#define ACTIVE_CLIENTS_LENGTH 8192 - -#define NO_PREFIX "" - -/* ---------------------- Globals ---------------------- */ -static Handle:socket - -/* ---------------------- Queries ---------------------- */ -public QueryTeam(Handle:socketl, char[] steamid, bool rebuild){ - /* steamid may be used to only query a single player's new team */ - char strActiveClients[ACTIVE_CLIENTS_LENGTH]; - char request[ACTIVE_CLIENTS_LENGTH + DEFAULT_LEN*2]; - - ActiveClients(NO_PREFIX, strActiveClients, ACTIVE_CLIENTS_LENGTH); - if(rebuild){ - Format(request, sizeof(request), "rebuildteam,%s", strActiveClients); - }else{ - Format(request, sizeof(request), "getteam,%s,%s", steamid, strActiveClients); - } - SocketSend(socket, request); -} - -public QueryRating(client){ - if(client>0 && IsClientConnected(client)){ - /* get steamid first */ - char pid[DEFAULT_LEN]; - GetClientAuthId(client, AuthId_SteamID64, pid, DEFAULT_LEN, true); - /* build the request and send */ - char request[2*DEFAULT_LEN]; - Format(request, sizeof(request), "player,%s", pid); - SocketSend(socket, request); - } -} - -/* ---------------------- Receive ---------------------- */ -public CaseSwitchReceive(Handle:socketl, String:receiveData[], const dataSize, any:arg) { - char tag[TAG_LEN]; - - //TODO why is receiveData and array of strings?!?! - SplitString(receiveData, INDEX_SEP, tag, TAG_LEN); - - if(StrEqual(tag, "BALANCE_SINGLE")){ - RebuildTeams(INDEX_SEP, "|",receiveData); - }else if(StrEqual(tag, "BALANCE_TEAMS")){ - RebuildTeams(INDEX_SEP, "|",receiveData); - }else if(StrEqual(tag, "RATING_SINGLE")){ - char ratingInfo[DEFAULT_LEN]; - SplitString(receiveData, INDEX_SEP, ratingInfo, DEFAULT_LEN); - PrintToChatAll("%s", receiveData); - } -} - -/* ---------------------- Socket ---------------------- */ -public CreateQuerySocket(int port){ - socket = SocketCreate(SOCKET_TCP, OnSocketError); - SocketConnect(socket, OnSocketConnected, CaseSwitchReceive, OnSocketDisconnected, "127.0.0.1", port); -} - -public Action AttemptReconnectSocket(Handle:socketl){ - if(socket != INVALID_HANDLE){ - CloseHandle(socketl); - }else{ - socket = SocketCreate(SOCKET_TCP,OnSocketError); - if(socket != INVALID_HANDLE){ - SocketConnect(socket, OnSocketConnected, CaseSwitchReceive, - OnSocketDisconnected, "127.0.0.1", 7040); - } - } - /* check if socket is connected */ - if(SocketIsConnected(socketl)){ - return Plugin_Stop; - }else{ - return Plugin_Continue; - } -} - -public Handle GetSocket(){ - return socket; -} - -public OnSocketConnected(Handle:socketl,any:arg) { -} - -public OnSocketDisconnected(Handle:socketl,any:arg) { - CreateTimer(10.0, AttemptReconnectSocket, socketl, TIMER_REPEAT); -} - -public OnSocketError(Handle:socketl, const errorType, const errorNum,any:arg) { - LogError("socket error %d (errno %d)", errorType, errorNum); - CloseHandle(socket); -} diff --git a/scripting/utils.sp b/scripting/utils.sp deleted file mode 100644 index 3435f44..0000000 --- a/scripting/utils.sp +++ /dev/null @@ -1,58 +0,0 @@ -#define DEFAULT_LEN 64 -#define MAX_PLAYERS 32 -#define MAX_LENGTH_ID_TEAM 128 - -public void EventWinnerTeam(Handle:event, char[] prefix, char[] buf, int buflen){ - new team_id = GetEventInt(event, "winner"); - Format(buf, buflen, "%s,%d", prefix, team_id); -} - -public void MapName(char[] prefix, char[] buf, int buflen){ - new String:map[DEFAULT_LEN]; - GetCurrentMap(map, sizeof(map)); - Format(buf, buflen, "%s%s", prefix, map); -} - -public void ServerName(char[] buf,int buflen){ - new String:sname[SNAME_LEN]; - ConVar servername = FindConVar("hostname"); - servername.GetString(sname,SNAME_LEN); - ReplaceString(sname, SNAME_LEN," ",""); - ReplaceString(sname, SNAME_LEN,"[",""); - ReplaceString(sname, SNAME_LEN,"]",""); - ReplaceString(sname, SNAME_LEN,"(",""); - ReplaceString(sname, SNAME_LEN,")",""); -} - - -public void RebuildTeams(char[] SEP, char[] SUBSEP, char[] input){ - - /* buffers for later */ - char buffers[MAX_PLAYERS][MAX_LENGTH_ID_TEAM]; - new parts = ExplodeString(input, SEP, buffers, MAX_PLAYERS, MAX_LENGTH_ID_TEAM); - new StringMap:map; - - /* i=1 to skip tag in something like TAG,player|team,player|team,... */ - for(new i = 1; i < parts; i++){ - char idAndTeam[2][MAX_LENGTH_ID_TEAM]; - ExplodeString(buffers[i], SUBSEP, idAndTeam, 2, MAX_LENGTH_ID_TEAM); - map.SetString(idAndTeam[0], idAndTeam[1], true); - } - - /* hasmap indirection nessesary cause there doesnt exist a "ClientByAuthID-like function */ - for(new client=0; client 0 && IsClientConnected(client)){ - GetClientAuthId(client, AuthId_SteamID64, sid, DEFAULT_LEN, true); - } - /* get team for steamid and balance*/ - char team[MAX_LENGTH_ID_TEAM]; - if(map.GetString(sid, team, sizeof(team))){ - new tid = StringToInt(team); - if(tid>0 && IsClientConnected(client)){ - ChangeClientTeam(client, tid); - } - } - } -}