diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/Main.hs b/Main.hs new file mode 100644 --- /dev/null +++ b/Main.hs @@ -0,0 +1,197 @@ +{-# LANGUAGE ConstraintKinds, FlexibleContexts, RankNTypes, ScopedTypeVariables #-} +module Main where + +import Prelude hiding (log) +import Control.Concurrent +import Control.Monad +import Control.Monad.IO.Class +import Data.List +import Data.Monoid +import Data.Chatty.Atoms +import Data.Chatty.Counter +import Data.Chatty.Hetero +import Data.Chatty.None +import Data.Chatty.TST +import Network +import Network.Anticiv.Config +import Network.Anticiv.Convenience +import Network.Anticiv.Masks +import Network.Anticiv.Modules.Barkeeper +import Network.Anticiv.Modules.Base +import Network.Anticiv.Modules.Ironforge +import Network.Anticiv.Modules.Mafia +import Network.Anticiv.Monad +import System.Chatty.Misc +import System.Directory +import System.Environment +import System.IO +import Text.Chatty.Channel.Printer +import Text.Chatty.Finalizer +import Text.Chatty.Printer +import Text.Chatty.Scanner +import Text.Chatty.Interactor +import Text.Printf + +anticiv :: (MonadAnticiv m,ChFinalizer m,MonadIO m) => m () +anticiv = cbracket Log $ do + mprintLn "Initializing Anticiv." + nick <- bnick + mods <- bkStrL "Modules" + forM_ mods $ \m -> switchTo m $ do + floc <- bkStr "Localization" + mloc <- readConf .<. floc + case mloc of + Nothing -> error $ printf "Module %s's localization cannot be read." m + Just loc -> bmodify $ \b -> b{localizations=tstInsert m loc $ localizations b} + s <- bkStr "Stereo" + bsetStereo s + lst <- runAnticiv $ Main.loadModule m + bmodify $ \b -> b{moduleLister=moduleLister b++[(m,lst)]} + cbracket Raw $ do + mprintLn $ printf "NICK %s\r" nick + mprintLn $ printf "USER %s 0 * :Igor\r" nick + mflush + loop + +loop :: (MonadIO m,MonadAnticiv m) => m () +loop = do + liftIO $ threadDelay 100 + -- Ticks + recs <- bgets tickRecipients + forM_ recs $ getAtom >=> runAnticiv + -- Report + b <- bget + t <- mgetstamp + d <- bkInt "ReportTick" + when (lastReport b + fromIntegral d < t) $ do + bmodify $ \b -> b{lastReport=t} + log $ printf "Channel Users: %i" $ length $ channelUsers b + log $ printf "Priority/Emergency Chanmsg: %i/%i" (length $ priorityChanmsg b) (length $ emergencyChanmsg b) + log $ printf "Priority/Emergency Querymsg: %i/%i" (length $ priorityQuerymsg b) (length $ emergencyQuerymsg b) + log $ printf "Tick Recipients: %i" (length $ tickRecipients b) + log $ printf "Module Stack: %s" (unwords $ moduleStack b) + -- Line Processing + ready <- mready + when ready $ do + ln <- mscanLn + cprint Log ("<-- "++ln++"\r\n") + n <- bnick + c <- bchan + void $ procln n c (init ln) + loop + +dumpusers :: Anticiv () +dumpusers = do + us <- bget + cprint Log "There are: " + forM_ (channelUsers us) $ getAtom >=> \u -> cprint Log (show u++" ") + cprint Log "\r\n" + +simul a b k = do + a' <- a k + b' <- b k + return (a',b') + +procln :: String -> String -> String -> Anticiv Bool +procln nick chan = + -- React to PING requests + CIString "PING" :-: RemString #-> (\s -> cprint Raw ("PONG :"++s++"\r\n")) + -- Evaluate JOIN messages, add user to list + .|| UserMask :-: CIToken "JOIN" :-: Remaining #-> (\(u,_) -> bmodify (\b -> b{channelUsers=channelUsers b `union` [u]}) >> dumpusers) + -- Evaluate NICK messages, change user entry + .|| UserMask :-: CIToken "NICK" :-: RemString #-> (\(ua,n) -> do + xus <- bgets channelUsers + xus' <- mapM (getAtom `Main.simul` return) xus + u <- getAtom ua + case filter (\(t,a) -> n `strEq` userNick t) xus' of + [(u,a)] -> putAtom a $ User [] [] [] $ reauthId u + case filter (\(t,a) -> userNick u `strEq` userNick t) xus' of + [(u,a)] -> putAtom a $ User n [] [] $ reauthId u + _ -> return ()) + -- Evaluate PART messages, remove user entry +-- .|| UserMask :-: Token "PART" :-: + -- JOIN on MOTD end + .|| ServerHost :-: Token "376" :-: Remaining #->> (cprint Raw $ printf "JOIN %s\r\n" chan) + -- JOIN on MOTD missing + .|| ServerHost :-: Token "422" :-: Remaining #->> (cprint Raw $ printf "JOIN %s\r\n" chan) + -- Evaluate NAMES list + .|| ServerHost :-: Token "353" :-: CIToken nick :-: Which [Token "=", Token "@"] :-: CIToken chan :-: RemString #-> (\(_,_,sus) -> do + xus <- bgets channelUsers + xus' <- mapM (getAtom `Main.simul` return) xus + let elemPrefix ('@':s) = s + elemPrefix ('+':s) = s + elemPrefix ('&':s) = s + elemPrefix ('!':s) = s + elemPrefix ('%':s) = s + elemPrefix s = s + us <- mapM (\n -> liftM (User n [] []) $ mrandomR (1,40000)) $ map elemPrefix $ words sus + let uelem us u = not $ null $ filter (strEq (userNick u) . userNick) us + uinc xs [] = return xs + uinc xs (x:mx) = do + a <- newAtom + putAtom a x + uinc ((x,a):xs) mx + ux <- uinc xus' $ filter (not . uelem (map fst xus')) us + bmodify $ \b -> b{channelUsers=map snd ux} + dumpusers) + -- Send CTCP PING response + .|| UserMask :-: CIToken "PRIVMSG" :-: CIToken nick :-: CIString " :\001PING " :-: Remaining #-> (\(u,st) -> notice u ("\001PING "++st)) + -- Send CTCP LIST response + .|| UserMask :-: CIToken "PRIVMSG" :-: CIToken nick :-: CIString " :\001LIST\001" :-: Remaining #-> (\(u,_) -> do + lsts <- bgets moduleLister + forM_ lsts $ \(m,l) -> do + notice u ("--- %"++m++" ---") + pref <- switchTo m bprefix + ls <- runAnticiv l + li <- ulang u + forM ls $ \c -> switchTo m $ do + c' <- bvStr li ("Commands/"++c) + noticefl u ("Commands/Descriptions/"++c) c' :: Anticiv ()) + -- Dispatch channel PRIVMSG to handlers + .|| UserMask :-: CIToken "PRIVMSG" :-: CIToken chan :-: RemString #-> (\(u,msg) -> do + let msg' + | "\001ACTION" `isPrefixOf` msg = "ME "++(init $ drop 8 msg) + | otherwise = msg + pas <- bgets priorityChanmsg + phs <- mapM getAtom pas + eas <- bgets emergencyChanmsg + ehs <- mapM getAtom eas + foldr (#||) (return False) $ map (\f -> runAnticiv $ f u msg') (phs ++ ehs) + return ()) + -- Dispatch query PRIVMSG to handlers + .|| UserMask :-: CIToken "PRIVMSG" :-: CIToken nick :-: RemString #-> (\(u,msg) -> do + let msg' + | "\001ACTION" `isPrefixOf` msg = "ME "++(init $ drop 8 msg) + | otherwise = msg + pas <- bgets priorityQuerymsg + phs <- mapM getAtom pas + eas <- bgets emergencyQuerymsg + ehs <- mapM getAtom eas + let fallback = private u "Sorry, I can't understand you." >> return False + foldr (#||) fallback $ map (\f -> runAnticiv $ f u msg') (phs ++ ehs) + return ()) + +main = void $ withLazyIO $ flip runCounterT 0 $ flip runAtomStoreT none $ do + args <- liftIO $ getArgs + conf <- readConf .<. if null args then "anticiv.conf" else args !! 0 + case conf of + Nothing -> error "Config cannot be found or is unintellegible." + Just conf -> + let initialBotState = BotState none none none none none none none conf ["%"] none none none none none (fromIntegral 0) (fromIntegral 0) + in flip runBotT initialBotState $ do + server <- bkStr "Connection/Server" + port <- bkInt "Connection/Port" + chan <- bkStr "Connection/Channel" + nick <- bkStr "Connection/Nick" + h <- liftIO $ connectTo server (PortNumber (fromIntegral port)) + mqfh h + liftIO $ hSetBuffering h NoBuffering + bkStr "LinguaInitii" >>= bmodify . \l b -> b{botLingua=l} + runOutPlex anticiv h [Raw] .<. h + +loadModule :: String -> Packciv (Packciv [String]) +loadModule "Base" = initBase +loadModule "Barkeeper" = initBarkeeper +loadModule "Mafia" = initMafia +loadModule "Ironforge" = initIronforge +loadModule _ = return $ return none diff --git a/Network/Anticiv/Convenience.hs b/Network/Anticiv/Convenience.hs new file mode 100644 --- /dev/null +++ b/Network/Anticiv/Convenience.hs @@ -0,0 +1,373 @@ +{-# LANGUAGE RankNTypes, ConstraintKinds, FlexibleContexts, FlexibleInstances, UndecidableInstances, IncoherentInstances, MultiParamTypeClasses #-} +module Network.Anticiv.Convenience where + +import Control.Monad +import Control.Monad.State +import Data.Char +import Data.List +import Data.Chatty.Atoms +import Data.Chatty.AVL +import Data.Chatty.Hetero +import Data.Chatty.TST +import Network.Anticiv.Config +import Network.Anticiv.Masks +import Network.Anticiv.Monad +import System.Chatty.Misc +import Text.Chatty.Channel.Printer +import Text.Chatty.Printer +import Text.Chatty.Scanner +import Text.Chatty.Scanner.Buffered +import Text.CTPL +import qualified Text.CTPL0 as Null +import Text.Printf + +regPriorityChanmsg :: (Atom Handler -> UserA -> String -> Anticiv Bool) -> Anticiv (Atom Handler) +regPriorityChanmsg f = do + a <- newAtom + m <- bmodule + putAtom a $ \u s -> Anticiv $ switchTo m $ f a u s + bmodify $ \b -> b{priorityChanmsg=a : priorityChanmsg b} + return a + +unregPriorityChanmsg :: Atom Handler -> Anticiv () +unregPriorityChanmsg a = do + bmodify $ \b -> b{priorityChanmsg=delete a $ priorityChanmsg b} + dispAtom a + +regEmergencyChanmsg :: (Atom Handler -> UserA -> String -> Anticiv Bool) -> Anticiv (Atom Handler) +regEmergencyChanmsg f = do + a <- newAtom + m <- bmodule + putAtom a $ \u s -> Anticiv $ switchTo m $ f a u s + bmodify $ \b -> b{emergencyChanmsg=a : emergencyChanmsg b} + return a + +unregEmergencyChanmsg :: Atom Handler -> Anticiv () +unregEmergencyChanmsg a = do + bmodify $ \b -> b{emergencyChanmsg=delete a $ emergencyChanmsg b} + dispAtom a + +regPriorityQuerymsg :: (Atom Handler -> UserA -> String -> Anticiv Bool) -> Anticiv (Atom Handler) +regPriorityQuerymsg f = do + a <- newAtom + m <- bmodule + putAtom a $ \u s -> Anticiv $ switchTo m $ f a u s + bmodify $ \b -> b{priorityQuerymsg=a : priorityQuerymsg b} + return a + +unregPriorityQuerymsg :: HandlerA -> Anticiv () +unregPriorityQuerymsg a = do + bmodify $ \b -> b{priorityQuerymsg=delete a $ priorityQuerymsg b} + dispAtom a + +regEmergencyQuerymsg :: (HandlerA -> UserA -> String -> Anticiv Bool) -> Anticiv (Atom Handler) +regEmergencyQuerymsg f = do + a <- newAtom + m <- bmodule + putAtom a $ \u s -> Anticiv $ switchTo m $ f a u s + bmodify $ \b -> b{emergencyQuerymsg=a : emergencyQuerymsg b} + return a + +unregEmergencyQuerymsg :: HandlerA -> Anticiv () +unregEmergencyQuerymsg a = do + bmodify $ \b -> b{emergencyQuerymsg=delete a $ emergencyQuerymsg b} + dispAtom a + +regTickRecipient :: (AnticivA () -> Anticiv ()) -> Anticiv (AnticivA ()) +regTickRecipient f = do + a <- newAtom + m <- bmodule + putAtom a $ Anticiv $ switchTo m $ f a + bmodify $ \b -> b{tickRecipients=a:tickRecipients b} + return a + +unregTickRecipient :: AnticivA () -> Anticiv () +unregTickRecipient a = do + bmodify $ \b -> b{tickRecipients=delete a $ tickRecipients b} + dispAtom a + +bchan :: (MonadBot m,ChAtoms m) => m String +bchan = bkStr "Connection/Channel" + +bnick :: (MonadBot m,ChAtoms m) => m String +bnick = bkStr "Connection/Nick" + +bprefix :: (MonadBot m,ChAtoms m) => m String +bprefix = bkStr "Prefix" + +switchTo :: MonadBot m => String -> m a -> m a +switchTo m f = do + bmodify $ \b -> b{moduleStack=m:moduleStack b} + a <- f + bmodify $ \b -> b{moduleStack=tail $ moduleStack b} + return a + + +blStr :: (MonadBot m,ChAtoms m) => String -> m String +blStr k = do + m <- bmodule + let unjust (Just u) = u + c <- bgets $ unjust . tstLookup m . localizations + case mgetKey m k c of + Just (TempLeaf (StrValT i)) -> return i + Just (RefLeaf (StrVal a)) -> getAtom a + Nothing -> error $ printf "Could not find essential key %s. Check your locale file." k + _ -> error $ printf "Key %s has the wrong type (string expected). Check your locale file." k + +blStrL :: (MonadBot m,ChAtoms m) => String -> m [String] +blStrL k = do + m <- bmodule + let unjust (Just u) = u + c <- bgets $ unjust . tstLookup m . localizations + case mgetKey m k c of + Just (TempLeaf (StrListT i)) -> return i + Just (RefLeaf (StrList a)) -> getAtom a + Nothing -> error $ printf "Could not find essential key %s. Check your locale file." k + _ -> error $ printf "Key %s has the wrong type (string list expected). Check your locale file." k + +blInt :: (MonadBot m,ChAtoms m) => String -> m Int +blInt k = do + m <- bmodule + let unjust (Just u) = u + c <- bgets $ unjust . tstLookup m . localizations + case mgetKey m k c of + Just (TempLeaf (IntValT i)) -> return i + Just (RefLeaf (IntVal a)) -> getAtom a + Nothing -> error $ printf "Could not find essential key %s. Check your locale file." k + _ -> error $ printf "Key %s has the wrong type (integer expected). Check your locale file." k + +blFun :: (MonadBot m,ChAtoms m) => String -> m (String -> String) +blFun k = do + m <- bmodule + let unjust (Just u) = u + c <- bgets $ unjust . tstLookup m . localizations + case mgetKey m k c of + Just (TempLeaf (CtplT q)) -> return $ \s -> + case evalCTPL q s 40000 of + Null.Succ r -> r + _ -> s + Just (TempLeaf (Ctpl0T q)) -> return $ \s -> + case Null.evalCTPL0 q s 40000 of + Null.Succ r -> r + _ -> s + Just (RefLeaf (Ctpl0 a)) -> do + q <- getAtom a + return $ \s -> case Null.evalCTPL0 q s 40000 of + Null.Succ r -> r + _ -> s + Nothing -> error $ printf "Could not find essential key %s. Check your locale file." k + _ -> error $ printf "Key %s has the wrong type (function expected). Check your locale file." k + +bvStr :: (MonadBot m,ChAtoms m,ChRandom m) => String -> String -> m String +bvStr l k = do + ls <- blStrL "Linguas" + let unjust (Just u) = u + m <- bmodule + s <- bstereo + c <- bgets $ unjust . tstLookup m . localizations + f <- blStr "Fallback" + fs <- blStr "FallbackStereo" + let fallbacks = [k++":"++f++"-"++s, k++":"++f++"-"++fs, k++":"++f] + wanted = [k++":"++l++"-"++s, k++":"++l++"-"++fs, k++":"++l] ++ fallbacks + errstr = printf "Could not find essential localization key %%%s/%s:%s." m k (if null s then l else l++"-"++s) + prock k = case k of + TempLeaf (StrValT i) -> return i + TempLeaf (StrListT i) -> do + r <- mrandomR (0, length i - 1) + return (i !! r) + RefLeaf (StrVal a) -> getAtom a + RefLeaf (StrList a) -> do + i <- getAtom a + r <- mrandomR (0, length i - 1) + return (i !! r) + if not $ elem l ls + then mgetFirstKey m fallbacks c & maybe (error errstr) id & prock + else mgetFirstKey m wanted c & maybe (error errstr) id & prock + +private :: UserA -> String -> Anticiv () +private ua s = do + u <- getAtom ua + cprint (Target $ userNick u) (s++"\r\n") + +address :: UserA -> String -> Anticiv () +address ua s = do + u <- getAtom ua + cprint (Address u) (s++"\r\n") + +log :: String -> Anticiv () +log = cprint Log . (++"\r\n") + +action :: String -> Anticiv () +action s = do + c <- bchan + cprint (Target c) (printf "\001ACTION %s\001\r\n" s) + +notice :: UserA -> String -> Anticiv () +notice ua s = do + u <- getAtom ua + cprint (Notice $ userNick u) (s++"\r\n") + +type Speaker = forall r. PrintlType r => UserA -> String -> r + +privatefl :: Speaker +privatefl u s = emitl (Just u) (return . Target . userNick =<< getAtom u) return s [] + +addressfl :: Speaker +addressfl u s = emitl (Just u) (liftM Target bchan) (\s -> getAtom u >>= \u -> return (userNick u++": "++s)) s [] + +actionfl :: PrintlType r => String -> r +actionfl s = emitl Nothing (liftM Target bchan) (\s -> return ("\001ACTION "++s++"\001")) s [] + +noticefl :: Speaker +noticefl u s = emitl (Just u) (return . Notice . userNick =<< getAtom u) return s [] + +globalfl :: PrintlType r => String -> r +globalfl s = emitl Nothing (liftM Target bchan) return s [] + +newtype PrintlArgW = PrintlArgW { runPrintlArgW :: String -> Anticiv String } + +class PrintlType t where + emitl :: Maybe UserA -> Anticiv Target -> (String -> Anticiv String) -> String -> [PrintlArgW] -> t + +instance MonadAnticiv m => PrintlType (m ()) where + emitl um t f s ss = do + li <- case um of + Nothing -> bgets botLingua + Just ua -> ulang ua + ls <- bvStr li s + ls' <- f ls + t' <- t + ss' <- forM ss $ \s -> runPrintlArgW s li + ssx <- liftM (++"\r\n") (repll ls' ss') + cprint t' ssx + case um of + Just _ -> return () + Nothing -> do + us <- bgets channelUsers + orl <- bgets linguaOverride + forM_ us $ \ua -> + case avlLookup ua orl of + Nothing -> return () + Just l | l == li -> return () + Just l -> do + u <- getAtom ua + ls <- bvStr l s + ls' <- f ls + ssx <- liftM (++"\r\n") (repll ls' ss') + cprint (Notice $ userNick u) ssx + +instance (PrintlArg a,PrintlType r) => PrintlType (a -> r) where + emitl u t f s ss a = emitl u t f s (ss++[printlargw a]) + +printlargw :: PrintlArg a => a -> PrintlArgW +printlargw a = PrintlArgW $ flip showl a + +class PrintlArg a where + showl :: String -> a -> Anticiv String + +instance PrintlArg String where + showl _ = return + +instance PrintlArg Int where + showl _ = return . show + +data Lookup = Lookup String | Lookupf String [PrintlArgW] + +instance PrintlArg Lookup where + showl li (Lookup k) = bvStr li k + showl li (Lookupf k as) = do + fmt <- bvStr li k + as' <- forM as $ \a -> runPrintlArgW a li + repll fmt as' + +ulang :: UserA -> Anticiv String +ulang ua = do + orl <- bgets linguaOverride + case avlLookup ua orl of + Just s -> return s + Nothing -> bgets botLingua + +repll :: String -> [String] -> Anticiv String +repll ('%':'s':s) (t:ts) = liftM (t++) $ repll s ts +repll ('%':'f':s) (t:ts) = repll (t++s) ts +repll ('%':'p':s) ts = liftM2 (++) bprefix $ repll s ts +repll ('%':'%':s) ts = liftM ('%':) $ repll s ts +repll ('%':'[':s) (t:ts) = + let fs = takeWhile (/=']') s + s' = tail $ dropWhile (/=']') s + in do + fun <- blFun fs + liftM (fun t++) $ repll s' ts +repll ('#':s) ts = + let n = read $ takeWhile isDigit s + s' = dropWhile isDigit s + in liftM ((ts!!n)++) $ repll s' ts +repll (c:s) ts = liftM (c:) $ repll s ts +repll [] _ = return [] + +{-repll :: String -> String -> [String] -> String +repll ('%':'s':s) p (t:ts) = t++repll s p ts +repll ('%':'f':s) p (t:ts) = repll (t++s) p ts +repll ('%':'p':s) p ts = p++repll s p ts +repll ('%':'%':s) p ts = '%' : repll s p ts +repll ('#':s) p ts = + let n = read $ takeWhile isDigit s + s' = dropWhile isDigit s + in (ts !! n) ++ repll s' p ts +repll (c:s) p ts = c : repll s p ts +repll [] _ _ = []-} + +data LocalToken = LocalT UserA String + +instance MatchMask LocalToken Nil where + matchmask (LocalT ua t) = do + let guardr a f = mscannable >>= \b -> if b then f else return a + skipWhite = guardr () $ do + k <- mpeek1 + if isSpace k + then mscan1 >> skipWhite + else return () + scanAnumToken = guardr [] $ do + k <- mpeek1 + if isAlphaNum k + then do + mscan1 + ks <- scanAnumToken + return (k:ks) + else return [] + scanMiscToken = guardr [] $ do + k <- mpeek1 + if not (isAlphaNum k) && not (isSpace k) + then do + mscan1 + ks <- scanMiscToken + return (k:ks) + else return [] + scanToken = guardr [] $ do + skipWhite + k <- mpeek1 + if isAlphaNum k + then scanAnumToken + else scanMiscToken + rep k f = forM [1..k] $ const f + allTokens = do + ss <- get + if null ss + then return [] + else do + t <- scanToken + ts <- allTokens + return (t:ts) + li <- lift $ ulang ua + ls <- lift $ bvStr li ("Commands/"++t) + lts <- lift $ evalStateT allTokens ls + sts <- rep (length lts) scanToken + if all (\(l,s) -> l `strEq` s) $ zip lts sts + then return (Just Nil) + else return Nothing + verbosemask (LocalT ua t) = "the localization of Commands/"++t + +bsetStereo :: MonadBot m => String -> m () +bsetStereo s = do + m <- bmodule + bmodify $ \b -> b{moduleStereo=tstInsert m s $ moduleStereo b} diff --git a/Network/Anticiv/Masks.hs b/Network/Anticiv/Masks.hs new file mode 100644 --- /dev/null +++ b/Network/Anticiv/Masks.hs @@ -0,0 +1,296 @@ +{-# LANGUAGE MultiParamTypeClasses, FunctionalDependencies, ScopedTypeVariables, ConstraintKinds, FlexibleContexts, FlexibleInstances, TypeSynonymInstances, UndecidableInstances, RankNTypes, PatternGuards #-} +module Network.Anticiv.Masks where + +import Control.Monad +import Control.Monad.State +import Data.Char +import Data.List +import Data.Chatty.Atoms +import Data.Chatty.Hetero +import Network.Anticiv.Monad +import System.Chatty.Misc + +class MatchMask mm l | mm -> l where + matchmask :: forall m. MonadAnticiv m => mm -> StateT String m (Maybe l) + verbosemask :: mm -> String + +data CatchString = Remaining | RemString | QuotString | ServerHost +data CatchUser = ChannelUser | UserMask +data CatchInt = CatchInt +data Token = Token String | CIToken String | CIString String +newtype Optional a = Optional a +newtype Which a = Which [a] + +instance Tuplify Token Token where + tuplify = id + +instance MatchMask String Nil where + matchmask t = do + ss <- get + if take (length t) ss == t + then modify (drop $ length t) >> return (Just Nil) + else return Nothing + verbosemask t = "the case sensitive string \""++t++"\"" + +instance MatchMask Token Nil where + matchmask (Token t) = do + ss <- liftM (takeUntil isSpace . dropWhile isSpace) get + if ss == t + then modify (drop (length ss) . dropWhile isSpace) >> return (Just Nil) + else return Nothing + matchmask (CIToken t) = do + ss <- liftM (takeUntil isSpace . dropWhile isSpace) get + if ss `strEq` t + then modify (drop (length ss) . dropWhile isSpace) >> return (Just Nil) + else return Nothing + matchmask (CIString t) = do + ss <- get + if take (length t) ss `strEq` t + then modify (drop $ length t) >> return (Just Nil) + else return Nothing + verbosemask (Token t) = "the case sensitive token \""++t++"\"" + verbosemask (CIToken t) = "the case insensitive token \""++t++"\"" + verbosemask (CIString t) = "the case insenstive string \""++t++"\"" + +takeUntil = takeWhile . (not.) +nickfirstchars = ['A'..'Z'] ++ ['a'..'z'] ++ "_\\`|^" +nicknextchars = nickfirstchars ++ ['0'..'9'] +namefirstchars = "~_-" ++ ['A'..'Z'] ++ ['a'..'z'] +namenextchars = ['A'..'Z'] ++ ['a'..'z'] ++ ['0'..'9'] ++ "_-" +hostfirstchars = ['A'..'Z'] ++ ['a'..'z'] ++ ['0'..'9'] ++ "_-:" +hostnextchars = hostfirstchars ++ "./" +strEq a b = map toLower a == map toLower b + +instance MatchMask CatchInt (Cons Int Nil) where + matchmask CatchInt = do + ss <- gets (takeWhile isDigit . dropWhile isSpace) + if null ss + then return Nothing + else do + modify (dropWhile isDigit . dropWhile isSpace) + return $ Just (read ss :-: Nil) + verbosemask CatchInt = "integer" + +instance MatchMask CatchString (Cons String Nil) where + matchmask Remaining = do + ss <- get + put [] + return $ Just (ss :-: Nil) + matchmask RemString = do + ss <- liftM (dropWhile isSpace) get + if null ss then return Nothing + else if head ss == ':' then put [] >> return (Just (tail ss :-: Nil)) + else return Nothing + matchmask QuotString = do + let catchquote [] = Nothing + catchquote ('\"':rs) = Just ("",rs) + catchquote ('\\':'\"':rs) + | Nothing <- catchquote rs = Nothing + | Just (as,rx) <- catchquote rs = Just ('\"':as, rx) + catchquote ('\\':'\\':rs) + | Nothing <- catchquote rs = Nothing + | Just (as,rx) <- catchquote rs = Just ('\\':as, rx) + catchquote (a:rs) + | Nothing <- catchquote rs = Nothing + | Just (as,rx) <- catchquote rs = Just (a:as, rx) + ss <- get + if null ss + then return Nothing + else if head ss /= '\"' + then return Nothing + else + case catchquote ss of + Nothing -> return Nothing + Just (as,rx) -> put rx >> return (Just (as :-: Nil)) + matchmask ServerHost = do + ss <- gets (dropWhile isSpace) + if null ss + then return Nothing + else if head ss /= ':' + then return Nothing + else if null (tail ss) + then return Nothing + else if not (head (tail ss) `elem` hostfirstchars) + then return Nothing + else let ho = head (tail ss) : takeWhile (`elem` hostnextchars) (tail $ tail ss) + in modify (drop (length ho) . tail) >> return (Just (ho :-: Nil)) + verbosemask Remaining = "free form content" + verbosemask RemString = "colon-introduced string to line end" + verbosemask QuotString = "quoted string" + verbosemask ServerHost = "server host mask starting with a colon" + +simul a b k = do + a' <- lift $ a k + b' <- lift $ b k + return (a',b') + +instance MatchMask CatchUser (Cons UserA Nil) where + matchmask UserMask = do + let consumeColon = do + ss <- gets (dropWhile isSpace) + if null ss + then return Nothing + else if head ss /= ':' + then return Nothing + else modify (tail . dropWhile isSpace) >> return (Just ()) + consumeNick = do + ss <- get + if null ss + then return Nothing + else if not (head ss `elem` nickfirstchars) + then return Nothing + else let nm = head ss : takeWhile (`elem` nicknextchars) (tail ss) + in modify (drop $ length nm) >> return (Just nm) + consumeBang = do + ss <- get + if null ss + then return Nothing + else if head ss /= '!' + then return Nothing + else modify tail >> return (Just ()) + consumeName = do + ss <- get + if null ss + then return Nothing + else if not (head ss `elem` namefirstchars) + then return Nothing + else let nm = head ss : takeWhile (`elem` namenextchars) (tail ss) + in modify (drop $ length nm) >> return (Just nm) + consumeAt = do + ss <- get + if null ss + then return Nothing + else if head ss /= '@' + then return Nothing + else modify tail >> return (Just ()) + consumeHost = do + ss <- get + if null ss + then return Nothing + else if not (head ss `elem` hostfirstchars) + then return Nothing + else let ho = head ss : takeWhile (`elem` hostnextchars) (tail ss) + in modify (drop $ length ho) >> return (Just ho) + colon <- consumeColon + nick <- consumeNick + bang <- consumeBang + name <- consumeName + at <- consumeAt + host <- consumeHost + let u = do + colon + ni <- nick + bang + na <- name + at + ho <- host + return (User ni na ho 0) + case u of + Nothing -> return Nothing + Just u -> do + us <- lift $ bgets channelUsers + us' <- mapM (getAtom `simul` return) us + a <- lift $ case filter (strEq (userNick u) . userNick . fst) us' of + [] -> do + a <- newAtom + r <- mrandomR (1,40000) + putAtom a u{reauthId=r} + bmodify $ \b -> b{channelUsers=a:channelUsers b} + return a + ((k,a):_) -> do + putAtom a u{reauthId=reauthId k} + return a + return (Just (a :-: Nil)) + matchmask ChannelUser = do + ss <- liftM (dropWhile isSpace) get + if null ss + then return Nothing + else if not (head ss `elem` nickfirstchars) + then return Nothing + else let nm = head ss : takeWhile (`elem` nicknextchars) (tail ss) + in do + us <- lift $ bgets channelUsers + us' <- mapM (getAtom `simul` return) us + let ux = filter (strEq nm . userNick . fst) us' + if not $ null ux + then do + modify (drop (length nm) . dropWhile isSpace) + return (Just (snd (head ux) :-: Nil)) + else return Nothing + verbosemask UserMask = "full user mask starting with a colon" + verbosemask ChannelUser = "a user nick present in this channel" + + +instance (MatchMask a ar, IntoMaybe ar am, Append am Nil am) => MatchMask (Optional a) am where + matchmask (Optional a) = do + matchmask a >>= \a -> case a of + Nothing -> return $ Just $ tnothing (undefined :: ar) + Just k -> return $ Just $ tjust k + verbosemask (Optional a) = "optionally [" ++ verbosemask a ++ "]" + +firstSeq :: Monad m => (a -> m (Maybe b)) -> [a] -> m (Maybe (a,b)) +firstSeq _ [] = return Nothing +firstSeq f (p:ps) = f p >>= \c -> case c of + Nothing -> firstSeq f ps + Just k -> return $ Just (p,k) + +instance (MatchMask a r,Append (Cons a Nil) r ar) => MatchMask (Which a) ar where + matchmask (Which []) = return Nothing + matchmask (Which ps) = do + ss <- get + firstSeq matchmask ps >>= \c -> case c of + Nothing -> return Nothing + Just (k,r) -> return $ Just (tappend (k :-: Nil) r) + verbosemask (Which []) = "empty choice (you should blame the bot's or module's author)" + verbosemask (Which ps) = unwords $ intersperse "or" $ map verbosemask ps + +instance MatchMask Nil Nil where + matchmask Nil = return $ Just Nil + verbosemask _ = "end of mask" + +instance (MatchMask x r, MatchMask xs rs, Append r rs rx) => MatchMask (Cons x xs) rx where + matchmask (x :-: xs) = do + l1 <- matchmask x + case l1 of + Nothing -> return Nothing + Just l1 -> do + l2 <- matchmask xs + case l2 of + Nothing -> return Nothing + Just l2 -> return $ Just $ tappend l1 l2 + verbosemask (x :-: xs) = verbosemask x ++ ", then " ++ verbosemask x + +trymask :: (MatchMask m r,Tuplify r t) => m -> String -> Anticiv (Maybe t) +trymask m s = do + r <- runStateT (matchmask m) s + return $ case r of + (Nothing,_) -> Nothing + (Just a,[]) -> Just $ tuplify a + (Just a,_) -> Nothing + +infixr 8 #-> +(#->) :: (MatchMask m r, Tuplify r t) => m -> (t -> Anticiv ()) -> String -> Anticiv Bool +mm #-> f = \s -> do + b <- trymask mm s + case b of + Nothing -> return False + Just t -> f t >> return True + +infixr 8 #->> +(#->>) :: (MatchMask m r, Tuplify r t) => m -> Anticiv () -> String -> Anticiv Bool +mm #->> f = mm #-> const f + +infixr 7 #|| +(#||) :: Monad m => m Bool -> m Bool -> m Bool +a #|| b = do + ax <- a + if ax + then return True + else b + +infixr 7 .|| +(.||) :: Monad m => (a -> m Bool) -> (a -> m Bool) -> (a -> m Bool) +a .|| b = \x -> a x #|| b x + +infixl 6 & +(&) = flip ($) diff --git a/Network/Anticiv/Monad.hs b/Network/Anticiv/Monad.hs new file mode 100644 --- /dev/null +++ b/Network/Anticiv/Monad.hs @@ -0,0 +1,278 @@ +{-# LANGUAGE ConstraintKinds, RankNTypes, TemplateHaskell, FlexibleInstances, MultiParamTypeClasses, FlexibleContexts #-} +module Network.Anticiv.Monad where + +import Control.Arrow +import Control.Applicative +import Control.Monad +import Control.Monad.Trans.Class +import Control.Monad.IO.Class +import Data.Monoid +import Data.Time.Clock +import Data.Typeable +import Game.Antisplice.Monad +import Game.Antisplice.Templates +import Data.Chatty.Atoms +import Data.Chatty.Counter +import Data.Chatty.AVL +import Data.Chatty.Hetero +import Data.Chatty.TST +import Network.Anticiv.Config +import System.Chatty.Misc +import System.IO +import Text.Chatty.Channel.Printer +import Text.Chatty.Finalizer +import Text.Chatty.Printer +import Text.Chatty.Scanner +import Text.Chatty.Interactor +import Text.Chatty.Interactor.Templates +import Text.Printf + +newtype BotT m a = BotT { runBotT :: BotState -> m (a,BotState) } + +instance Functor f => Functor (BotT f) where + fmap f (BotT a) = BotT $ \s -> fmap (first f) $ a s + +instance (Functor f, Monad f) => Applicative (BotT f) where + pure = return + fm <*> fa = do + f <- fm + a <- fa + return (f a) + +instance Monad m => Monad (BotT m) where + return a = BotT $ \s -> return (a,s) + m >>= f = BotT $ \s -> do (a,s') <- runBotT m s; runBotT (f a) s' + +instance MonadTrans BotT where + lift m = BotT $ \s -> do a <- m; return (a,s) + +instance MonadIO m => MonadIO (BotT m) where + liftIO = lift . liftIO + +data User = User { + userNick :: String, + userName :: String, + userHost :: String, + reauthId :: Int + } deriving Eq + +type UserA = Atom User + +instance Show User where + show (User ni "" "" _) = ni + show (User ni na ho _) = printf "%s!%s@%s" ni na ho + +instance Tuplify User User where + tuplify = id + +instance Tuplify (Atom a) (Atom a) where + tuplify = id + +data BotState = BotState { + channelUsers :: [UserA], + orphanedUsers :: [UserA], + priorityChanmsg :: [HandlerA], + emergencyChanmsg :: [HandlerA], + priorityQuerymsg :: [HandlerA], + emergencyQuerymsg :: [HandlerA], + tickRecipients :: [AnticivA ()], + botConfig :: Config, + moduleStack :: [String], + localizations :: TST Config, + botLingua :: String, + linguaOverride :: AVL (UserA, String), + moduleStereo :: TST String, + moduleLister :: [(String,Packciv [String])], + lastMsg :: NominalDiffTime, + lastReport :: NominalDiffTime + } + +type MonadAnticiv m = (Functor m, Monad m, ChPrinter m, ChScanner m, ChClock m, ChChannelPrinter Target m, MonadBot m, ChAtoms m,ChRandom m) + +type Anticiv a = forall m. MonadAnticiv m => m a +newtype Packciv a = Anticiv { runAnticiv :: Anticiv a } +type AnticivA a = Atom (Packciv a) + +instance Monad Packciv where + return a = Anticiv $ return a + m >>= f = Anticiv $ runAnticiv m >>= runAnticiv . f + +instance Functor Packciv where + fmap f a = liftM f a + +class Monad m => MonadBot m where + bget :: m BotState + bput :: BotState -> m () + +instance Monad m => MonadBot (BotT m) where + bget = BotT $ \s -> return (s,s) + bput s = BotT $ \_ -> return ((),s) + +bmodify :: MonadBot m => (BotState -> BotState) -> m () +bmodify f = bgets f >>= bput + +bgets :: MonadBot m => (BotState -> a) -> m a +bgets f = f `liftM` bget + +sleep :: ChClock m => Int -> m () +sleep ms = do + a <- mgetstamp + let loop = do + b <- mgetstamp + if a + fromRational (fromIntegral ms/1000) > b + then loop + else return () + loop + +type Handler = UserA -> String -> Packciv Bool +type HandlerA = Atom Handler + +data Target = Log | Target String | Notice String | Address User | Raw deriving Eq + +-- | Directs Log messages through the underlying MonadPrinter, and server communication through the passed handle +newtype OutPlexT m a = OutPlex { runOutPlex :: Handle -> [Target] -> m (a,[Target]) } + +instance Functor f => Functor (OutPlexT f) where + fmap f a = OutPlex $ \h ts -> fmap (first f) $ runOutPlex a h ts + +instance (Functor f, Monad f) => Applicative (OutPlexT f) where + pure = return + fm <*> fa = do + f <- fm + a <- fa + return (f a) + +instance Monad m => Monad (OutPlexT m) where + return a = OutPlex $ \h ts -> return (a,ts) + m >>= f = OutPlex $ \h ts -> do + (a,ts') <- runOutPlex m h ts + runOutPlex (f a) h ts' + +instance MonadTrans OutPlexT where + lift m = OutPlex $ \h ts -> do a <- m; return (a,ts) + +instance MonadIO m => MonadIO (OutPlexT m) where + liftIO = lift . liftIO + +instance (MonadIO m,ChPrinter m,MonadBot m,ChClock m,ChAtoms m) => ChPrinter (OutPlexT m) where + mprint s = OutPlex $ \h ts -> do + unless (head ts == Log) $ do + t <- bgets lastMsg + tw <- bkInt "Throttle" + let wait = do + t' <- mgetstamp + if t' > t+(fromRational (fromIntegral tw / 1000)) + then return () + else wait + wait + t' <- mgetstamp + bmodify $ \b -> b{lastMsg=t'} + case head ts of + Log -> do + m <- bmodule + mprint ("["++m++"] "++s) + Raw -> liftIO $ hPutStr h s + Target ch -> liftIO $ hPrintf h "PRIVMSG %s :%s" ch s + Address de -> do + ch <- bkStr "Connection/Channel" + liftIO $ hPrintf h "PRIVMSG %s :%s: %s" ch (userNick de) s + Notice ch -> liftIO $ hPrintf h "NOTICE %s :%s" ch s + return ((),ts) + mflush = OutPlex $ \h ts -> (case head ts of + Log -> mflush + _ -> liftIO $ hFlush h ) >> return ((),ts) + +instance (MonadIO m,ChPrinter m,MonadBot m,ChClock m,ChAtoms m) => ChChannelPrinter Target (OutPlexT m) where + cstart c = OutPlex $ \_ ts -> return ((),c:ts) + cfin _ = OutPlex $ \_ ts -> return ((),tail ts) + cthis = OutPlex $ \_ ts -> return (head ts,ts) + +instance MonadBot m => MonadBot (OutPlexT m) where + bget = lift bget + bput = lift . bput + +instance MonadBot m => MonadBot (OutRedirT m) where + bget = lift bget + bput = lift . bput + +instance MonadBot m => MonadBot (InRedirT m) where + bget = lift bget + bput = lift . bput + +bkInt :: (MonadBot m,ChAtoms m) => String -> m Int +bkInt s = do + c <- bgets botConfig + m <- bmodule + case mgetKey m s c of + Nothing -> error $ printf "Could not find essential key %s. Check your config file." s + Just (TempLeaf (IntValT i)) -> return i + Just (RefLeaf (IntVal a)) -> getAtom a + _ -> error $ printf "Key %s has the wrong type. Check your config file." s + +bkStr :: (MonadBot m,ChAtoms m) => String -> m String +bkStr s = do + c <- bgets botConfig + m <- bmodule + case mgetKey m s c of + Nothing -> error $ printf "Could not find essential key %s. Check your config file." s + Just (TempLeaf (StrValT i)) -> return i + Just (RefLeaf (StrVal a)) -> getAtom a + _ -> error $ printf "Key %s has the wrong type. Check your config file." s + +bkStrL :: (MonadBot m,ChAtoms m) => String -> m [String] +bkStrL s = do + c <- bgets botConfig + m <- bmodule + case mgetKey m s c of + Nothing -> error $ printf "Could not find essential key %s. Check your config file." s + Just (TempLeaf (StrListT i)) -> return i + Just (RefLeaf (StrList a)) -> getAtom a + _ -> error $ printf "Key %s has the wrong type. Check your config file." s + +bmodule :: MonadBot m => m String +bmodule = bgets $ head . moduleStack + +bstereo :: MonadBot m => m String +bstereo = do + m <- bmodule + ms <- bgets moduleStereo + return $ case tstLookup m ms of + Just s -> s + Nothing -> [] + +mkInteractor ''BotT mkPrinter mkScanner mkFinalizer mkRandom mkClock mkAtoms mkCounter +mkInteractor ''OutPlexT mkScanner mkFinalizer mkRandom mkClock mkAtoms mkCounter + +instance ChPrinter Packciv where + mprint s = Anticiv $ mprint s + mnoecho s = Anticiv $ mnoecho s + mflush = Anticiv mflush + mnomask s = Anticiv $ mnomask s +instance ChScanner Packciv where + mscan1 = Anticiv mscan1 + mscanL = Anticiv mscanL + mscannable = Anticiv mscannable + mscanh = Anticiv mscanh + mready = Anticiv mready +instance ChClock Packciv where + mutctime = Anticiv mutctime + mgetstamp = Anticiv mgetstamp +instance ChChannelPrinter Target Packciv where + cstart c = Anticiv $ cstart c + cfin c = Anticiv $ cfin c + cprint c s = Anticiv $ cprint c s + cthis = Anticiv cthis +instance ChAtoms Packciv where + newAtom = Anticiv newAtom + putAtom a v = Anticiv $ putAtom a v + getAtom a = Anticiv $ getAtom a + dispAtom a = Anticiv $ dispAtom a + cloneAtom a = Anticiv $ cloneAtom a +instance ChCounter Packciv where + countOn = Anticiv countOn +instance ChRandom Packciv where + mrandom = Anticiv mrandom + mrandomR r = Anticiv $ mrandomR r +instance MonadBot Packciv where + bget = Anticiv bget + bput s = Anticiv $ bput s diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/anticiv.cabal b/anticiv.cabal new file mode 100644 --- /dev/null +++ b/anticiv.cabal @@ -0,0 +1,76 @@ +-- Initial anticiv.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +-- The name of the package. +name: anticiv + +-- The package version. See the Haskell package versioning policy (PVP) +-- for standards guiding when and how versions should be incremented. +-- http://www.haskell.org/haskellwiki/Package_versioning_policy +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.1.0.4 + +-- A short (one-line) description of the package. +synopsis: This is an IRC bot for Mafia and Resistance. + +-- A longer description of the package. +-- description: + +-- The license under which the package is released. +license: AGPL-3 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: Marvin Cohrs + +-- An email address to which users can send suggestions, bug reports, and +-- patches. +maintainer: m@doomanddarkness.eu + +-- A copyright notice. +-- copyright: + +category: Network + +build-type: Simple + +-- Extra files to be distributed with the package, such as examples or a +-- README. +-- extra-source-files: + +-- Constraint on the version of Cabal needed to build this package. +cabal-version: >=1.10 + + +executable anticiv + -- .hs or .lhs file containing the Main module. + main-is: Main.hs + + -- Modules included in this executable, other than Main. + other-modules: Network.Anticiv.Monad, Network.Anticiv.Masks, Network.Anticiv.Convenience + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + + -- Other library packages from which modules are imported. + build-depends: base >=4.6 && <4.8, chatty >= 0.6 && <0.7, chatty-utils >= 0.6 && <0.8, chatty-text >=0.6 && <0.7, transformers >= 0.3 && <0.5, antisplice >=0.17 && <0.18, network >=2.3 && <2.4, mtl >= 2.1 && <2.3, ironforge >= 0.1 && < 0.2, time >=1.4 && <1.5, plugins >=1.5 && <1.6, directory >= 1.2 && <1.3, ctpl >=0.1 && <0.2 + + -- Base language which the package is written in. + default-language: Haskell2010 + + + -- Directories containing source files. + -- hs-source-dirs: + +library + build-depends: base >=4.6 && <4.8, chatty >= 0.6 && <0.7, chatty-utils >= 0.6 && <0.8, chatty-text >=0.6 && <0.7, transformers >= 0.3 && <0.5, antisplice >=0.17 && <0.18, network >=2.3 && <2.4, mtl >= 2.1 && <2.3, ironforge >= 0.1 && < 0.2, time >=1.4 && <1.5, plugins >=1.5 && <1.6, ctpl >=0.1 && <0.2 + + exposed-modules: Network.Anticiv.Monad, Network.Anticiv.Masks, Network.Anticiv.Convenience + + -- Base language which the package is written in. + default-language: Haskell2010 +