diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 --- /dev/null +++ b/COPYRIGHT @@ -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/Distribution/Gentoo/GHC.hs b/Distribution/Gentoo/GHC.hs new file mode 100644 --- /dev/null +++ b/Distribution/Gentoo/GHC.hs @@ -0,0 +1,241 @@ +{- | + Module : Distribution.Gentoo.GHC + Description : Find GHC-related breakages on Gentoo. + Copyright : (c) Ivan Lazar Miljenovic 2009 + License : GPL-2 or later + Maintainer : Ivan.Miljenovic@gmail.com + + This module defines helper functions to find broken packages in + GHC, or else find packages installed with older versions of GHC. + -} +module Distribution.Gentoo.GHC + ( ghcVersion + , ghcLoc + , ghcLibDir + , libFronts + , oldGhcPkgs + , brokenPkgs + ) where + +import Distribution.Gentoo.Util +import Distribution.Gentoo.Packages + +-- Cabal imports +import Distribution.Simple.PackageIndex( PackageIndex + , brokenPackages + , reverseDependencyClosure) +import Distribution.Simple.GHC(getInstalledPackages, configure) +import Distribution.Simple.Program( ProgramConfiguration + , defaultProgramConfiguration) +import Distribution.Simple.Compiler(PackageDB(GlobalPackageDB)) +import Distribution.Simple.Utils(rawSystemStdout) +import Distribution.Verbosity(silent) +import Distribution.Package(PackageIdentifier, packageId) +import Distribution.InstalledPackageInfo( InstalledPackageInfo_ + , installedPackageId) +import Distribution.Text(display) + +-- Other imports +import Data.Char(isDigit) +import Data.Either(Either(..), partitionEithers) +import Data.Maybe(Maybe(..), maybe, fromJust) +import qualified Data.Map as Map +import Data.Map(Map) +import qualified Data.ByteString.Char8 as BS +import System.FilePath((), takeExtension, pathSeparator) +import System.Directory( canonicalizePath + , doesDirectoryExist + , findExecutable) +import Control.Monad(foldM, liftM, unless) + +-- ----------------------------------------------------------------------------- + +-- Common helper utils, etc. + +-- Get only the first line of output +rawSysStdOutLine :: FilePath -> [String] -> IO String +rawSysStdOutLine app = liftM (head . lines) . rawSystemStdout silent app + +-- Get the first line of output from calling GHC with the given +-- arguments. +ghcRawOut :: [String] -> IO String +ghcRawOut args = ghcLoc >>= flip rawSysStdOutLine args + +-- Cheat with using fromJust since we know that GHC must be in $PATH +-- somewhere, probably /usr/bin. +ghcLoc :: IO FilePath +ghcLoc = liftM fromJust $ findExecutable "ghc" + +-- The version of GHC installed. +ghcVersion :: IO String +ghcVersion = liftM (dropWhile (not . isDigit)) $ ghcRawOut ["--version"] + +-- The directory where GHC has all its libraries, etc. +ghcLibDir :: IO FilePath +ghcLibDir = canonicalizePath =<< ghcRawOut ["--print-libdir"] + +-- Return the Gentoo .conf files found in this GHC libdir +confFiles :: FilePath -> IO [FilePath] +confFiles dir = do let gDir = dir "gentoo" + exists <- doesDirectoryExist gDir + if exists + then do conts <- getDirectoryContents' gDir + return $ map (gDir ) + $ filter isConf conts + else return [] + where + isConf file = takeExtension file == ".conf" + +-- Print a list of packages, with a description of what they are. +pkgListPrint :: String -> [Package] -> IO () +pkgListPrint desc pkgs + = if null pkgs + then putStrLn $ unwords ["No", desc, "packages found!\n"] + else do putStrLn $ unwords ["Found the following" + , desc, "packages:"] + printList printPkg pkgs + putStrLn "" + +-- Print a bullet list of values with one value per line. +printList :: (a -> String) -> [a] -> IO () +printList f = mapM_ (putStrLn . (++) " * " . f) + +tryMaybe :: (a -> Maybe b) -> a -> Either a b +tryMaybe f a = maybe (Left a) Right $ f a + +-- ----------------------------------------------------------------------------- + +-- Finding packages installed with other versions of GHC +oldGhcPkgs :: IO [Package] +oldGhcPkgs = do putStrLn "Searching for packages installed with a \ + \different version of GHC." + thisGhc <- ghcLibDir + let thisGhc' = BS.pack thisGhc + -- It would be nice to do this, but we can't assume + -- some crazy user hasn't deleted one of these dirs + -- libFronts' <- filterM doesDirectoryExist libFronts + pkgs <- liftM notGHC + $ concatMapM (checkLibDir thisGhc') libFronts + pkgListPrint "old" pkgs + return pkgs + +-- Find packages installed by other versions of GHC in this possible +-- library directory. +checkLibDir :: BSFilePath -> BSFilePath -> IO [Package] +checkLibDir thisGhc libDir = pkgsHaveContent (hasDirMatching wanted) + where + wanted dir = isValid dir && (not . isInvalid) dir + + isValid = isGhcLibDir libDir + + -- Invalid if it's this GHC + isInvalid = BS.isPrefixOf thisGhc + +-- A valid GHC library directory starting at libdir has a name of +-- either "ghc" or "ghc-bin", then a hyphen and then a version number. +isGhcLibDir :: BSFilePath -> BSFilePath -> Bool +isGhcLibDir libdir dir = go ghcDirName || go ghcBinDirName + where + -- This is hacky because FilePath doesn't work on Bytestrings... + libdir' = BS.snoc libdir pathSeparator + ghcDirName = BS.pack "ghc" + ghcBinDirName = BS.pack "ghc-bin" + + go dn = BS.isPrefixOf ghcDir dir + -- Any possible version starts with a digit + && isDigit (BS.index dir ghcDirLen) + where + ghcDir = flip BS.snoc '-' $ BS.append libdir' dn + ghcDirLen = BS.length ghcDir + + +-- The possible places GHC could have installed lib directories +libFronts :: [BSFilePath] +libFronts = map BS.pack + $ do loc <- ["usr", "opt" "ghc"] + lib <- ["lib", "lib64"] + return $ "/" loc lib + +-- ----------------------------------------------------------------------------- + +-- Finding broken packages in this install of GHC. +brokenPkgs :: IO [Package] +brokenPkgs = do putStrLn "Searching for Haskell libraries with broken dependencies." + (pns, cnfs) <- brokenConfs + unless (null pns) + $ unknownPackages pns + (nI, pkgs) <- liftM partitionEithers $ mapM hasFile' cnfs + unless (null nI) + $ unknownFiles nI + let pkgs' = notGHC pkgs + pkgListPrint "broken" pkgs' + return pkgs + where + hasFile' f = do mp <- hasFile f + return $ maybe (Left f) Right mp + + unknownPackages ps + = do putStrLn "\nThe following packages don't seem \ + \to have been installed by your package manager:" + printList display ps + + unknownFiles fs + = do putStrLn "\nThe following files are those corresponding \ + \to packages installed by your package manager\n\ + \which can't be matched up to the packages that own them." + printList id fs + +-- .conf files from broken packages of this GHC version +brokenConfs :: IO ([PackageIdentifier], [FilePath]) +brokenConfs = do brkn <- getBroken + -- Check if we actually have to go look up files and + -- do IO. + if null brkn + then return ([], []) + else do cnfs <- readConf + return $ partitionEithers + $ map (matchConf cnfs) brkn + +type ConfMap = Map PackageIdentifier FilePath + +-- Attempt to match the provided broken package to one of the +-- installed packages. +matchConf :: ConfMap -> PackageIdentifier -> Either PackageIdentifier FilePath +matchConf = tryMaybe . flip Map.lookup + +-- Read in all Gentoo .conf files from the current GHC version and +-- create a Map +readConf :: IO ConfMap +readConf = ghcLibDir >>= confFiles >>= foldM addConf Map.empty + +-- Add this .conf file to the Map +addConf :: ConfMap -> FilePath -> IO ConfMap +addConf cmp conf = do cnts <- readFile conf + case (reads cnts) of + [] -> return cmp + -- ebuilds that have CABAL_CORE_LIB_GHC_PV set + -- for this version of GHC will have a .conf + -- file containing just [] + [([],_)] -> return cmp + rd -> do let nm = cfNm rd + return $ Map.insert nm conf cmp + + where + -- It's not InstalledPackageInfo, as it can't read the modules + cfNm :: [([InstalledPackageInfo_ String], String)] -> PackageIdentifier + cfNm = packageId . head . fst . head + +-- Obtain GHC info about installed libs, etc. +configureGHC :: IO ProgramConfiguration +configureGHC = liftM snd + $ configure silent Nothing Nothing defaultProgramConfiguration + +-- Return all packages registered with GHC +pkgIndex :: IO PackageIndex +pkgIndex = configureGHC >>= getInstalledPackages silent [GlobalPackageDB] + +-- Return the closure of all packages affected by breakage +getBroken :: IO [PackageIdentifier] +getBroken = do ind <- pkgIndex + let broken = map (installedPackageId . fst) $ brokenPackages ind + return $ map packageId $ reverseDependencyClosure ind broken diff --git a/Distribution/Gentoo/Packages.hs b/Distribution/Gentoo/Packages.hs new file mode 100644 --- /dev/null +++ b/Distribution/Gentoo/Packages.hs @@ -0,0 +1,231 @@ +{- | + Module : Distribution.Gentoo.Packages + Description : Dealing with installed packages on Gentoo. + Copyright : (c) Ivan Lazar Miljenovic, Lennart Kolmodin 2009 + License : GPL-2 or later + Maintainer : Ivan.Miljenovic@gmail.com + + This module defines helper functions that deal with installed + packages in Gentoo. +-} +module Distribution.Gentoo.Packages + ( Package + , Content + , notGHC + , printPkg + , hasFile + , pkgsHaveContent + , hasContentMatching + , hasDirMatching + , hasObjMatching + ) where + +import Distribution.Gentoo.Util + +import Data.Char(isDigit, isAlphaNum) +import Data.List(delete) +import Data.Maybe(mapMaybe, listToMaybe) +import qualified Data.ByteString.Char8 as BS +import Data.ByteString.Char8(ByteString) +import System.Directory( doesDirectoryExist + , doesFileExist) +import System.FilePath(()) +import Control.Monad(filterM, liftM) + +-- ----------------------------------------------------------------------------- + +-- Representation of a cat/pkgname in Gentoo. Note that this is +-- overly simplified. + +type Category = String +type Pkg = String -- Package name. +type VerPkg = String -- Package name with version. +type VCatPkg = (Category, VerPkg) +type Slot = String + +-- When we are (re-)building packages, we don't care about the +-- version, just the slot. +data Package = Package Category Pkg (Maybe Slot) + deriving(Eq, Ord, Show, Read) + +-- Package equality, ignoring the Slot (i.e. same category and package +-- name). +samePackageAs :: Package -> Package -> Bool +samePackageAs (Package c1 p1 _) (Package c2 p2 _) + = c1 == c2 && p1 == p2 + +ghcPkg :: Package +ghcPkg = Package "dev-lang" "ghc" Nothing + +ghcBinPkg :: Package +ghcBinPkg = Package "dev-lang" "ghc-bin" Nothing + +-- Return all packages that are not a version of GHC. +notGHC :: [Package] -> [Package] +notGHC = filter (\p -> isNot ghcPkg p && isNot ghcBinPkg p) + where + isNot p1 = not . samePackageAs p1 + +-- Pretty-print the Package name based on how PMs expect it +printPkg :: Package -> String +printPkg (Package c p s) = addS cp + where + addS = maybe id (flip (++) . (:) ':') s + cp = c ++ '/' : p + +-- Determine which slot the specific version of the package is in and +-- create the appropriate Package value. +toPackage :: VCatPkg -> IO Package +toPackage cp@(c,vp) = do sl <- getSlot cp + let p = stripVersion vp + return $ Package c p sl + +-- Determine which slot the specific version of the package is in. +getSlot :: VCatPkg -> IO (Maybe Slot) +getSlot cp = do ex <- doesFileExist sFile + if ex + then parse + else return Nothing + where + sFile = pkgPath cp "SLOT" + parse = do fl <- readFile sFile + -- Don't want the trailing newline + return $ listToMaybe $ lines fl + +-- | Remove the version information from the package name. +stripVersion :: VerPkg -> Pkg +stripVersion = concat . takeUntilVer . breakAll partSep + where + partSep x = x `elem` ['-', '_'] + + -- Only the last bit that matches isVer is the real version bit. + -- Note that this doesn't check that the last non-version bit is + -- not a hyphen followed by digits. + takeUntilVer = concat . init . breakAll isVer + + isVer as = isVerFront (init as) && isAlphaNum (last as) + isVerFront ('-':as) = all (\a -> isDigit a || a == '.') as + isVerFront _ = False + +pkgPath :: VCatPkg -> FilePath +pkgPath (c,vp) = pkgDBDir c vp + +pkgDBDir :: FilePath +pkgDBDir = "/var/db/pkg" + +-- ----------------------------------------------------------------------------- + +-- Parsing the CONTENTS file of installed packages. + +-- Representation of individual lines in a CONTENTS file. +data Content = Dir BSFilePath + | Obj BSFilePath + deriving (Eq, Show) + +isDir :: Content -> Bool +isDir (Dir _) = True +isDir _ = False + +isObj :: Content -> Bool +isObj (Obj _) = True +isObj _ = False + +pathOf :: Content -> BSFilePath +pathOf (Dir dir) = dir +pathOf (Obj obj) = obj + +-- Searching predicates. + +hasContentMatching :: (BSFilePath -> Bool) -> [Content] -> Bool +hasContentMatching p = any p . map pathOf + +hasDirMatching :: (BSFilePath -> Bool) -> [Content] -> Bool +hasDirMatching p = hasContentMatching p . filter isDir + +hasObjMatching :: (BSFilePath -> Bool) -> [Content] -> Bool +hasObjMatching p = hasContentMatching p . filter isObj + +-- Parse the CONTENTS file. +parseContents :: VCatPkg -> IO [Content] +parseContents cp = do ex <- doesFileExist cFile + if ex + then parse + else return [] + where + cFile = pkgPath cp "CONTENTS" + + parse = do lns <- liftM BS.lines $ BS.readFile cFile + return $ mapMaybe (parseCLine .BS.words) lns + + -- Use unwords of list rather than taking next element because of + -- how spaces are represented in file names. + -- This might cause a problem if there is more than a single + -- space (or a tab) in the filename... + parseCLine :: [ByteString] -> Maybe Content + parseCLine (tp:ln) + | tp == dir = Just . Dir . BS.unwords $ ln + | tp == obj = Just . Obj . BS.unwords $ dropLastTwo ln + | otherwise = Nothing + parseCLine [] = Nothing + + dropLastTwo :: [a] -> [a] + dropLastTwo = init . init + + obj = BS.pack "obj" + dir = BS.pack "dir" + +-- ----------------------------------------------------------------------------- + +-- Find the package (if any) that contain this file. +-- Assumes collision protection (i.e. at most one package per file). +hasFile :: FilePath -> IO (Maybe Package) +hasFile fp = liftM listToMaybe $ pkgsHaveContent p + where + fp' = BS.pack fp + p = hasObjMatching ((==) fp') + +-- Find which packages have Content information that matches the +-- provided predicate; to be used with the searching predicates +-- above. +pkgsHaveContent :: ([Content] -> Bool) -> IO [Package] +pkgsHaveContent p = do cs <- installedCats' + cps <- concatMapM (catHasContent p) cs + mapM toPackage cps + +-- Determine if this is a valid Category (such that at least one +-- package in that category has been installed). +isCat :: String -> IO Bool +isCat fp = do isD <- doesDirectoryExist (pkgDBDir fp) + return $ isD && isCat' fp + where + isCat' ('.':_) = False + isCat' "world" = False + isCat' _ = True + +-- Return all Categories known in this system. +installedCats :: IO [Category] +installedCats = filterM isCat =<< getDirectoryContents' pkgDBDir + +-- We are most likely to need to look in dev-haskell, so put that +-- first in our list. +installedCats' :: IO [Category] +installedCats' = do cats <- installedCats + return $ if haskCat `elem` cats + then haskCat : delete haskCat cats + else cats + where + haskCat = "dev-haskell" + +-- Return all packages in this category whose contents match the +-- provided predicate. +catHasContent :: ([Content] -> Bool) -> Category -> IO [VCatPkg] +catHasContent p c = do inDir <- getDirectoryContents' cfp + let psbl = map ((,) c) inDir + pkgs <- filterM (doesDirectoryExist . pkgPath) psbl + filterM (hasContent p) pkgs + where + cfp = pkgDBDir c + +-- Determine if this package matches the predicate. +hasContent :: ([Content] -> Bool) -> VCatPkg -> IO Bool +hasContent p = liftM p . parseContents diff --git a/Distribution/Gentoo/PkgManager.hs b/Distribution/Gentoo/PkgManager.hs new file mode 100644 --- /dev/null +++ b/Distribution/Gentoo/PkgManager.hs @@ -0,0 +1,110 @@ +{- | + Module : Distribution.Gentoo.PkgManager + Description : Using package managers in Gentoo. + Copyright : (c) Ivan Lazar Miljenovic 2009 + License : GPL-2 or later + Maintainer : Ivan.Miljenovic@gmail.com + + This module defines ways to use different Gentoo package managers. + -} +module Distribution.Gentoo.PkgManager + ( PkgManager + , definedPMs + , choosePM + , defaultPM + , defaultPMName + , dummy + , PMFlag(..) + , buildCmd + ) where + +import Distribution.Gentoo.Packages + +import Data.Char(toLower) +import Data.Maybe(mapMaybe) +import qualified Data.Map as M +import Data.Map(Map) + +-- ----------------------------------------------------------------------------- + +-- | Defines the available Gentoo package managers. +data PkgManager = Portage + | PkgCore + | Paludis + | CustomPM String + deriving (Eq, Ord, Show, Read) + +-- | A dummy package manager used for testing purposes. +dummy :: PkgManager +dummy = CustomPM "echo" + +-- | The default package manager. +defaultPM :: PkgManager +defaultPM = pmNameMap M.! defaultPMName + +defaultPMName :: String +defaultPMName = "portage" + +-- | The names of known package managers. +definedPMs :: [String] +definedPMs = M.keys pmNameMap + +pmNameMap :: Map String PkgManager +pmNameMap = M.fromList [ ("portage", Portage) + , ("pkgcore", PkgCore) + , ("paludis", Paludis) + ] + +-- | Choose the appropriate PM from the textual representation; throws +-- an error if that PM isn't known. +choosePM :: String -> Either String PkgManager +choosePM pm = maybe (Left pm) Right $ pm' `M.lookup` pmNameMap + where + pm' = map toLower pm + +pmCommand :: PkgManager -> String +pmCommand Portage = "emerge" +pmCommand PkgCore = "pmerge" +pmCommand Paludis = "paludis" +pmCommand (CustomPM cmd) = cmd + +defaultPMFlags :: PkgManager -> [String] +defaultPMFlags Portage = ["--oneshot", "--keep-going"] +defaultPMFlags PkgCore = ["--deep", "--oneshot", "--ignore-failures"] +defaultPMFlags Paludis = [ "--install", "--preserve-world" + , "--continue-on-failure if-independent"] +defaultPMFlags CustomPM{} = [] + +buildCmd :: PkgManager -> [PMFlag] -> [Package] -> String +buildCmd pm fs ps = unwords $ pmCommand pm : fs' ++ ps' + where + fs' = mapMaybe (flagRep pm) fs ++ defaultPMFlags pm + ps' = map printPkg ps + +-- ----------------------------------------------------------------------------- + +-- | Different optional flags to be passed to the PM. +data PMFlag = PretendBuild + | UpdateDeep + | UpdateAsNeeded + deriving (Eq, Ord, Show, Read) + +flagRep :: PkgManager -> PMFlag -> Maybe String +flagRep Portage = portagePMFlag +flagRep PkgCore = pkgcorePMFlag +flagRep Paludis = paludisPMFlag +flagRep CustomPM{} = const Nothing -- Can't tell how flags would work. + +portagePMFlag :: PMFlag -> Maybe String +portagePMFlag PretendBuild = Just "--pretend" +portagePMFlag UpdateDeep = Just "--deep" +portagePMFlag UpdateAsNeeded = Nothing + +pkgcorePMFlag :: PMFlag -> Maybe String +pkgcorePMFlag = portagePMFlag -- The options are the same for the 3 + -- current flags. + +paludisPMFlag :: PMFlag -> Maybe String +paludisPMFlag PretendBuild = Just "--pretend" +paludisPMFlag UpdateDeep = Just "--dl-upgrade always" +paludisPMFlag UpdateAsNeeded = Just "--dl-upgrade as-needed" diff --git a/Distribution/Gentoo/Util.hs b/Distribution/Gentoo/Util.hs new file mode 100644 --- /dev/null +++ b/Distribution/Gentoo/Util.hs @@ -0,0 +1,29 @@ +{- | + Module : Distribution.Gentoo.Util + Description : Utility functions + Copyright : (c) Ivan Lazar Miljenovic 2009 + License : GPL-2 or later + Maintainer : Ivan.Miljenovic@gmail.com + + Common utility functions. + -} +module Distribution.Gentoo.Util where + +import Data.List(groupBy) +import Data.ByteString.Char8(ByteString) +import System.Directory(getDirectoryContents) +import Control.Monad(liftM) + +-- Alias used to indicate that this ByteString represents a FilePath +type BSFilePath = ByteString + +concatMapM :: (a -> IO [b]) -> [a] -> IO [b] +concatMapM f = liftM concat . mapM f + +breakAll :: (a -> Bool) -> [a] -> [[a]] +breakAll p = groupBy (const (not . p)) + +-- Don't return . or .. +getDirectoryContents' :: FilePath -> IO [FilePath] +getDirectoryContents' dir = do is <- getDirectoryContents dir + return $ filter (`notElem` [".", ".."]) is diff --git a/Main.hs b/Main.hs new file mode 100644 --- /dev/null +++ b/Main.hs @@ -0,0 +1,256 @@ +{- | + Module : Main + Description : The haskell-updater executable + Copyright : (c) Ivan Lazar Miljenovic, Stephan Friedrichs 2009 + License : GPL-2 or later + Maintainer : Ivan.Miljenovic@gmail.com + + The executable module of haskell-updater, which finds Haskell + packages to rebuild after a dep upgrade or a GHC upgrade. +-} +module Main where + +import Distribution.Gentoo.GHC +import Distribution.Gentoo.Packages +import Distribution.Gentoo.PkgManager + +import Data.Either(partitionEithers) +import Data.List(foldl1') +import Data.Version(showVersion) +import qualified Data.Set as Set +import Data.Set(Set) +import qualified Paths_haskell_updater as Paths(version) +import System.Console.GetOpt +import System.Environment(getArgs, getProgName) +import System.Exit(ExitCode(..), exitWith) +import System.IO(hPutStrLn, stderr) +import Control.Monad(liftM, liftM2, unless) +import System.Process(system) + +-- ----------------------------------------------------------------------------- +-- The overall program. + +main :: IO () +main = uncurry runAction =<< parseArgs + +-- ----------------------------------------------------------------------------- +-- The possible actions that haskell-updater can perform. + +data Action = Help + | Version + | Build { targets :: Set BuildTarget } + -- If anything is added here after Build, MAKE SURE YOU + -- UPDATE combineActions or it won't always work! + deriving (Eq, Ord, Show, Read) + +defaultAction :: Action +defaultAction = Build $ Set.fromList [GhcUpgrade, DepCheck] + +-- Combine all the actions together. If the list is empty, use the +-- defaultAction. +combineAllActions :: [Action] -> Action +combineAllActions = emptyElse defaultAction (foldl1' combineActions) + +-- Combine two actions together. If they're both Build blah, merge +-- them; otherwise, pick the lower of the two (i.e. more important). +-- Note that it's safe (at the moment at least) to assume that when +-- the lower of one is a Build that they're both build. +combineActions :: Action -> Action -> Action +combineActions a1 a2 = case (a1 `min` a2) of + Build{} -> Build $ targets a1 `Set.union` targets a2 + a -> a + +runAction :: RunModifier -> Action -> IO a +runAction _ Help = help +runAction _ Version = version +runAction rm (Build ts) = do systemInfo + ps <- allGetPackages ts + buildPkgs rm ps + +-- ----------------------------------------------------------------------------- +-- The possible things to build. + +data BuildTarget = GhcUpgrade + | DepCheck + deriving (Eq, Ord, Show, Read) + +getPackages :: BuildTarget -> IO [Package] +getPackages GhcUpgrade = oldGhcPkgs +getPackages DepCheck = brokenPkgs + +getPackages' :: BuildTarget -> IO (Set Package) +getPackages' = liftM Set.fromList . getPackages + +allGetPackages :: Set BuildTarget -> IO [Package] +allGetPackages = liftM (Set.toList . Set.unions) + . mapM getPackages' + . Set.toList + +-- ----------------------------------------------------------------------------- +-- How to build packages. + +data RunModifier = RM { pkgmgr :: PkgManager + , flags :: [PMFlag] + , withCmd :: WithCmd + } + deriving (Eq, Ord, Show, Read) + +-- At the moment, PrintAndRun is the only option available. +data WithCmd = RunOnly + | PrintOnly + | PrintAndRun + deriving (Eq, Ord, Show, Read) + +runCmd :: WithCmd -> String -> IO a +runCmd RunOnly = runCommand +runCmd PrintOnly = success +runCmd PrintAndRun = liftM2 (>>) putStrLn runCommand + +runCommand :: String -> IO a +runCommand cmd = system cmd >>= exitWith + +buildPkgs :: RunModifier -> [Package] -> IO a +buildPkgs _ [] = success "\nNothing to build!" +buildPkgs rm ps = runCmd (withCmd rm) cmd + where + cmd = buildCmd (pkgmgr rm) (flags rm) ps + +-- ----------------------------------------------------------------------------- +-- Command-line flags + +data Flag = HelpFlag + | VersionFlag + | PM String + | Check + | Upgrade + | Pretend + | NoDeep + deriving (Eq, Ord, Show, Read) + +parseArgs :: IO (RunModifier, Action) +parseArgs = do args <- getArgs + argParser $ getOpt Permute options args + +argParser :: ([Flag], [String], [String]) + -> IO (RunModifier, Action) +argParser (fls, oth, []) = do unless (null oth) + $ putErrLn + $ unwords $ "Unknown options:" : oth + unless (null bPms) + $ putErrLn + $ unwords $ "Unknown package managers:" : bPms + return (rm, a) + where + (fls', as) = partitionBy flagToAction fls + a = combineAllActions as + (opts, pms) = partitionBy flagToPM fls' + (bPms, pms') = partitionBy choosePM pms + pm = emptyElse defaultPM last pms' + opts' = Set.fromList opts + hasFlag = flip Set.member opts' + pmFlags = bool id (PretendBuild:) (hasFlag Pretend) + . return $ bool UpdateDeep UpdateAsNeeded (hasFlag NoDeep) + rm = RM { pkgmgr = pm + , flags = pmFlags + -- We need to get Flags that represent this as well. + , withCmd = PrintAndRun + } + +argParser (_, _, errs) = die $ unwords $ "Errors in arguments:" : errs + +flagToAction :: Flag -> Either Flag Action +flagToAction HelpFlag = Right Help +flagToAction VersionFlag = Right Version +flagToAction Check = Right . Build $ Set.singleton DepCheck +flagToAction Upgrade = Right . Build $ Set.singleton GhcUpgrade +flagToAction f = Left f + +flagToPM :: Flag -> Either Flag String +flagToPM (PM pm) = Right pm +flagToPM f = Left f + +options :: [OptDescr Flag] +options = + [ Option ['c'] ["dep-check"] (NoArg Check) + "Check dependencies of Haskell packages." + , Option ['u'] ["upgrade"] (NoArg Upgrade) + "Rebuild Haskell packages after a GHC upgrade." + , Option ['P'] ["package-manager"] (ReqArg PM "PM") + $ "Use package manager PM, where PM can be one of:\n" + ++ pmList ++ defPM + , Option ['p'] ["pretend"] (NoArg Pretend) + "Only pretend to build packages." + , Option [] ["no-deep"] (NoArg NoDeep) + "Don't pull deep dependencies (--deep with emerge)." + , Option ['v'] ["version"] (NoArg VersionFlag) + "Version information." + , Option ['h', '?'] ["help"] (NoArg HelpFlag) + "Print this help message." + ] + where + pmList = unlines . map ((++) " * ") $ definedPMs + defPM = "The last valid value of PM specified is chosen.\n\ + \The default package manager is: " ++ defaultPMName + +-- ----------------------------------------------------------------------------- +-- Printing information. + +help :: IO a +help = progInfo >>= success + +version :: IO a +version = fmap (++ '-' : showVersion Paths.version) getProgName >>= success + +err :: String -> IO a +err msg = liftM addMsg progInfo >>= die + where + addMsg str = msg ++ "\n\n"++ str + +progInfo :: IO String +progInfo = do pName <- getProgName + return $ usageInfo (header pName) options + where + header pName = pName ++ " -- Find and rebuild packages broken due to either:\n\ + \ * GHC upgrade\n\ + \ * Haskell dependency upgrade\n\ + \ Default action is to do both.\n\ + \\n\ + \Usage: " ++ pName ++ " [Option]\n\ + \\n\ + \\n\ + \Options:" + +systemInfo :: IO () +systemInfo = do ver <- ghcVersion + pName <- getProgName + pLoc <- ghcLoc + libDir <- ghcLibDir + putStrLn $ "Running " ++ pName ++ " using GHC " ++ ver + putStrLn $ " * Executable: " ++ pLoc + putStrLn $ " * Library directory: " ++ libDir + putStrLn "" + +-- ----------------------------------------------------------------------------- +-- Utility functions + +success :: String -> IO a +success msg = do putStrLn msg + exitWith ExitSuccess + +die :: String -> IO a +die msg = do putErrLn msg + exitWith (ExitFailure 1) + +putErrLn :: String -> IO () +putErrLn = hPutStrLn stderr + +bool :: a -> a -> Bool -> a +bool f t b = if b then t else f + +partitionBy :: (a -> Either l r) -> [a] -> ([l], [r]) +partitionBy f = partitionEithers . map f + +-- If the list is empty, return the provided value; otherwise use the function. +emptyElse :: b -> ([a] -> b) -> [a] -> b +emptyElse e _ [] = e +emptyElse _ f as = f as diff --git a/Setup.lhs b/Setup.lhs new file mode 100644 --- /dev/null +++ b/Setup.lhs @@ -0,0 +1,3 @@ +#!/usr/bin/env runhaskell +> import Distribution.Simple +> main = defaultMain diff --git a/TODO b/TODO new file mode 100644 --- /dev/null +++ b/TODO @@ -0,0 +1,11 @@ +* Allow user-defined PMs (in case they have custom scripts, etc.) + +* Have the option to spit out the PM command to be used instead of using it. + +* Pretty colours in output? + +* Detect packages that are installed but not registered with GHC. + This is for cases where GHC was re-built but packages were not + properly re-registered. + +* Add an --info option to give us information on haskell-packages, etc. diff --git a/haskell-updater.cabal b/haskell-updater.cabal new file mode 100644 --- /dev/null +++ b/haskell-updater.cabal @@ -0,0 +1,45 @@ +Name: haskell-updater +Homepage: http://haskell.org/haskellwiki/Gentoo#haskell-updater +Version: 1.0.0.0 +Synopsis: Rebuild Haskell dependencies in Gentoo +Description: haskell-updater rebuilds Haskell packages on Gentoo + after a GHC upgrade or a dependency upgrade. + + haskell-updater is written so as to use only + GHC's boot libraries so as to have no external + dependencies. + + This version is for GHC-6.12 with Cabal-1.8. +Category: Distribution +License: GPL +License-file: COPYRIGHT +Copyright: (c) Ivan Lazar Miljenovic, + Lennart Kolmodin, + Stephan Friedrichs +Author: Ivan Lazar Miljenovic, + Lennart Kolmodin, + Stephan Friedrichs +Maintainer: Ivan.Miljenovic@gmail.com +Cabal-Version: >= 1.2 +Build-Type: Simple +Extra-Source-Files: TODO + +Executable haskell-updater { + + Main-Is: Main.hs + Other-Modules: Distribution.Gentoo.GHC, + Distribution.Gentoo.Util, + Distribution.Gentoo.Packages, + Distribution.Gentoo.PkgManager, + Paths_haskell_updater + Ghc-Options: -Wall + Ghc-Prof-Options: -auto-all + + Build-Depends: base >= 3 && < 5, + Cabal >= 1.8 && < 1.9, + containers < 0.4, + filepath < 1.2, + directory < 1.1, + bytestring < 1.0, + process < 1.1 +}