diff --git a/COPYING.txt b/COPYING.txt deleted file mode 100644 index f288702..0000000 --- a/COPYING.txt +++ /dev/null @@ -1,674 +0,0 @@ - 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.txt b/README.txt index a3ec915..1570448 100644 --- a/README.txt +++ b/README.txt @@ -1,28 +1,18 @@ =============================================================================== -FACILSERVIL : `Easy Server` Dead-simple, dead-useful. +FACILSERVIL : `Easy Server` =============================================================================== Sometimes, it's just annoying and time-draining to deal with all of the -intricacies of :usockets-- if, to that, you say something like... - - "I just want to write a simple TCP server, dammit! - There's got to be an easier way!" - -... then Facilservil is for you! - -Facilservil ("easy server") abstracts away the entire server bits, allowing you -to focus on flexibility. +intricacies of :usockets— facilservil abstracts away all of those bits. ---------------------------------------- FEATURES ---------------------------------------- - * Multi-user - * Shutdown protection + * Multi-threaded * Input-handling - * Simple logging system - * Flexibility + * Logging system * UTF-8 @@ -32,25 +22,25 @@ DEMONSTRATION Load up Facilservil, then run this in your repl: - (facilservil:ex-server 8888) + (facilservil:ex-server "localhost" 8888) + +Now, connect your computer on port 8888. +This example server is a chat server, so it might be useful to connect a couple +of times, for demonstration's sake. -Now, connect your computer on port 8888! If you're on LiGNUx or BSD, you can use "telnet localhost 8888" -It'll show you a pretty example server. :) In reality, 'ex-server is just a small function for demonstration-- the example server really looks like this: - (facilservil:server "0.0.0.0" port - 'facilservil:connect-ex 'facilservil:disconnect-ex - 'facilservil:input-handle-ex) + (facilservil:server host port + #'ex-connect #'ex-disconnect #'ex-input #'ex-loop) -It runs #'connect-ex when you connect, #'disconnect-ex when you disconnect, -and #'input-handle-ex after you finish a command, to handle your input. +It runs #'ex-connect when you connect, #'ex-disconnect when you disconnect, +and #'ex-input-ex after you finish a command, and #'ex-loop after handling +everyone's input (or after timeout of waiting for input). -If you wanna see this example's code (is there a better way to learn?), look -in "/src/ex.lisp". For a different kind of example (less interesting, since it takes no user input), look at QOTDD (https://git.eunichx.us/qotdd). @@ -58,93 +48,41 @@ input), look at QOTDD (https://git.eunichx.us/qotdd). For a more comprehensive guide to Facilservil, look to USAGE, coming right up. + ---------------------------------------- USAGE ---------------------------------------- -To use Facilservil, just use the `facilservil:server` function somewhere: - - (facilservil:server host port - connecting disconnecting input-handler - &key (command-byte 10) (halting 'halt-ex)) +To use Facilservil, just use the `facilservil:server` function somewhere. "host" and "port" are, obviously, the host-IP and port, respectively. -"connecting" is the function that will be executed when a user connects. -"disconnecting" is the function that will run when someone disconnects. -"input-handler" interprets the input of a user, when they complete a command. -"command-byte" is the byte which determines if they've completed a command. - it's 10 by default, which is newline. -"halting" is the function executed when the server shuts down. +"on-connect" is the function that will be executed when a user connects. +"on-disconnect" is the function that will run when someone disconnects. +"on-input" is the function that will run when someone sends a command +"on-loop" is the function running when all input is complete/timeouts Basically, you write the "connecting", "disconnecting", and "input-handler" functions (maybe "halting"), and you've got a handy-dandy server. These functions you write must accept the following arguments: - connecting (socket client-id) - disconnecting (socket client-id) - input-handler (socket client-id input-string) - halting () - -Let's say that you want to write a connecting function which sends a friendly -"welcome" message. You'd do that like this, just about: - - (defun my-connecting-function (socket client-id) - (client-write socket - (format nil "Hey, welcome to this server, ~A! <3" client-id) - 'T)) - -This will write to the connecting user's socket (which is passed to your -function), "Hey, welcome to this server," followed by their client-id. - -Every user, upon connection, is given a client ID number which is correlated -with their connection socket. This ID number is random, and can be up to -999999 in value. - -To send a message to a user, get their socket, and run - (facilservil:client-write socket string &optional newline) - -"newline", which defaults to nil, determines whether or not your message is -followed with a newline. - -I'll give you one more quick example-- then you'll probably get usage. - -Let's write a quick input handler. - (defun my-input-handler (socket client-id input-string) - (if (equal input-string "Hello") - (facilservil:client-write socket "And hi to you!" 't) - (facilservil:client-write socket "You won't even say hi?" 'T))) - -It should be pretty self-explanatory. -You just scale up from them-- write a nice command parser or something, and -you're on your way! :) - -Now, one more thing: to run the server with your new functions, just do this: - - (facilservil:server host port - 'my-connecting-function 'facilservil:disconnect-ex - 'my-input-handler) + on-connect (connection connection-list) + on-disconnect (connection connection-list) + on-input (connection input-string connection-list) + on-loop (connection-list) -TIP: When it comes to user data, you might want to use a hash-table or two which - correlate client-ids and user data. ^_^ +You can use #'send to send strings to a given connection. +Each connection has a built-in hashtable (for storing user-IDs, usernames, +whatever you need). You can store/set a variable with #'bury, and retrieve with +#'dig. ----------------------------------------- -NON-FEATURES (TODO) ----------------------------------------- - - * Ctrl-C etc will crash servers - * Some UTF characters don't go over well - * Internationalization should be supported-- - right now, logs etc are always in English. - Not cool. - * You should be able to log to a file. ---------------------------------------- BORING STUFF ---------------------------------------- -License is in COPYING (GNU GPLv3) +Based on Trout's server. Author is Jaidyn Ann -Sauce is at https://git.eunichx.us/facilservil +Sauce is at https://git.eunichx.us/facilservil.git diff --git a/facilservil.asd b/facilservil.asd index a61c1d0..bcd9702 100755 --- a/facilservil.asd +++ b/facilservil.asd @@ -1,16 +1,7 @@ (defsystem "facilservil" - :version "0.2" + :version "1.0" :author "Jaidyn Lev " - :license "CC0" - :depends-on ("usocket" "trivial-utf-8" "alexandria" "nih") - :components ((:module "src" - :components - ((:file "package") - (:file "meta") - (:file "io") - (:file "ex") - (:file "client") - (:file "server")))) - + :depends-on ("usocket" "flexi-streams" "bordeaux-threads") + :components ((:file "facilservil")) :description "Simple TCP/telnet server for Lisp.") diff --git a/facilservil.lisp b/facilservil.lisp new file mode 100644 index 0000000..f818524 --- /dev/null +++ b/facilservil.lisp @@ -0,0 +1,312 @@ +;; facilservil.lisp +;; A simple lib for making a TCP server. +;; Based on a server by Trout, +;; https://gist.github.com/traut/6bf71d0da54493e6f22eb3d00671f2a9 +;; which is in turn inspired by +; https://gist.github.com/shortsightedsid/71cf34282dfae0dd2528 +; https://gist.github.com/shortsightedsid/a760e0d83a9557aaffcc +; http://mihai.bazon.net/blog/howto-multi-threaded-tcp-server-in-common-lisp + +(defpackage :facilservil + (:use :cl) + (:export :server :ex-server + :send :recieve + :dig :bury + :close-it + :get-ip + :socket→con + :logger)) + +(in-package :facilservil) + +;; ————————————————————————————————————— +;; CLASSES + +(defclass connection () + ((socket :accessor con→socket :initarg :socket) + (data :initform (make-hash-table :test #'equal) :initarg :data))) + + + +;; ————————————————————————————————————— +;; MACROS + +;; LIST-OF-CONNECTIONS CONNECTION FUNCTION FUNCTION → NIL +(defmacro old-activity (all-connections con on-input on-disconnect) + "Macro for #'server, for handling client activity." + `(bordeaux-threads:make-thread + (lambda () + (handler-case + (process-con-activity ,con ,all-connections ,on-input) + (t (e) + (logger "Error during processing ~a" e) + (setf ,all-connections (delete ,con ,all-connections)) + (funcall ,on-disconnect ,con ,all-connections) + (close-it ,con)))))) + + +;; LIST-OF-CONNECTIONS CONNECTION FUNCTION +(defmacro new-connection (all-connections master-con on-connect) + "Macro for #'server, for handling new connections." + `(let* ((new-socket + (usocket:socket-accept (con→socket ,master-con) :element-type 'character)) + (new-con + (make-instance 'connection :socket new-socket))) + (logger "New connection from ~A" (get-ip new-con)) + (push new-con ,all-connections) + (funcall on-connect new-con ,all-connections))) + + + +;; ————————————————————————————————————— +;; SERVER + +;; STRING NUMBER [:FUNCTION :FUNCTION :FUNCTION] → NIL +(defun server (host port &key (on-connect #'blank) (on-input #'blank) + (on-disconnect #'blank) (on-loop #'blank)) + "Starts server on given host at given port; and executes the given functions + (with connection/connections/input as arguments) according to their triggers. + This is the function you want to use. + Look at #'ex-*, the example server, for example of use." + (let* ((master-socket (usocket:socket-listen host port :backlog 256)) + (master-con (make-instance 'connection :socket master-socket)) + (all-connections `(,master-con))) + (loop + (loop for con in (wait-for-input all-connections) + do (if (eq con master-con) + (new-connection all-connections master-con on-connect) + (old-activity all-connections con on-input on-disconnect))) + (funcall on-loop all-connections)))) + + +;; STRING NUMBER → THREAD +(defun server-in-thread (host port) + "Run the TCP server in a seperate thread." + (let ((thread-name (format nil "facilservil"))) + (logger "Starting server in a separate thread:'~a'" thread-name) + (bordeaux-threads:make-thread + (lambda () (server host port)) + :name thread-name))) + + + +;; ————————————————————————————————————— +;; CONNECTION I/O + +(defgeneric send (target message &rest args) + (:documentation "Send a given message to a target user.")) + +;; CONNECTION VARYING → NIL +(defmethod send ((con connection) message &rest args) + (apply 'send (append (list (con→socket con) message) args))) + +;; STREAM-USOCKET VARYING → NIL +(defmethod send ((socket usocket::stream-usocket) message &rest args) + (let ((sstream (usocket:socket-stream socket))) + (apply 'format (append (list sstream message) args)) +;; (format sstream (format nil (format nil "~A" message))) + (force-output sstream))) + +;; STREAM-SERVER-USOCKET VARYING → NIL +(defmethod send ((s usocket::stream-server-usocket) a &rest d) nil) + +;; LIST-OF-SOCKETS/CONNECTIONS VARYING → NIL +(defmethod send ((sockets list) message &rest args) + (mapcar (lambda (socket) + (apply 'send (append (list socket message) args))) sockets)) + +;; ————————————————— + +(defgeneric recieve (target) + (:documentation "Recieve a string from a given target.")) + +;; CONNECTION → STRING +(defmethod recieve ((con connection)) + (recieve (con→socket con))) + +;; STREAM-USOCKET → STRING +(defmethod recieve ((socket usocket::stream-usocket)) + (string-sanitize (read-line (usocket:socket-stream socket)))) + +;; STREAM-SERVER-USOCKET → NIL +(defmethod recieve ((socket usocket::stream-server-usocket)) nil) + + + +;; ————————————————————————————————————— +;; CONNECTION STORAGE + +;; CONNECTION STRING → VARYING +(defun dig (connection variable) + "Get the value of a variable from the connection's hashtable." + (gethash variable (slot-value connection 'data))) + +;; CONNECTION STRING VARYING → VARYING +(defun bury (connection variable value) + "Set the value of a variable in the connection's hashtable." + (setf (gethash variable (slot-value connection 'data)) value)) + + + +;; ————————————————————————————————————— +;; CONNECTION MANAGEMENT + +;; SOCKET → NIL +(defun process-con-activity (con connection-list on-input) + "Process client socket that got some activity" + (let ((message (recieve con))) + (logger "~A: ~A" (get-ip con) message) + (funcall on-input con message connection-list))) + +;; ————————————————— + +(defgeneric close-it (target con-list on-disconnect) + (:documentation "Shut down a target's connection, forcefully. + Run the disconnect function as well.")) + +;; CONNECTION LIST-OF-CONNECTIONS FUNCTION +(defmethod close-it ((con connection) connection-list on-disconnect) + (close (con→stream con) connection-list on-disconnect)) + +;; STREAM-USOCKET LIST-OF-CONNECTIONS FUNCTION +(defmethod close-it ((socket usocket:stream-usocket) connection-list on-disconnect) + (funcall on-disconnect socket connection-list) + (handler-case + (usocket:socket-close socket) + (error (e) + (logger "Ignoring the error from closing connection: ~a" e))) + (logger "Connection closed: ~A" con)) + +;; ————————————————— + +;; SOCKET LIST-OF-CONNECTIONS → CONNECTION +(defun socket→con (socket connections) + "Return the connection— from a list of them— that matches the given socket." + (loop :for con :in connections + :if (eq (con→socket con) socket) + :return con)) + +;; ————————————————— + +;; LIST-OF-CONNECTIONS → LIST-OF-READY-CONNECTIONS +(defun wait-for-input (connections) + "Basically a wrapper around #'usocket:wait-for-input, but for connections + rather than stream-usocket objects." + (let ((sockets (mapcar #'con→socket connections))) + (mapcar (lambda (socket) (socket→con socket connections)) + (usocket:wait-for-input sockets :timeout 10 :ready-only 'T)))) + + + +;; ————————————————————————————————————— +;; LOGGING, ETC + +;; STRING … ARG → NIL +(defun logger (text &rest args) + "Simple wrapper around format func to simplify logging." + (apply 'format (append (list t (concatenate 'string text "~%")) args))) + + + +;; ————————————————————————————————————— +;; CONNECTION METADATA + +(defgeneric server-p (target) + (:documentation "Return if a given item's the server's connection/socket.")) + +;; USOCKET → BOOL +(defmethod server-p ((socket usocket::usocket)) + (eq (type-of socket) 'usocket:stream-server-usocket)) + +;; CONNECTION → BOOL +(defmethod server-p ((con connection)) + (server-p (con→socket con))) + +;; ————————————————— + +(defgeneric get-ip (target) + (:documentation "Return the IP address of a given socket/connection.")) + +;; CONNECTION → IP +(defmethod get-ip ((con connection)) + (get-ip (con→socket con))) + +;; STREAM-USOCKET → IP +(defmethod get-ip ((socket usocket::stream-usocket)) + (usocket:get-peer-address socket)) + + + +;; ————————————————————————————————————— +;; MISC + +;; STRING → STRING +(defun string-remove-octets (string &rest restricted-octs) + "Remove characters from a string matching any passed 'restricted' octet." + (let ((octets (flexi-streams:string-to-octets string :external-format :utf-8))) + (mapcar (lambda (octet) (setq octets (remove octet octets))) restricted-octs) + (flexi-streams:octets-to-string octets :external-format :utf-8))) + +;; NUMBER NUMBER → LIST +(defun range (start end) + "Return whole numbers between start and end, inclusive." + (loop :for i :from start :to end :collect i)) + +(defun string-sanitize (string) + (string-remove-octets string 12 13 14 15)) + +;; VARYING … → NIL +(defun blank (&rest ignored) + "Literal nothing. Used as a default for #'server, so that one can ommit + any given trigger, if they want." + nil) + + + +;; ————————————————————————————————————— +;; EXAMPLE SERVER + +;; This is a general outline of any server using facilservil. +;; Four functions for each type of trigger (connection, disconnection, input, +;; loop), passed to the #'facilservil:server function. + +;; If you can't tell, it's a simple chat server! + +;; STRING NUMBER +(defun ex-server (host port) + "Wrapping up the example-server for convenience." + (server host port + :on-connect #'ex-connect :on-disconnect #'ex-disconnect + :on-input #'ex-input :on-loop #'ex-loop)) + + +;; CONNECTION LIST-OF-CONNECTIONS → NIL +(defun ex-connect (con con-list) + "Executed whenever a client connects." + (bury con "id-number" (random 9999)) + + (send con "Welcome to facila example! ♥~%") + (send con "Users online now—~%") + (mapcar (lambda (acon) (send con "~A, " (dig acon "id-number"))) con-list) + (send con "~%~%") + + (send con-list + (format nil "~A just joined as ~A!~%" + (get-ip con) (dig con "id-number")))) + + +;; CONNECTION LIST-OF-CONNECTIONS → NIL +(defun ex-disconnect (con con-list) + "Executed whenever a client disconnects." + (send con-list (format nil "~A just died~%" (dig con "id-number")))) + +;; CONNECTION STRING LIST-OF-CONNECTIONS → NIL +(defun ex-input (con input con-list) + "Executed on a connection + it's input." + (send (remove con con-list) "~A: ~A~%" (dig con "id-number") input)) + +;; LIST-OF-CONNECTIONS → NIL +(defun ex-loop (con-list) + "Executed after input taken, or after #'wait-until-input timeout + (so maximum, every 10 seconds)." + nil) diff --git a/src/client.lisp b/src/client.lisp deleted file mode 100644 index 5bdbb62..0000000 --- a/src/client.lisp +++ /dev/null @@ -1,119 +0,0 @@ -(in-package :facilservil) - -;: SOCKET --> STRING -(defun make-socket-id (socket) - "Create a socket-id from a socket." - (format nil "~A" socket)) - -;; NIL --> NUMBER -(defun make-client-id () - "Generate a new client ID." - (random 999999)) - -;; STRING --> STRING -(defun client-data-id (client-id data) - "Make an 'input ID' from a client-id." - (format nil "~A-~A" client-id data)) - - -;; ------------------------------------- - - -;; SOCKET --> NUMBER -(defun socket-to-client (socket) - "Return the client of a socket." - (cadr (socket-pair socket))) - - -;; NUMBER --> SOCKET -(defun client-to-socket (client) - "Return the socket of a client." - (car (client-pair client))) - - - -;; NUMBER --> LIST -(defun client-pair (client) - "Return the '(socket client) pair of a client." - (nih:getf-cadr *socket-client* client)) - - -;; SOCKET --> LIST -(defun socket-pair (socket) - "Return the '(socket client) pair of a socket." - (nih:getf-car *socket-client* socket)) - - -;; ------------------------------------- - - -;; NUMBER STRING DATA --> NIL -(defun client-data-set (client data value) - "Set a piece of a `client`'s `data` to `value`." - - (setf - (gethash (client-data-id client data) *client-data*) - value)) - - -;; NUMBER STRING --> ??? -(defun client-data-get (client data) - "Get the value of a client's `data` from *client-data*." - (gethash (client-data-id client data) *client-data*)) - - -;; NUMBER STRING --> NIL -(defun client-data-rem (client data) - "Remove a piece of client's `data` from *client-data*." - (remhash (client-data-id client data) *client-data*)) - - -;; ------------------------------------- - - -;; SOCKET --> NIL -(defun socket-register (socket) - "Register a new socket; add their data to globals, log it, etc." - - (let* ((client-id (make-client-id))) - - (setq *socket-list* (concatenate 'list *socket-list* (list socket))) - - (setq *socket-client* (concatenate 'list *socket-client* - (list (list socket client-id)))) - (setq *csocket-list* (concatenate 'list *csocket-list* - (list socket))) - (setq - *client-list* (concatenate 'list *client-list* - (list client-id))) - - (client-data-set client-id "input" '()) - - (journal (format nil "Client ~A has connected!" client-id) "Connect"))) - - -;; ------------------------------------- - - -;; NUMBER --> NIL -(defun client-slaughter (client) - "Clean up data from client, and disconnect their socket." - (socket-slaughter (client-to-socket client))) - - -;; SOCKET --> NIL -(defun socket-slaughter (socket) - "Clean up data from a client, and disconnect their socket." - - (let* ((client-id (socket-to-client socket))) - - (client-data-rem client-id "input") - (setq *socket-client* (delete (socket-pair socket) *socket-client*)) - (setq *socket-list* (delete socket *socket-list*)) - (setq *client-list* (delete client-id *client-list*)) - (setq *csocket-list* (delete socket *csocket-list*)) - - (usocket:socket-close socket) - (journal - (format nil "Client ~A has disconnected." client-id) - "Disconnect"))) diff --git a/src/ex.lisp b/src/ex.lisp deleted file mode 100644 index 14a94e8..0000000 --- a/src/ex.lisp +++ /dev/null @@ -1,60 +0,0 @@ -(in-package :facilservil) - - -(defun connect-ex (socket client-id) - "Example connection handler-- sends a friendly welcome message!" - - (client-write client-id - (format nil "Hey, welcome to this server, ~A! <3" client-id) - 'T)) - - -(defun disconnect-ex (socket client-id) - "Example disconnection handler-- tells the world, for some reason." - - (client-broadcast - (format nil "~%~A's just run away... NIL -(defun ex-server (port) - "Start a server-instance with the built-in example functions. - Demonstration purposes only!" - - (server "0.0.0.0" port 'connect-ex 'disconnect-ex 'input-handle-ex)) diff --git a/src/io.lisp b/src/io.lisp deleted file mode 100644 index 3dabda1..0000000 --- a/src/io.lisp +++ /dev/null @@ -1,168 +0,0 @@ -(in-package :facilservil) - - -;; ------------------------------------- -;; SOCKET I/O - - -;; SOCKET --> NIL -(defun socket-read (socket) - "Read new input from a client socket to its `stack` list of bytes." - - (let* ((client-id (socket-to-client socket)) - (input-stack (client-data-get client-id "input"))) - (client-data-set - client-id "input" - (concatenate 'list input-stack - (list (read-byte (usocket:socket-stream socket))))))) - - -;; SOCKET LIST/ARRAY --> NIL -(defun socket-write-bytes (socket bytes) - "Write bytes to a client socket." - - (let ((sstream (usocket:socket-stream socket)) - (i 0)) - (loop - :while (< i (length bytes)) - :do - (cond ((listp bytes) - (write-byte (nth i bytes) sstream)) - ((arrayp bytes) - (write-byte (aref bytes i) sstream))) - (setq i (+ i 1))) - - (force-output sstream))) - - -;; SOCKET STRING [BOOLEAN] --> NIL -(defun socket-write (socket string &optional (line-break nil)) - "Writes a string to a socket-- w/o line-break, by default." - - (socket-write-bytes - socket - (ignore-errors - (babel:string-to-octets - (if line-break - (format nil "~A~%" string) - string) - :encoding :utf-8)))) - - -;; STRING [BOOLEAN] [SOCKET] --> NIL -(defun socket-broadcast (string &optional (line-break nil) (exception nil)) - "Writes a `string` to all client sockets (aside from an `exception`)." - - (client-broadcast string line-break - (socket-to-client exception))) - - -;; SOCKET --> NIL -(defun socket-input-flush (socket) - "Clean all input from a socket." - - (let ((client-id (socket-to-client socket))) - (client-data-set client-id "input" '()))) - - -;; SOCKET --> STRING -(defun socket-input-string (socket) - "Get input from a socket as a string." - - (client-input-string (socket-to-client socket))) - - - -;; ------------------------------------- -;; CLIENT I/O - - - -;; NUMBER --> NIL -(defun client-read (client) - "Read new input from a client to their stack of input bytes." - - (socket-read (client-to-socket client))) - - -;; NUMBER LIST --> NIL -(defun client-write-bytes (client bytes) - "Write bytes to a client's socket." - (format t "CLIENT-TO-SOCKET: " (client-to-socket client)) - - (socket-write-bytes (client-to-socket client) bytes)) - - -;; NUMBER STRING [BOOLEAN] --> NIL -(defun client-write (client string &optional (line-break nil)) - "Writes a string to a client's socket-- w/o line-break, default." - - (socket-write (client-to-socket client) string line-break)) - - -;; NUMBER --> NIL -(defun client-input-flush (client) - "Clean up input from a client." - - (socket-input-flush (client-to-socket client))) - - -;; STRING [BOOLEAN] [SOCKET] --> NIL -(defun client-broadcast (string &optional (line-break nil) (exception nil)) - "Writes a `string` to all client sockets (aside from an `exception`-- w/o line-break, by default." - - (mapcar - (lambda (client) - (if (not (eq client exception)) - (client-write client string line-break))) - *client-list*)) - - -;; NUMBER --> STRING -(defun client-input-string (client) - "Get input from a client as a string." - - (let* ((input-bytes (client-data-get client "input")) - (sanitized-bytes (remove-newline-bytes input-bytes)) - (byte-vector (list-to-byte-vector sanitized-bytes))) - - (if sanitized-bytes - (ignore-errors (babel:octets-to-string byte-vector :encoding :utf-8)) - ""))) - - - -(defun list-to-byte-vector (list) - (make-array (list (length list)) - :initial-contents list - :element-type '(unsigned-byte 8))) - - -;; ------------------------------------- - -;; SOCKET --> BOOLEAN -(defun socket-connectp (socket) - "Return whether or not a socket is still connected." - (listen (usocket:socket-stream socket))) - -;; ------------------------------------- -;; MISC. - - - -;; LIST --> LIST -(defun remove-newline-bytes (bytes) - "Remove undesired bytes-- null, LF, CR, etc, from a list of bytes." - - (remove 0 (remove 10 (remove 13 bytes)))) - - -;; SOCKET -(defun commandp (byte-list command-byte) - "Returns whether or not a command is complete, judging on it's bytes." - - (let* ((last-byte (car (last byte-list)))) - - (eq command-byte last-byte))) - - diff --git a/src/meta.lisp b/src/meta.lisp deleted file mode 100644 index 840ac2e..0000000 --- a/src/meta.lisp +++ /dev/null @@ -1,58 +0,0 @@ -(in-package :facilservil) - - -;; DATA [STRING] --> STRING -(defun journal (data &optional (name "unnamed") (second-name "-")) - "Print out a piece of data for logging on stdout." - (format t "~A | ~A | ~A | ~A~%" - (string-date (get-universal-time)) - (force-string-length name 10) - (force-string-length second-name 10) - data)) - - -(defun standard-journaling ()) - - -;; ------------------------------------- - - -(defun string-date (universal-time) - (multiple-value-bind (second minute hour day month year) - (decode-universal-time universal-time) - - (nih:string-combine - (nih:string-combine year (make-digits month 2) (make-digits day 2) - :seperator "-") - " " - (nih:string-combine (make-digits hour 2) (make-digits minute 2) - (make-digits second 2) :seperator ":")))) - - -(defun make-digits (string number) - (nih:min-string-length string number :prefix "0")) - - -;; LIST --> STRING -(defun print-bytes (bytes) - "Print a list of (UTF-8) bytes as a string to stdout." - - (if bytes - (format t "~A" - (ignore-errors (babel:octets-to-string bytes :encoding :utf-8))))) - - -;; STRING NUMBER [STRING} --> STRING -(defun force-string-length (string desired-length &key (prefix "") (suffix " ")) - "Force a string to be of a certain length-- by whatever means necessary!" - - (cond - ((< (length string) desired-length) - (nih:min-string-length string desired-length :suffix suffix :prefix prefix)) - - ((< desired-length (length string)) - (nih:line-car (nih:max-string-length string desired-length))) - - ((eq (length string) desired-length) - string) - (nih:min-string-length string desired-length :suffix suffix))) diff --git a/src/package.lisp b/src/package.lisp deleted file mode 100644 index b680ca5..0000000 --- a/src/package.lisp +++ /dev/null @@ -1,54 +0,0 @@ -(defpackage :facilservil - (:use :cl) - (:nicknames :fs) - (:export - - *socket-client* - - *socket-list* - *csocket-list* - - *client-list* - *client-data* - - :journal - - :client-write - :cline-write-bytes - :client-broadcast - :client-read - :client-slaughter - - :socket-write - :socket-write-bytes - :socket-broadcast - :socket-read - :socket-register - :socket-slaughter - - :client-data-get - :client-data-set - :client-data-rem - - :socket-to-client - :client-to-socket - - :connect-ex - :disconnect-ex - :input-handle-ex - :halt-ex - :reboot-ex - - :ex-server - - :server-shutdown - :server-reboot - - :strequal - - :server)) - -(in-package :facilservil) - - -(rename-package :trivial-utf-8 :trivial-utf-8 (list :tu8)) diff --git a/src/server.lisp b/src/server.lisp deleted file mode 100644 index 1349dfa..0000000 --- a/src/server.lisp +++ /dev/null @@ -1,135 +0,0 @@ -(in-package :facilservil) - -;; ------------------------------------- -;; GLOBAL VARIABLES - -(defvar *socket-client* '()) - -(defvar *client-list* '()) -(defvar *client-data* '()) - -(defvar *socket-list* '()) -(defvar *csocket-list* '()) - - - -(defun reset-globals () - "Set all global variables to default state." - (setq *socket-client* '()) ;; list correlating client IDs and sockets - - (setq *client-list* '()) ;; list of client (ID numbers) - (setq *client-data* (make-hash-table :test 'equal)) - - (setq *socket-list* '()) ;; all sockets - (setq *csocket-list* '())) ;; all sockets except for master socket - - -;; ------------------------------------- - - -;; STRING NUMBER CHARACTER FUNCTION-NAME FUNCTION-NAME FUNCTION-NAME --> NIL -(defun server - (host port connecting disconnecting input-handler - &key (command-byte 10) (halting 'halt-ex) (init 'blank)) - - "Runs the basic server on `host`:`port`, running `connecting` when a new - client connects, `disconnecting` when one disconnects, and `input-handler` - when the byte `command-byte` is recieved as input. - - The three user-provided functions must take the following two arguments: - (socket client-id) - - The exception, `input-handler`, takes three arguments: - (socket client-id client-input-string) - - Inspired by - http://mihai.bazon.net/blog/howto-multi-threaded-tcp-server-in-common-lisp" - - (let* ((master-socket - (usocket:socket-listen host port - :reuse-address 'T - :element-type '(unsigned-byte 8)))) - (reset-globals) - (setq *socket-list* (list master-socket)) - - (funcall init) - - (unwind-protect - (loop - (loop - :for socket - :in (usocket:wait-for-input *socket-list* :ready-only 'T) - :do - (cond - - ;; if new connection... - ((eq socket master-socket) - (let ((new-socket (usocket:socket-accept socket))) - - ;; add data to client-pairs, socket-pairs, client-data vv - (socket-register new-socket) - - ;; execute user-provided #'connecting ^-^ - (funcall connecting new-socket (socket-to-client new-socket)))) - - - ;; ...if functioning old connection... - ((socket-connectp socket) - (progn (socket-read socket) - ;; check if command is complete-- if so, use user-provided - ;; input-handler. - (let* ((client-id (socket-to-client socket)) - (client-bytes (client-data-get client-id "input")) - (client-input (client-input-string client-id))) - - ;; if reached *command-byte*, handle and flush input - (if (commandp client-bytes command-byte) - (progn - (funcall input-handler socket client-id client-input) - (socket-input-flush socket)))))) - - - ;; ...if EOF connection or error...