diff --git a/COPYING b/COPYING deleted file mode 100644 index 94a9ed0..0000000 --- a/COPYING +++ /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/src/Makefile.am b/src/Makefile.am index e90b5de..03e5280 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -3,11 +3,14 @@ LIBS = $(INTLLIBS) PROGS = gameserver -INCLUDES = -I../include +# INCLUDES = -I./include bin_PROGRAMS = $(PROGS) -gameserver_SOURCES = gameserver.c +gameserver_SOURCES = gameserver.c clientClose.c clientRead.c \ + daemonize.c handleCmdLine.c logRotate.c monitor.c \ + serverInit.c serverRun.c serverShutdown.c signalHandling.c \ + socket.c writeBuffer.c # install: install-am # strip -x $(DESTDIR)$(libdir)/libscot.so.0.0.2 diff --git a/src/clientClose.c b/src/clientClose.c new file mode 100644 index 0000000..85983dd --- /dev/null +++ b/src/clientClose.c @@ -0,0 +1,27 @@ +#include /* for free() */ +#include /* for close() */ +#include /* for shutdown() */ +#include /* for memset and stuff */ + +#include "include/appConfig.h" +#include "include/client.h" +#include "include/monitor.h" + +void clientClose(tClient * client) +{ + if (0 != verbose) { + syslog(LOG_INFO, "closing socket for %s", client->remoteAddr); + } + + /* close socket an remove from fd_set */ + shutdown(client->socket, SHUT_RDWR); + close(client->socket); + + /* free buffer */ + free(client->buffer); + client->buffer = NULL; + client->socket = 0; + client->readPos = 0; + client->bufMult = 0; + memset(client->remoteAddr, 0, 16); +} diff --git a/src/clientRead.c b/src/clientRead.c new file mode 100644 index 0000000..578a5d5 --- /dev/null +++ b/src/clientRead.c @@ -0,0 +1,87 @@ +#include /* for getopt */ +#include /* for exit */ +#include /* for memset and stuff */ +#include /* for errno */ + +#include "include/client.h" +#include "include/monitor.h" + +#define GET_MULTIPLIER(size) (((size) - 1) / READBUFSIZE + 1) +int +_clientReallocBuffer(tClient * client, unsigned int newSize) +{ + unsigned int newMult = GET_MULTIPLIER(newSize); + + if (CLIENTMULTMAX < newMult) { + /* line exceeds maximum line length */ + + return 0; + } + + if (client->bufMult < newMult) { + + char * newBuffer = calloc(newMult * READBUFSIZE, sizeof(char)); + + if (NULL == newBuffer) { + + syslogMonitor(LOG_ERR, MON_CRITICAL, "calloc", + "calloc for readbuffer[%s] failed", + client->remoteAddr); + + syslogMonitor(LOG_ERR, MON_FAILURE, "calloc", + "calloc for readbuffer[%s] failed - service terminated", + client->remoteAddr); + + exit(EXIT_FAILURE); + } + + if (NULL != client->buffer) { + memcpy(newBuffer, client->buffer, client->readPos); + free(client->buffer); + } + + client->buffer = newBuffer; + client->bufMult = newMult; + } + + return newMult; +} + +int clientRead(tClient * client) +{ + int readSize; + char readBuf[READBUFSIZE]; + + /* + * initialize values // read data from socket + */ + memset(readBuf, 0, READBUFSIZE); + readSize = read(client->socket, readBuf, READBUFSIZE); + + switch (readSize) { + case -1: + syslogMonitor(LOG_WARNING, MON_WARNING, "socket.read", + "read returns -1 for client[%s]: %s - connection closed", + client->remoteAddr, strerror(errno)); + break; + + case 0: + break; + + default: + if (!_clientReallocBuffer(client, client->readPos + readSize)) { + + syslogMonitor(LOG_WARNING, MON_WARNING, "data.longline", + "got to long line from client[%s] - connection closed", + client->remoteAddr); + + return READ_ERR_LONGLINE; + } + + memcpy(client->buffer+client->readPos, readBuf, readSize); + client->readPos += readSize; + break; + } + + return readSize; +} diff --git a/src/daemonize.c b/src/daemonize.c new file mode 100644 index 0000000..6776da1 --- /dev/null +++ b/src/daemonize.c @@ -0,0 +1,23 @@ +#include /* for printf() and fprintf() */ +#include /* for getopt */ +#include + + +void daemonize(void) { + pid_t pid; + + if (0 > ((pid = fork()))) { + perror("deamoinze[fork]"); + exit(EXIT_FAILURE); + } else if (0 != pid) { + exit(EXIT_SUCCESS); + } + + /* make new child session leader */ + setsid(); + + /* connect all standard streams to /dev/null */ + freopen("/dev/null", "w", stderr); + freopen("/dev/null", "r", stdin); + freopen("/dev/null", "w", stdout); +} diff --git a/src/gameserver.c b/src/gameserver.c index 5cbd9f3..2a5ea83 100644 --- a/src/gameserver.c +++ b/src/gameserver.c @@ -1,54 +1,56 @@ -/*************************************************************************** - * - * gameserver.c: This is a gameserver....more to come - * - * Copyright (C) 2009 Georg Steffers - * This file is part of gameserver - * - * gameserver 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 . - * - * Author: Georg Steffers (gst), georg@steffers.org - * - * Version: 0.0 - * Created: 16.08.2009 18:52:57 - * Revision: none - * - ***************************************************************************/ - - -/* #### HEADER FILE INCLUDES ######################################### */ -#include -#include - -/* #### MACROS - LOCAL TO THIS SOURCE FILE ######################### */ - -/* #### TYPE DEFINITIONS - LOCAL TO THIS SOURCE FILE ############### */ - -/* #### DATA TYPES - LOCAL TO THIS SOURCE FILE ##################### */ - -/* #### VARIABLES - LOCAL TO THIS SOURCE FILE ###################### */ - -/* #### PROTOTYPES - LOCAL TO THIS SOURCE FILE ##################### */ - -/* #### FUNCTION DEFINITIONS - EXPORTED FUNCTIONS ################## */ - -/* #### FUNCTION DEFINITIONS - LOCAL TO THIS SOURCE FILE ########### */ +#include /* for memset and stuff */ +#include /* for logging */ + +#include "include/server.h" +#include "include/monitor.h" +#include "include/signalHandling.h" +#include "include/appConfig.h" +#include "include/daemonize.h" + +/* some global configurations */ +/* TODO: make this whole stuff work without these globals */ +unsigned char verbose; +unsigned char doGzip; + int -main ( int argc, char *argv[] ) +main(int argc, char *argv[]) { - printf ( "Hello World\n" ); - - return EXIT_SUCCESS; -} /* ---------- end of function main ---------- */ + tVirtualItemServer server; + + tAppConfig appConfig = { + 0, // no verbose + 0, // no daemon + 0, // no gzip + MAXPENDING, + DEFAULTPORT, + DEFAULTPATH, + LOGNAMEPATTERN + }; + + memset(&server, 0, sizeof(server)); + + handleCmdLine(&appConfig, argc, argv); + verbose = appConfig.verbose; + doGzip = appConfig.doGzip; + + /* decouple procss from controlling shell and make it session leader */ + if (appConfig.doDaemon) { + daemonize(); + } + init_signals(); + openlog(argv[0], LOG_PID, LOG_USER); + + syslogMonitor(LOG_INFO, MON_INFO, "startup", "service started"); + + serverInit( + &server, + appConfig.port, + appConfig.maxPending, + appConfig.logPath, + appConfig.namePat); + serverRun(&server); + serverShutdown(&server); + + return 0; +} diff --git a/src/handleCmdLine.c b/src/handleCmdLine.c new file mode 100644 index 0000000..f45b5f2 --- /dev/null +++ b/src/handleCmdLine.c @@ -0,0 +1,74 @@ +#include /* for getopt */ +#include +#include +#include + +#include "include/appConfig.h" + +int +handleCmdLine(tAppConfig * config, int argc, char *argv[]) +{ + int opt; + + while ((opt = getopt(argc, argv, "Dvgp:l:n:b:")) != -1) { + switch (opt) { + case 'p': + /* port */ + config->port = atoi(optarg); + break; + + case 'l': + /* logPath */ + strncpy(config->logPath, optarg, sizeof(config->logPath)-1); + break; + + case 'n': + /* logNamePattern */ + strncpy(config->namePat, optarg, sizeof(config->namePat)-1); + break; + + case 'b': + /* maxPending (connection backlog) */ + config->maxPending = atoi(optarg); + break; + + case 'v': + /* verbose */ + config->verbose = 1; + break; + + case 'g': + /* do gzip of data */ + config->doGzip = 1; + break; + + case 'D': + /* verbose */ + config->doDaemon = 1; + break; + + default: + /* '?' */ + fprintf( + stderr, + "Usage: %s [-p port] [-l logPath] [-n logNamePattern] [-c maxClient] [-b backlog] [-v] [-D]\n" + "Defaults:\n" + "\t%-20s: port this service will use [%d]\n" + "\t%-20s: path where the logfiles will be stored [%s/]\n" + "\t%-20s: patten used by strftime to create the log filename [%s]\n" + "\t%-20s: maximum connection backlog [%d]\n" + "\t%-20s: be more verbose in syslog [off]\n" + "\t%-20s: deamonize me\n", + argv[0], + "-p port", DEFAULTPORT, + "-l logPath", DEFAULTPATH, + "-n logNamePattern", LOGNAMEPATTERN, + "-b backlog", MAXPENDING, + "-v", + "-D"); + exit(EXIT_FAILURE); + } + } + + return 0; +} diff --git a/src/include/appConfig.h b/src/include/appConfig.h new file mode 100644 index 0000000..90956e1 --- /dev/null +++ b/src/include/appConfig.h @@ -0,0 +1,27 @@ +#ifndef __APP_CONFIG_H__ +#define __APP_CONFIG_H__ + +#define MAXPENDING 10 /* Maximum outstanding connection requests */ +#define MAXCLIENTS 1000 /* Maximum connection handled in paralell */ +#define READBUFSIZE 2048 /* Size of receive buffer */ +#define DEFAULTPORT 8801 /* default port for service */ +#define DEFAULTPATH "logfiles" +#define LOGNAMEPATTERN "log-%Y-%m-%d_%Hh" + +typedef struct { + unsigned char verbose; + unsigned char doDaemon; + unsigned char doGzip; + unsigned int maxPending; + unsigned int port; + char logPath[513]; + char namePat[513]; +} tAppConfig; + +extern unsigned char verbose; +extern unsigned char doGzip; + +int +handleCmdLine(tAppConfig * config, int argc, char *argv[]); + +#endif // __APP_CONFIG_H__ diff --git a/src/include/client.h b/src/include/client.h new file mode 100644 index 0000000..c265f73 --- /dev/null +++ b/src/include/client.h @@ -0,0 +1,28 @@ +#ifndef __CLIENT_H__ +#define __CLIENT_H__ + +#include /* for FILE */ + +#define READBUFSIZE 2048 /* Size of receive buffer */ +#define CLIENTMULTMAX 512U /* 1MB maximum size the readbuffer may grow */ + +#define WRITE_ERR_IO -1 +#define WRITE_ERR_NOPRINT -2 + +#define READ_ERR_LONGLINE -2 + +typedef struct { + int socket; + char * buffer; + unsigned int readPos; + unsigned int bufMult; + char remoteAddr[16]; +} tClient; + + +void clientClose(tClient *); +int clientRead(tClient *); +int writeRemaining(tClient *, FILE *); +int writeBuffer(tClient *, FILE *); + +#endif // __CLIENT_H__ diff --git a/src/include/daemonize.h b/src/include/daemonize.h new file mode 100644 index 0000000..209aed3 --- /dev/null +++ b/src/include/daemonize.h @@ -0,0 +1,6 @@ +#ifndef __DAEMONIZE_H__ +#define __DAEMONIZE_H__ + +void daemonize(void); + +#endif // __DAEMONIZE_H__ diff --git a/src/include/monitor.h b/src/include/monitor.h new file mode 100644 index 0000000..35c6a40 --- /dev/null +++ b/src/include/monitor.h @@ -0,0 +1,14 @@ +#ifndef __MONITOR_H__ +#define __MONITOR_H__ + +#include /* for logging */ + +#define MON_INFO 0 +#define MON_WARNING 1 +#define MON_CRITICAL 2 +#define MON_FAILURE 3 + +int monitor(unsigned int sev, const char * pattern, const char * message); +int syslogMonitor (unsigned int logLvl, unsigned int sev, const char *pattern, const char * message, ...) __attribute__ ((format (printf, 4, 5))); + +#endif /* __MONITOR_H__ */ diff --git a/src/include/server.h b/src/include/server.h new file mode 100644 index 0000000..bc9a51f --- /dev/null +++ b/src/include/server.h @@ -0,0 +1,31 @@ +#ifndef __SERVER_H__ +#define __SERVER_H__ + +#include /* for printf() and fprintf() */ +#include /* for select system call and related */ + +#include "client.h" + +typedef struct { + int servSock; + tClient clients[FD_SETSIZE]; + unsigned int maxFd; + fd_set socks; + char logPath[512]; + char namePat[512]; + FILE * wHandle; +} tVirtualItemServer; + + +void serverClose(tVirtualItemServer *); +void serverShutdown(tVirtualItemServer *); +void serverInit( + tVirtualItemServer *, + unsigned int, + unsigned int, + const char *, + const char *); +void serverRun(tVirtualItemServer *); +void logRotate(tVirtualItemServer *); + +#endif // __SERVER_H__ diff --git a/src/include/signalHandling.h b/src/include/signalHandling.h new file mode 100644 index 0000000..0bd25b0 --- /dev/null +++ b/src/include/signalHandling.h @@ -0,0 +1,10 @@ +#ifndef __SIGNAL_HANDLING_H__ +#define __SIGNAL_HANDLING_H__ + +extern volatile int doShutdown; + +void terminate(int signum); +void init_signals(void); + +#endif // __SIGNAL_HANDLING_H__ + diff --git a/src/include/socket.h b/src/include/socket.h new file mode 100644 index 0000000..36a070a --- /dev/null +++ b/src/include/socket.h @@ -0,0 +1,9 @@ +#ifndef __SOCKET_H__ +#define __SOCKET_H__ + +#include /* for in_port_t */ + +int initServerSocket(in_port_t port, int backlog); +int acceptConnection(int servSock, char remoteAddr[16]); + +#endif /* __SOCKET_H__ */ diff --git a/src/logRotate.c b/src/logRotate.c new file mode 100644 index 0000000..b7242ae --- /dev/null +++ b/src/logRotate.c @@ -0,0 +1,109 @@ +#include /* for select system call and related */ +#include +#include /* for fork and exec */ +#include +#include /* for wait */ +#include /* fopen and stuff */ +#include /* exit */ +#include /* strncpy, memcpy, etc. */ +#include +#include + +#include "include/appConfig.h" +#include "include/monitor.h" +#include "include/server.h" + + +void +_gzip(tVirtualItemServer * server, const char * logName) +{ + pid_t gzipPid = fork(); + + switch(gzipPid) { + pid_t tmpPid; + + case 0: + /* first close everything in child */ + serverClose(server); + + // We don't care about finishing of child, so decouple it + // by using a second child that stop immediatly + tmpPid = fork(); + if (0 == tmpPid) { + syslog(LOG_INFO, "gzip: %s", logName); + // if (-1 == execl("/bin/gzip", "/bin/gzip", "-9", logName, (char *) 0)) { + if (-1 == execl("/bin/gzip", "/bin/gzip", logName, (char *) 0)) { + syslogMonitor(LOG_ERR, MON_WARNING, "logrotate.gzip", + "execl failed for gzip %s: %s", logName, strerror(errno)); + } + } + exit(EXIT_SUCCESS); + + case -1: + syslogMonitor(LOG_ERR, MON_WARNING, "logrotate.fork", + "fork failed for gzip %s: %s", logName, strerror(errno)); + break; + + default: + wait(NULL); + break; + } +} + + +void +logRotate(tVirtualItemServer * server) +{ + static char logName[1024] = ""; + + char strftimeName[128] = ""; + char newLogName[1024] = ""; + + time_t t; + struct tm *tmp; + + t = time(NULL); + tmp = localtime(&t); + if (tmp == NULL) { + syslogMonitor(LOG_ERR, MON_WARNING, "logrotate.localtime", + "can't get localtime for new logname. continue with old one"); + return; + } + + if (strftime( + strftimeName, + sizeof(strftimeName)-1, + server->namePat, + tmp) == 0) + { + syslogMonitor(LOG_ERR, MON_WARNING, "logrotate.strftime", + "strftime returned 0 for new logname. continue with old one"); + return; + } + + snprintf( + newLogName, + sizeof(newLogName)-1, + "%s/%s", + server->logPath, + strftimeName); + + if (0 != strncmp(logName, newLogName, sizeof(logName)-1)) { + if (0 != verbose) { + syslog(LOG_INFO, "actual logfile name: %s", logName); + syslog(LOG_INFO, "new logfile name: %s", newLogName); + } + + if (NULL != server->wHandle) { + fclose(server->wHandle); + server->wHandle = NULL; + + if (doGzip) { + _gzip(server, logName); + } + } + + strncpy(logName, newLogName, sizeof(logName)-1); + server->wHandle = fopen(logName, "w"); + } +} diff --git a/src/monitor.c b/src/monitor.c new file mode 100644 index 0000000..38aef69 --- /dev/null +++ b/src/monitor.c @@ -0,0 +1,87 @@ +#include /* for system() */ +#include +#include +#include +#include +#include +#include /* for ellipse handling */ + +#include "include/signalHandling.h" +#include "include/monitor.h" + + +#define MONITORCMD "/usr/bin/monitor" +#define MONITORTYPE "app" +#define MONITORNAME "virtualitem.logreceiver" + +const char severity[][10] = { + "info", + "warning", + "critical", + "failure" +}; + + +int +monitor( + unsigned int sev, + const char * pattern, + const char * message +) { + char monCall[1024]; + int ret; + + snprintf(monCall, 1023, + "%s %s %s.%s.%s \"%s\"", + MONITORCMD, + severity[sev], + MONITORTYPE, + MONITORNAME, + pattern, + message); + + ret = system(monCall); + + if (WIFSIGNALED(ret)) { + switch (WTERMSIG(ret)) { + case SIGINT: + case SIGQUIT: + syslog(LOG_INFO, "interrupted in monitor call"); + doShutdown=1; + } + } + + if (-1 == ret || 0 != WEXITSTATUS(ret)) { + syslog(LOG_ERR, "call monitoring failed: %s", strerror(errno)); + } + + return ret; +} + +/* this handles simple %d and %s replacements, + * complexer stuff must be prepared via snprintf + * the complete message should not extend 1024 + * Bytes, else it will be truncated silently */ +int +syslogMonitor( + unsigned int logLvl, + unsigned int sev, + const char * pattern, + const char * message, + ... +) { + va_list args; + char buffer[1025]; + int maxBuf = sizeof(buffer)/sizeof(buffer[0]); + + memset(buffer, 0, maxBuf); + + va_start(args, message); + vsnprintf(buffer, 1024, message, args); + va_end(args); + + syslog(logLvl, "%s", buffer); + monitor(sev, pattern, buffer); + + return 0; +} diff --git a/src/po b/src/po new file mode 100644 index 0000000..2436c49 --- /dev/null +++ b/src/po @@ -0,0 +1,19 @@ +# Sed script that remove the POT-Creation-Date line in the header entry +# from a POT file. +# +# The distinction between the first and the following occurrences of the +# pattern is achieved by looking at the hold space. +/^"POT-Creation-Date: .*"$/{ +x +# Test if the hold space is empty. +s/P/P/ +ta +# Yes it was empty. First occurrence. Remove the line. +g +d +bb +:a +# The hold space was nonempty. Following occurrences. Do nothing. +x +:b +} diff --git a/src/serverInit.c b/src/serverInit.c new file mode 100644 index 0000000..3a67b1f --- /dev/null +++ b/src/serverInit.c @@ -0,0 +1,43 @@ +#include /* for select system call and related */ +#include /* for memset and stuff */ +#include /* for getopt */ + +#include "include/server.h" +#include "include/socket.h" +#include "include/monitor.h" + +void +serverInit( + tVirtualItemServer * server, + unsigned int port, + unsigned int pending, + const char * logPath, + const char * namePat) +{ + FD_ZERO(&(server->socks)); + + server->servSock = initServerSocket(port, pending); + server->maxFd = server->servSock; + FD_SET(server->servSock, &(server->socks)); + + strncpy(server->logPath, logPath, sizeof(server->logPath)-1); + strncpy(server->namePat, namePat, sizeof(server->namePat)-1); + + memset(server->clients, 0, sizeof(server->clients)); + + /* + * try to open file (firstrun) + */ + if (NULL == server->wHandle) { + logRotate(server); + if (NULL == server->wHandle) { + syslogMonitor(LOG_ERR, MON_CRITICAL, "logfile.rotate", + "no valid handle for logfile"); + + syslogMonitor(LOG_ERR, MON_FAILURE, "logfile.rotate", + "no valid handle for logfile - service terminated"); + + exit(EXIT_FAILURE); + } + } +} diff --git a/src/serverRun.c b/src/serverRun.c new file mode 100644 index 0000000..b7844ed --- /dev/null +++ b/src/serverRun.c @@ -0,0 +1,128 @@ +#include /* for select system call and related */ +#include /* for memset and stuff */ +#include /* for exit */ +#include /* for errno */ + +#include "include/server.h" +#include "include/socket.h" +#include "include/monitor.h" +#include "include/signalHandling.h" + +#undef MAX +#define MAX(x,y) ((x) > (y) ? (x) : (y)) + +void +serverRun(tVirtualItemServer * server) +{ + syslogMonitor(LOG_INFO, MON_INFO, "startup", "service started"); + + while (!doShutdown) /* until error or signal */ + { + fd_set rfds; + int i; + + memcpy(&rfds, &(server->socks), sizeof(fd_set)); + + /* + * wait for handles to become ready + */ + if (-1 == select((server->maxFd)+1, &rfds, NULL, NULL, NULL)) + { + switch (errno) { + default: + case EBADF: + case EINVAL: + case ENOMEM: + doShutdown = 1; + /* Fallthrough */ + + case EINTR: + syslogMonitor(LOG_ERR, MON_CRITICAL, "select", + "select systemcall failed: [%s]", + strerror(errno)); + syslogMonitor(LOG_ERR, MON_FAILURE, "select", + "select systemcall failed: [%s] - service terminated", + strerror(errno)); + continue; /* in while loop above */ + } + } + + /* + * update file to actual time + */ + logRotate(server); + if (NULL == server->wHandle) { + syslogMonitor(LOG_ERR, MON_CRITICAL, "logfile.rotate", + "no valid handle for logfile - service terminated"); + exit(EXIT_FAILURE); + } + + /* + * handle accept + */ + if (FD_ISSET(server->servSock, &rfds)) { + int fd; + char remoteAddr[16] = ""; + + if (-1 != (fd = acceptConnection(server->servSock, remoteAddr))) { + (server->clients)[fd].socket = fd; // save the socket handle + // within the client struct + // + strncpy( + (server->clients)[fd].remoteAddr, + remoteAddr, + sizeof((server->clients)[fd].remoteAddr)-1); + FD_SET(fd, &(server->socks)); + server->maxFd = MAX(fd, server->maxFd); + } + + FD_CLR(server->servSock, &rfds); + } + + /* handle reads */ + for (i=3; i<=server->maxFd; i++) { + if (FD_ISSET(i, &rfds)) { + switch (clientRead(&((server->clients)[i]))) { + case 0: + /* + * normal close: write remaining data + */ + writeRemaining( + &((server->clients)[i]), + server->wHandle); + /* FALLTHROUGH */ + + case -1: + /* + * read failure / close connection + * FALLTHROUGH + */ + + case READ_ERR_LONGLINE: + /* + * detected very long line read from client + * message is already given now terminate connection + * FALLTHROUG + */ + clientClose(&((server->clients)[i])); + FD_CLR(i, &(server->socks)); + break; + + default: + if (0 > writeBuffer( + &((server->clients)[i]), + server->wHandle)) + { + /* + * got IO Error or binary data + * the message is already monitored in client code + */ + clientClose(&((server->clients)[i])); + FD_CLR(i, &(server->socks)); + } + break; + } + } + } + } +} diff --git a/src/serverShutdown.c b/src/serverShutdown.c new file mode 100644 index 0000000..e5d4d8d --- /dev/null +++ b/src/serverShutdown.c @@ -0,0 +1,57 @@ +#include /* for printf() and fprintf() */ +#include /* for select system call and related */ +#include /* for select system call and related */ +#include /* for exit */ +#include /* for memset and stuff */ +#include /* for getopt */ +#include /* for errno */ + +#include "include/appConfig.h" +#include "include/server.h" +#include "include/monitor.h" + + +void +serverClose(tVirtualItemServer * server) +{ + int i; + + for (i=3; i<=server->maxFd; i++) { + if (FD_ISSET(i, &(server->socks))) { + if (i == server->servSock) { + close(server->servSock); + } else { + close(((server->clients)[i]).socket); + free(((server->clients)[i]).buffer); + FD_CLR(i, &(server->socks)); + } + } + } + + if (NULL != server->wHandle) { + fclose(server->wHandle); + } +} + +void +serverShutdown(tVirtualItemServer * server) +{ + int i; + + for (i=3; i<=server->maxFd; i++) { + if (FD_ISSET(i, &(server->socks))) { + if (i == server->servSock) { + shutdown(server->servSock, SHUT_RDWR); + close(server->servSock); + } else { + writeBuffer(&(server->clients[i]), server->wHandle); + clientClose(&((server->clients)[i])); + FD_CLR(i, &(server->socks)); + } + } + } + + if (NULL != server->wHandle) { + fclose(server->wHandle); + } +} diff --git a/src/signalHandling.c b/src/signalHandling.c new file mode 100644 index 0000000..485f26c --- /dev/null +++ b/src/signalHandling.c @@ -0,0 +1,28 @@ +#include /* for signal() and signal names */ + +#include "include/monitor.h" + +volatile int doShutdown; + +void terminate(int signum) +{ + signal(signum, SIG_IGN); + syslogMonitor(LOG_INFO, MON_CRITICAL, "signals", + "caugth deadly signal %d", signum); + syslogMonitor(LOG_INFO, MON_FAILURE, "signals", + "caugth deadly signal %d - service terminated", signum); + doShutdown = 1; +} + +void init_signals(void) +{ + signal(SIGTERM, terminate); + signal(SIGHUP, SIG_IGN); + signal(SIGINT, terminate); + signal(SIGQUIT, terminate); + signal(SIGABRT, terminate); + signal(SIGALRM, SIG_IGN); + signal(SIGURG, SIG_IGN); + + signal(SIGPIPE, SIG_IGN); +} diff --git a/src/socket.c b/src/socket.c new file mode 100644 index 0000000..ab74af2 --- /dev/null +++ b/src/socket.c @@ -0,0 +1,93 @@ +#include /* for printf() and fprintf() */ +#include /* SO_REUSEADDR */ +#include /* for socket(), bind(), and connect() */ +#include /* for sockaddr_in and inet_ntoa() */ +#include /* for atoi() and exit() */ +#include /* for memset() */ +#include /* for close() */ +#include /* for errno */ +#include + +#include "include/appConfig.h" +#include "include/monitor.h" + + +int +initServerSocket(in_port_t port, int backlog) +{ + int sock; /* socket descriptor for server */ + struct sockaddr_in addr; /* Local address */ + + int reUse = 1; /* TODO: make this configurable */ + + /* Create socket for incoming connections */ + if (-1 == (sock = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP))) { + syslogMonitor(LOG_ERR, MON_CRITICAL, "server.socket", + "error opening socket: %s", + strerror(errno)); + syslogMonitor(LOG_ERR, MON_FAILURE, "server.socket", + "error opening socket: %s - service terminated", + strerror(errno)); + exit(EXIT_FAILURE); + } + + /* Make the socket REUSE a TIME_WAT socket */ + setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &reUse, sizeof (reUse)); + + /* Construct local address structure */ + memset(&addr, 0, sizeof(addr)); /* Zero out structure */ + + addr.sin_family = AF_INET; /* Internet address family */ + addr.sin_addr.s_addr = htonl(INADDR_ANY); /* Any incoming interface */ + addr.sin_port = htons(port); /* Local port */ + + /* Bind to the local address */ + if (-1 == bind(sock, (struct sockaddr *) &addr, sizeof(addr))) { + syslogMonitor(LOG_ERR, MON_CRITICAL, "server.bind", + "error binding socket: %s", + strerror(errno)); + syslogMonitor(LOG_ERR, MON_FAILURE, "server.bind", + "error binding socket: %s - service terminated", + strerror(errno)); + exit(EXIT_FAILURE); + } + + /* Mark the socket so it will listen for incoming connections */ + if (-1 == listen(sock, backlog)) { + syslogMonitor(LOG_ERR, MON_CRITICAL, "server.listen", + "error binding socket: %s - service terminated", + strerror(errno)); + syslogMonitor(LOG_ERR, MON_FAILURE, "server.listen", + "error binding socket: %s - service terminated", + strerror(errno)); + exit(EXIT_FAILURE); + } + + return sock; +} + +int +acceptConnection(int servSock, char remoteAddr[16]) +{ + int sock; /* Socket descriptor for client */ + struct sockaddr_in addr; /* Client address */ + unsigned int len; /* Length of client address data structure */ + + /* Set the size of the in-out parameter */ + len = sizeof(addr); + + /* Wait for a client to connect */ + if (-1 == (sock = accept(servSock, (struct sockaddr *) &addr, &len))) { + syslogMonitor(LOG_ERR, MON_WARNING, "server.accept", + "error acception connection: %s", strerror(errno)); + } else { + strncpy (remoteAddr, inet_ntoa(addr.sin_addr), sizeof(remoteAddr)-1); + } + + /* clntSock is connected to a client! */ + if (0 != verbose) { + syslog(LOG_INFO, "handling client %s\n", inet_ntoa(addr.sin_addr)); + } + + return sock; +} diff --git a/src/writeBuffer.c b/src/writeBuffer.c new file mode 100644 index 0000000..0f633b0 --- /dev/null +++ b/src/writeBuffer.c @@ -0,0 +1,153 @@ +#include /* for ferror() */ +#include /* for memset and stuff */ +#include /* for errno */ +#include /* for isprint */ + +#include "include/client.h" +#include "include/monitor.h" + +int +_handleIoError(FILE * wHandle) +{ + if (ferror(wHandle)) { + switch (errno) { + case EIO: + /* FALLTHROUGHT */ + + case ENOSPC: + syslogMonitor(LOG_ERR, MON_CRITICAL, "io.fatal", + "fatal IO error [%s]", + strerror(errno)); + + syslogMonitor(LOG_ERR, MON_FAILURE, "io.fatal", + "fatal IO error [%s] - service terminated", + strerror(errno)); + + break; + } + + return 1; + } + + return 0; +} + +int +_isPrintableBuffer(const char * buffer, size_t size, char * found) +{ + while (isprint(*(buffer++)) && 1 < size--); + + if (0 == size) { + return 1; + } else { + *found = *(buffer-1); + return 0; + } +} + +int +_doWrite(tClient * client, size_t size, FILE * wHandle) +{ + char found = '\0'; + + if (NULL != client->buffer) { + + if (!_isPrintableBuffer(client->buffer, size, &found)) { + syslogMonitor(LOG_ERR, MON_WARNING, "data.binary", + "got non printable character[0x%02x] from client[%s] - connection closed", + found, + client->remoteAddr); + + return WRITE_ERR_NOPRINT; + } + + /* write remaining stuff to file */ + fwrite(client->buffer, size, 1, wHandle); + if (_handleIoError(wHandle)) { + return WRITE_ERR_IO; + } + + fputc('\n', wHandle); + if (_handleIoError(wHandle)) { + return WRITE_ERR_IO; + } + + fflush(wHandle); + if (_handleIoError(wHandle)) { + return WRITE_ERR_IO; + } + + return size + 1; + + } else { + + return 0; + + } +} + +/* + * write all data that remains in buffer, even if its not terminated by + * a newline. Anyway ignore trailing newlines. + */ +int +writeRemaining(tClient * client, FILE * wHandle) +{ + int written = writeBuffer(client, wHandle); + + if (0 < client->readPos) { + unsigned int wLen = client->readPos; + + /* ignore trailing newlines */ + while (0 < client->readPos && '\n' == client->buffer[wLen]) { + wLen--; + } + + written += _doWrite(client, wLen, wHandle); + } + + memset(client->buffer, 0, client->readPos); + client->readPos = 0; + + return written; +} + +/* + * write buffer till last newline is reached. + * If no newline is in buffer, nothing is written. + */ +int +writeBuffer(tClient * client, FILE * wHandle) +{ + char * nlpos = memchr(client->buffer, '\n', client->readPos); + int written = 0; + + while (NULL != nlpos) { + unsigned int moveSize, clearSize; + char * actAddr; + + if (nlpos > client->buffer) { + unsigned int wLen = nlpos - client->buffer; + int wTemp = _doWrite(client, wLen, wHandle); + + if (0 > wTemp) { + return wTemp; + } + + written += wTemp; + } + + actAddr = client->buffer + client->readPos; + moveSize = actAddr - nlpos - 1; + clearSize = actAddr - client->buffer - moveSize; + + memmove(client->buffer, nlpos+1, moveSize); + memset(client->buffer + moveSize, 0, clearSize); + + client->readPos = moveSize; + + nlpos = memchr(client->buffer, '\n', client->readPos); + } + + return written; +}