diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/orgstat.cabal b/orgstat.cabal new file mode 100644 --- /dev/null +++ b/orgstat.cabal @@ -0,0 +1,115 @@ +name: orgstat +version: 0.0.1 +synopsis: Statistics visualizer for org-mode +license: GPL-3 +license-file: LICENSE +author: Mikhail Volkhov , Zhenya Vinogradov +maintainer: volhovm.cs@gmail.com +build-type: Simple +cabal-version: >=1.10 + +library + exposed-modules: OrgStat.Ast + , OrgStat.Config + , OrgStat.IO + , OrgStat.Logic + , OrgStat.Parser + , OrgStat.Scope + , OrgStat.Report + , OrgStat.Report.Types + , OrgStat.Report.Class + , OrgStat.Report.Timeline + , OrgStat.Util + , OrgStat.WorkMonad + build-depends: aeson >= 0.11.2.0 + , attoparsec + , base >=4.9 && <4.10 + , bytestring + , colour >= 2.3.3 + , containers >= 0.5.7.1 + , data-default >= 0.7.1.1 + , diagrams-lib + , diagrams-svg + , directory + , exceptions >= 0.8.3 + , filepath + , formatting + , hashable >= 1.2.4.0 + , lens >= 4.14 + , linear + , log-warper >= 0.2.1 + , mtl >= 2.2.1 + , optparse-simple + , orgmode-parse + , text >= 1.2.2.1 + , time >= 1.6.0.1 + , turtle >= 1.2.8 + , universum >= 0.2.1 + , yaml >= 0.8.21.1 + hs-source-dirs: src + default-language: Haskell2010 + ghc-options: -Wall + default-extensions: GeneralizedNewtypeDeriving + StandaloneDeriving + FlexibleContexts + FlexibleInstances + MultiParamTypeClasses + FunctionalDependencies + NoImplicitPrelude + OverloadedStrings + RecordWildCards + TypeApplications + TupleSections + ViewPatterns + LambdaCase + MultiWayIf + +executable orgstat + main-is: Main.hs + build-depends: base >=4.9 && <4.10 + , bytestring + , directory + , exceptions >= 0.8.3 + , filepath + , formatting + , log-warper >= 0.2.1 + , optparse-simple + , orgstat + , universum >= 0.2.1 + hs-source-dirs: src/cli + default-language: Haskell2010 + ghc-options: -threaded -Wall -O2 + default-extensions: NoImplicitPrelude + OverloadedStrings + RecordWildCards + TypeApplications + + +test-suite orgstat-test + main-is: Test.hs + other-modules: Spec + , GlobalSpec + build-depends: HUnit >= 1.3.1.2 + , QuickCheck + , base >=4.9 && <4.10 + , colour >= 2.3.3 + , hspec + , orgstat + , lens + , quickcheck-text >= 0.1.2.1 + , time >= 1.6.0.1 + , text + , transformers + , universum >= 0.2.1 + type: exitcode-stdio-1.0 + hs-source-dirs: test + default-language: Haskell2010 + ghc-options: -threaded -rtsopts + -Wall + -fno-warn-orphans + -O2 + default-extensions: NoImplicitPrelude + OverloadedStrings + RecordWildCards + TypeApplications + GeneralizedNewtypeDeriving diff --git a/src/OrgStat/Ast.hs b/src/OrgStat/Ast.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Ast.hs @@ -0,0 +1,81 @@ +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE TemplateHaskell #-} + +-- | Abstract syntax tree for org. + +module OrgStat.Ast + ( Clock (..) + , Org (..) + , orgTitle + , orgTags + , orgClocks + , orgSubtrees + , fmapOrgLens + , traverseTree + , atDepth + , mergeClocks + ) where + +import Control.Lens (ASetter', makeLenses) +import Data.Time (LocalTime, diffUTCTime, localTimeToUTC, utc) + +import Universum + +---------------------------------------------------------------------------- +-- Types +---------------------------------------------------------------------------- + +-- | Org clock representation -- a pair of time in UTC. Should be +-- local time in fact, but we'll assume that UTC timestamps support in +-- org will be added at some point. For now all tags are to be read in +-- local time. +data Clock = Clock + { cFrom :: LocalTime + , cTo :: LocalTime + } deriving (Show,Eq,Ord) + +-- | Main datatype of org AST. It may contain some metadata if needed +-- (e.g. current node depth, children number etc). Content of headers +-- is ignored. +data Org = Org + { _orgTitle :: Text + , _orgTags :: [Text] + , _orgClocks :: [Clock] + , _orgSubtrees :: [Org] + } deriving (Show,Eq) + +makeLenses ''Org + +---------------------------------------------------------------------------- +-- Helpers and lenses +---------------------------------------------------------------------------- + +-- | Functor-like 'fmap' on field chosen by lens. +fmapOrgLens :: ASetter' Org a -> (a -> a) -> Org -> Org +fmapOrgLens l f o = o & l %~ f & orgSubtrees %~ map (fmapOrgLens l f) + +-- | Traverses node and subnodes, all recursively +traverseTree :: Traversal' Org Org +traverseTree f o = o' + where + o' = liftA2 (\org x -> org & orgSubtrees .~ x) (f o) traversedChildren + traversedChildren = traverse (traverseTree f) $ o ^. orgSubtrees + +atDepth :: Int -> Traversal' Org Org +atDepth i _ o | i < 0 = pure o +atDepth 0 f o = f o +atDepth n f o = + (\x -> o & orgSubtrees .~ x) <$> traverse (atDepth (n-1) f) (o ^. orgSubtrees) + +-- | Merges task clocks that have less then 2m delta between them into +-- one. +mergeClocks :: Org -> Org +mergeClocks = fmapOrgLens orgClocks (mergeClocksDo . sort) + where + toUTC = localTimeToUTC utc + mergeClocksDo [] = [] + mergeClocksDo [x] = [x] + mergeClocksDo (a:b:xs) + | toUTC (cFrom b) `diffUTCTime ` toUTC (cTo a) < 2*60 = + mergeClocksDo $ (Clock (cFrom a) (cTo b)):xs + | otherwise = a : mergeClocksDo (b:xs) diff --git a/src/OrgStat/Config.hs b/src/OrgStat/Config.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Config.hs @@ -0,0 +1,167 @@ +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# OPTIONS_GHC -Wno-orphans #-} + +-- | Configuration file types, together with json instances. + +module OrgStat.Config + ( ConfigException (..) + , ConfDate(..) + , ConfRange(..) + , ConfReportType(..) + , ConfScope (..) + , ConfReport (..) + , OrgStatConfig (..) + ) where + +import Data.Aeson (FromJSON (..), Value (Object, String), (.!=), + (.:), (.:?)) +import Data.Aeson.Types (typeMismatch) +import Data.Default (def) +import Data.List.NonEmpty (NonEmpty) +import qualified Data.Text as T +import Data.Time (LocalTime) +import Data.Time.Format (defaultTimeLocale, parseTimeM) +import Universum + +import OrgStat.Report.Timeline (TimelineParams, tpBackground, tpColumnHeight, + tpColumnWidth, tpLegend, tpTopDay) +import OrgStat.Scope (AstPath (..), ScopeModifier (..)) +import OrgStat.Util (parseColour, (??~)) + +-- | Exception type for everything bad that happens with config, +-- starting from parsing to logic errors. +data ConfigException + = ConfigParseException Text + | ConfigLogicException Text + deriving (Show, Typeable) + +instance Exception ConfigException + +data ConfDate + = ConfNow + | ConfLocal !LocalTime + deriving (Show) + +data ConfRange + = ConfFromTo !ConfDate !ConfDate + | ConfBlockWeek !Integer + | ConfBlockDay !Integer + | ConfBlockMonth !Integer + deriving (Show) + +data ConfReportType = Timeline + { timelineRange :: !ConfRange + , timelineScope :: !Text + , timelineParams :: !TimelineParams + } deriving (Show) + +data ConfScope = ConfScope + { csName :: !Text -- default is "default" + , csPaths :: !(NonEmpty FilePath) + } deriving (Show) + +data ConfReport = ConfReport + { crType :: !ConfReportType -- includes config + , crName :: !Text + , crModifiers :: ![ScopeModifier] + } deriving (Show) + +data OrgStatConfig = OrgStatConfig + { confScopes :: ![ConfScope] + , confReports :: ![ConfReport] + , confBaseTimelineParams :: !TimelineParams + , confTodoKeywords :: ![Text] + , confOutputDir :: !FilePath -- default is "./orgstat" + , confColorSalt :: !Int + } deriving (Show) + +instance FromJSON AstPath where + parseJSON (String s) = pure $ AstPath $ filter (not . T.null) $ T.splitOn "/" s + parseJSON invalid = typeMismatch "AstPath" invalid + +instance FromJSON ScopeModifier where + parseJSON (Object v) = do + v .: "type" >>= \case + (String "prune") -> ModPruneSubtree <$> v .: "path" <*> v .:? "depth" .!= 0 + (String "select") -> ModSelectSubtree <$> v .: "path" + other -> fail $ "Unsupported scope modifier type: " ++ show other + parseJSON invalid = typeMismatch "ScopeModifier" invalid + +instance FromJSON ConfDate where + parseJSON (String "now") = pure $ ConfNow + parseJSON (String s) = + case parseTimeM True defaultTimeLocale "%Y-%m-%d %H:%M" (T.unpack s) of + Nothing -> fail $ + "Couldn't read date " <> show s <> + ". Correct format is 2016-01-01 23:59" + Just ut -> pure $ ConfLocal ut + parseJSON invalid = typeMismatch "ConfDate" invalid + +instance FromJSON ConfRange where + parseJSON (String s) | any (`T.isPrefixOf` s) ["day", "week", "month"] = do + let splitted = T.splitOn "-" $ if "-" `T.isInfixOf` s then s else s <> "-" + [range, number] = splitted + constructor = case range of + "day" -> ConfBlockDay + "week" -> ConfBlockWeek + "month" -> ConfBlockMonth + _ -> panic "ConfRange@parseJSON" + numberParsed + | number == "" = pure 0 + | otherwise = case readMaybe (T.unpack number) of + Nothing -> fail $ "Couldn't parse number modifier of " <> T.unpack s + Just x -> pure x + when (length splitted /= 2) $ + fail $ "Couldn't parse range " <> T.unpack s <> + ", splitted is " <> show splitted + constructor <$> numberParsed + parseJSON (Object v) = ConfFromTo <$> v .: "from" <*> v .: "to" + parseJSON invalid = typeMismatch "ConfRange" invalid + +instance FromJSON TimelineParams where + parseJSON (Object v) = do + legend <- v .:? "legend" + topDay <- v .:? "topDay" + colWidth <- v .:? "colWidth" + colHeight <- v .:? "colHeight" + bgColorRaw <- v .:? "background" + pure $ def & tpLegend ??~ legend + & tpTopDay ??~ topDay + & tpColumnWidth ??~ colWidth + & tpColumnHeight ??~ colHeight + & tpBackground ??~ (T.strip <$> bgColorRaw >>= parseColour @Text) + parseJSON invalid = typeMismatch "TimelineParams" invalid + +instance FromJSON ConfReportType where + parseJSON o@(Object v) = do + v .: "type" >>= \case + (String "timeline") -> + Timeline <$> v .: "range" + <*> v .:? "scope" .!= "default" + <*> parseJSON o + other -> fail $ "Unsupported scope modifier type: " ++ show other + parseJSON invalid = typeMismatch "ConfReportType" invalid + +instance FromJSON ConfScope where + parseJSON (Object v) = do + ConfScope <$> v .:? "name" .!= "default" <*> v .: "paths" + parseJSON invalid = typeMismatch "ConfScope" invalid + +instance FromJSON ConfReport where + parseJSON (Object v) = do + ConfReport <$> v .: "type" + <*> v .:? "name" .!= "default" + <*> v .:? "modifiers" .!= [] + parseJSON invalid = typeMismatch "ConfReport" invalid + +instance FromJSON OrgStatConfig where + parseJSON (Object v) = do + OrgStatConfig <$> v .: "scopes" + <*> v .: "reports" + <*> v .:? "timelineDefault" .!= def + <*> v .:? "todoKeywords" .!= [] + <*> v .:? "output" .!= "./orgstat" + <*> v .:? "colorSalt" .!= 0 + parseJSON invalid = typeMismatch "ConfReport" invalid diff --git a/src/OrgStat/IO.hs b/src/OrgStat/IO.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/IO.hs @@ -0,0 +1,81 @@ +{-# LANGUAGE ScopedTypeVariables #-} + +-- | Operations with files mostly. + +module OrgStat.IO + ( readOrgFile + , readConfig + ) where + +import qualified Base as Base +import qualified Data.ByteString as BS +import qualified Data.Text as T +import qualified Data.Text.IO as TIO +import Data.Yaml (decodeEither) +import System.Directory (doesFileExist) +import System.FilePath (takeBaseName, takeExtension) +import System.Wlog (WithLogger, logDebug) +import Turtle (ExitCode (..), procStrict) +import Universum + +import OrgStat.Ast (Org) +import OrgStat.Config (ConfigException (ConfigParseException), OrgStatConfig) +import OrgStat.Parser (runParser) +import OrgStat.Util (dropEnd) + +data OrgIOException + = OrgIOException Text + -- ^ All exceptions related to reading files + | ExternalException Text + -- ^ Failed to run some external app (gpg) + deriving (Typeable) + +instance Base.Show OrgIOException where + show (OrgIOException r) = "IOException: " <> T.unpack r + show (ExternalException r) = "ExternalException: " <> T.unpack r + +instance Exception OrgIOException + +-- | Attempts to read a file. If extension is ".gpg", asks a user to +-- decrypt it first. Returns a pair @(filename, content)@. It also +-- takes a list of TODO-keywords to take header names correctly. +readOrgFile + :: (MonadIO m, MonadCatch m, WithLogger m) + => [Text] -> FilePath -> m (Text, Org) +readOrgFile todoKeywords fp = do + logDebug $ "Reading org file " <> fpt + unlessM (liftIO $ doesFileExist fp) $ + throwM $ OrgIOException $ "Org file " <> fpt <> " doesn't exist" + (content, fname) <- case takeExtension fp of + ".gpg" -> (,dropEnd 4 fp) <$> decryptGpg + ".org" -> (,fp) <$> liftIO (TIO.readFile fp) + _ -> throwM $ OrgIOException $ + "File " <> fpt <> " has unknown extension. Need to be .org or .org.gpg" + let filename = T.pack $ takeBaseName fname + logDebug $ "Parsing org file " <> fpt + parsed <- runParser todoKeywords content + pure (filename, parsed) + where + fpt = T.pack fp + failExternal = throwM . ExternalException + decryptGpg = do + logDebug $ "Decrypting gpg file: " <> fpt + (exCode, output) <- + (procStrict "gpg" ["--quiet", "--decrypt", fpt] empty) + `catch` + (\(e :: SomeException) -> failExternal $ "gpg procStrict failed: " <> show e) + case exCode of + ExitSuccess -> pass + ExitFailure n -> failExternal $ "Gpg failed with code " <> show n + pure output + +-- | Reads yaml config +readConfig :: (MonadIO m, MonadThrow m, WithLogger m) => FilePath -> m OrgStatConfig +readConfig fp = do + logDebug $ "Reading config file from: " <> fpt + unlessM (liftIO $ doesFileExist fp) $ + throwM $ OrgIOException $ "Config file " <> fpt <> " doesn't exist" + res <- liftIO $ BS.readFile fp + either (throwM . ConfigParseException . T.pack) pure $ decodeEither res + where + fpt = T.pack fp diff --git a/src/OrgStat/Logic.hs b/src/OrgStat/Logic.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Logic.hs @@ -0,0 +1,136 @@ +{-# LANGUAGE ScopedTypeVariables #-} + +-- | Main logic combining all components + +module OrgStat.Logic + ( convertRange + , runOrgStat + ) where + +import Data.List (notElem, nub, nubBy) +import qualified Data.List.NonEmpty as NE +import qualified Data.Map as M +import qualified Data.Text as T +import Data.Time (LocalTime (..), TimeOfDay (..), addDays, + defaultTimeLocale, formatTime, getZonedTime, + toGregorian, zonedTimeToLocalTime) +import Data.Time.Calendar (addGregorianMonthsRollOver) +import Data.Time.Calendar.WeekDate (toWeekDate) +import System.Directory (createDirectoryIfMissing) +import System.FilePath (()) +import System.Wlog (logDebug, logInfo) +import Universum +import Unsafe (unsafeHead) + +import OrgStat.Ast (Org (..), mergeClocks, orgTitle) +import OrgStat.Config (ConfDate (..), ConfRange (..), + ConfReport (..), ConfReportType (..), + ConfScope (..), ConfigException (..), + OrgStatConfig (..)) +import OrgStat.IO (readConfig, readOrgFile) +import OrgStat.Report (processTimeline, tpColorSalt, writeReport) +import OrgStat.Scope (applyModifiers) +import OrgStat.Util (fromJustM) +import OrgStat.WorkMonad (WorkM, wConfigFile, wXdgOpen) +import Turtle (shell) + + +-- Converts config range to a pair of 'UTCTime', right bound not inclusive. +convertRange :: (MonadIO m) => ConfRange -> m (LocalTime, LocalTime) +convertRange range = case range of + (ConfFromTo f t) -> (,) <$> fromConfDate f <*> fromConfDate t + (ConfBlockDay i) | i < 0 -> panic $ "ConfBlockDay i is <0: " <> show i + (ConfBlockDay 0) -> (,) <$> (localFromDay <$> startOfDay) <*> curTime + (ConfBlockDay i) -> do + d <- (negate (i - 1) `addDays`) <$> startOfDay + pure $ localFromDayPair ((negate 1) `addDays` d, d) + (ConfBlockWeek i) | i < 0 -> panic $ "ConfBlockWeek i is <0: " <> show i + (ConfBlockWeek 0) -> (,) <$> (localFromDay <$> startOfWeek) <*> curTime + (ConfBlockWeek i) -> do + d <- (negate (i - 1) `addWeeks`) <$> startOfWeek + pure $ localFromDayPair ((negate 1) `addWeeks` d, d) + (ConfBlockMonth i) | i < 0 -> panic $ "ConfBlockMonth i is <0: " <> show i + (ConfBlockMonth 0) -> (,) <$> (localFromDay <$> startOfMonth) <*> curTime + (ConfBlockMonth i) -> do + d <- addGregorianMonthsRollOver (negate $ i-1) <$> startOfMonth + pure $ localFromDayPair ((negate 1) `addGregorianMonthsRollOver` d, d) + where + localFromDay d = LocalTime d $ TimeOfDay 0 0 0 + localFromDayPair = bimap localFromDay localFromDay + curTime = liftIO $ zonedTimeToLocalTime <$> getZonedTime + curDay = localDay <$> curTime + addWeeks i d = (i*7) `addDays` d + startOfDay = curDay + startOfWeek = do + d <- curDay + let weekDay = pred $ view _3 $ toWeekDate d + pure $ fromIntegral (negate weekDay) `addDays` d + startOfMonth = do + d <- curDay + let monthDate = pred $ view _3 $ toGregorian d + pure $ fromIntegral (negate monthDate) `addDays` d + fromConfDate ConfNow = curTime + fromConfDate (ConfLocal x) = pure x + + +runOrgStat :: WorkM () +runOrgStat = do + conf@OrgStatConfig{..} <- readConfig =<< view wConfigFile + logDebug $ "Config: \n" <> show conf + + curTime <- liftIO getZonedTime + let reportDir = confOutputDir formatTime defaultTimeLocale "%F-%H-%M-%S" curTime + liftIO $ createDirectoryIfMissing True reportDir + logInfo $ "This report set will be put into: " <> T.pack reportDir + + logInfo $ "Parsing files..." + allParsedOrgs <- parseNeededFiles conf + forM_ confReports $ \ConfReport{..} -> case crType of + Timeline {..} -> do + logDebug $ "Processing report " <> crName + scope <- getScope conf timelineScope crName + let scopeFiles = NE.toList $ csPaths scope + neededOrgs = + map (\f -> fromMaybe (panic $ scopeNotFound (T.pack f) crName) $ + M.lookup f allParsedOrgs) + scopeFiles + let orgTop = Org "/" [] [] $ map (\(fn,o) -> o & orgTitle .~ fn) neededOrgs + withModifiers <- mergeClocks <$> applyMods crModifiers orgTop + let timelineParamsFinal = + (confBaseTimelineParams <> timelineParams) & tpColorSalt .~ confColorSalt + logDebug $ "Launching timeline report with params: " <> show timelineParamsFinal + fromto <- convertRange timelineRange + logDebug $ "Using range: " <> show fromto + res <- processTimeline timelineParamsFinal withModifiers fromto + logInfo $ "Generating report " <> crName <> "..." + writeReport reportDir (T.unpack crName) res + whenM (view wXdgOpen) $ do + logInfo "Opening reports using xdg-open..." + void $ shell ("for i in $(ls "<>T.pack reportDir<>"/*); do xdg-open $i; done") empty + where + applyMods mods o = case applyModifiers o mods of + Left k -> throwM k + Right r -> pure r + scopeNotFound scope report = + mconcat ["Scope ", scope, " is requested for config report ", + report, ", but is not present in scopes section"] + throwLogic = throwM . ConfigLogicException + getScope OrgStatConfig{..} scopeName reportName = + fromJustM (throwLogic $ scopeNotFound scopeName reportName) $ + pure $ find ((== scopeName) . csName) confScopes + getScopes (Timeline _ s _) = [s] + -- Reads needed org files and returns a map + parseNeededFiles :: OrgStatConfig -> WorkM (Map FilePath (Text, Org)) + parseNeededFiles conf@OrgStatConfig{..} = do + let neededScopes = + nubBy ((==) `on` snd) $ + concatMap (\cr -> map (crName cr,) $ getScopes (crType cr)) confReports + let availableScopes = map csName confScopes + let notAvailableScopes = filter (\(_,s) -> s `notElem` availableScopes) neededScopes + unless (null notAvailableScopes) $ do + let (r,s) = unsafeHead notAvailableScopes + throwLogic $ scopeNotFound s r + neededFiles <- + nub . concatMap (NE.toList . csPaths) <$> + mapM (\(r,s) -> getScope conf s r) neededScopes + fmap M.fromList $ forM neededFiles (\f -> (f,) <$> readOrgFile confTodoKeywords f) diff --git a/src/OrgStat/Parser.hs b/src/OrgStat/Parser.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Parser.hs @@ -0,0 +1,88 @@ +-- | Org-mode format parsing. + +module OrgStat.Parser + ( ParsingException (..) + , parseOrg + , runParser + ) where + +import Control.Exception (Exception) +import qualified Data.Attoparsec.Text as A +import qualified Data.OrgMode.Parse as OP +import qualified Data.Text as T +import Data.Time (LocalTime (..), TimeOfDay (..), fromGregorian) +import Data.Time.Calendar () +import Universum + +import OrgStat.Ast (Clock (..), Org (..)) + +---------------------------------------------------------------------------- +-- Exceptions +---------------------------------------------------------------------------- + +data ParsingException = + ParsingException Text + deriving (Show, Typeable) + +instance Exception ParsingException + +---------------------------------------------------------------------------- +-- Parsing +---------------------------------------------------------------------------- + +parseOrg :: [Text] -> A.Parser Org +parseOrg todoKeywords = convertDocument <$> OP.parseDocument todoKeywords + where + convertDocument :: OP.Document -> Org + convertDocument (OP.Document _ headings) = Org + { _orgTitle = "" + , _orgTags = [] + , _orgClocks = [] + , _orgSubtrees = map convertHeading headings + } + + convertHeading :: OP.Heading -> Org + convertHeading heading = Org + { _orgTitle = OP.title heading + , _orgTags = OP.tags heading + , _orgClocks = getClocks $ OP.section heading + , _orgSubtrees = map convertHeading $ OP.subHeadings heading + } + + mapEither :: (a -> Either e b) -> ([a] -> [b]) + mapEither f xs = rights $ map f xs + + getClocks :: OP.Section -> [Clock] + getClocks section = + mapMaybe convertClock $ concat + [ OP.sectionClocks section + , mapEither (A.parseOnly OP.parseClock) $ + lines $ + OP.sectionParagraph section + ] + + -- convert clocks from orgmode-parse format, returns Nothing for clocks + -- without end time or time-of-day + convertClock :: (Maybe OP.Timestamp, Maybe OP.Duration) -> Maybe Clock + convertClock (Just (OP.Timestamp start _active (Just end)), _duration) = + Clock <$> convertDateTime start <*> convertDateTime end + convertClock _ = Nothing + + -- Nothing for DateTime without time-of-day + convertDateTime :: OP.DateTime -> Maybe LocalTime + convertDateTime + OP.DateTime + { yearMonthDay = OP.YMD' (OP.YearMonthDay year month day) + , hourMinute = Just (hour, minute) + } + = Just $ LocalTime + (fromGregorian (toInteger year) month day) + (TimeOfDay hour minute 0) + convertDateTime _ = Nothing + +-- Throw parsing exception if it can't be parsed (use Control.Monad.Catch#throwM) +runParser :: (MonadThrow m) => [Text] -> Text -> m Org +runParser todoKeywords t = + case A.parseOnly (parseOrg todoKeywords) t of + Left err -> throwM $ ParsingException $ T.pack err + Right res -> pure res diff --git a/src/OrgStat/Report.hs b/src/OrgStat/Report.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Report.hs @@ -0,0 +1,9 @@ +-- | Re-exporting report functionality + +module OrgStat.Report + ( module Exports + ) where + +import OrgStat.Report.Class as Exports +import OrgStat.Report.Timeline as Exports +import OrgStat.Report.Types as Exports diff --git a/src/OrgStat/Report/Class.hs b/src/OrgStat/Report/Class.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Report/Class.hs @@ -0,0 +1,23 @@ +-- | Common things among reports + +module OrgStat.Report.Class + ( Report (..) + ) where + +import qualified Diagrams.Backend.SVG as DB +import qualified Diagrams.Prelude as D +import System.FilePath (replaceExtension, ()) +import Universum + +import OrgStat.Report.Types (SVGImageReport (..)) + +-- | Things that reporters output an what we can do with them. +class Report a where + -- | Writes report to the disk, given directory and filename. + writeReport :: (MonadIO m) => FilePath -> FilePath -> a -> m () + +instance Report SVGImageReport where + writeReport dir filename (SVGImage diagram) = + liftIO $ DB.renderSVG (replaceExtension (dir filename) "svg") size diagram + where + size = D.dims2D (D.width diagram) (D.height diagram) diff --git a/src/OrgStat/Report/Timeline.hs b/src/OrgStat/Report/Timeline.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Report/Timeline.hs @@ -0,0 +1,315 @@ +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} + +-- | Timeline reporting. Prouces a svg with columns. + +module OrgStat.Report.Timeline + ( TimelineParams (..) + , tpColorSalt + , tpLegend + , tpTopDay + , tpColumnWidth + , tpColumnHeight + , tpBackground + + , processTimeline + ) where + +import Control.Lens (makeLenses) +import Data.Colour.CIE (luminance) +import Data.Default (Default (..)) +import Data.List (lookup, nub) +import qualified Data.Text as T +import Data.Time (Day, DiffTime, LocalTime (..), defaultTimeLocale, + formatTime, timeOfDayToTime) +import Diagrams.Backend.SVG (B) +import qualified Diagrams.Prelude as D +import qualified Prelude +import Text.Printf (printf) +import Universum + +import OrgStat.Ast (Clock (..), Org (..)) +import OrgStat.Report.Types (SVGImageReport (..)) +import OrgStat.Util (addLocalTime, hashColour) + + +---------------------------------------------------------------------------- +-- Parameters +---------------------------------------------------------------------------- + +data TimelineParams = TimelineParams + { _tpColorSalt :: !Int + -- ^ Salt added when getting color out of task name. + , _tpLegend :: !Bool + -- ^ Include map legend? + , _tpTopDay :: !Int + -- ^ How many items to include in top day (under column) + , _tpColumnWidth :: !Double + -- ^ Column width in percent + , _tpColumnHeight :: !Double + -- ^ Column height + , _tpBackground :: !(D.Colour Double) + -- ^ Color of background + } deriving (Show) + +instance Default TimelineParams where + def = TimelineParams 0 True 5 1 1 (D.sRGB24 0xf2 0xf2 0xf2) + +makeLenses ''TimelineParams + +-- | For all non-default field values of RHS, override LHS with them. +mergeParams :: TimelineParams -> TimelineParams -> TimelineParams +mergeParams lhs rhs = mods lhs + where + mods = foldr1 (.) + [ asId tpColorSalt + , asId tpLegend + , asId tpTopDay + , asId tpColumnWidth + , asId tpColumnHeight + , asId tpBackground ] + asId :: forall b. (Eq b) => Lens' TimelineParams b -> TimelineParams -> TimelineParams + asId l x = + if def ^. l == rhs ^. l + then x else x & l .~ (rhs ^. l) + +instance Monoid TimelineParams where + mempty = def + mappend = mergeParams + +---------------------------------------------------------------------------- +-- Processing clocks +---------------------------------------------------------------------------- + +-- [(a, [b])] -> [(a, b)] +allClocks :: [(Text, [(DiffTime, DiffTime)])] -> [(Text, (DiffTime, DiffTime))] +allClocks tasks = do + (label, clocks) <- tasks + clock <- clocks + pure (label, clock) + +-- separate list for each day +selectDays :: [Day] -> [(Text, [Clock])] -> [[(Text, [(DiffTime, DiffTime)])]] +selectDays days tasks = + foreach days $ \day -> + filter (not . null . snd) $ + map (second (selectDay day)) tasks + where + selectDay :: Day -> [Clock] -> [(DiffTime, DiffTime)] + selectDay day clocks = do + Clock (LocalTime dFrom tFrom) (LocalTime dTo tTo) <- clocks + guard $ any (== day) [dFrom, dTo] + let tFrom' = if dFrom == day then timeOfDayToTime tFrom else fromInteger 0 + let tTo' = if dTo == day then timeOfDayToTime tTo else fromInteger (24*60*60) + pure (tFrom', tTo') + +-- total time for each task +totalTimes :: [(Text, [(DiffTime, DiffTime)])] -> [(Text, DiffTime)] +totalTimes tasks = map (second clocksSum) tasks + where + clocksSum :: [(DiffTime, DiffTime)] -> DiffTime + clocksSum clocks = sum $ map (\(start, end) -> end - start) clocks + +-- list of leaves +orgToList :: Org -> [(Text, [Clock])] +orgToList = orgToList' "" + where + orgToList' :: Text -> Org -> [(Text, [Clock])] + orgToList' _pr org = + --let path = pr <> "/" <> _orgTitle org + let path = _orgTitle org + in (path, _orgClocks org) : concatMap (orgToList' path) (_orgSubtrees org) + + +---------------------------------------------------------------------------- +-- Drawing +---------------------------------------------------------------------------- + + +diffTimeSeconds :: DiffTime -> Integer +diffTimeSeconds time = floor $ toRational time + +diffTimeMinutes :: DiffTime -> Integer +diffTimeMinutes time = diffTimeSeconds time `div` 60 + +-- diffTimeHours :: DiffTime -> Integer +-- diffTimeHours time = diffTimeMinutes time `div` 60 + + +labelColour :: TimelineParams -> Text -> D.Colour Double +labelColour params _label = hashColour (params ^. tpColorSalt) _label + +-- | Returns if the label is to be shown. Second param is font-related +-- heuristic constant, third is length of interval. +fitLabelHeight :: TimelineParams -> Double -> Double -> Bool +fitLabelHeight params n h = h >= (params ^. tpColumnHeight) * n + +-- | Decides by , width of column +-- and string, should it be truncated. And returns modified string. +fitLabelWidth :: TimelineParams -> Double -> Text -> Text +fitLabelWidth params n s = + if T.length s <= toTake then s else T.take toTake s <> ".." + where + toTake = floor $ n * ((params ^. tpColumnWidth) ** 1.2) + +-- timeline for a single day +timelineDay :: TimelineParams -> Day -> [(Text, (DiffTime, DiffTime))] -> D.Diagram B +timelineDay params day clocks = + (D.strutY 5 D.===) $ + (dateLabel D.===) $ + D.scaleUToY height $ + (timeticks D.|||) $ + mconcat + [ mconcat (map showClock clocks) + , background + ] + where + width = 140 * (totalHeight / height) * (params ^. tpColumnWidth) + ticksWidth = 20 * (totalHeight / height) + height = 700 * (params ^. tpColumnHeight) + + totalHeight :: Double + totalHeight = 24*60 + + timeticks :: D.Diagram B + timeticks = + mconcat $ + foreach [(0::Int)..23] $ \hour -> + mconcat + [ D.alignedText 0.5 1 (show hour) + & D.font "DejaVu Sans" + & D.fontSize 8 + & D.moveTo (D.p2 (0, -5)) + , D.rect ticksWidth 1 + & D.lw D.none + ] + & D.fc (D.sRGB24 150 150 150) + & D.moveTo (D.p2 (0, totalHeight - fromIntegral hour * 60)) + + dateLabel :: D.Diagram B + dateLabel = + mconcat + [ D.strutY 20 + , D.alignedText 0 0.65 (formatTime defaultTimeLocale "%a, %d.%m.%Y" day) + & D.font "DejaVu Sans" + & D.fontSize 12 + & D.moveTo (D.p2 (25, 0)) + ] + + background :: D.Diagram B + background = + D.rect width totalHeight + & D.lw D.none + & D.fc (params ^. tpBackground) + & D.moveOriginTo (D.p2 (-width/2, totalHeight/2)) + & D.moveTo (D.p2 (0, totalHeight)) + + contrastFrom c = if luminance c < 0.14 then D.sRGB24 224 224 224 else D.black + + showClock :: (Text, (DiffTime, DiffTime)) -> D.Diagram B + showClock (label, (start, end)) = + let + w = width + h = fromInteger $ diffTimeMinutes $ end - start + bgboxColour = labelColour params label + bgbox = D.rect w h + & D.lw D.none + & D.fc bgboxColour + label' = D.alignedText 0 0.5 (T.unpack $ fitLabelWidth params 21 label) + & D.font "DejaVu Sans" + & D.fontSize 10 + & D.fc (contrastFrom bgboxColour) + & D.moveTo (D.p2 (-w/2+10, 0)) + box = mconcat $ bool [] [label'] (fitLabelHeight params 14 h) ++ [bgbox] + in box & D.moveOriginTo (D.p2 (-w/2, h/2)) + & D.moveTo (D.p2 (0, totalHeight - fromInteger (diffTimeMinutes start))) +-- timelines for several days, with top lists +timelineDays + :: TimelineParams + -> [Day] + -> [[(Text, (DiffTime, DiffTime))]] + -> [[(Text, DiffTime)]] + -> D.Diagram B +timelineDays params days clocks topLists = + D.hcat $ + foreach (days `zip` (clocks `zip` topLists)) $ \(day, (dayClocks, topList)) -> + D.vsep 5 + [ timelineDay params day dayClocks + , taskList params topList True + ] + +-- task list, with durations and colours +taskList :: TimelineParams -> [(Text, DiffTime)] -> Bool -> D.Diagram B +taskList params labels fit = D.vsep 5 $ map oneTask $ reverse $ sortOn snd labels + where + oneTask :: (Text, DiffTime) -> D.Diagram B + oneTask (label, time) = + D.hsep 3 + [ D.alignedText 1 0.5 (showTime time) + & D.font "DejaVu Sans" + & D.fontSize 10 + & D.translateX 30 + , D.rect 12 12 + & D.fc (labelColour params label) + & D.lw D.none + , D.alignedText 0 0.5 (T.unpack $ bool label (fitLabelWidth params 18 label) fit) + & D.font "DejaVu Sans" + & D.fontSize 10 + ] + + showTime :: DiffTime -> Prelude.String + showTime time = printf "%d:%02d" hours minutes + where + (hours, minutes) = diffTimeMinutes time `divMod` 60 + +timelineReport :: TimelineParams -> Org -> (LocalTime, LocalTime) -> SVGImageReport +timelineReport params org (from,to) = SVGImage pic + where + lookupDef :: Eq a => b -> a -> [(a, b)] -> b + lookupDef d a xs = fromMaybe d $ lookup a xs + + -- period to show. Right border is -1min, we assume it's non-inclusive + daysToShow = [localDay from .. + localDay ((negate 120 :: Int) `addLocalTime` to)] + + -- unfiltered leaves + tasks :: [(Text, [Clock])] + tasks = orgToList org + + -- tasks from the given period, split by days + byDay :: [[(Text, [(DiffTime, DiffTime)])]] + byDay = selectDays daysToShow tasks + + -- total durations for each task, split by days + byDayDurations :: [[(Text, DiffTime)]] + byDayDurations = map totalTimes byDay + + -- total durations for the whole period + allDaysDurations :: [(Text, DiffTime)] + allDaysDurations = + let allTasks = nub $ map fst $ concat byDayDurations in + foreach allTasks $ \task -> + (task,) $ sum $ foreach byDayDurations $ \durations -> + lookupDef (fromInteger 0) task durations + + -- split clocks + clocks :: [[(Text, (DiffTime, DiffTime))]] + clocks = map allClocks byDay + + -- top list for each day + topLists :: [[(Text, DiffTime)]] + topLists = + map (take (params ^. tpTopDay) . reverse . sortOn (\(_task, time) -> time)) + byDayDurations + + optLegend | params ^. tpLegend = [taskList params allDaysDurations False] + | otherwise = [] + + pic = + D.vsep 30 $ [ timelineDays params daysToShow clocks topLists ] ++ optLegend + +processTimeline + :: (MonadThrow m) + => TimelineParams -> Org -> (LocalTime, LocalTime) -> m SVGImageReport +processTimeline params org fromto = pure $ timelineReport params org fromto diff --git a/src/OrgStat/Report/Types.hs b/src/OrgStat/Report/Types.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Report/Types.hs @@ -0,0 +1,13 @@ +-- | Types common among reports. + +module OrgStat.Report.Types + ( SVGImageReport (..) + ) where + +import Diagrams.Backend.SVG (B) +import qualified Diagrams.Prelude as D + +-- Also thing to think about is how we output settings (time ranges +-- etc.) -- on the plot, in the corner, in the file name, as a +-- description file ? +data SVGImageReport = SVGImage (D.Diagram B) diff --git a/src/OrgStat/Scope.hs b/src/OrgStat/Scope.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Scope.hs @@ -0,0 +1,116 @@ +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} + +-- | This module defines how report input is formed. + +module OrgStat.Scope + ( AstPath (..) + , isSubPath + , existsPath + , ScopeModifier (..) + , applyModifiers + ) where + +import qualified Base as Base +import Control.Lens (to) +import Control.Monad.Except (throwError) +import qualified Data.Text as T +import Universum + +import OrgStat.Ast (Org, atDepth, orgClocks, orgSubtrees, orgTitle, + traverseTree) + +-- | Path in org AST is just a list of paths, head ~ closer to tree +-- root. +newtype AstPath = AstPath + { getAstPath :: [Text] + } deriving (Eq, Ord) + +instance Base.Show AstPath where + show (AstPath path) + | null path = "" + | otherwise = intercalate "/" (map T.unpack path) + +isSubPath :: AstPath -> AstPath -> Bool +isSubPath (AstPath l1) (AstPath l2) = l1 `isPrefixOf` l2 + +-- | Lens to a org node at path. +atPath :: AstPath -> Lens' Org (Maybe Org) +atPath (AstPath []) f o = fromMaybe o <$> f (Just o) +atPath (AstPath p) f o = atPathDo p o + where + atPathDo [] org = f Nothing $> org + atPathDo (x:xs) org = + let match = find ((== x) . view orgTitle) $ org ^. orgSubtrees + modified foo = org & orgSubtrees %~ foo . filter ((/= match) . Just) + fmapFoo Nothing = modified identity + fmapFoo (Just o') = modified (o' :) + in case (xs,match) of + (_,Nothing) -> f Nothing $> org + ([],_) -> fmap fmapFoo $ f match + (cont,Just m) -> fmap (\new -> modified (new:)) $ atPathDo cont m + +-- | Checks if something is on that path in given 'Org'. +existsPath :: AstPath -> Org -> Bool +existsPath p o = o ^. atPath p . to isJust + +-- | Modificicators of org tree. They remove some subtrees +data ScopeModifier + = ModPruneSubtree AstPath Int + -- ^ Turns all subtrees starting with @path@ and then on depth @d@ into leaves. + | ModFilterTag Text + -- ^ Given text tag name, it leaves only those subtrees that + -- have this tag (tags inherit). + | ModSquash AstPath + -- ^ Starting at node on path A and depth n, turn A into set of + -- nodes A/a1/a2/.../an. Doesn't work/make sense for empty path. + | ModSelectSubtree AstPath + -- ^ Leaves only node at @path@, deletes all other subtrees. + deriving (Show,Eq,Ord) + +-- | Errors related to modifiers application +data ModifierError + = MEConflicting ScopeModifier ScopeModifier Text + -- ^ Modifiers can't be applied together (del/sel) + | MEWrongParam ScopeModifier Text + -- ^ Modifier doesn't support this parameter + deriving (Show,Typeable) + +instance Exception ModifierError + +-- | Applies modifier to org tree +applyModifier :: ScopeModifier -> Org -> Either ModifierError Org +applyModifier m@(ModPruneSubtree path depth) org = do + unless (depth >= 0) $ throwError $ MEWrongParam m "Depth should be >= 0" + unless (existsPath path org) $ + throwError $ MEWrongParam m $ "Path " <> show path <> " doesn't exist" + let subclocks o' = o' & orgClocks .~ (concatMap (view orgClocks) $ o' ^.. traverseTree) + & orgSubtrees .~ [] + let pruneChildren o = o & atDepth depth %~ subclocks + pure $ org & atPath path %~ (\x -> maybe x (Just . pruneChildren) x) +applyModifier m@(ModSelectSubtree path) org = do + unless (existsPath path org) $ + throwError $ MEWrongParam m $ "Path " <> show path <> " doesn't exist" + pure $ + fromMaybe (panic "applyModifier@ModSelectSubtree is broken") $ + org ^. atPath path +applyModifier _ org = pure org -- TODO + +-- | Generates an org to be processed by report generators from 'Scope'. +applyModifiers :: Org -> [ScopeModifier] -> Either ModifierError Org +applyModifiers org s = do +-- whenList addDelConflicts $ \(m1,m2) -> +-- throwError $ MEConflicting m1 m2 "Path of first modifier is subpath of second one" + foldrM applyModifier org mods + where +-- whenList ls foo = case ls of +-- [] -> pass +-- (h:_) -> foo h +-- addDelConflicts = +-- let addDelConflict (ModPruneSubtree a _) (ModSelectSubtree b) = a `isSubPath` b +-- addDelConflict _ _ = False +-- in filter (uncurry addDelConflict) modsPairs +-- modsPairs = [(a,b) | a <- mods, b <- mods, a < b] + mods = sort s diff --git a/src/OrgStat/Util.hs b/src/OrgStat/Util.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/Util.hs @@ -0,0 +1,84 @@ +{-# LANGUAGE RankNTypes #-} +-- | Different utilities + +module OrgStat.Util + ( dropLowerOptions + , dropEnd + , addLocalTime + , fromJustM + , parseColour + , hashColour + , (??~) + ) where + +import Control.Lens (ASetter, ix) +import Data.Aeson.TH (defaultOptions) +import Data.Aeson.Types (Options, fieldLabelModifier) +import Data.Char (isLower, toLower) +import Data.Colour (Colour) +import Data.Colour.CIE (luminance) +import Data.Colour.SRGB (RGB (..), sRGB24, toSRGBBounded) +import Data.Hashable (hashWithSalt) +import Data.List (nub) +import Data.List ((!!)) +import Data.Time (LocalTime (..), addUTCTime, localTimeToUTC, utc, + utcToLocalTime) +import Universum + +-- | JSON/Yaml TH modifier. Each field of type "aoeuKek" turns into +-- "kek". Placed here because it can't be defined near json TH +-- deriving (ghc restriction). +dropLowerOptions :: Options +dropLowerOptions = + defaultOptions + { fieldLabelModifier = \x -> (dropWhile isLower x) & ix 0 %~ toLower + } + +fromJustM :: Monad m => m b -> m (Maybe b) -> m b +fromJustM e m = maybe e pure =<< m + +-- | Drops n items from the end. +dropEnd :: Int -> [x] -> [x] +dropEnd n xs = take (length xs - n) xs + +-- | Same as 'addUTCTime', but for local +addLocalTime :: (Integral n) => n -> LocalTime -> LocalTime +addLocalTime n a = + utcToLocalTime utc $ fromIntegral n `addUTCTime` localTimeToUTC utc a + +-- | Parses colour from format '#rrggbb' or just 'rrggbb' +parseColour :: forall s a. (ToString s, Floating a, Ord a) => s -> Maybe (Colour a) +parseColour (toString -> s) = toColour $ dropWhile (== '#') s + where + toColour [r1,r2,g1,g2,b1,b2] = do + r <- toWord8 r1 r2 + g <- toWord8 g1 g2 + b <- toWord8 b1 b2 + pure $ sRGB24 r g b + toColour _ = Nothing + toWord8 a b = readMaybe $ "0x"++[a,b] + +-- | Generates a colour given salt and anything hashable. Doesn't return +-- too dark or too light colors. +hashColour :: (Hashable a) => Int -> a -> Colour Double +hashColour salt item = colours !! (hashWithSalt salt item `mod` length colours) + where + broken = panic "Util#hashColour is broken" + range = [-5,0,5] + colours = filter (\c -> luminance c < 0.8 && luminance c > 0.06) mutate + ac :: Word8 -> Integer -> Word8 + ac a b = fromIntegral $ (fromIntegral a) + b `mod` 255 + mutate = nub $ concatMap + (\(r,g,b) -> [sRGB24 (r `ac` i) (g `ac` j) (b `ac` k) + | i <- range, j <- range, k <- range]) + coloursBasic + coloursBasic = + map (toTriple . fromMaybe broken . parseColour @[Char] @Double) popularColours + toTriple c = let RGB{..} = toSRGBBounded c in (channelRed, channelGreen, channelBlue) + popularColours :: [[Char]] + popularColours = ["00FF00","01FFFE","FFA6FE","FFDB66","006401","010067","95003A","007DB5","FF00F6","FFEEE8","774D00","90FB92","0076FF","D5FF00","FF937E","6A826C","FF029D","FE8900","7A4782","7E2DD2","85A900","FF0056","A42400","00AE7E","683D3B","BDC6FF","263400","BDD393","00B917","9E008E","001544","C28C9F","FF74A3","01D0FF","004754","E56FFE","788231","0E4CA1","91D0CB","BE9970","968AE8","BB8800","43002C","DEFF74","00FFC6","FFE502","620E00","008F9C","98FF52","7544B1","B500FF","00FF78","FF6E41","005F39","6B6882","5FAD4E","A75740","A5FFD2","FFB167","009BFF","E85EBE"]; + +-- | Maybe setter that does nothing on Nothing. +(??~) :: ASetter s s a b -> Maybe b -> s -> s +(??~) _ Nothing = identity +(??~) l (Just k) = l .~ k diff --git a/src/OrgStat/WorkMonad.hs b/src/OrgStat/WorkMonad.hs new file mode 100644 --- /dev/null +++ b/src/OrgStat/WorkMonad.hs @@ -0,0 +1,34 @@ +{-# LANGUAGE TemplateHaskell #-} + +-- | Definition for main work scope + +module OrgStat.WorkMonad + ( WorkScope (..) + , wConfigFile + , wXdgOpen + , WorkM (..) + , runWorkM + ) where + +import Control.Lens (makeLenses) +import qualified System.Wlog as W +import Universum + +data WorkScope = WorkScope + { _wConfigFile :: FilePath + , _wXdgOpen :: Bool + } + +makeLenses ''WorkScope + +newtype WorkM a = WorkM + { getWorkM :: ReaderT WorkScope IO a + } deriving (Functor, Applicative, Monad, MonadIO, MonadReader WorkScope, + W.CanLog, MonadThrow, MonadCatch) + +instance W.HasLoggerName WorkM where + getLoggerName = pure $ W.LoggerName "OrgStat" + modifyLoggerName _ = identity + +runWorkM :: MonadIO m => WorkScope -> WorkM a -> m a +runWorkM scope action = liftIO $ runReaderT (getWorkM action) scope diff --git a/src/cli/Main.hs b/src/cli/Main.hs new file mode 100644 --- /dev/null +++ b/src/cli/Main.hs @@ -0,0 +1,57 @@ +{-# LANGUAGE ScopedTypeVariables #-} + +module Main where + +import Control.Monad.Catch (catch) +import Data.Version (showVersion) +import Options.Applicative.Simple (Parser, help, long, metavar, simpleOptions, + strOption, switch, value) +import Paths_orgstat (version) +import System.Directory (getHomeDirectory) +import System.FilePath (()) +import System.Wlog (LoggingFormat (..), logDebug, logError) +import qualified System.Wlog as W +import Universum + +import OrgStat.Logic (runOrgStat) +import OrgStat.WorkMonad (WorkScope (..), runWorkM) + +data Args = Args + { configPath :: !FilePath + -- ^ Path to configuration file. + , xdgOpen :: Bool + -- ^ Open report types using xdg-open + , debug :: Bool + -- ^ Enable debug logging + } deriving Show + +argsParser :: FilePath -> Parser Args +argsParser homeDir = + Args <$> + strOption + (long "conf-path" <> metavar "FILEPATH" <> value (homeDir ".orgstat.yaml") <> + help "Path to the configuration file") <*> + switch (long "xdg-open" <> help "Open each report using xdg-open") <*> + switch (long "debug" <> help "Enable debug logging") + +getNodeOptions :: FilePath -> IO Args +getNodeOptions homeDir = do + (res, ()) <- + simpleOptions + ("orgstat-" <> showVersion version) + "----- OrgStat ------" + "Statistic reports visualizer for org-mode" + (argsParser homeDir) + empty + pure res + +main :: IO () +main = do + args@Args{..} <- getNodeOptions =<< getHomeDirectory + W.initLoggingWith (LoggingFormat False) (if debug then W.Debug else W.Info) + runWorkM (WorkScope configPath xdgOpen) $ do + logDebug $ "Just started with options: " <> show args + runOrgStat `catch` topHandler + where + topHandler (e :: SomeException) = do + logError $ "Top level error occured: " <> show e diff --git a/test/GlobalSpec.hs b/test/GlobalSpec.hs new file mode 100644 --- /dev/null +++ b/test/GlobalSpec.hs @@ -0,0 +1,153 @@ +{-# LANGUAGE ScopedTypeVariables #-} + +module GlobalSpec (spec) where + +import Control.Lens (to) +import Data.Colour.SRGB (sRGB24show) +import qualified Data.Text as T +import Data.Text.Arbitrary () +import Data.Time (LocalTime (..), TimeOfDay (..), getZonedTime, + zonedTimeToLocalTime) +import Data.Time.Calendar (addGregorianMonthsRollOver, fromGregorian) +import Test.Hspec (Spec, describe, runIO) +import Test.Hspec.QuickCheck (prop) +import Test.QuickCheck (Arbitrary (arbitrary), Gen, NonNegative (..), + Positive (..), Small (..), choose, forAll, + ioProperty, oneof, (.&&.), (===), (==>)) +import Universum +import Unsafe (unsafeTail) + +import OrgStat.Ast (Clock (..), Org (..), atDepth, mergeClocks, + orgClocks) +import OrgStat.Config (ConfDate (..), ConfRange (..)) +import OrgStat.Logic (convertRange) +import OrgStat.Util (addLocalTime, parseColour) + + +spec :: Spec +spec = do + astSpec + parseColourSpec + convertRangeSpec + +---------------------------------------------------------------------------- +-- AST +---------------------------------------------------------------------------- + +instance Arbitrary LocalTime where + arbitrary = do + d <- choose (1, 28) + m <- choose (1, 12) + y <- choose (2015, 2016) + todHour <- choose (0, 23) + todMin <- choose (0, 59) + todSec <- fromIntegral <$> (choose (0, 60) :: Gen Int) + return $ LocalTime (fromGregorian y m d) TimeOfDay{..} + +instance Arbitrary Clock where + arbitrary = do + [a,b] <- replicateM 2 arbitrary + pure . (uncurry Clock) $ if a < b then (a,b) else (b,a) + +genOrgDepth :: Int -> Gen Org +genOrgDepth n = do + childrenN <- choose (1,2) + clock <- arbitrary + name <- T.take 10 <$> arbitrary + children <- + if n == 0 + then pure [] + else replicateM childrenN (genOrgDepth $ n - 1) + pure $ Org name [] [clock] children + +instance Arbitrary Org where + arbitrary = genOrgDepth 5 + +newtype OrgWrapper = OrgWrapper Org deriving Show + +-- Generates an org file with almost-fitting intervals that should be +-- merged in one +contOrg :: Int -> Int -> Gen Org +contOrg dfrom dto = do + (Positive i) <- arbitrary + (checkpoints :: [LocalTime]) <- sort <$> replicateM (i+1) arbitrary + pairs <- forM (checkpoints `zip` unsafeTail checkpoints) $ \(c,c') -> do + delta <- choose (dfrom,dto) + pure (c, negate delta `addLocalTime` c') + let clocks = map (uncurry Clock) pairs + pure $ Org "ShouldHaveOneSubclock" [] clocks [] + +astSpec :: Spec +astSpec = do + describe "Ast#mergeClocks" $ do + prop "merges a set of clocks when needed into one" $ + forAll (contOrg 0 90) $ \o -> + mergeClocks o ^. orgClocks . to length === 1 + prop "doesn't modify big deltas" $ + forAll (contOrg 120 240) $ \o -> mergeClocks o === o + describe "Ast#lenses" $ do + prop "atDepth 0 is always the same" $ + forAll arbitrary $ \o -> o ^.. atDepth 0 === [o] + prop "atDepth i for i-tree is not empty" $ + forAll arbitrary $ \(Positive (Small i)) -> + forAll (genOrgDepth i) $ \o -> + i < 10 ==> (o ^.. atDepth i /= []) + prop "atDepth (i+1) for i-tree is empty" $ + forAll arbitrary $ \(Positive (Small i)) -> + forAll (genOrgDepth i) $ \o -> + i < 10 ==> (o ^.. atDepth (i+1) === []) + +---------------------------------------------------------------------------- +-- Ranges +---------------------------------------------------------------------------- + +convertRangeSpec :: Spec +convertRangeSpec = describe "Logic#convertRange" $ do + curTime <- runIO $ zonedTimeToLocalTime <$> getZonedTime + let subDays a i = (negate i * 60 * 60 * 24) `addLocalTime` a + let subWeeks a i = (negate i * 60 * 60 * 24 * 7) `addLocalTime` a + let subMonths a i = a { localDay = (negate i) `addGregorianMonthsRollOver` (localDay a) } + let inRange c (a,b) = c >= a && c <= b + let convert = liftIO . convertRange + prop "(now-1h, now) is correctly parsed" $ + forAll arbitrary $ \(Positive (Small (i :: Integer))) -> + let hourAgo = (negate i * 60 * 60) `addLocalTime` curTime + in ioProperty (inRange curTime <$> convert (ConfFromTo (ConfLocal hourAgo) ConfNow)) + prop "Today -N days is exactly in day-N range" $ + forAll arbitrary $ \(NonNegative (Small i)) -> + ioProperty (inRange (subDays curTime i) <$> convert (ConfBlockDay i)) .&&. + ioProperty (not . inRange (subDays curTime $ i+1) <$> convert (ConfBlockDay i)) .&&. + ioProperty (not . inRange (subDays curTime $ i) <$> convert (ConfBlockDay $ i+1)) + prop "Today -N weeks is exactly in week-N range" $ + forAll arbitrary $ \(NonNegative (Small i)) -> + ioProperty (inRange (subWeeks curTime i) <$> convert (ConfBlockWeek i)) .&&. + ioProperty (not . inRange (subWeeks curTime $ i+1) <$> convert (ConfBlockWeek i)) .&&. + ioProperty (not . inRange (subWeeks curTime $ i) <$> convert (ConfBlockWeek $ i+1)) + prop "Today -N months is excatly in month-N range" $ + forAll arbitrary $ \(NonNegative (Small i)) -> + ioProperty (inRange (subMonths curTime i) <$> convert (ConfBlockMonth i)) .&&. + ioProperty (not . inRange (subMonths curTime $ i+1) <$> convert (ConfBlockMonth i)) .&&. + ioProperty (not . inRange (subMonths curTime i) <$> convert (ConfBlockMonth $ i+1)) + + +---------------------------------------------------------------------------- +-- Utils +---------------------------------------------------------------------------- + +newtype ColorWrapper = ColorWrapper Text deriving Show + +instance Arbitrary ColorWrapper where + arbitrary = do + nums <- replicateM 6 $ oneof $ map pure "0123456789abcdef" + pref <- oneof $ map pure ["#", mempty] + pure $ ColorWrapper $ pref <> T.pack nums + +parseColourSpec :: Spec +parseColourSpec = describe "Util#parseColour" $ do + prop "Doesn't fail on correct inputs" $ + forAll arbitrary $ \(ColorWrapper s) -> + let s' = T.unpack $ if "#" `T.isPrefixOf` s then s else "#" <> s + in (sRGB24show <$> (parseColour @Text @Double s)) === Just s' + prop "Fails on incorrect inputs" $ + forAll arbitrary $ \s -> + length s > 6 ==> (parseColour @Text @Double s) === Nothing diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover -optF --module-name=Spec #-} diff --git a/test/Test.hs b/test/Test.hs new file mode 100644 --- /dev/null +++ b/test/Test.hs @@ -0,0 +1,6 @@ +import Spec (spec) +import Test.Hspec (hspec) +import Universum + +main :: IO () +main = hspec spec