diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/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/src/Devel.hs b/src/Devel.hs new file mode 100644 --- /dev/null +++ b/src/Devel.hs @@ -0,0 +1,61 @@ +{-| +Module : Devel +Description : An entry point for GHC to compile yesod-devel. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX +-} +module Devel (buildAndRun) where + +-- Related to config +import IdeSession (sessionConfigFromEnv) +import System.Environment (lookupEnv, setEnv) + +-- Internal functions. +import Devel.Config (setConfig) +import Devel.ReverseProxy (cyclePorts) +import Devel.Build (build) + +-- | Build and run our haskell application. +buildAndRun :: FilePath -> String -> Bool -> IO () +buildAndRun buildFile runFunction isReverseProxy = do + + -- set Environment variables: GHC_PACKAGE_PATH and PATH + -- Needed for ide-backend to provide sessionConfig + _ <- setConfig + + + -- Let ide-backend set session config now because ide-backend can't set it during rebuilds. + -- We then pass sessionConfig around between rebuilds + -- You must restart wai-devel in the terminal for it to get a new session config + sessionConfig <- sessionConfigFromEnv + + -- If port isn't set we assume port 3000 + maybePort <- lookupEnv "PORT" + let fromProxyPort = case maybePort of + Just port -> read port :: Int + _ -> 3000 + + -- Look for and give us a port to reverse proxy to + -- i.e a destination port. + toProxyPort <- cyclePorts fromProxyPort + + -- Set PORT depending on whether reverse proxying is disallowed or not. + -- If reverse proxying is set to disabled i.e False + -- Then PORT variable is set to the source port i.e fromProxyPort + -- By default reverse proxying is True. + if isReverseProxy + then setEnv "PORT" (show toProxyPort) + else setEnv "PORT" (show fromProxyPort) + + -- We call the build function only the first time we want to build our application. + build + buildFile -- The target file, should contain the function we wish to call. + runFunction -- The function we want to call. + isReverseProxy -- Use reverse proxying? Default to True. + sessionConfig -- We need this when compiling. + (fromProxyPort, toProxyPort) -- The port we reverse proxy to and from. + Nothing -- Maybe IdeSession + False -- To rebuild or not to. diff --git a/src/Devel/Build.hs b/src/Devel/Build.hs new file mode 100644 --- /dev/null +++ b/src/Devel/Build.hs @@ -0,0 +1,129 @@ +{-| +Module : Devel.Compile +Description : For building and running your WAI application. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX +-} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE CPP #-} + +module Devel.Build +( build +) where + + +import IdeSession +import qualified Data.ByteString.Char8 as S8 +import Data.Text (unpack) + +import GHC.Conc (newTVarIO) +import Control.Concurrent (forkIO, killThread, ThreadId) + +-- Rebuild +import Control.Monad (unless) +# if __GLASGOW_HASKELL__ < 710 +import Data.Monoid (mempty) +#endif + +import Devel.Compile +import Devel.ReverseProxy (startReverseProxy) +import Devel.Watch + + +-- | Compiles and calls run on your WAI application. +build :: FilePath -> String -> Bool -> SessionConfig -> (Int, Int) -> Maybe IdeSession -> Bool -> IO () +build buildFile runFunction isReverseProxy sessionConfig (fromProxyPort, toProxyPort) mSession isRebuild = do + + (initialSession, extensionList, includeTargets) <- initCompile sessionConfig mSession + + -- Do this if isRebuild is False. + unless isRebuild $ + if isReverseProxy then + do _ <- forkIO $ startReverseProxy (fromProxyPort, toProxyPort) + putStrLn $ "Starting devel application at http://localhost:" ++ + show fromProxyPort + else + putStrLn $ "Starting app without reverse proxying at http://localhost:" ++ + show fromProxyPort + + + (updatedSession, update) <- + if isRebuild + then return (initialSession, mempty) + else compile initialSession buildFile extensionList includeTargets + + eitherSession <- finishCompile (updatedSession, update) + + case eitherSession of + Left _ -> do + -- Listen for changes in the current working directory. + isDirty <- newTVarIO False + + _ <- forkIO $ watch isDirty includeTargets + + -- Block until relevant change is made then carry on with program execution. + _ <- checkForChange isDirty + + -- Stop the current app. + putStrLn "\n\nRebuilding...\n\n" + + _ <- shutdownSession updatedSession + + -- Coming to fix. + build buildFile runFunction False sessionConfig (fromProxyPort, toProxyPort) Nothing False + + Right session -> do + -- run the session + (runActionsRunResult, threadId) <- run session buildFile runFunction + + -- Start watching for file changes. + isDirty <- newTVarIO False + + -- Watch for changes in the current working directory. + watchId <- forkIO $ watch isDirty includeTargets + + -- Block until relevant change is made then carry on with program execution. + _ <- checkForChange isDirty + + killThread watchId + + -- Stop the current app. + _ <- stopApp runActionsRunResult threadId + putStrLn "\n\nRebuilding...\n\n" + build buildFile runFunction isReverseProxy sessionConfig (fromProxyPort, toProxyPort) (Just session) True + + +run :: IdeSession -> FilePath -> String -> IO (RunActions RunResult, ThreadId) +run session buildFile runFunction = do + -- Get the module name from the file path + mapFunction <- getFileMap session + buildModule <- case mapFunction buildFile of + Nothing -> fail $ "The file's module name for: " ++ show buildFile ++" couldn't be found" + Just moduleId -> return $ unpack $ moduleName moduleId + + -- Run the given ide-backend session. + runActionsRunResult <- runStmt session buildModule runFunction + threadId <- forkIO $ loop runActionsRunResult + + return (runActionsRunResult, threadId) + + +-- | Stop the currently running WAI application. +stopApp :: RunActions RunResult -> ThreadId -> IO () +stopApp runResult threadId = do + interrupt runResult + killThread threadId + + +-- | Run for as long as we need to. +loop :: RunActions RunResult -> IO () +loop res = do + runAction <- runWait res + case runAction of + Left bs -> S8.putStr bs >> loop res + Right result -> putStrLn $ "Run result: " ++ show result + diff --git a/src/Devel/CmdArgs.hs b/src/Devel/CmdArgs.hs new file mode 100644 --- /dev/null +++ b/src/Devel/CmdArgs.hs @@ -0,0 +1,43 @@ +{-| +Module : Devel.Args +Description : For handling command line arguments. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX +-} +module Devel.CmdArgs +( cmdArgs +, CmdArgs (..) +) where + +import Options.Applicative + +-- | Command line arguments for yesod devel. +-- All arguments are optional. +data CmdArgs = CmdArgs + { buildFile :: FilePath + , runFunction :: String + , isReverseProxy :: Bool -- By default reverse proxy should be True + } deriving (Show, Eq) + +cmdArgs :: Parser CmdArgs +cmdArgs = CmdArgs + <$> strOption + (long "path" + <> short 'p' + <> value "Application.hs" + <> metavar "FILEPATH" + <> help "The file with the function you want to run. Default is `Application.hs`.") + <*> strOption + (long "function" + <> short 'f' + <> value "develMain" + <> metavar "FUNCTION" + <> help "The function you want run. Default is `develMain`.") + <*> flag True False + (long "no-reverse-proxy" + <> short 'r' + <> help "use `-r` to disable reverse proxying." ) + diff --git a/src/Devel/Compile.hs b/src/Devel/Compile.hs new file mode 100644 --- /dev/null +++ b/src/Devel/Compile.hs @@ -0,0 +1,198 @@ +{-| +Module : Devel.Compile +Description : Attempts to compile the WAI application. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX + +Compile compiles the app to give: +Either a list of source errors or an ide-backend session. +-} + +{-# LANGUAGE OverloadedStrings #-} + +module Devel.Compile +( initCompile +, compile +, finishCompile +) where + + +-- The backbone library of ide-backend. +-- Almost everything is dependent on ide-backend. +import IdeSession + +-- From Cabal-ide-backend +-- for parsing the cabal file and extracting lang extensions used. +import Distribution.PackageDescription +import Distribution.ModuleName +import Distribution.PackageDescription.Parse +import Distribution.PackageDescription.Configuration +import Language.Haskell.Extension + +-- Used internally for showing errors. +import Data.Text (unpack) + +-- Utility functions +import Data.Monoid ((<>)) + +-- Local imports +import Devel.Paths +import Devel.Types + +import System.FilePath.Posix (takeExtension, pathSeparator) +import System.Directory (doesFileExist) +import Data.List (union, delete, isInfixOf, nub) +import Data.Maybe (fromMaybe) +import Control.Monad (filterM) + +-- |Initialize the compilation process. +initCompile :: SessionConfig -> Maybe IdeSession -> IO (IdeSession, [GhcExtension], [FilePath]) +initCompile sessionConfig mSession = do + -- Initialize the session + session <- case mSession of + Just session -> return session + Nothing -> initSession + defaultSessionInitParams + sessionConfig + + -- This is "rebuilding" the cabal file. + (extensionList, srcDir, cabalSrcList) <- getExtensions + sourceList <- getSourceList srcDir cabalSrcList + return (session, extensionList, sourceList) + +getSourceList :: [FilePath] -> [FilePath] -> IO [FilePath] +getSourceList srcDir cabalSrcList = do + + fileList' <- mapM getRecursiveContents srcDir + + let -- Remove duplicate values. + fileList = foldr union [] fileList' + -- Remove files in test dir. + + fileListNoTests = filter (not.(\x -> isInfixOf "test/" x || isInfixOf "cabal-sandbox/" x || isInfixOf "stack-work/" x)) fileList + + -- Add both lists together. + fileListCombined = fileListNoTests ++ cabalSrcList + + -- Remove all non hs and non .lhs files. + -- also remove "app/devel.hs" because it has an extra main function + sourceList' = filter + (\f -> let ext = takeExtension f in ext == ".lhs" || ext == ".hs") + fileListCombined + -- nub to remove duplicates yet again. + sourceList = nub $ delete "app/DevelMain.hs" $ delete "app/devel.hs" sourceList' + + + return sourceList + + +-- | Contains code regarding target files and coming up with the IdeSession update. +compile :: IdeSession -> FilePath -> [GhcExtension] -> [FilePath] -> IO (IdeSession, IdeSessionUpdate) +compile session buildFile extensionList sourceList = do + + -- Description of session updates. + let targetList = TargetsInclude (if buildFile `elem` sourceList + then sourceList + else buildFile : sourceList) :: Targets + update = updateTargets targetList + <> updateCodeGeneration True + <> updateGhcOpts (["-Wall", "-ddump-hi", "-ddump-to-file"] ++ extensionList) + + return (session, update) + + +-- |The final part of the compilation process. +finishCompile :: (IdeSession, IdeSessionUpdate) -> IO (Either [SourceError'] IdeSession) +finishCompile (session, update) = do + _ <- updateSession session update print + + -- Customizing error showing. + errorList' <- getSourceErrors session + let errorList = case filterErrors errorList' of + [] -> [] + _ -> prettyPrintErrors errorList' + + -- We still want to see errors and warnings on the terminal. + mapM_ putStrLn $ prettyPrintErrors errorList' + + return $ case errorList of + [] -> Right session + _ -> Left errorList + + +-- ----------------------------------------------------------- +-- Utility functions. +-- ----------------------------------------------------------- + +-- | Parse the cabal file to get the ghc extensions in use. +getExtensions :: IO ([GhcExtension], [FilePath], [FilePath]) +getExtensions = do + cabalFilePath <- getCabalFile + cabalFile <- readFile cabalFilePath + + let unsafePackageDescription = parsePackageDescription cabalFile + + genericPackageDescription = case unsafePackageDescription of + ParseOk _ a -> a + _ -> error "failed package description." + + packDescription = flattenPackageDescription genericPackageDescription + + rawExt = usedExtensions $ head $ allBuildInfo packDescription + + lib = fromMaybe emptyLibrary $ library packDescription + + -- I think it would be wise to avoid src files under executable to avoid conflict. + srcDir = hsSourceDirs $ libBuildInfo lib + srcList = extraSrcFiles packDescription + + + parseExtension :: Extension -> String + parseExtension (EnableExtension extension) = "-X" ++ show extension + parseExtension (DisableExtension extension) = "-XNo" ++ show extension + parseExtension (UnknownExtension extension) = "-X" ++ show extension + + extensions = map parseExtension rawExt + + -- Now we handle source files from executable section here. + execList = executables packDescription + + paths <- mapM getPathList execList + + return (extensions, srcDir, (srcList ++ (concat paths))) + where + getPathList :: Executable -> IO [FilePath] + getPathList exec = + let mainModule' = modulePath exec + bInfo = buildInfo exec + execModuleList = otherModules bInfo + srcDirsList = hsSourceDirs bInfo + execSrcFileList = map toFilePath execModuleList + nonPaths = [dir ++ (pathSeparator : fp) | fp <- execSrcFileList, dir <- srcDirsList] + paths' = map (++ (pathSeparator : mainModule') ) srcDirsList -- For the main module + ++ [x++y | x <- nonPaths, y <- [".hs", ".lhs"]] + + in filterM doesFileExist paths' + + + +-- | Remove the warnings from [SourceError] if any. +-- Return an empty list if there are no errors and only warnings +-- Return non empty list if there are errors. +filterErrors :: [SourceError] -> [SourceError] +filterErrors [] = [] +filterErrors (x:xs) = + case errorKind x of + KindWarning -> filterErrors xs + _ -> x : filterErrors xs + +prettyPrintErrors :: [SourceError] -> [SourceError'] +prettyPrintErrors [] = [] +prettyPrintErrors (x: xs) = + case errorKind x of + KindWarning -> ("Warning: " ++ show (errorSpan x) ++ " " ++ unpack (errorMsg x)) : prettyPrintErrors xs + KindError -> ("Error: " ++ show (errorSpan x) ++ " " ++ unpack (errorMsg x)) : prettyPrintErrors xs + KindServerDied -> show (errorKind x) : prettyPrintErrors xs diff --git a/src/Devel/Config.hs b/src/Devel/Config.hs new file mode 100644 --- /dev/null +++ b/src/Devel/Config.hs @@ -0,0 +1,122 @@ +{-| +Module : Devel.Config +Description : To have wai-devel depend on it's environment a lot less. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX + +Currently we'll query for this information from the stack binary. + +Ideal case it to use the stack library to figure out depends and stuff. +Depending on the stack library causes a breakage in the dependecy tree. +As of now I can't find a single function (or set of functions) that fetches this information from stack. +Closest thing is in the stack Main module. + +Will be rewritten to depend on the stack library. +-} +{-# LANGUAGE ScopedTypeVariables #-} + +module Devel.Config +( setConfig +, getPath +, getPkgDb +) where + +import System.Process (readProcessWithExitCode) +import System.Environment (unsetEnv, setEnv, lookupEnv) +import Control.Exception (catch) + +import System.FilePath.Posix (pathSeparator) +import System.Directory (getCurrentDirectory, getHomeDirectory, doesDirectoryExist) +import System.Info (arch, compilerName, os) + +import Devel.Types + +setConfig :: IO () +setConfig = do + (path, pkgDb) <- getConfig + _ <- unsetEnv "PATH" + _ <- unsetEnv "GHC_PACKAGE_PATH" + _ <- setEnv "PATH" path + setEnv "GHC_PACKAGE_PATH" pkgDb + + +getConfig :: IO Config +getConfig = do + -- If stack isn't installed use cabal-install. + catch getStackConfig getCabalConfig + where + getStackConfig :: IO Config + getStackConfig = do + (_, stdout, _) <- readProcessWithExitCode "stack" ["path"] "" + parseConfig stdout + + + parseConfig :: String -> IO Config + parseConfig stdout = do + let outputList = lines stdout + tupleList = map (span (/=':') ) outputList + path = concatMap getPath tupleList + pkgDb = concatMap getPkgDb tupleList + return (path, pkgDb) + +getCabalConfig :: IOError -> IO Config +getCabalConfig _ = do + mPath <- lookupEnv "PATH" + mPkgDb <- lookupEnv "GHC_PACKAGE_PATH" + + ghcVersion <- catch getGhcVersion getGhcVersionError + + cwd <- getCurrentDirectory + homeDir <- getHomeDirectory + isSandBoxed <- doesDirectoryExist ".cabal-sandbox" + + let compilerVersion' = last $ words ghcVersion + forSandboxPath = arch ++ "-" ++ os ++ "-" ++ compilerName ++ "-" ++ compilerVersion' + forUserPath = arch ++ "-" ++ os ++ "-" ++ compilerVersion' + forGlobalPath = compilerName ++ "-" ++ compilerVersion' + + + sandboxPkgDb = if isSandBoxed + then cwd ++ (pathSeparator : ".cabal-sandbox") + ++ (pathSeparator : forSandboxPath) ++ "-packages.conf.d:" + else "" -- We're not using a sandbox. + + userPkgDb = homeDir ++ (pathSeparator: ".ghc") ++ (pathSeparator:forUserPath) + ++ (pathSeparator:"package.conf.d:") + globalPkgDb = "/usr/lib/" ++ forGlobalPath ++"/package.conf.d:" + + pkgDb' = sandboxPkgDb ++ userPkgDb ++ globalPkgDb + + path = case mPath of + Just p -> p + Nothing -> fail "The environment variable PATH isn't set." + pkgDb = case mPkgDb of + Just db -> db + Nothing -> pkgDb' + + return (path, pkgDb) + +getGhcVersion :: IO String +getGhcVersion = do + (_, stdout, _) <- readProcessWithExitCode "ghc" ["--version"] "" + return stdout + +-- Give proper fail information. +getGhcVersionError :: IOError -> IO String +getGhcVersionError _ = do + fail $ "Is GHC not in your PATH? " + ++ "Because wai-devel can't get the version number from: " + ++ "`ghc --version`" + +getPath :: (String, String) -> String +getPath (key,value) + | key == "bin-path" = dropWhile (==':') $ filter (/=' ') value + | otherwise = "" + +getPkgDb :: (String, String) -> String +getPkgDb (key,value) + | key == "ghc-package-path" = dropWhile (==':') $ filter (/=' ') value + | otherwise = "" diff --git a/src/Devel/Modules.hs b/src/Devel/Modules.hs new file mode 100644 --- /dev/null +++ b/src/Devel/Modules.hs @@ -0,0 +1,37 @@ +{-| +Module : Devel.Modules +Description : For handling modules and Filepath matters. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX + +Resolve filepaths from module names. +-} + +{-# LANGUAGE PackageImports #-} + +module Devel.Modules (getCompiledFiles) where + +import IdeSession +import System.FilePath (pathSeparator) +import Data.Text (unpack) +import Data.String.Utils +import System.Directory (getCurrentDirectory) + +-- | Paths without extensions. +-- Uncomment for absolute paths. +getCompiledFiles :: IdeSession -> IO [FilePath] +getCompiledFiles session = do + + moduleList <- getLoadedModules session + dir <- getCurrentDirectory + + let toFilePath :: ModuleName -> FilePath -- A.B.C = A/B/C + toFilePath moduleName' = replace "." [pathSeparator] $ unpack moduleName' + absPaths = map (((dir ++ "/") ++) . toFilePath) moduleList + + -- We use absolute paths because when we match them against dir contents we use absolute paths. + -- or the result of Devel.Paths.getRecursiveContents + return absPaths diff --git a/src/Devel/Paths.hs b/src/Devel/Paths.hs new file mode 100644 --- /dev/null +++ b/src/Devel/Paths.hs @@ -0,0 +1,107 @@ +{-| +Module : Devel.Paths +Description : For filepath related matters. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX + +Uses the GHC package to parse .hi files. +Will hopefully be moved upstream to ide-backend. +-} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE PackageImports #-} + +module Devel.Paths +( getFilesToWatch +, getThFiles +, getCabalFile +, getRecursiveContents +-- , getRecursiveContentsRelative +) where + +-- Qualified imports +import qualified Data.ByteString.Char8 as C8 + +import "Glob" System.FilePath.Glob (globDir, compile, Pattern, glob) +import System.FilePath.Posix (replaceExtension) +import System.Directory (doesFileExist, removeFile, getDirectoryContents, doesDirectoryExist) +import System.FilePath (()) +import Control.Monad.IO.Class (liftIO) +import Control.Monad (forM,filterM) +import Data.List ((\\)) + + +getThFiles :: [FilePath] -> IO [FilePath] +getThFiles targetList = do + let dumpFiles' = map (`replaceExtension` "dump-hi") targetList + dumpFiles <- filterM doesFileExist dumpFiles' + thFiles' <- mapM parseHi dumpFiles + let thFiles = map (takeWhile (/='\"') . dropWhile (=='\"') . dropWhile (/='\"')) $ concat thFiles' + + _ <- mapM removeFile dumpFiles + return thFiles + +getFilesToWatch :: [FilePath] -> IO [FilePath] +getFilesToWatch targetList = do + thFiles <- getThFiles targetList + return $ thFiles ++ targetList + + + +parseHi :: FilePath -> IO [FilePath] +parseHi path = do + dumpHI <- liftIO $ fmap C8.lines (C8.readFile path) + let thDeps' = + -- The dependent file path is surrounded by quotes but is not escaped. + -- It can be an absolute or relative path. + filter ("addDependentFile \"" `C8.isPrefixOf`) dumpHI + return $ map C8.unpack thDeps' + + + +getRecursiveContents :: FilePath -> IO [FilePath] +getRecursiveContents topdir = do + names <- getDirectoryContents topdir + + -- We want to take these files out. + let patterns :: [Pattern] + patterns = [ (compile "*.*~") + , (compile "*.hi") + , (compile "*.dump-hi") + , (compile "*.o") + , (compile "*.dyn_o") + , (compile "*.dyn_hi") + , (compile "*.so") + , (compile "*.conf") + , (compile "*.h") + , (compile "*.a") + , (compile "*.inplace") + , (compile "*.cache") + , (compile "*.*.el") + , (compile ".*") + ] + (x, _) <- globDir patterns topdir + + let properNames = filter (`notElem` [".", ".."]) names + paths <- forM properNames $ \name -> do + let path = makePathRelative topdir name + isDirectory <- doesDirectoryExist path + if isDirectory + then getRecursiveContents path + else return $ [path] \\ concat x + return (concat paths) + where makePathRelative :: FilePath -> FilePath + makePathRelative topDir + | topDir == "." = "" + | otherwise = topDir + + +getCabalFile :: IO FilePath +getCabalFile = do + list <- glob "*cabal" + case list of + [] -> fail "No cabal file." + (cabalFile:_) -> return cabalFile diff --git a/src/Devel/ReverseProxy.hs b/src/Devel/ReverseProxy.hs new file mode 100644 --- /dev/null +++ b/src/Devel/ReverseProxy.hs @@ -0,0 +1,92 @@ +{-| +Module : Devel.ReverseProxy +Description : Reverse proxies and starts warp on localhost:\. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX + +Reverse proxying and other socket realated activities. +-} +{-# LANGUAGE OverloadedStrings, ScopedTypeVariables, TemplateHaskell #-} +module Devel.ReverseProxy +( startReverseProxy +, createSocket +, createSocketSafe +, checkPort +, cyclePorts +) where + +import Network.HTTP.ReverseProxy (WaiProxyResponse(WPRProxyDest), ProxyDest(ProxyDest), waiProxyTo) +import Network.HTTP.Client (newManager, defaultManagerSettings) +import Network.HTTP.Types (status200) + +-- import Network.Wai.Handler.Warp (runSettingsSocket, defaultSettings, run) +import Network.Wai.Handler.Warp (run) +import Control.Exception + +import Network.Socket +import Data.Streaming.Network (bindPortTCP) + +import qualified Data.ByteString.Lazy as LB +import Data.FileEmbed (embedFile) +import Network.Wai (Application, responseLBS) + + + +startReverseProxy :: (Int, Int) -> IO () +startReverseProxy (fromProxyPort, toProxyPort) = do + mgr <- newManager defaultManagerSettings + + let onException' :: SomeException -> Application + onException' _ _ respond = do + let refreshHtml = LB.fromChunks $ return $(embedFile "refreshing.html") + respond $ responseLBS status200 + [ ("content-type", "text/html") + , ("Refresh", "1") + ] + refreshHtml + + let proxyApp = waiProxyTo + (\_ -> return $ WPRProxyDest $ ProxyDest "0.0.0.0" toProxyPort) + onException' + mgr + + -- runSettingsSocket defaultSettings sock proxyApp + run fromProxyPort proxyApp + + +createSocketSafe :: Int -> IO (Socket, Int) +createSocketSafe port' = do + port <- cyclePorts port' + sock <- createSocket port + return (sock, port) + +createSocket :: Int -> IO Socket +createSocket port = do + sock <- bindPortTCP port "*4" + + -- Tell the OS *not* to reserve the socket after your program exits. + setSocketOption sock ReuseAddr 1 + + return sock + + +-- Check whether a port is available to bind to. +checkPort :: Int -> IO Bool +checkPort port = do + es <- try $ bindPortTCP port "*4" + case es of + Left (_ :: IOException) -> return False + Right s -> do + sClose s + return True + +cyclePorts :: Int -> IO Int +cyclePorts p = do + let port = p + 1 + portAvailable <- checkPort port + case portAvailable of + True -> return port + _ -> cyclePorts port diff --git a/src/Devel/Types.hs b/src/Devel/Types.hs new file mode 100644 --- /dev/null +++ b/src/Devel/Types.hs @@ -0,0 +1,31 @@ +{-| +Module : Devel.Build +Description : Attempts to compile the WAI application. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX + +compile compiles the app to give: +Either a list of source errors or an ide-backend session. +-} + +module Devel.Types where + +type SourceError' = String + +type GhcExtension = String + +data FileChange = + Addition FilePath + | Modification FilePath + | Removal FilePath + | NoChange + deriving (Show, Eq) + +type PATH = String + +type PACKAGEDB = String + +type Config = (PATH, PACKAGEDB) diff --git a/src/Devel/Watch.hs b/src/Devel/Watch.hs new file mode 100644 --- /dev/null +++ b/src/Devel/Watch.hs @@ -0,0 +1,79 @@ +{-| +Module : Devel.Watch +Description : Watch for changes in the current working direcory. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX + +Actually checks only for modified files. +Added or removed files don't trigger new builds. +-} +{-# LANGUAGE OverloadedStrings, CPP #-} +module Devel.Watch where + +-- import IdeSession + +import Control.Monad.STM +import Control.Concurrent.STM.TVar + +import System.FSNotify +import Control.Monad (forever) +import Control.Concurrent (threadDelay) + +-- import Devel.Types +-- import Devel.Paths (getFilesToWatch) + +# if __GLASGOW_HASKELL__ < 710 +import Data.Text (unpack) +import Filesystem.Path.CurrentOS (toText) +-- import qualified Filesystem.Path as FSP +#endif + +import System.Directory (getCurrentDirectory) +import System.FilePath (pathSeparator) + +import Devel.Paths + +watch :: TVar Bool -> [FilePath] -> IO () +watch isDirty includeTargets = do + -- Get files to watch. + files <- getFilesToWatch includeTargets + -- Making paths to watch a list of absolute paths. + dir <- getCurrentDirectory + let pathsToWatch = map (\fp -> dir ++ (pathSeparator: fp)) files + + -- Actual file watching. + manager <- startManagerConf defaultConfig + _ <- watchTree manager "." (const True) + -- Last argument to watchTree. +# if __GLASGOW_HASKELL__ >= 710 + (\event -> do + let getPath :: Event -> FilePath + getPath (Added fp _) = fp + getPath (Modified fp _) = fp + getPath (Removed fp _) = fp + + isModified = getPath event `elem` pathsToWatch + + atomically $ writeTVar isDirty isModified) + +#else + (\event -> do + pathMod' <- case toText $ eventPath event of + Right text -> return $ unpack text -- Gives an abs path + Left text -> fail $ unpack text + + let isModified = pathMod' `elem` pathsToWatch + + atomically $ writeTVar isDirty isModified) +#endif + + _ <- forever $ threadDelay maxBound + stopManager manager + +checkForChange :: TVar Bool -> IO () +checkForChange isDirty = + atomically $ do readTVar isDirty >>= check + writeTVar isDirty False diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,29 @@ +{-| +Module : Main +Description : The main module of the executable. +Copyright : (c) +License : GPL-3 +Maintainer : njagi@urbanslug.com +Stability : experimental +Portability : POSIX +-} +module Main where + +import Devel +import Devel.CmdArgs +import Options.Applicative + +main :: IO () +main = do + cmdArgs' <- execParser opts + + let isReverseProxy' = isReverseProxy cmdArgs' + buildFile' = buildFile cmdArgs' + runFunction' = runFunction cmdArgs' + + buildAndRun buildFile' runFunction' isReverseProxy' + where opts :: ParserInfo CmdArgs + opts = info (helper <*> cmdArgs) + (fullDesc + <> progDesc "For WAI complaint haskell web applications" + <> header "wai-devel: development server for haskell web applications." ) diff --git a/tests/Spec.hs b/tests/Spec.hs new file mode 100644 --- /dev/null +++ b/tests/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-} diff --git a/wai-devel.cabal b/wai-devel.cabal new file mode 100644 --- /dev/null +++ b/wai-devel.cabal @@ -0,0 +1,124 @@ +name: wai-devel +version: 0.0.0.1 +synopsis: A web server for the development of WAI compliant web applications. +description: A development server for WAI applications. +homepage: https://github.com/urbanslug/wai-devel +license: GPL-3 +license-file: LICENSE +author: Njagi Mwaniki +maintainer: njagi@urbanslug.com +-- copyright: +category: Web +build-type: Simple +-- extra-source-files: +cabal-version: >=1.10 + +library + ghc-options: -Wall + exposed-modules: Devel + , Main + , Devel.Watch + , Devel.CmdArgs + , Devel.ReverseProxy + , Devel.Config + , Devel.Compile + , Devel.Types + , Devel.Build + other-modules: Devel.Paths + , Devel.Modules + + -- other-extensions: + build-depends: base >= 4.7 && <5.0 + , Cabal-ide-backend >= 1.23 && < 1.24 + , Glob >= 0.7 && < 0.8 + , MissingH >= 1.3 && < 1.4 + , array >= 0.5 && < 0.6 + , blaze-html >= 0.8 && < 0.9 + , bytestring >= 0.10 && < 0.11 + , directory >= 1.2 && < 1.3 + , filepath >= 1.3 && < 1.5 + , fsnotify >= 0.1 && < 0.3 + , ghc >= 7.8 && < 7.12 + , http-client >= 0.4 && < 0.5 + , http-conduit >= 2.1 && < 2.2 + , http-reverse-proxy >= 0.4 && < 0.5 + , http-types >= 0.8 && < 0.9 + , ide-backend >= 0.10 && < 0.11 + , network >= 2.6 && < 2.7 + , optparse-applicative >= 0.11 && < 0.12 + , process >= 1.2 && < 1.3 + , shakespeare >= 2.0 && < 2.1 + , stm >= 2.4 && < 2.5 + , streaming-commons >= 0.1 && < 0.2 + , system-filepath >= 0.4 && < 0.5 + , text >= 1.2 && < 1.3 + , time >= 1.4 && < 1.6 + , transformers >= 0.3 && < 0.5 + , wai >= 3.0 && < 3.1 + , warp >= 3.0 && < 3.2 + , file-embed >= 0.0 && < 0.1 + , websockets >= 0.9 && < 1.1 + + hs-source-dirs: src + default-language: Haskell2010 + +executable wai-devel + ghc-options: -Wall + main-is: Main.hs + other-modules: Devel + Devel.CmdArgs + Devel.Build + Devel.Compile + Devel.Config + Devel.Modules + Devel.Paths + Devel.ReverseProxy + Devel.Types + Devel.Watch + -- other-extensions: + build-depends: base + , Cabal-ide-backend + , Glob + , MissingH + , blaze-html + , bytestring + , directory + , filepath + , fsnotify + , ghc + , http-client + , http-conduit + , http-reverse-proxy + , http-types + , ide-backend + , network + , optparse-applicative + , process + , shakespeare + , stm + , streaming-commons + , system-filepath + , text + , time + , transformers + , wai + , wai-devel + , warp + , file-embed + , websockets + + hs-source-dirs: src + default-language: Haskell2010 + +test-suite tests + ghc-options: -Wall + type: exitcode-stdio-1.0 + main-is: Spec.hs + -- exposed-modules: + -- other-modules: Tests.Watch + hs-source-dirs: tests + build-depends: base + , hspec >= 2.1 && < 3.0 + , stm + , wai-devel + default-language: Haskell2010