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,4 @@ +#! /usr/bin/env runhaskell + +import Distribution.Simple +main = defaultMain diff --git a/lat.cabal b/lat.cabal new file mode 100644 --- /dev/null +++ b/lat.cabal @@ -0,0 +1,54 @@ +name : lat +version : 0.5 +license : GPL-3 +author : Magnus Therning +maintainer : magnus@therning.org +bug-reports : mailto: magnus@therning.org +copyright : 2010 Magnus Therning +synopsis : Tool to track security alerts on LWN +description : + lat (Linux Alert Tracker) is a tool for tracking security alerts published + on Linux Weekly News (http://lwn.net/Security/). It does this by scraping + information from the site and recording it in a local database (sqlite3). + + Alerts are organised by distribution in the same way as on the LWN site. + They can also be filtered so that only alerts on packages of interest to + the user are shown. + + It is also possible to directly from the tool raise a bug in a bugtracker + based on an alert. (Only Jira is supported yet.) + + The envisioned user is someone who's interested in following the security + alerts of a specific distribution, e.g. someone who's basing a project on + a sub-set of packages from a distribution. +category : Utils +license-file : LICENSE +build-type : Simple +cabal-version : >= 1.6 +extra-source-files : misc/zshcompletion._lat + +source-repository head + type : darcs + location : http://patch-tag.com/r/magnus/lat + +executable lat + hs-source-dirs : src + main-is : lat.hs + other-modules : + AlertDB + Commands + Commands.ArgTypes + Commands.Distro + Commands.Vulns + Filter + LWN + RepEng + Report + Types + build-depends : + base >=4 && <5, haskell98, safe, HDBC, HDBC-sqlite3, mtl, time, + directory, filepath, old-locale, regex-compat, tagsoup, ConfigFile, + haxr, MissingH, wl-pprint, cmdargs, HTTP + ghc-options : + -Wall -fno-warn-missing-signatures -fno-warn-name-shadowing + -fno-warn-orphans diff --git a/misc/zshcompletion._lat b/misc/zshcompletion._lat new file mode 100644 --- /dev/null +++ b/misc/zshcompletion._lat @@ -0,0 +1,39 @@ +#compdef lat + +# Zsh completion script for lat. Stick it in $fpath with the name "_lat". + +emulate -LR zsh + +_lat() { + local curcontext="${curcontext}" + + if (( CURRENT > 2 )); then + local cmd=${words[2]} + curcontext="${curcontext%:*:*}:lat-${cmd}:" + + local args + args=() + ${words[1]} $cmd --help=simple|awk '/^O:/ { split( $0, a, ":"); print a[2], a[3], a[4]; }' \ + | while read short long desc; do + args=($args "${short}[${desc}]" "${long%\[*\]}[${desc}]" ) + done + + (( CURRENT-- )) + shift words + + _arguments -s : ${args} + + else + # no command given yet, list commands and be done with it + local -a cmdlist + + cmdlist=() + for cmd in $(${words[1]} --help=simple|awk '/^C:lat / { print $2 }'); do + cmdlist=( ${cmdlist} "$cmd" ) + done + + _describe -t lat-commands 'lat command' cmdlist + fi +} + +_lat "$@" diff --git a/src/AlertDB.hs b/src/AlertDB.hs new file mode 100644 --- /dev/null +++ b/src/AlertDB.hs @@ -0,0 +1,220 @@ +{-# OPTIONS_GHC -fno-warn-unused-do-bind #-} + +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module AlertDB + ( AlertDB + , runAlertDB + -- functions for distros + , addDistro + , getDistroById + , deleteDistro + , getAllDistro + -- functions for alerts + , addAlert + , getAlert + , setReportedAlert + --, deleteAlert + , getAllAlertId + , getAllAlert + , getReportedAlert + , getUnreportedAlert + ) where + +import Control.Monad.Reader +import Data.Maybe +import Database.HDBC +import Database.HDBC.Sqlite3 +import System +import System.Directory (createDirectory, doesDirectoryExist) +import System.FilePath (joinPath) + +import qualified Types as T + +type AlertDB a = ReaderT Connection IO a + +-- {{{1 general funcs +runAlertDB :: FilePath -> AlertDB a -> IO a +runAlertDB path func = do + doesDirectoryExist path >>= flip unless (createDirectory path) + conn <- connectSqlite3 $ joinPath [path, "lat.db"] + tbls <- getTables conn + unless ("distro" `elem` tbls) (createTableDistro conn >> commit conn) + unless ("alert" `elem` tbls) (createTableAlert conn >> commit conn) + unless ("alerturl" `elem` tbls) (createTableAlertUrl conn >> commit conn) + res <- runReaderT func conn + liftIO $ commit conn + disconnect conn + return res + +failOnException msg = handleSql + (\ exc -> putStrLn ("Error: " ++ seErrorMsg exc) >> putStrLn msg >> exitFailure) + +-- {{{1 create tables +createTableDistro conn = failOnException "Couldn't create table 'distro'" $ run conn + "CREATE TABLE distro ( id INTEGER PRIMARY KEY , name TEXT NOT NULL UNIQUE , url TEXT UNIQUE);" [] + +createTableAlert conn = failOnException "Couldn't create table 'alert'" $ run conn + "CREATE TABLE alert ( id INTEGER PRIMARY KEY , identity TEXT NOT NULL UNIQUE , package TEXT NOT NULL , date DATE NOT NULL , sent BOOLEAN NOT NULL , distro_id INTEGER NOT NULL);" [] + +createTableAlertUrl conn = failOnException "Couldn't create table 'alerturl'" $ run conn + "CREATE TABLE alerturl ( alertidentity TEXT, url TEXT NOT NULL );" [] + + +-- {{{1 distro +-- | Add a distribution to the database. +addDistro :: T.Distro -> AlertDB () +addDistro (T.Distro _ name Nothing) = do + conn <- ask + liftIO $ failOnException "Couldn't add distribution, are you sure it isn't added already?" $ run conn "INSERT INTO distro (name) VALUES (?)" [ toSql name ] + return () + +addDistro (T.Distro _ name url) = do + conn <- ask + liftIO $ failOnException "Couldn't add distribution, are you sure it isn't added already?" $ run conn "INSERT INTO distro (name, url) VALUES (?, ?)" + [ toSql name + , toSql $ fromJust url + ] + return () + +-- | Get a distro from the database based on ID +_list2Distro :: [SqlValue] -> T.Distro +_list2Distro [sid, sname, surl] = T.Distro + (fromSql sid) + (fromSql sname) + (fromSql surl) +_list2Distro _ = error "_list2Distro" + +getDistroById :: Int -> AlertDB (Maybe T.Distro) +getDistroById distroID = do + conn <- ask + sd <- liftIO $ failOnException "" $ quickQuery' conn "SELECT id, name, url FROM distro WHERE id = ?" [toSql distroID] + return $ if null sd + then Nothing + else Just $ _list2Distro $ head sd + +-- | Delete a distribution from the database. +deleteDistro :: T.Distro -> AlertDB () +deleteDistro d = do + conn <- ask + liftIO $ failOnException "" $ run conn "DELETE FROM distro WHERE name=?" [toSql $ T.distroName d] + return () + +-- | List all distributions in the database. +getAllDistro :: AlertDB [T.Distro] +getAllDistro = do + conn <- ask + sd <- liftIO $ failOnException "" $ quickQuery' conn "SELECT * FROM distro" [] + return $ map _list2Distro sd + +addAlertUrl :: String -> String -> AlertDB () +addAlertUrl aident url = do + conn <- ask + oldUrls <- getAlertUrls aident + if url `elem` oldUrls + then return () + else do + liftIO $ failOnException ("Couldn't add alert URL " ++ url ++ " to alert " ++ aident) $ run conn "INSERT INTO alerturl (alertidentity, url) VALUES (?, ?)" + [ toSql aident + , toSql url + ] + return () + +getAlertUrls :: String -> AlertDB [String] +getAlertUrls aident = do + conn <- ask + urls <- liftIO $ failOnException ("Couldn't find URLs for " ++ aident) $ quickQuery' conn "SELECT url FROM alerturl WHERE alertidentity=?" [toSql aident] + return $ map fromSql $ concat urls + +-- -- {{{1 alert +addAlert :: T.Alert -> AlertDB () +addAlert alert@(T.Alert _ urls identity package date proc distro) = let + doAddAlert = do + conn <- ask + liftIO $ failOnException ("Couldn't add alert: " ++ show alert) $ run conn "INSERT INTO alert (identity, package, date, sent, distro_id) VALUES (?, ?, ?, ?, ?)" + [ toSql identity + , toSql package + , toSql date + , toSql proc + , toSql $ fromJust $ T.distroId distro + ] + mapM_ (addAlertUrl identity) urls + -- liftIO $ commit conn -- silly, but seems to help when adding many vulns + return () + doAddUrlToAlert url = do + addAlertUrl identity url + unsetReportedAlertId identity + in do + b <- getAlert identity + maybe doAddAlert (const $ mapM_ doAddUrlToAlert urls) b + +-- | Get an alert with a specific identity. +getAlert :: String -- ^ Identity of alert + -> AlertDB (Maybe T.Alert) +getAlert identity = do + conn <- ask + sd <- liftIO $ failOnException "getAlert" $ quickQuery' conn "SELECT * FROM alert WHERE identity=?" [toSql identity] + if null sd + then return Nothing + else liftM Just (_list2Alert $ head sd) + +setReportedAlert :: Int -> AlertDB () +setReportedAlert alertId = do + conn <- ask + liftIO $ failOnException "" $ run conn "UPDATE alert SET sent=? WHERE id=?" + [ toSql True, toSql alertId] + return () + +unsetReportedAlertId aident = do + conn <- ask + liftIO $ failOnException "" $ run conn "UPDATE alert SET sent=? WHERE identity=?" + [ toSql False, toSql aident ] + return () + +getAllAlertId :: AlertDB [String] +getAllAlertId = do + conn <- ask + sd <- liftIO $ failOnException "" $ quickQuery' conn "SELECT identity FROM alert" [] + return $ map fromSql $ concat sd + +_list2Alert :: [SqlValue] -> AlertDB T.Alert +_list2Alert [aid, aident, pkg, date, proc, distroid] = do + d <- getDistroById (fromSql distroid) + us <- getAlertUrls (fromSql aident) + return $ T.Alert + (fromSql aid) + us + (fromSql aident) + (fromSql pkg) + (fromSql date) + (fromSql proc) + (fromJust d) +_list2Alert _ = error "_list2Alert" + +_getAlert query = do + conn <- ask + sd <- liftIO $ failOnException "" $ quickQuery' conn query [] + mapM _list2Alert sd + +getAllAlert :: AlertDB [T.Alert] +getAllAlert = _getAlert "SELECT * FROM alert" + +getReportedAlert :: AlertDB [T.Alert] +getReportedAlert = _getAlert "SELECT * FROM alert WHERE sent='True'" + +getUnreportedAlert :: AlertDB [T.Alert] +getUnreportedAlert = _getAlert "SELECT * FROM alert WHERE sent='False'" diff --git a/src/Commands.hs b/src/Commands.hs new file mode 100644 --- /dev/null +++ b/src/Commands.hs @@ -0,0 +1,80 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module Commands + ( doCommand + ) where + +import System.Console.CmdArgs +import System.Directory +import Data.Version (showVersion) +import Paths_lat (version) + +import qualified Commands.Distro as D +import qualified Commands.Vulns as V +import qualified Commands.ArgTypes as CAT + +-- {{{1 doCommand +doCommand = do + home <- getAppUserDataDirectory "lat" + let allArgs = map (\ f -> f home) [_distroAddArgs, _distroListArgs, _vulnUpdateArgs, _vulnListArgs, _vulnReportArgs] + let ver = "lat " ++ (showVersion version) ++ " - Linux Alert Tracker" + ++ "\nCopyright 2010 Magnus Therning " + cmdArgs ver allArgs >>= _doCommand + +_doCommand a@(CAT.DistroAdd {}) = D.distroAdd a +_doCommand a@(CAT.DistroList {}) = D.distroList a +_doCommand a@(CAT.VulnUpdate {}) = V.vulnUpdate a +_doCommand a@(CAT.VulnList {}) = V.vulnList a +_doCommand a@(CAT.VulnReport {}) = V.vulnReport a + +-- {{{1 Command line arg definitions +_configAttrib = text "Set dir for configuration" & empty "~/.lat" & typDir + +_distroAddArgs h = mode CAT.DistroAdd + { CAT.config = h &= _configAttrib + , CAT.name = def &= argPos 0 & typ "NAME" + , CAT.url = def &= argPos 1 & typ "URL" + } &= text "add a distribution" + +_distroListArgs h = mode CAT.DistroList + { CAT.config = h &= _configAttrib + } &= text "list distributions" + +_vulnUpdateArgs h = mode CAT.VulnUpdate + { CAT.config = h &= _configAttrib + , CAT.dry = def &= text "Dry run" + } &= text "update the vulnerability database" + +_vulnListArgs h = mode CAT.VulnList + { CAT.config = h &= _configAttrib + , CAT.typ = enum CAT.Unreported + [ CAT.Unreported &= text "List unreported issues (default)" + , CAT.Reported &= text "List reported issues" + , CAT.All &= text "List all issues" + ] + , CAT.size = enum CAT.Normal + [ CAT.Small &= text "Output format: small" + , CAT.Normal &= text "Output format: normal" & flag "n" + , CAT.Full &= text "Output format: full" + ] + , CAT.nofilter = def &= text "Filter off" & explicit & flag "nofilter" + } &= text "list known vulnerabilities" + +_vulnReportArgs h = mode CAT.VulnReport + { CAT.config = h &= _configAttrib + , CAT.nofilter = def &= text "Filter off" & explicit & flag "nofilter" + } &= text "report (process) vulnerabilities" diff --git a/src/Commands/ArgTypes.hs b/src/Commands/ArgTypes.hs new file mode 100644 --- /dev/null +++ b/src/Commands/ArgTypes.hs @@ -0,0 +1,41 @@ +{-# LANGUAGE DeriveDataTypeable #-} + +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module Commands.ArgTypes + where + +import Data.Data + +data VulnListType = All | Reported | Unreported + deriving (Data, Typeable, Show, Eq) + +data VulnListSize = Small | Normal | Full + deriving (Data, Typeable, Show, Eq) + +data ArgType + = DistroAdd { config :: FilePath , name :: String , url :: String } + | DistroList { config :: FilePath } + | VulnUpdate { config :: FilePath, dry :: Bool } + | VulnList + { config :: FilePath + , typ :: VulnListType + , size :: VulnListSize + , nofilter :: Bool + } + | VulnReport { config :: FilePath, nofilter :: Bool } + deriving (Data, Typeable, Show) diff --git a/src/Commands/Distro.hs b/src/Commands/Distro.hs new file mode 100644 --- /dev/null +++ b/src/Commands/Distro.hs @@ -0,0 +1,36 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module Commands.Distro + ( distroAdd + , distroList + ) where + +import qualified AlertDB as ADB +import qualified Types as T +import qualified Commands.ArgTypes as CAT + +-- {{{1 distroadd +distroAdd :: CAT.ArgType -> IO () +distroAdd (CAT.DistroAdd dbPath name url) = + ADB.runAlertDB dbPath (ADB.addDistro $ T.distro name (Just url)) +distroAdd _ = print "Bad argument for distroAdd" + +-- {{{1 distrolist +distroList :: CAT.ArgType -> IO () +distroList (CAT.DistroList dbPath) = + ADB.runAlertDB dbPath ADB.getAllDistro >>= mapM_ (print . T.prettyNormal) +distroList _ = print "Bad argument for distroList" diff --git a/src/Commands/Vulns.hs b/src/Commands/Vulns.hs new file mode 100644 --- /dev/null +++ b/src/Commands/Vulns.hs @@ -0,0 +1,71 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module Commands.Vulns + ( vulnUpdate + , vulnList + , vulnReport + ) where + +import Control.Monad + +import qualified AlertDB as ADB +import qualified Types as T +import qualified LWN +import qualified Report as R +import qualified Commands.ArgTypes as CAT +import qualified Filter as F + +-- {{{1 vulnUpdate +vulnUpdate (CAT.VulnUpdate dbPath _) = let + keepAlert alertIds alert = T.alertIdentity alert `notElem` alertIds + in do + distros <- ADB.runAlertDB dbPath ADB.getAllDistro + alerts <- liftM concat $ mapM LWN.getAlerts distros + alertIds <- ADB.runAlertDB dbPath ADB.getAllAlertId + let filteredAlerts = filter (keepAlert alertIds) alerts + ADB.runAlertDB dbPath (mapM_ ADB.addAlert filteredAlerts) + +vulnUpdate _ = error "vulnUpdate called with bad argument" + +-- {{{1 vulnList +vulnList :: CAT.ArgType -> IO () +vulnList (CAT.VulnList dbPath ty size nf) = let + getAlerts = case ty of + CAT.Unreported -> ADB.getUnreportedAlert + CAT.Reported -> ADB.getReportedAlert + CAT.All -> ADB.getAllAlert + filter = if nf + then return + else F.filterAlerts + prettyPrinter = case size of + CAT.Small -> T.prettyTerse + CAT.Normal -> T.prettyNormal + CAT.Full -> T.prettyVerbose + in + ADB.runAlertDB dbPath getAlerts >>= filter >>= mapM_ (print . prettyPrinter) + +vulnList _ = error "vulnList called with bad argument" + +-- {{{1 vulnReport +vulnReport :: CAT.ArgType -> IO () +vulnReport (CAT.VulnReport dbPath nf) = let + filter = if nf + then return + else F.filterAlerts + in ADB.runAlertDB dbPath ADB.getUnreportedAlert >>= filter >>= R.report dbPath + +vulnReport _ = error "vulnReport called with bad argument" diff --git a/src/Filter.hs b/src/Filter.hs new file mode 100644 --- /dev/null +++ b/src/Filter.hs @@ -0,0 +1,71 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module Filter where + +import qualified Types as T + +import Control.Monad.Error +import Data.ConfigFile +import Data.Either.Utils +import Data.Maybe +import System.Directory +import System.FilePath +import Text.Regex +import qualified Control.Exception as CE + +filterAlerts :: [T.Alert] -> IO [T.Alert] +filterAlerts as = do + filters <- _getFilters + return $ _doFilter filters as + +-- Load the config file, extract all entries in the sections [filters], each +-- value is a filename, each file is loaded, and the [(distroName, [lines])] is +-- compiled +-- _getFilters :: IO [(String, [Regex])] +_getFilters = let + readRegexFile (d, fn) = do + home <- getAppUserDataDirectory "lat" + rxs <- lines `fmap` readFile (home fn) + return $ (d, map mkRegex rxs) + + in do + cfg <- _getConfigFile + if (not $ has_section cfg "packages") + then return [] + else do + let is = forceEither $ items cfg "packages" + sequence $ map readRegexFile is + +-- _getConfigFile :: IO ConfigParser +_getConfigFile = let + gCF h = runErrorT $ join $ liftIO $ readfile emptyCP (h "lat.conf") + in do + home <- getAppUserDataDirectory "lat" + conf <- CE.catch (gCF home) (\ e -> return $ Left (OtherProblem "IO Error", show (e :: CE.SomeException))) + -- TODO: add some better error handling here, or at least reporting to the user + return $ either (const emptyCP) id conf + +-- _doFilter :: [(String, [Regex])] -> [T.Alert] -> [T.Alert] +_doFilter fs = filter (_isGoodalert fs) + +-- _isGoodalert :: [(String, [Regex])] -> T.Alert -> Bool +_isGoodalert fs a = let + dn = T.getAlertDistroName a + mrs = lookup dn fs + an = T.alertPackage a + isGoodName name = not . null . catMaybes . map (\ r -> matchRegex r name) + in maybe True (isGoodName an) mrs diff --git a/src/LWN.hs b/src/LWN.hs new file mode 100644 --- /dev/null +++ b/src/LWN.hs @@ -0,0 +1,107 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module LWN + ( getAlerts + ) where + +import Control.Monad +import Data.Maybe +import Data.Time.Format +import Network.HTTP +import System.Locale +-- import Text.HTML.Download +import Text.HTML.TagSoup +import Text.Regex + +import qualified Types as T + +type MyTag = Tag String + +--{{{1 useful stuff +getAllTags :: String -> IO [MyTag] +getAllTags = liftM parseTags . openURL + where + openURL url = getResponseBody =<< simpleHTTP (getRequest url) + +--{{{1 get the number of alerts +getAlertCount :: String -> IO Int +getAlertCount url = liftM (getTheCount .(!! 0)) $ getAllTags url >>= filterM (return . isTheCount) + where + regex = mkRegex "([[:digit:]]+) alerts total" + + --isTheCount :: MyTag -> Bool + isTheCount (TagText s) = isJust $ matchRegex regex s + isTheCount _ = False + + --getTheCount :: MyTag -> Int + getTheCount (TagText s) = read $ maybe "0" (!! 0) (matchRegex regex s) + getTheCount _ = 0 + +getFullAlertPage url = do + count <- getAlertCount url + let url2 = url ++ "?n=" ++ show count + getAllTags url2 + +-- I want to extract the table: +-- getFullAlertPage >>= return . (!! 2) . partitions (~== TagOpen "table" []) +-- +-- The 4 parts of the partitioning on (roughly the page is split into +-- [head, table for Google ad stuff, table for navigation, table for content]) +extractAlertTable :: [MyTag] -> [MyTag] +extractAlertTable = (!! 3) . partitions (~== TagOpen "table" []) + +-- Then I can partition it on (TagOpen "tr" []), drop the first item (it's the +-- header) and then take the number of items equal to the number of alerts. +extractAlertRows :: [MyTag] -> [[MyTag]] +extractAlertRows = tail . partitions (~== TagOpen "tr" []) + +-- Each line has the following form: +-- +-- [TagOpen "tr" [], +-- TagText " ", +-- TagOpen "td" [], +-- TagOpen "a" [("href","/Alerts/293022")], <-- catch the href (prefix with http://lwn.net +-- TagText "CESA-2008:0612", <-- catch the ID +-- TagClose "a", +-- TagClose "td", +-- TagText "\n ", +-- TagOpen "td" [], +-- TagText "kernel", <-- catch the package +-- TagClose "td", +-- TagOpen "td" [], +-- TagText "2008-08-06", <-- date +-- TagClose "td", +-- TagClose "tr", +-- TagText "\n "] +alertFromRow :: T.Distro -> [MyTag] -> Maybe T.Alert +alertFromRow distro ts = do + guard (length ts >= 16) + return $ T.alert + [("http://lwn.net" ++ fromAttrib "href" (ts !! 3))] + (fromTagText $ ts !! 4) -- id + (fromTagText $ ts !! 9) -- package + (readTime defaultTimeLocale "%Y-%m-%d" $ fromTagText $ ts !! 12) + False -- not processed + distro + +--{{{1 turning the full page into alerts +getAlerts :: T.Distro -> IO [T.Alert] +getAlerts distro = do + let url = fromMaybe ("http://lwn.net/Alerts/" ++ T.distroName distro ++ "/") $ T.distroUrl distro + page <- getFullAlertPage url + let rows = extractAlertRows $ extractAlertTable page + return $ mapMaybe (alertFromRow distro) rows diff --git a/src/RepEng.hs b/src/RepEng.hs new file mode 100644 --- /dev/null +++ b/src/RepEng.hs @@ -0,0 +1,166 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module RepEng where + +import Control.Monad.Error +import Control.Exception as CE +import Data.ConfigFile +import Data.Either.Utils +import Data.Maybe +import Network.XmlRpc.Client +import Network.XmlRpc.Internals +import System.Directory +import System.FilePath + +import qualified AlertDB as ADB +import qualified Types as T + +-- assoc of backend name and function (taking path to database and the alert) +type Engine = (String, FilePath -> T.Alert -> IO ()) + +allEngines :: [Engine] +allEngines = [ ("jira", _jiraReport)] + +_getConfigFile :: IO ConfigParser +_getConfigFile = let + gCF h = runErrorT $ join $ liftIO $ readfile emptyCP (combine h "lat.conf") + in do + home <- getAppUserDataDirectory "lat" + conf <- CE.catch (gCF home) (\ e -> return $ Left (OtherProblem "IO Error", show (e :: CE.SomeException))) + -- TODO: add some better error handling here, or at least reporting to the user + return $ either (const emptyCP) id conf + +data JiraConfig = JiraConfig + { jiraURL :: String + , jiraUser :: String + , jiraPwd :: String + , jiraProject :: String + , jiraType :: String + , jiraPriority :: String + , jiraComponent :: String + } deriving (Show) + +_getWithDefault cfg section option def = either (const def) id (get cfg section option) + +_getJiraConfig cfg = JiraConfig url user pwd project typ priority component + where + url = _getWithDefault cfg "jira" "url" "NoUrl" -- http://scale-dev.uk.xensource.com/rpc/xmlrpc + user = _getWithDefault cfg "jira" "user" "NoUser" -- magnusth + pwd = _getWithDefault cfg "jira" "pwd" "NoPassword" + project = _getWithDefault cfg "jira" "project" "NoProject" -- Carbon + typ = _getWithDefault cfg "jira" "type" "NoType" -- Task + priority = _getWithDefault cfg "jira" "priority" "NoPriority" -- Major + component = _getWithDefault cfg "jira" "component" "NoComponent" -- Security + +_jiraReport :: FilePath -> T.Alert -> IO () +_jiraReport dbpath a = do + cfg <- liftM _getJiraConfig _getConfigFile + bracket + (_jiraLogin (jiraURL cfg) (jiraUser cfg) (jiraPwd cfg)) + (_jiraLogout (jiraURL cfg)) + (\ s -> do + --proj <- _getProjectKey (jiraURL cfg) s (jiraProject cfg) + --typ <- _getTypeId (jiraURL cfg) s (jiraType cfg) + --pri <- _getPriorityId (jiraURL cfg) s (jiraPriority cfg) + --comp <- _getComponentId (jiraURL cfg) s proj (jiraComponent cfg) + key <- _createIssue cfg a s + putStrLn $ "Recorded as " ++ key + ADB.runAlertDB dbpath (ADB.setReportedAlert (fromJust $ T.alertId a))) + +_jiraLogin :: String -- ^ url + -> String -- ^ username + -> String -- ^ password + -> IO String -- ^ session token +_jiraLogin url = remote url "jira1.login" + +_jiraLogout :: String -- ^ url + -> String -- ^ session token + -> IO Bool +_jiraLogout url = remote url "jira1.logout" + +_jiraGetProjects :: String -> String -> IO [[(String, String)]] +_jiraGetProjects url = remote url "jira1.getProjects" + +_jiraGetTypes :: String -> String -> IO [[(String, String)]] +_jiraGetTypes url = remote url "jira1.getIssueTypes" + +_jiraGetPriorities :: String -> String -> IO [[(String, String)]] +_jiraGetPriorities url = remote url "jira1.getPriorities" + +_jiraGetComponents :: String -- ^ url + -> String -- ^ session token + -> String -- ^ project name + -> IO [[(String, String)]] +_jiraGetComponents url = remote url "jira1.getComponents" + +_jiraCreateIssue :: String -- ^ url + -> String -- ^ session token + -> Value -- ^ issue description + -> IO String +_jiraCreateIssue url session desc = do + res <- remote url "jira1.createIssue" session desc + liftM fromRight $ runErrorT (fromValue $ fromJust $ lookup "key" res) + +_jiraUpdateIssue :: String -- ^ url + -> String -- ^ session token + -> String -- ^ issue key (e.g. "CA-12345") + -> Value -- ^ issue description + -> IO String +_jiraUpdateIssue url session issue desc = do + res <- remote url "jira1.updateIssue" session issue desc + liftM fromRight $ runErrorT (fromValue $ fromJust $ lookup "key" res) + +_getJiraValue jiraFunc matchKey matchValue key = let + filterF p = lookup matchKey p == Just matchValue + in do + projects <- jiraFunc + return . fromJust . lookup key $ head (filter filterF projects) + +_getProjectKey url session project = _getJiraValue (_jiraGetProjects url session) "name" project "key" +_getTypeId url session typ = _getJiraValue (_jiraGetTypes url session) "name" typ "id" +_getPriorityId url session priority = _getJiraValue (_jiraGetPriorities url session) "name" priority "id" +_getComponentId url session project component = _getJiraValue (_jiraGetComponents url session project) "name" component "id" + +-- for some strange reason I can't manage to set the components of an issue as +-- its created, hence the two calls +_createIssue cfg alert session = let + summary = "(Upstream security issue) " ++ show (T.prettyTerse alert) + description = show $ T.prettyVerbose alert + url = jiraURL cfg + in do + project <- _getProjectKey url session (jiraProject cfg) + typ <- _getTypeId url session (jiraType cfg) + priority <- _getPriorityId url session (jiraPriority cfg) + component <- _getComponentId url session project (jiraComponent cfg) + let issueDesc = toValue [("project", project), ("type", typ), ("priority", priority), ("summary", summary), ("assignee", jiraUser cfg), ("description", description)] + newIssue <- _jiraCreateIssue url session issueDesc + let issueDescUpdate = toValue [("components", [component])] + _jiraUpdateIssue url session newIssue issueDescUpdate + +-- {- ********************************************* -} +-- import Data.Time.Calendar +-- _sillyDistro = T.distro "name" $ Just "url" +-- _sillyAlert = T.alert ["url"] "identity" "package" (ModifiedJulianDay 42) False _sillyDistro +-- _sillyDesc = [("project", "CA"), ("type", "3"), ("priority", "3"), ("summary", "MT: another summary"), ("assignee", "magnusth"), ("description", "Description of issue created with lat")] +-- _sillyUpdate = [("components", ["10095"])] +-- __url = "http://scale-dev.uk.xensource.com/rpc/xmlrpc" +-- +-- {- +-- sess <- _jiraLogin __url "magnusth" " +-- ik <- _jiraCreateIssue __url sess (toValue _sillyDesc) +-- _jiraUpdateIssue __url sess ik (toValue _sillyUpdate) +-- -} diff --git a/src/Report.hs b/src/Report.hs new file mode 100644 --- /dev/null +++ b/src/Report.hs @@ -0,0 +1,80 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module Report where + +import Data.List +import Data.Maybe +import System.Exit +import System.IO + +import qualified AlertDB as ADB +import qualified RepEng as RE +import qualified Types as T + +report :: FilePath -> [T.Alert] -> IO () +report dbpath alerts = let + engs = RE.allEngines + in do + _printEngines engs + mapM_ (_report dbpath engs) alerts + +_printEngines engines = let + numeng = zip ([1..] :: [Int]) (map fst engines) + _ne2s ne = (show . fst $ ne) ++ " : " ++ snd ne + in do + putStrLn "Report engines:" + mapM_ (putStrLn . _ne2s) numeng + +_report dbpath engines alert = let + _engChoices = map show (take (length engines) ([1..] :: [Int])) + _engStr = foldl (\ a b -> a ++ b ++ "/") "" _engChoices + + _withNoStdinBuffering foo = do + old <- hGetBuffering stdin + hSetBuffering stdin NoBuffering + result <- foo + hSetBuffering stdin old + return result + + _allChoices = _engChoices ++ ["s", "m", "q"] + _allChoicesString = foldl (\ a b -> a ++ b ++ "/") "" _allChoices + _getValidChar = let + _printInteractiveHelp = do + _printEngines engines + putStrLn "s : skip" + putStrLn "m : mark as done" + putStrLn "q : quit reporting" + putStrLn "h : print this help" + _isValid c + | c == 'h' = _printInteractiveHelp >> _getValidChar + | [c] `elem` _allChoices = return c + | otherwise = putStrLn ("Invalid choice: " ++ [c]) >> _getValidChar + in do + putStr (_allChoicesString ++ "h ") >> hFlush stdout + _withNoStdinBuffering (getChar >>= (\ c -> putStrLn "" >> return c)) >>= _isValid + + _processWithEngine = snd + _processAlert c + | c == 'q' = exitWith ExitSuccess + | c == 'm' = ADB.runAlertDB dbpath (ADB.setReportedAlert (fromJust (T.alertId alert))) + | c == 's' = return () + | [c] `elem` _engChoices = _processWithEngine (engines !! fromJust (elemIndex [c] _engChoices)) dbpath alert + | otherwise = putStrLn $ "Unknown choice: " ++ [c] -- not possible! + + in do + print $ T.prettyNormal alert + _getValidChar >>= _processAlert >> putStrLn "" diff --git a/src/Types.hs b/src/Types.hs new file mode 100644 --- /dev/null +++ b/src/Types.hs @@ -0,0 +1,80 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module Types where + +import Data.Maybe +import Data.Time.Calendar +--import Data.Time.Clock +import Text.PrettyPrint.Leijen + +data Distro = Distro + { distroId :: Maybe Int -- ^ DB ID, automatically populated by the DB + , distroName :: String + , distroUrl :: Maybe String -- ^ URL to use for lookup, if it's 'Nothing' then @distroName@ will be used to construct the URL + } deriving (Show, Eq) + +data Alert = Alert + { alertId :: Maybe Int -- ^ DB ID, automatically populated by the DB + , alertUrl :: [String] + , alertIdentity :: String -- ^ identity as reported by LWN + , alertPackage :: String + , alertDate :: Day + , alertProcessed :: Bool -- ^ record of whether the alert has been processed by lat before + , alertDistro :: Distro + } deriving (Show, Eq) + +distro = Distro Nothing +alert = Alert Nothing + +getAlertDistroName :: Alert -> String +getAlertDistroName = distroName . alertDistro + +-- | Class for pretty output of different levels of verbosity. +class PrettyLevels a where + prettyTerse :: a -> Doc + prettyTerse = prettyNormal + + prettyNormal :: a -> Doc + + prettyVerbose :: a -> Doc + prettyVerbose = prettyNormal + +instance PrettyLevels Distro where + prettyNormal d = let + name = pretty $ distroName d + url = parens $ text $ fromMaybe "-" (distroUrl d) + in name <> space <> url + +instance PrettyLevels Alert where + prettyTerse a = let + urls = foldl (<+>) empty . map text $ alertUrl a + identity = text $ alertIdentity a + package = text $ alertPackage a + in identity <+> colon <+> package <+> colon <+> urls + + prettyNormal a = let + urls = foldl (<+>) empty . map text $ alertUrl a + identity = text $ alertIdentity a + package = text $ alertPackage a + date = pretty $ alertDate a + processed = pretty $ alertProcessed a + distro = prettyNormal $ alertDistro a + in package <+> colon <+> identity + <$> indent 2 (date <+> distro <+> processed <+> urls) + +instance Pretty Day where + pretty = text . show diff --git a/src/lat.hs b/src/lat.hs new file mode 100644 --- /dev/null +++ b/src/lat.hs @@ -0,0 +1,23 @@ +{- lat - tool to track alerts from LWN. + - Copyright (C) 2010 Magnus Therning + - + - 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, version 3 of the License. + - + - 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 . + -} + +module Main + ( main + ) where + +import qualified Commands as C + +main = C.doCommand