simple-server (empty) → 0.0.1
raw patch · 7 files changed
+1348/−0 lines, 7 filesdep +basedep +bytestringdep +concurrent-extrasetup-changed
Dependencies added: base, bytestring, concurrent-extra, containers, hashtables, network, time, unbounded-delays
Files
- LICENSE +674/−0
- Network/SimpleServer.hs +442/−0
- Network/SimpleServer/Examples/ChatClient.hs +69/−0
- Network/SimpleServer/Examples/ChatServer.hs +136/−0
- README.md +2/−0
- Setup.hs +5/−0
- simple-server.cabal +20/−0
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ 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.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ 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 <http://www.gnu.org/licenses/>.++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:++ <program> Copyright (C) <year> <name of author>+ 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+<http://www.gnu.org/licenses/>.++ 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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ Network/SimpleServer.hs view
@@ -0,0 +1,442 @@+{-# LANGUAGE ConstraintKinds #-} +module Network.SimpleServer(CmdHandler,+ ConnectionHandler,+ DisconnectHandler,+ ClientConn(cid, lookup, modify),+ Server(),+ new, + addCommand,+ start, + stop, + respond, + broadcast, + disconnectClient,+ clientList) where++import Control.Concurrent hiding(modifyMVar)+import qualified Control.Concurrent.Lock as Lock+import Control.Concurrent.MVar hiding(modifyMVar)+import Control.Concurrent.Thread.Delay+import Control.Exception+import Control.Monad+import qualified Data.ByteString.Char8 as ByteS+import Data.Either+import Data.Foldable(toList)+import qualified Data.HashTable.IO as HT+import Data.IORef+import Data.Maybe+import Data.Time.Clock+import qualified Data.Sequence as Seq+import qualified Network as Net+import qualified Network.Socket as Net(close)+import System.IO(Handle, hSetBuffering, BufferMode(NoBuffering))++-- |A CmdHandler is used to handle a command in the form of a list of strings+type CmdHandler = [String] -> Server -> ClientConn -> IO ()++-- |A ConnectionHandler is called each time a client connects to the server.+type ConnectionHandler = Server -> ClientConn -> IO ()++-- |A DisconnectHandler is called each time a client is disconnected from the server.+type DisconnectHandler = Server -> ClientConn -> IO ()++{-|+Describes a Clients connection and provides an interface for+storing data associated with the client. Each client will be given+a unique cid and are Eq if their cid's are Eq.++A ClientConn comes packaged with two functions for storing additional+information in Strings. `lookup` and `modify`. The lookup function+takes a key and returns the current value of the key or the empty+string if it has never been set. The modify function+takes a key and value and updates it such that the next call to+lookup with that key will return the value provided.+-}+data ClientConn = ClientConn { -- | The Unique ID for this client+ cid :: Integer,+ -- | A lookup function for this client+ lookup :: (String -> IO String),+ -- | A modify function for this client+ modify :: (String -> String -> IO ()),+ chandle :: Handle,+ host :: Net.HostName,+ pid :: Net.PortNumber,+ msgList :: List String,+ dead :: MVar Bool,+ timestamp :: TimeStamp,+ tid :: MVar (ThreadId, ThreadId),+ lock :: MVar Lock.Lock}++instance Eq ClientConn where+ (==) c0 c1 = (cid c0) == (cid c1)++-- |A Generic Server+data Server = Server { port :: Net.PortID, + socket :: IORef (Maybe Net.Socket), + clients :: List ClientConn,+ cmdList :: List Message,+ lastclean :: TimeStamp,+ timeout :: NominalDiffTime,+ serverLock :: MVar Lock.Lock,+ cmdTable :: CmdTable,+ nextID :: MVar Integer,+ cHandler :: ConnectionHandler,+ dHandler :: DisconnectHandler,+ threads :: MVar (ThreadId, ThreadId)}++++++{-|+Creates a new server that is not connected to anything.+If a client does not talk to a server for more than 60 seconds+it will be disconnected.+-}+new :: ConnectionHandler -> DisconnectHandler -> Int -> IO Server+new cHandler dHandler pid = do+ socket <- newIORef Nothing+ clients <- emptyList+ cmdList <- emptyList+ time <- getCurrentTime+ lastClean <- newMVar time+ lock <- Lock.new+ serverLock <- newMVar lock+ let allowed = 60+ cmdTable <- HT.new+ nextID <- newMVar 0+ threads <- newEmptyMVar+ return $ Server (Net.PortNumber $ fromIntegral pid) socket clients cmdList lastClean allowed serverLock cmdTable nextID cHandler dHandler threads++{-|+Given a server, a command, and a command handler, adds the command to the+server. If the command already exists, it will be overwritten+-}+addCommand :: Server -> String -> CmdHandler -> IO ()+addCommand server cmd handler = HT.insert (cmdTable server) cmd handler++{-|+Starts a server if it is currently not started. Otherwise, does nothing.+-}+start :: Server -> IO ()+start server = Net.withSocketsDo $ do+ maybeSocket <- readIORef $ socket server+ case maybeSocket of+ Nothing -> do + s <- try $ Net.listenOn (port server) :: IO (Either IOException Net.Socket)+ case s of + Left e -> debugLn' (serverLock server) $ "The server could not be started: " ++ (show e)+ Right s -> do+ writeIORef (socket server) (Just s)+ rt <- forkIO $ runServer server+ at <- forkIO $ acceptCon server s+ putMVar (threads server) (rt, at)+ return ()+ Just s -> return ()++{-|+Stops a server if it is running sending a disconnect message+to all clients. Otherwise, does nothing.+Any shutdown operations should be run before this is called. +-}+stop :: Server -> IO ()+stop server = Net.withSocketsDo $ do+ maybeSocket <- readIORef $ socket server+ case maybeSocket of+ Nothing -> return ()+ Just s -> do+ clist <- takeAll $ clients server+ mapM_ (disconnect server) (toList clist)+ (rt, at) <- takeMVar (threads server)+ killThread rt+ killThread at+ Net.close s+ writeIORef (socket server) Nothing++{-|+Adds a response message to the queue.+-}+respond :: ClientConn -> String -> IO ()+respond client string = put (msgList client) string++{-|+Broadcasts a message to all clients on the server+-}+broadcast :: Server -> String -> IO ()+broadcast server string = do+ debugLn' (serverLock server) "Reading client list"+ q <- readAll (clients server)+ debugLn' (serverLock server) "Processing client list"+ mapM_ ((flip put string) . msgList) q+ debugLn' (serverLock server) "Message queued."++{-|+Disconnects the client if they are on this server. If+they are not on this server, the results are unspecified.+-}+disconnectClient :: Server -> ClientConn -> IO ()+disconnectClient server client = do+ swapMVar (dead client) True+ clean server++{-|+Returns a list of all clients that are currently connected to the server+-}+clientList :: Server -> IO [ClientConn]+clientList = readAll . clients+++--------------------------------------+-- Helper Functions and Types Begin --+--------------------------------------++type List a = MVar (Seq.Seq a)+type TimeStamp = MVar UTCTime+type CmdTable = HT.BasicHashTable String CmdHandler+type UserTable = HT.BasicHashTable String String+++data Message = Message { cmd :: String,+ client :: ClientConn } deriving Eq++{-| +Creates a new client connection+-}+newConn :: Integer -> Handle -> Net.HostName -> Net.PortNumber -> IO ClientConn+newConn id handle host pid = do+ queue <- emptyList+ dead' <- newMVar False+ tid <- newEmptyMVar+ timestamp <- newEmptyMVar+ lock <- newEmptyMVar+ table <- HT.new+ l <- Lock.new+ let lookup = safeLookup l table+ modify = safeModify l table+ return $ ClientConn id lookup modify handle host pid queue dead' timestamp tid lock++safeLookup :: Lock.Lock -> UserTable -> (String -> IO String)+safeLookup lock usertable = (\key -> do+ Lock.acquire lock+ val <- HT.lookup usertable key+ Lock.release lock+ return $ case val of+ Nothing -> ""+ Just x -> x)++safeModify :: Lock.Lock -> UserTable -> (String -> String -> IO ())+safeModify lock usertable = (\key val -> do+ Lock.acquire lock+ HT.insert usertable key val+ Lock.release lock)++++{-| +The main loop for the server. Checks to see if the+server has started, if it has it checks for any clients+who need to be disconnected then processes any commands in its queue.+Every 30 seconds, the server will check to see if a client has disconnected+or timed out and remove those clients from the client list.+After processing the loop continues until the server is stopped.+If there are no commands, it will wait approx. 1/10th of a second+before continuing.+-}+runServer :: Server -> IO ()+runServer server = Net.withSocketsDo $ do+ maybeSocket <- readIORef $ socket server+ case maybeSocket of+ Nothing -> return ()+ Just _ -> do+ checkClean server+ cmds <- takeAll (cmdList server)+ if (cmds == []) + then delay (1000*100) + else do+ debugLn' (serverLock server) "Processing Commands..."+ mapM_ (processCommand server) cmds+ debugLn' (serverLock server) "Done."+ runServer server++{-|+Using a servers command table, processess the a message. If+the message cannot be processed, a message is added to its response queue+-}+processCommand :: Server -> Message -> IO ()+processCommand server msg = do+ let commands = words (cmd msg)+ if commands == [] + then return ()+ else do+ maybeFunction <- HT.lookup (cmdTable server) (head commands)+ case maybeFunction of+ Nothing -> do+ debugLn' (serverLock server) $ "Could not process command: " ++ (cmd msg)+ put (response_queue msg) ("Invalid command: " ++ (cmd msg))+ Just f -> f commands server (client msg)+ where response_queue = msgList . client+{-|+Checks for dead or timed out clients and removes them.+-}+checkClean :: Server -> IO ()+checkClean server = do+ time <- getCurrentTime+ last <- readMVar (lastclean server)+ let passed = diffUTCTime time last+ allowed = timeout server+ if (passed > allowed) + then do+ swapMVar (lastclean server) time+ clean server+ else return ()++clean :: Server -> IO ()+clean server = do+ let allowed = timeout server+ clist <- takeMVar (clients server)+ (newCList, removed) <- filterM' (timedout server allowed) clist+ putMVar (clients server) (Seq.fromList newCList)+ mapM_ (disconnect server) removed+++-- Helper function for filtering Seq with a pred of a -> IO Bool+filterM' :: Monad m => (a -> m Bool) -> Seq.Seq a -> m ([a],[a])+filterM' pred seq = do+ ls <- filterM pred (toList seq)+ ls' <- filterM not' (toList seq)+ return (ls, ls')+ where not' a = do+ val <- pred a+ return $ not val++-- Helper that checks if a client is timed out or marked dead. If they are+-- they are sent a disconnect message and removed from the +-- client list+timedout :: Server -> NominalDiffTime -> ClientConn -> IO Bool+timedout server allowed client = do+ time <- getCurrentTime+ last <- readMVar (timestamp client)+ dead' <- readMVar (dead client)+ let passed = diffUTCTime time last+ return $ not $ (passed > allowed) || (dead' == True)++-- Sends a disconnect message to a client, marks it dead+-- and kills any associated threads+disconnect :: Server -> ClientConn -> IO ()+disconnect server client = do+ (dHandler server) server client+ flush server client+ (wio,rio) <- readMVar $ tid client+ killThread wio+ killThread rio+ swapMVar (dead client) True+ return ()++flush :: Server -> ClientConn -> IO ()+flush server client = do+ messages <- takeAll $ msgList client+ mapM_ (hPutStrLn (chandle client)) messages++{-|+Accepts a connection and adds it to the clients list+-}+acceptCon :: Server -> Net.Socket -> IO ()+acceptCon server sock = do+ (handle, host, pid) <- Net.accept sock+ hSetBuffering handle NoBuffering+ id <- takeMVar (nextID server)+ putMVar (nextID server) (id+1)+ conn <- newConn id handle host pid+ time <- getCurrentTime+ putMVar (timestamp conn) time+ lock' <- readMVar $ serverLock server+ putMVar (lock conn) lock'+ put (clients server) conn+ wio <- forkIO $ writeClient conn+ rio <- forkIO $ readClient conn (cmdList server)+ putMVar (tid conn) (wio,rio)+ (cHandler server) server conn+ acceptCon server sock+ +{-+The main loop for receiving input from a client.+Read a whole string input, create a message, queue it for processing, repeat+-}+readClient :: ClientConn -> List Message -> IO ()+readClient client queue = do+ either <- try $ hGetLine (chandle client) :: IO (Either IOException String)+ case either of+ Left e -> do + swapMVar (dead client) True+ return ()+ Right val -> do+ time <- getCurrentTime+ swapMVar (timestamp client) time+ put queue (Message val client)+ readClient client queue+{-+The main loop for sending output to a client. All messages that are queued+to be sent, are sent. If the queue was empty, the thread sleeps for approx 1/10th+a second+-}+writeClient :: ClientConn -> IO () +writeClient client = do+ queue <- takeAll (msgList client)+ if queue == [] + then do + delay (1000*100)+ writeClient client+ else do+ debugLn' (lock client) "Client List non-empty. Writing to client."+ either <- try $ mapM_ (hPutStrLn (chandle client)) queue :: IO (Either IOException ())+ case either of+ Left e -> do+ debugLn' (lock client) $ "Could not read from handle: " ++ (show e)+ swapMVar (dead client) True+ return ()+ Right _ -> writeClient client+++-- Debugging putStrLn that takes a lock such that+-- the output is readable.+putStrLn' :: MVar Lock.Lock -> String -> IO ()+putStrLn' mvar string = do+ lock <- readMVar mvar+ Lock.acquire lock+ putStrLn string+ Lock.release lock+ +hPutStrLn :: Handle -> String -> IO ()+hPutStrLn handle string = ByteS.hPutStrLn handle (ByteS.pack string)++hGetLine :: Handle -> IO String+hGetLine handle = do+ line <- ByteS.hGetLine handle+ return $ ByteS.unpack line++debug = False++debugLn' :: MVar Lock.Lock -> String -> IO ()+debugLn' lock str = if debug then putStrLn' lock str else return ()++emptyList :: IO (List a)+emptyList = newMVar Seq.empty++takeAll :: List a -> IO [a]+takeAll queue = do+ q <- swapMVar queue Seq.empty+ return $ toList q++readAll :: List a -> IO [a]+readAll queue = do+ q <- readMVar queue+ return $ toList q++modifyMVar :: MVar a -> (a -> a) -> IO ()+modifyMVar mvar f = do+ el <- takeMVar mvar+ putMVar mvar (f el)++put :: List a -> a -> IO ()+put queue el = modifyMVar queue (Seq.|> el) +
+ Network/SimpleServer/Examples/ChatClient.hs view
@@ -0,0 +1,69 @@+module Network.SimpleServer.Examples.ChatClient(main, run) where+import Network+import System.Environment+import Control.Concurrent+import Control.Concurrent.MVar+import Control.Concurrent.Thread.Delay+import Control.Monad+import System.IO+import Data.Char++-- Attempts to connect to a host on a specified port+-- If successful, a thread is started that prints out+-- incoming data, a thread starts that takes input from+-- standard in, and a thread starts that pings the server+-- every 30 seconds. Once the message "disconnect" is received+-- from the server, each thread stops and the program exits.+run :: HostName -> Int -> IO ()+run host port = do+ handle <- connectTo host (PortNumber (fromIntegral port))+ stopVar <- newEmptyMVar+ ioo <- forkIO $ forever (doOutput handle)+ ioi <- forkIO $ forever (doInput handle stopVar)+ iom <- forkIO $ forever (maintainConnection handle)+ readMVar stopVar+ killThread ioo+ killThread ioi+ killThread iom+ return ()+ +-- Given a handle, takes a line from standard in and+-- sends it to the handle. If the message starts with a '/'+-- it is sent normally, if it does not start with '/' a+-- '/message ' is appended to the front of it before it is+-- sent.+doOutput :: Handle -> IO ()+doOutput handle = do+ msg <- getLine+ case msg of+ msg@('/':_) -> hPutStrLn handle msg+ msg -> hPutStrLn handle $ "/message " ++ msg++-- Given a handle for sending output, reads a line and+-- prints it to stdout. If the input is "disconnected"+-- the mvar is set which allows the main thread to die.+doInput :: Handle -> MVar Bool -> IO ()+doInput handle mvar = do+ string <- hGetLine handle+ putStrLn string+ if string == "disconnected" then putMVar mvar True else return ()++-- Sends the '/ping silent' command to the server+-- every 30 seconds+maintainConnection :: Handle -> IO ()+maintainConnection handle = do+ hPutStrLn handle "/ping silent"+ delay (1000 * 1000 * 30) -- 30 seconds++main = do+ args <- getArgs+ case args of+ [] -> printUsage+ (x:[]) -> printUsage+ (host:port:_) -> if isInt port then run host (read port) else printUsage+ +printUsage :: IO () +printUsage = putStrLn "./ChatClient hostname port"++isInt :: [Char] -> Bool+isInt = (== []) . (filter (not . isDigit))
+ Network/SimpleServer/Examples/ChatServer.hs view
@@ -0,0 +1,136 @@+module Network.SimpleServer.Examples.ChatServer(main, run) where+import Data.Char+import Data.List+import System.Environment++import qualified Network.SimpleServer as S++-- Constants --+-- A Welcome message to send to clients when they connect.+welcomeMessage = "Welcome to the Simple Chat Server.\n" +++ "Commands:\n" +++ "/message [message] - Broadcast a message to all users.\n" +++ "/name [newname] - Change your name to newname.\n" +++ "/ping - Let's the server know you're still there.\n" ++ + "/who - Displays a list of users connected to the server.\n" +++ "/disconnect - Disconnect from Simple Chat Server.\n"++-- Keys+-- The display name for a ClientConn+username = "username"++-- Handlers++-- The Connection Handler sets a newly connected+-- users username to "user #{cid}" broadcasts+-- that they have connected and then sends them the welcome message+connHandler :: S.ConnectionHandler+connHandler server client = do+ let name = "user #" ++ (show (S.cid client))+ msg = name ++ " connected."+ S.modify client username name+ S.broadcast server msg+ S.respond client welcomeMessage++-- The Disconnection Handler responds to the client "disconnected"+-- Then broadcasts to the room that the user has disconnected+dissHandler :: S.DisconnectHandler+dissHandler server client = do+ name <- S.lookup client username+ let msg = name ++ " disconnected."+ S.respond client "disconnected"+ S.broadcast server msg++-- Commands+ +-- The name command sets the username to the value specified+-- by the user as long as it is not the empty string. If+-- the name is the empty string, the client is notified that+-- the name is not valid. Otherwise, a message is broadcast+-- stating the user changed their name+nameCmd = "/name"+nameHandler :: S.CmdHandler+nameHandler (_:msg) server client = do+ case msg of+ [] -> S.respond client "You did not provide a name to change to."+ msg -> do+ before <- S.lookup client username+ let name = intercalate " " msg+ message = before ++ " is now known as " ++ name+ S.modify client username (intercalate " " msg)+ S.broadcast server message++-- The ping command notifies the server that the user is still connected+-- so they don't time out. If the /ping command is followed by "silent"+-- the server does not respond. Otherwise, the server responds with+-- a received message.+pingCmd = "/ping"+pingHandler :: S.CmdHandler+pingHandler (_:flag) _ client = do+ case flag of+ ("silent":_) -> return ()+ _ -> S.respond client "Ping received."++-- If the message command is received, any text following it is+-- broadcast to all users.+msgCmd = "/message"+msgHandler :: S.CmdHandler+msgHandler (cmd:msg) server client = do+ name <- S.lookup client username+ S.broadcast server $ name ++ "> " ++ (intercalate " " msg)++-- The disconnect command causes the message "Goodbye!" to be sent to+-- the client. Then they are disconnected from the server.+disCmd = "/disconnect"+disHandler :: S.CmdHandler+disHandler _ server client = do+ S.respond client "Goodbye!"+ S.disconnectClient server client+ +-- The who command responds to the client with+-- a list of usernames+whoCmd = "/who"+whoHandler :: S.CmdHandler+whoHandler _ server client = do+ clients <- S.clientList server+ usernames <- mapM (flip S.lookup username) clients+ let message = "Users:\n" ++ (intercalate "\n" usernames)+ S.respond client message++-- Builds a server on the given port, adds the commands+-- starts the server, and waits for the word stop to be entered+run :: Int -> IO ()+run port = do+ server <- S.new connHandler dissHandler port+ S.addCommand server whoCmd whoHandler+ S.addCommand server nameCmd nameHandler+ S.addCommand server disCmd disHandler+ S.addCommand server msgCmd msgHandler+ S.addCommand server pingCmd pingHandler+ S.start server+ putStrLn $ "Chat Server Started on Port: " ++ (show port)+ putStrLn $ "Type 'stop' to stop the server."+ waitStop server+ S.stop server+ putStrLn "Server Stopped"++-- Waits for the word 'stop' to be entered+waitStop :: S.Server -> IO ()+waitStop server = do+ string <- getLine+ case string of+ "stop" -> return ()+ _ -> waitStop server+ +-- Starts a server on the specified port or prints the usage message+main = do+ args <- getArgs+ case args of+ [] -> printUsage+ (x:_) -> if isInt x then (return (read x)) >>= run else printUsage++printUsage :: IO ()+printUsage = putStrLn "Usage ./ChatServer [port]"++isInt :: [Char] -> Bool+isInt = (== []) . (filter (not . isDigit))
+ README.md view
@@ -0,0 +1,2 @@+simple-server+=============
+ Setup.hs view
@@ -0,0 +1,5 @@+module Main where++import Distribution.Simple++main = defaultMain
+ simple-server.cabal view
@@ -0,0 +1,20 @@+Name: simple-server+Version: 0.0.1+License: GPL+License-File: LICENSE+Author: Joseph Collard+Stability: experimental+Maintainer: jcollard@unm.edu+Category: Network+Synopsis: Simple Server interface+Description: This library provides a very simple interface for creating a server that sends and recieves ByteString messages and attempts to remove concurrency so the programmer can focus on the functionality of the server. A simple ChatServer example is available in the Examples module+Cabal-Version: >= 1.4+Build-Type: Simple++Library+ Build-Depends: base>=4 && <5, bytestring>=0.9.2.1, concurrent-extra>=0.7.0.5, hashtables>=1.0.1.7, time>=1.4.0.2, containers>=0.4.2.1, network>=2.4.1.0, unbounded-delays>=0.1.0.5+ Extensions: ConstraintKinds+ Exposed-Modules:+ Network.SimpleServer+ Network.SimpleServer.Examples.ChatClient+ Network.SimpleServer.Examples.ChatServer