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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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/hakyll-shortcode.cabal b/hakyll-shortcode.cabal new file mode 100644 --- /dev/null +++ b/hakyll-shortcode.cabal @@ -0,0 +1,83 @@ +Name: hakyll-shortcode +Description: WordPress-style shortcodes for the Hakyll static site generator. +Version: 0.0.2 +Cabal-Version: >= 1.10 +License: GPL-3 +License-File: LICENSE +Author: Nathan Bloomfield +Maintainer: nbloomf@gmail.com +Synopsis: A shortcode extension module for Hakyll +Stability: Experimental +Build-Type: Simple +Category: Web + +Library + default-language: + Haskell2010 + hs-source-dirs: + src/ + exposed-modules: + Hakyll.Shortcode, + Hakyll.Shortcode.Service, + Hakyll.Shortcode.Types, + Hakyll.Shortcode.Render, + Hakyll.Shortcode.Service.Example + other-modules: + Hakyll.Shortcode.Parser, + Hakyll.Shortcode.Validate, + Hakyll.Shortcode.Service.YouTube, + Hakyll.Shortcode.Service.GeoGebra, + Hakyll.Shortcode.Service.Gravatar, + Hakyll.Shortcode.Types.CommaSep, + Hakyll.Shortcode.Types.Css_Class_Name, + Hakyll.Shortcode.Types.Domain_With_Scheme, + Hakyll.Shortcode.Types.Hex_Color_Code, + Hakyll.Shortcode.Types.Iso_639_1_Language_Code, + Hakyll.Shortcode.Types.Letters_Numbers, + Hakyll.Shortcode.Types.Letters_Numbers_Hyphens_Underscores, + Hakyll.Shortcode.Types.MD5_Digest, + Hakyll.Shortcode.Types.Natural_Number_Base_10, + Hakyll.Shortcode.Types.RFC_3986_Unreserved_Uri_Characters, + Hakyll.Shortcode.Types.YesNo + build-depends: + base >= 4.0 && < 5.0, + regex-posix, + MissingH >= 1.3.0.1 && < 2.0, + blaze-html >= 0.8.1.0 && < 1.0, + blaze-markup >= 0.7.0.2 && < 1.0, + parsec >= 3.1.9 && < 4.0, + network-uri >= 2.6.0.3 && < 3.0, + split >= 0.2.2 && < 1.0 + +Test-Suite hakyll-shortcode-test-suite + default-language: + Haskell2010 + type: + exitcode-stdio-1.0 + main-is: + Tests/Main.hs + hs-source-dirs: + test/, + src/ + ghc-options: + -main-is Tests.Main + -fforce-recomp + build-depends: + base >= 4.0 && < 5.0, + QuickCheck >= 2.6 && < 3.0, + tasty >= 0.10.1.2 && < 1.0, + tasty-quickcheck >= 0.8.3.2 && < 1.0, + tasty-hunit >= 0.9.2 && < 1.0, + regex-posix, + MissingH >= 1.3.0.1 && < 2.0, + blaze-html >= 0.8.1.0 && < 1.0, + blaze-markup >= 0.7.0.2 && < 1.0, + parsec >= 3.1.9 && < 4.0, + network-uri >= 2.6.0.3 && < 3.0, + split >= 0.2.2 && < 1.0 + +source-repository head + type: + git + location: + https://github.com/nbloomf/hakyll-shortcode diff --git a/src/Hakyll/Shortcode.hs b/src/Hakyll/Shortcode.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode.hs @@ -0,0 +1,59 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental + +This module provides a filter for Hakyll which expands WordPress-style shortcodes. To use it, include the line @>>= applyShortcodes allServices@ in your compiler. +-} + +module Hakyll.Shortcode ( + ShortcodeService(..), + expandShortcodes, + applyShortcodes, + allServices +) where + +import Hakyll.Shortcode.Service.GeoGebra +import Hakyll.Shortcode.Service.Gravatar +import Hakyll.Shortcode.Service.YouTube +import Hakyll.Shortcode.Service.Example + + +-- | A simple sum type representing the available shortcodes. +data ShortcodeService + = GeoGebra + | Gravatar + | YouTube + | Example + deriving Eq + + +-- Expand shortcodes of the provided type. +expandShortcodesFor :: ShortcodeService -> String -> String +expandShortcodesFor x = case x of + GeoGebra -> expandGeoGebraShortcodes + Gravatar -> expandGravatarShortcodes + YouTube -> expandYouTubeShortcodes + Example -> expandExampleShortcodes + + +-- | Expand shortcodes of each of the provided types. +expandShortcodes :: [ShortcodeService] -> String -> String +expandShortcodes = foldr1 (.) . map expandShortcodesFor + + +-- | Monadic version of 'expandShortcodes', for use with Hakyll. +applyShortcodes :: (Monad m, Functor f) + => [ShortcodeService] -> f String -> m (f String) +applyShortcodes svc text = + return $ (fmap $ expandShortcodes svc) text + + +-- | A list of all the available shortcodes (for convenience). +allServices :: [ShortcodeService] +allServices = + [ GeoGebra + , Gravatar + , YouTube + ] diff --git a/src/Hakyll/Shortcode/Parser.hs b/src/Hakyll/Shortcode/Parser.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Parser.hs @@ -0,0 +1,55 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Parser ( + shortcodeParser +) where + +import Text.ParserCombinators.Parsec + + +-- | Given a tag, parses strings of the form @

[tag key1='val1' ... keyN='valN']

@ into lists of @(keyI,valI)@ pairs. +shortcodeParser :: String -> Parser [(String, String)] +shortcodeParser tag = do + string "

[" + many $ char ' ' + string tag + many $ char ' ' + attributes <- sepBy (try keyvalParser) (many $ char ' ') + many $ char ' ' + string "]

" + return attributes + + +keyvalParser :: Parser (String, String) +keyvalParser = do + key <- many1 $ oneOf $ ['a'..'z'] ++ ['A'..'Z'] ++ ['-'] + char '=' + value <- quotedString + return (key, value) + + +quotedString :: Parser String +quotedString = foldl1 (<|>) + [ delimitedString '\'' '\'' + , delimitedString '"' '"' + , delimitedString '\x2018' '\x2019' -- handed single quotes + , delimitedString '\x201C' '\x201D' -- handed double quotes + ] + where + delimitedString :: Char -> Char -> Parser String + delimitedString open close = do + _ <- char open + t <- many $ choice + [ try $ noneOf [ close, '\\', '\n', ']' ] + , try $ string ['\\',close] >> return close + , try $ string "\\\\" >> return '\\' + , try $ string "\\n" >> return '\n' + , try $ string "\\]" >> return ']' + ] + _ <- char close + return t diff --git a/src/Hakyll/Shortcode/Render.hs b/src/Hakyll/Shortcode/Render.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Render.hs @@ -0,0 +1,177 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental + +Helper functions for constructing URLs and HTML fragments. +-} + +module Hakyll.Shortcode.Render ( + Scheme(..), + buildURL, + + QueryParameter(..), + queryValid, + queryOneOf, + queryYesNo, + + pathValid, + pathYesNo, + pathValidPre, + pathYesNoPre, + + attrValid +) where + +import Data.List (intercalate) +import Network.URI +import qualified Text.Blaze.Html5 as H +import Text.Blaze.Renderer.String () +import Data.Monoid + +import Hakyll.Shortcode.Types.YesNo + + +-- | Simple sum type representing URL schemes. +data Scheme + = HTTPS + +instance Show Scheme where + show HTTPS = "https" + + +-- | Helper function for safely building URLs. +buildURL + :: Scheme -- ^ The scheme + -> String -- ^ The domain (not including ://) + -> [String] -- ^ List of path components, to be separated by /. + -> [String] -- ^ List of query components, to be separated by &. + -> [String] -- ^ List of fragment components. + -> String +buildURL scheme auth path query frag = uriToString show uri "" + where + uri = URI + { uriScheme = show scheme ++ ":" + , uriAuthority = Just $ URIAuth + { uriUserInfo = "" + , uriRegName = auth + , uriPort = "" + } + , uriPath = buildPath path + , uriQuery = buildQuery query + , uriFragment = "" + } + + +{-------------------} +{- Query Fragments -} +{-------------------} + +sanitizeQuery :: String -> String +sanitizeQuery = escapeURIString encode + where + encode c = not $ (isReserved c) && (c /= '=') + +buildQuery :: [String] -> String +buildQuery ps = + let + qs = intercalate "&" + $ filter (/= "") + $ map sanitizeQuery + $ ps + in + if null qs + then "" + else '?' : qs + + +class QueryParameter t where + renderQueryParameter :: t -> String + + +-- | Helper function for rendering @Maybe@ 'OneOf' shortcode parameters as query parameters. +queryOneOf :: (QueryParameter t) + => Maybe t -- ^ The 'OneOf' parameter. + -> String +queryOneOf Nothing = "" +queryOneOf (Just x) = renderQueryParameter x + +-- | Helper function for rendering @Maybe@ 'Valid' shortcode parameters as query parameters. +queryValid :: (Show t) + => Maybe t -- ^ The 'Valid' parameter. + -> String -- ^ The parameter key. + -> String +queryValid Nothing _ = "" +queryValid (Just x) key = key ++ "=" ++ show x + +-- | Helper function for rendering @Maybe@ 'YesNo' shortcode parameters as query parameters. +queryYesNo + :: Maybe YesNo -- ^ The 'YesNo' parameter. + -> String -- ^ Parameter for the 'Yes' case. + -> String -- ^ Parameter for the 'No' case. + -> String +queryYesNo x yes no = case x of + Nothing -> "" + Just Yes -> yes + Just No -> no + + +{------------------} +{- Path Fragments -} +{------------------} + +sanitizePath :: String -> String +sanitizePath = escapeURIString encode + where + encode c = not $ isReserved c + +buildPath :: [String] -> String +buildPath = concatMap ('/':) . filter (/= "") . map sanitizePath + +-- | Helper function for rendering @Maybe@ 'Valid' parameters as path components. +pathValid :: (Show t) => Maybe t -> String +pathValid Nothing = "" +pathValid (Just x) = show x + +-- | Helper function for rendering @Maybe@ 'Valid' parameters as path components, with a prefix. +pathValidPre :: (Show t) + => String -- ^ The prefix path. + -> Maybe t -- ^ The 'Valid' parameter. + -> [String] +pathValidPre _ Nothing = [] +pathValidPre p (Just x) = [p, show x] + +-- | Helper function for rendering @Maybe@ 'YesNo' parameters as path components. +pathYesNo + :: Maybe YesNo -- ^ The 'YesNo' parameter. + -> String -- ^ Path for the 'Yes' case. + -> String -- ^ Path for the 'No' case. + -> String +pathYesNo x yes no = case x of + Nothing -> "" + Just Yes -> yes + Just No -> no + +-- | Helper function for rendering @Maybe@ 'YesNo' parameters as path components, with a prefix. +pathYesNoPre + :: String -- ^ The prefix path. + -> Maybe YesNo -- ^ The 'YesNo' parameter. + -> String -- ^ Path for the 'Yes' case. + -> String -- ^ Path for the 'No' case. + -> [String] +pathYesNoPre p x yes no = case x of + Nothing -> [] + Just Yes -> [p,yes] + Just No -> [p,no] + + +{--------------} +{- Attributes -} +{--------------} + +-- | Helper function for optionally rendering a @Maybe@ as an HTML attribute. +attrValid :: (Monoid a, Show b) => (H.AttributeValue -> a) -> Maybe b -> a +attrValid key Nothing = mempty +attrValid key (Just x) = key $ H.stringValue $ show x + diff --git a/src/Hakyll/Shortcode/Service.hs b/src/Hakyll/Shortcode/Service.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Service.hs @@ -0,0 +1,181 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE GADTs #-} + +module Hakyll.Shortcode.Service ( + Shortcode(..), + ShortcodeTag(ShortcodeTag), + ShortcodeAttribute(YesNo, OneOf, Valid), + expandShortcodes, + missingError +) where + +import Hakyll.Shortcode.Validate +import Hakyll.Shortcode.Parser +import Hakyll.Shortcode.Types.YesNo + +import Control.Monad (foldM) +import Data.List (intercalate) +import Data.List.Utils (replace) +import Text.ParserCombinators.Parsec +import Text.Regex.Posix + + + +{-----------------------} +{- The Shortcode Class -} +{-----------------------} + +-- | Class representing abstract shortcode types. +class Shortcode t where + -- | The tag for our shortcode. + tag :: ShortcodeTag t + + -- | The allowed keys for our shortcode. + attributes :: [ShortcodeAttribute t] + + -- | An empty shortcode instance. + emptycode :: t + + -- | Convert t to HTML. + embedcode :: t -> String + + +-- | Type representing the tag of a shortcode; such as @youtube@. +data ShortcodeTag a = ShortcodeTag + { unTag :: String + } deriving Show + + +-- | Type representing the allowed attributes of a shortcode. +-- These come in three forms: Yes\/No attributes, which are present or not; +-- Enumerated attributes, which take on one of a given list of values; +-- and Validated attributes, whose values are strings of a given form. +data ShortcodeAttribute t where + -- The key string and a mutator. + YesNo :: String -> (YesNo -> t -> t) -> ShortcodeAttribute t + + -- The key string and a list of value-mutator pairs. + OneOf :: String -> [(String, t -> t)] -> ShortcodeAttribute t + + -- The key string and a mutator taking a Validate type. + Valid :: (Validate a) => String -> (a -> t -> t) -> ShortcodeAttribute t + + + +-- Update t with a keyval pair +update :: (Shortcode t) => t -> (String, String) -> Either String t +update x kv = foldM (processKeyVal kv) x attributes + where + processKeyVal :: forall t. (Shortcode t) + => (String, String) -> t -> ShortcodeAttribute t -> Either String t + + processKeyVal (k,v) x (YesNo key f) + | key /= k = Right x + | otherwise = case v of + "yes" -> Right $ f Yes x + "no" -> Right $ f No x + _ -> Left $ typeError (unTag theTag) key v ["\"yes\"", "\"no\""] + where + theTag :: ShortcodeTag t + theTag = tag + + processKeyVal (k,v) x (OneOf key cases) + | key /= k = Right x + | otherwise = foo cases + where + foo [] = Left $ typeError (unTag theTag) key v $ map (show . fst) cases + foo ((val,f):cs) = if val /= v + then foo cs + else Right $ f x + + theTag :: ShortcodeTag t + theTag = tag + + processKeyVal (k,v) x (Valid key f) + | key /= k = Right x + | otherwise = case validate v of + Right z -> return $ f z x + Left er -> Left $ validateError (unTag theTag) k v er + where + theTag :: ShortcodeTag t + theTag = tag + + + +{------------------------} +{- Expanding Shortcodes -} +{------------------------} + +-- | Generic shortcode expansion. This function almost certainly +-- should not be called directly unless you are implementing a new +-- shortcode. +expandShortcodes :: (Shortcode t) => t -> String -> String +expandShortcodes x text = foldr (expandOne x) text matches + where + matches :: [String] + matches = getAllTextMatches $ text =~ (shortcodeRegex x) + + expandOne :: (Shortcode t) => t -> String -> String -> String + expandOne x code text = replace code (getReplacement x code) text + + shortcodeRegex :: forall t. (Shortcode t) => t -> String + shortcodeRegex x = "

\\[[[:blank:]]*" ++ (unTag theTag) ++ "[^]]*]

" + where + theTag :: ShortcodeTag t + theTag = tag + + getReplacement :: forall t. (Shortcode t) => t -> String -> String + getReplacement x text = case runParser p () "" text of + Left err -> parseError (unTag theTag) $ show err + Right atts -> case foldM update init atts of + Left err -> err + Right result -> embedcode result + where + p :: Parser [(String, String)] + p = shortcodeParser (unTag theTag) + + init :: t + init = emptycode + + theTag :: ShortcodeTag t + theTag = tag + + +{----------} +{- Errors -} +{----------} + +validateError :: String -> String -> String -> String -> String +validateError tag key badval expect = concat + [ "(Nb. there is an error in this '" ++ tag ++ "' shortcode; " + , "the value '" ++ badval ++ "' for key '" ++ key ++ "' is invalid. " + , expect ++ ")" + ] + +typeError :: String -> String -> String -> [String] -> String +typeError tag key badval expects = concat + [ "(Nb. there is an error in this '" ++ tag ++ "' shortcode; " + , "the value '" ++ badval ++ "' for key '" ++ key ++ "' was not expected. " + , "Possible values: " ++ (intercalate " " expects) ++ ".)" + ] + +parseError :: String -> String -> String +parseError tag err = concat + [ "(Nb. there was an error while parsing this '" ++ tag ++ "' tag. " + , err ++ ".)" + ] + +-- | Helper function for reporting errors; this one in case we are trying +-- to expand a shortcode with a missing key value. +missingError :: String -> String -> String +missingError tag key = concat + [ "(Nb. there is an error in this '" ++ tag ++ "' shortcode; " + , "you must provide a value for the '" ++ key ++ "' key.)" + ] diff --git a/src/Hakyll/Shortcode/Service/Example.hs b/src/Hakyll/Shortcode/Service/Example.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Service/Example.hs @@ -0,0 +1,158 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental + +Do you want to make more shortcodes? Of course, we all do. + +This module demonstrates how to implement a type-safe shortcode. +The basic steps are as follows: + + 1. Define a type @t@ which represents the state of a shortcode. + Typically @t@ will be a record type, and the fields should all + be Maybes or Lists of instances of the 'Validate' class. + + 2. Define a default instance of your shortcode state. This may + consist of a bunch of @Nothing@s and @[]@s, or maybe you prefer + nontrivial defaults. This is the 'emptycode' method of the + 'Shortcode' class. + + 3. Declare the usable keys for your shortcode by giving a list of + 'ShortcodeAttribute t's. This type lets us define our keys in + a declarative way, sort of like GetOpt. This is the 'attributes' + method of the 'Shortcode' class. + + 4. Provide a map @t -> String@, to be used to convert abstract + shortcodes to their expanded form. This is the 'embedcode' + method of the 'Shortcode' class. + + 5. Last but not least, declare which tag will be used to name + your shortcode. + +And that's it! The shortcode API and type library will take care of +parsing, validation, and sanitization for you, giving you a function +@String -> String@ that expands your new shortcode while making sure +only input conforming to your type model is allowed. + +Now let's walk through a sample shortcode module. To read along, +view the source of this module. +-} + + +-- A couple of language extensions will be useful. +-- The OverloadedStrings extension is used by Text.Blaze +-- to minimize boilerplate. Similarly, RecordWildCards will +-- make working with large records less verbose. + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + + +-- We only need to export one function: an alias for +-- the 'expandShortcodes' function. More on this later. +module Hakyll.Shortcode.Service.Example( + expandExampleShortcodes +) where + + +-- Now for some imports; these bring in the Shortcode API. +import Hakyll.Shortcode.Service -- Handles parsing and expanding shortcodes. +import Hakyll.Shortcode.Render -- Helper functions for rendering URLs and HTML. +import Hakyll.Shortcode.Types -- A library of validatable string-like types. + + +-- These modules are not necessary for defining a shortcode. +-- However, we will use them to more easily construct sanitized HTML. +import Data.Monoid +import Network.URI +import qualified Text.Blaze.Html5 as H +import qualified Text.Blaze.Html5.Attributes as A +import Text.Blaze.Html.Renderer.String (renderHtml) + + +-- For the sake of an example, I want my shortcode to look like this: +-- +-- [example valid='foo' item='bar' yesno='baz' oneof='qux'] +-- +-- subject to the following constraints: +-- 1. foo should be a sequence of digits, +-- 2. bar should be a sequence of letters and numbers; +-- 3. baz should be either 'yes' or 'no'; and +-- 4. qux should be either 'john', 'paul', 'george', or 'ringo'. +-- +-- Moreover, +-- 1. I want to require that 'valid' be present; +-- 2. I only want one 'yesno' and 'oneof'; and +-- 3. I want to be able to give zero or more 'list' values. + + +-- | We can represent this information using the following type. +-- Note that @Maybe@ means "zero or one" and @[]@ means "zero or more". +data Example = Example + { ex_valid :: Maybe Natural_Number_Base_10 + , ex_list :: [Letters_Numbers] + , ex_yesno :: Maybe YesNo + , ex_oneof :: Maybe Beatle + } + +-- | The 'Decimal_Digits', 'Letters_Numbers', and 'YesNo' types +-- are provided by 'Hakyll.Shortcode.Types'. But the 'Beatle' type +-- is custom, so we need to define it. +data Beatle + = John + | Paul + | George + | Ringo + deriving Show + + +-- | This is the function that finds and replaces @example@ +-- shortcodes. It is just a type-specific version of the +-- 'expandShortcodes' function, that takes a shortcode specification +-- and generates a find-and-replace function for it. +expandExampleShortcodes :: String -> String +expandExampleShortcodes = + expandShortcodes (emptycode :: Example) + + + +instance Shortcode Example where + tag = ShortcodeTag "example" + + + emptycode = Example + -- String Properties + { ex_valid = Nothing + , ex_list = [] + , ex_yesno = Nothing + , ex_oneof = Nothing + } + + + -- | The 'embedcode' function renders a shortcode object as text; + -- typically HTML, but here we'll just use plain text for simplicity. + embedcode ex@Example{..} + | ex_valid /= Nothing = unlines + [ "Here are the arguments of your example shortcode:" + , " " ++ show ex_valid + , " " ++ show ex_list + , " " ++ show ex_yesno + , " " ++ show ex_oneof + ] + + | otherwise = "Missing 'valid' key!" + + + attributes = + [ Valid "valid" $ \x ex -> ex { ex_valid = Just x } + , Valid "item" $ \x ex -> ex { ex_list = x : ex_list ex } + , YesNo "yesno" $ \x ex -> ex { ex_yesno = Just x } + , OneOf "oneof" + [ ("john", \ex -> ex { ex_oneof = Just John }) + , ("paul", \ex -> ex { ex_oneof = Just Paul }) + , ("george", \ex -> ex { ex_oneof = Just George }) + , ("ringo", \ex -> ex { ex_oneof = Just Ringo }) + ] + ] + diff --git a/src/Hakyll/Shortcode/Service/GeoGebra.hs b/src/Hakyll/Shortcode/Service/GeoGebra.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Service/GeoGebra.hs @@ -0,0 +1,137 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + +module Hakyll.Shortcode.Service.GeoGebra( + expandGeoGebraShortcodes +) where + +import Hakyll.Shortcode.Service +import Hakyll.Shortcode.Render +import Hakyll.Shortcode.Types + +import Data.Monoid +import Network.URI +import qualified Text.Blaze.Html5 as H +import qualified Text.Blaze.Html5.Attributes as A +import Text.Blaze.Html.Renderer.String (renderHtml) + + +data GeoGebraEmbed = GeoGebraEmbed + -- String Properties + { gg_id :: Maybe Letters_Numbers + , gg_class :: Maybe Css_Class_Name + , gg_height :: Maybe Natural_Number_Base_10 + , gg_width :: Maybe Natural_Number_Base_10 + , gg_bordercolor :: Maybe Hex_Color_Code + + -- Yes/No Properties + , gg_inputbar :: Maybe YesNo + , gg_stylebar :: Maybe YesNo + , gg_menubar :: Maybe YesNo + , gg_toolbar :: Maybe YesNo + , gg_toolbarhelp :: Maybe YesNo + , gg_reseticon :: Maybe YesNo + , gg_clicktoload :: Maybe YesNo + , gg_rightclick :: Maybe YesNo + , gg_labeldrag :: Maybe YesNo + , gg_panzoom :: Maybe YesNo + } deriving Show + + +-- | Find and replace @geogebra@ shortcodes. +expandGeoGebraShortcodes :: String -> String +expandGeoGebraShortcodes = + expandShortcodes (emptycode :: GeoGebraEmbed) + + +-- | Constructs the embed URI of a GeoGebraEmbed. +embedUri :: GeoGebraEmbed -> H.AttributeValue +embedUri GeoGebraEmbed{..} = H.stringValue + $ buildURL HTTPS "www.geogebra.org" path [] [] + where + path = concat + [ ["material"] + , ["iframe"] + , pathValidPre "id" gg_id + , pathValidPre "width" gg_width + , pathValidPre "height" gg_height + , pathValidPre "border" gg_bordercolor + , pathYesNoPre "ai" gg_inputbar "true" "false" + , pathYesNoPre "asb" gg_stylebar "true" "false" + , pathYesNoPre "smb" gg_menubar "true" "false" + , pathYesNoPre "stb" gg_toolbar "true" "false" + , pathYesNoPre "stbh" gg_toolbarhelp "true" "false" + , pathYesNoPre "sri" gg_reseticon "true" "false" + , pathYesNoPre "ctl" gg_clicktoload "true" "false" + , pathYesNoPre "rc" gg_rightclick "true" "false" + , pathYesNoPre "ld" gg_labeldrag "true" "false" + , pathYesNoPre "sdz" gg_panzoom "true" "false" + ] + + +instance Shortcode GeoGebraEmbed where + tag = ShortcodeTag "geogebra" + + + emptycode = GeoGebraEmbed + -- String Properties + { gg_id = Nothing + , gg_class = validateMaybe "geogebra-container" + , gg_height = Nothing + , gg_width = Nothing + , gg_bordercolor = Nothing + + -- Yes/No Properties + , gg_inputbar = Nothing + , gg_stylebar = Nothing + , gg_menubar = Nothing + , gg_toolbar = Nothing + , gg_toolbarhelp = Nothing + , gg_reseticon = Nothing + , gg_clicktoload = Nothing + , gg_rightclick = Nothing + , gg_labeldrag = Nothing + , gg_panzoom = Nothing + } + + + embedcode gg@GeoGebraEmbed{..} + | gg_id /= Nothing = do + renderHtml $ do + H.div H.! (attrValid A.class_ gg_class) $ do + H.iframe H.! mconcat + [ attrValid A.height gg_height + , attrValid A.width gg_width + , A.src $ embedUri gg + ] $ mempty + + | otherwise = missingError "geogebra" "id" + + + attributes = + -- String Properties + [ Valid "id" $ \x gg -> gg { gg_id = Just x } + , Valid "class" $ \x gg -> gg { gg_class = Just x } + , Valid "color" $ \x gg -> gg { gg_bordercolor = Just x } + , Valid "height" $ \x gg -> gg { gg_height = Just x } + , Valid "width" $ \x gg -> gg { gg_width = Just x } + + -- Yes/No Properties + , YesNo "show-input-bar" $ \x gg -> gg { gg_inputbar = Just x } + , YesNo "show-style-bar" $ \x gg -> gg { gg_stylebar = Just x } + , YesNo "show-menu-bar" $ \x gg -> gg { gg_menubar = Just x } + , YesNo "show-tool-bar" $ \x gg -> gg { gg_toolbar = Just x } + , YesNo "show-tool-help" $ \x gg -> gg { gg_toolbarhelp = Just x } + , YesNo "show-reset-icon" $ \x gg -> gg { gg_reseticon = Just x } + , YesNo "click-to-load" $ \x gg -> gg { gg_clicktoload = Just x } + , YesNo "allow-right-click" $ \x gg -> gg { gg_rightclick = Just x } + , YesNo "drag-labels" $ \x gg -> gg { gg_labeldrag = Just x } + , YesNo "allow-pan-zoom" $ \x gg -> gg { gg_panzoom = Just x } + ] diff --git a/src/Hakyll/Shortcode/Service/Gravatar.hs b/src/Hakyll/Shortcode/Service/Gravatar.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Service/Gravatar.hs @@ -0,0 +1,154 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + +module Hakyll.Shortcode.Service.Gravatar( + expandGravatarShortcodes +) where + +import Hakyll.Shortcode.Service +import Hakyll.Shortcode.Render +import Hakyll.Shortcode.Types + +import Data.Monoid +import Network.URI +import qualified Text.Blaze.Html5 as H +import qualified Text.Blaze.Html5.Attributes as A +import Text.Blaze.Html.Renderer.String (renderHtml) +import Data.Hash.MD5 (md5s) + + +data GravatarEmbed = GravatarEmbed + { gv_hash :: Maybe MD5_Digest + , gv_class :: Maybe Css_Class_Name + , gv_size :: Maybe Natural_Number_Base_10 + , gv_default :: Maybe DefaultGravatar + , gv_force_default :: Maybe YesNo + , gv_rating :: Maybe Rating + } deriving Show + + +{- default gravatar style -} + +data DefaultGravatar + = FourOhFour + | MysteryMan + | Identicon + | MonsterID + | Wavatar + | Retro + | Blank + deriving (Eq, Show) + +instance QueryParameter DefaultGravatar where + renderQueryParameter x = case x of + FourOhFour -> "d=404" + MysteryMan -> "d=mm" + Identicon -> "d=identicon" + MonsterID -> "d=monsterid" + Wavatar -> "d=wavatar" + Retro -> "d=retro" + Blank -> "d=blank" + + +{- rating -} + +data Rating + = GRating + | PGRating + | RRating + | XRating + deriving (Eq, Show) + +instance QueryParameter Rating where + renderQueryParameter x = case x of + GRating -> "r=g" + PGRating -> "r=pg" + RRating -> "r=r" + XRating -> "r=x" + + +-- | Find and replace @gravatar@ shortcodes. +expandGravatarShortcodes :: String -> String +expandGravatarShortcodes = + expandShortcodes (emptycode :: GravatarEmbed) + + +-- | Constructs the embed URI of a GeoGebraEmbed. +embedUri :: GravatarEmbed -> H.AttributeValue +embedUri GravatarEmbed{..} = H.stringValue + $ buildURL HTTPS "www.gravatar.com" path query [] + where + path = + [ "avatar" + , pathValid gv_hash + ] + + query = + [ queryValid gv_size "s" + , queryOneOf gv_default + , queryYesNo gv_force_default "f=y" "" + , queryOneOf gv_rating + ] + + + +instance Shortcode GravatarEmbed where + tag = ShortcodeTag "gravatar" + + + emptycode = GravatarEmbed + -- String Properties + { gv_hash = Nothing + , gv_class = validateMaybe "gravatar-container" + , gv_size = Nothing + , gv_force_default = Nothing + , gv_default = Nothing + , gv_rating = Nothing + } + + + embedcode gv@GravatarEmbed{..} + | gv_hash /= Nothing = do + renderHtml $ do + H.div H.! (attrValid A.class_ gv_class) $ do + H.img H.! mconcat + [ A.src $ embedUri gv + ] + + | otherwise = missingError "gravatar" "hash" + + + attributes = + -- String Properties + [ Valid "hash" $ \x gv -> gv { gv_hash = Just x } + , Valid "class" $ \x gv -> gv { gv_class = Just x } + , Valid "size" $ \x gv -> gv { gv_size = Just x } + + -- Yes/No Properties + , YesNo "force-default" $ \x gv -> gv { gv_force_default = Just x } + + -- Enumerated Properties + , OneOf "default" + [ ("404", \gv -> gv { gv_default = Just FourOhFour }) + , ("mystery", \gv -> gv { gv_default = Just MysteryMan }) + , ("identicon", \gv -> gv { gv_default = Just Identicon }) + , ("monsterid", \gv -> gv { gv_default = Just MonsterID }) + , ("wavatar", \gv -> gv { gv_default = Just Wavatar }) + , ("retro", \gv -> gv { gv_default = Just Retro }) + , ("blank", \gv -> gv { gv_default = Just Blank }) + ] + + , OneOf "rating" + [ ("g", \gv -> gv { gv_rating = Just GRating }) + , ("pg", \gv -> gv { gv_rating = Just PGRating }) + , ("r", \gv -> gv { gv_rating = Just RRating }) + , ("x", \gv -> gv { gv_rating = Just XRating }) + ] + ] diff --git a/src/Hakyll/Shortcode/Service/YouTube.hs b/src/Hakyll/Shortcode/Service/YouTube.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Service/YouTube.hs @@ -0,0 +1,262 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + +module Hakyll.Shortcode.Service.YouTube ( + expandYouTubeShortcodes +) where + + +import Hakyll.Shortcode.Service +import Hakyll.Shortcode.Render +import Hakyll.Shortcode.Types + +import Data.Monoid +import Network.URI +import qualified Text.Blaze.Html5 as H +import qualified Text.Blaze.Html5.Attributes as A +import Text.Blaze.Html.Renderer.String (renderHtml) + + + +{---------} +{- Types -} +{---------} + +-- | A type representing embedded YouTube videos and playlists. +-- See the . +data YouTubeEmbed = YouTubeEmbed + -- String Properties + { yt_id :: Maybe Letters_Numbers_Hyphens_Underscores + , yt_class :: Maybe Css_Class_Name + , yt_height :: Maybe Natural_Number_Base_10 + , yt_width :: Maybe Natural_Number_Base_10 + , yt_end :: Maybe Natural_Number_Base_10 + , yt_start :: Maybe Natural_Number_Base_10 + , yt_language :: Maybe Iso_639_1_Language_Code + , yt_playlist :: Maybe RFC_3986_Unreserved_Uri_Characters + , yt_origin :: Maybe Domain_With_Scheme + + -- Yes/No Properties + , yt_autoplay :: Maybe YesNo + , yt_disablekb :: Maybe YesNo + , yt_enablejs :: Maybe YesNo + , yt_fullscreen :: Maybe YesNo + , yt_loop :: Maybe YesNo + , yt_playinline :: Maybe YesNo + , yt_related :: Maybe YesNo + , yt_showannot :: Maybe YesNo + , yt_showinfo :: Maybe YesNo + , yt_showlogo :: Maybe YesNo + + -- Enumerated Properties + , yt_captions :: Maybe CaptionPolicy + , yt_color :: Maybe Color + , yt_controls :: Maybe ShowControls + , yt_listtype :: Maybe ListType + } + + +{- cc_load_policy -} + +data CaptionPolicy + = ShowCaptions + deriving Eq + +instance QueryParameter CaptionPolicy where + renderQueryParameter ShowCaptions = "cc_load_policy=1" + + +{- controls -} + +data ShowControls + = ShowControlsNever + | ShowControlsOnload + | ShowControlsOnplay + deriving Eq + +instance QueryParameter ShowControls where + renderQueryParameter x = case x of + ShowControlsNever -> "controls=0" + ShowControlsOnload -> "controls=1" + ShowControlsOnplay -> "controls=2" + + +{- color -} + +data Color + = Red + | White + deriving Eq + +instance QueryParameter Color where + renderQueryParameter x = case x of + Red -> "color=red" + White -> "color=white" + + +{- listType -} + +data ListType + = ListTypePlaylist + | ListTypeSearch + | ListTypeUserUploads + deriving Eq + +instance QueryParameter ListType where + renderQueryParameter x = case x of + ListTypePlaylist -> "listType=playlist" + ListTypeSearch -> "listType=search" + ListTypeUserUploads -> "listType=user_uploads" + + + +{----------------------} +{- Shortcode Instance -} +{----------------------} + +-- | Find and replace @youtube@ shortcodes. +expandYouTubeShortcodes :: String -> String +expandYouTubeShortcodes = + expandShortcodes (emptycode :: YouTubeEmbed) + + +-- Constructs the embed URI of a YouTubeEmbed. +embedUri :: YouTubeEmbed -> H.AttributeValue +embedUri YouTubeEmbed{..} = H.stringValue + $ buildURL HTTPS "www.youtube.com" path query [] + where + path = + [ "embed" + , pathValid yt_id + ] + + query = + -- String Properties + [ queryValid yt_start "start" + , queryValid yt_end "end" + , queryValid yt_language "hl" + , queryValid yt_playlist "playlist" + , queryValid yt_origin "origin" + + -- Yes/No Properties + , queryYesNo yt_autoplay "autoplay=1" "autoplay=0" + , queryYesNo yt_disablekb "disablekb=1" "disablekb=0" + , queryYesNo yt_enablejs "enablejsapi=1" "enablejsapi=0" + , queryYesNo yt_fullscreen "fs=1" "fs=0" + , queryYesNo yt_loop "loop=1" "loop=0" + , queryYesNo yt_playinline "playsinline=1" "playsinline=0" + , queryYesNo yt_related "rel=1" "rel=0" + , queryYesNo yt_showannot "iv_load_policy=1" "iv_load_policy=3" + , queryYesNo yt_showinfo "showinfo=1" "showinfo=0" + , queryYesNo yt_showlogo "modestbranding=0" "modestbranding=1" + + -- Enumerated Properties + , queryOneOf yt_captions + , queryOneOf yt_color + , queryOneOf yt_controls + , queryOneOf yt_listtype + ] + + + +instance Shortcode YouTubeEmbed where + tag = ShortcodeTag "youtube" + + + emptycode = YouTubeEmbed + { yt_id = Nothing + , yt_class = validateMaybe "youtube-container" + , yt_height = Nothing + , yt_width = Nothing + , yt_autoplay = Nothing + , yt_captions = Nothing + , yt_controls = Nothing + , yt_color = Nothing + , yt_disablekb = Nothing + , yt_end = Nothing + , yt_fullscreen = Nothing + , yt_related = Just No + , yt_start = Nothing + , yt_showlogo = Nothing + , yt_language = Nothing + , yt_playinline = Nothing + , yt_playlist = Nothing + , yt_showinfo = Nothing + , yt_showannot = Nothing + , yt_enablejs = Nothing + , yt_loop = Nothing + , yt_origin = Nothing + , yt_listtype = Nothing + } + + + embedcode yt@YouTubeEmbed{..} + {- check that 'origin' is set if 'enablejs' is 'yes' -} + | yt_enablejs == Just Yes && yt_origin /= Nothing = + "(Warning: if you set 'enablejs' to 'yes', you should also set 'origin' to your domain.)" + + {- id or list+listType -} + | yt_id /= Nothing || (yt_playlist /= Nothing && yt_listtype /= Nothing) = do + renderHtml $ do + H.div H.! (attrValid A.class_ yt_class) $ do + H.iframe H.! mconcat + [ attrValid A.height yt_height + , attrValid A.width yt_width + , A.type_ "text/html" + , A.src $ embedUri yt + ] $ mempty + + | otherwise = + "(Error: either the 'id' or the 'list' and 'list-type' parameter must be set.)" + + + attributes = + -- String Properties + [ Valid "id" $ \x yt -> yt { yt_id = Just x } + , Valid "class" $ \x yt -> yt { yt_class = Just x } + , Valid "height" $ \x yt -> yt { yt_height = Just x } + , Valid "width" $ \x yt -> yt { yt_width = Just x } + , Valid "end" $ \x yt -> yt { yt_end = Just x } + , Valid "start" $ \x yt -> yt { yt_start = Just x } + , Valid "list" $ \x yt -> yt { yt_playlist = Just x } + , Valid "origin" $ \x yt -> yt { yt_origin = Just x } + + -- Yes/No Properties + , YesNo "loop" $ \x yt -> yt { yt_loop = Just x } + , YesNo "show-related" $ \x yt -> yt { yt_related = Just x } + , YesNo "disable-keyboard" $ \x yt -> yt { yt_disablekb = Just x } + , YesNo "autoplay" $ \x yt -> yt { yt_autoplay = Just x } + , YesNo "show-fullscreen" $ \x yt -> yt { yt_fullscreen = Just x } + , YesNo "show-info" $ \x yt -> yt { yt_showinfo = Just x } + , YesNo "play-inline" $ \x yt -> yt { yt_playinline = Just x } + , YesNo "show-logo" $ \x yt -> yt { yt_showlogo = Just x } + , YesNo "show-annotations" $ \x yt -> yt { yt_showannot = Just x } + , YesNo "enable-js-api" $ \x yt -> yt { yt_enablejs = Just x } + + -- Enumerated Properties + , OneOf "captions" + [ ("show", \yt -> yt { yt_captions = Just ShowCaptions }) + , ("default", \yt -> yt { yt_captions = Nothing }) + ] + , OneOf "show-controls" + [ ("never", \yt -> yt { yt_controls = Just ShowControlsNever }) + , ("onload", \yt -> yt { yt_controls = Just ShowControlsOnload }) + , ("onplay", \yt -> yt { yt_controls = Just ShowControlsOnplay }) + ] + , OneOf "color" + [ ("red", \yt -> yt { yt_color = Just Red }) + , ("white", \yt -> yt { yt_color = Just White }) + ] + , OneOf "list-type" + [ ("playlist", \yt -> yt { yt_listtype = Just ListTypePlaylist }) + , ("search", \yt -> yt { yt_listtype = Just ListTypeSearch }) + , ("user-uploads", \yt -> yt { yt_listtype = Just ListTypeUserUploads }) + ] + ] diff --git a/src/Hakyll/Shortcode/Types.hs b/src/Hakyll/Shortcode/Types.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types.hs @@ -0,0 +1,41 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental + +The types reexported by this module (except for 'YesNo', which is a renaming of 'Bool') are safe strings. Each is an instance of the 'Validate' class, and may only be constructed using the 'validate' function. This ensures that the elements of a safe string type satisfy the constraints given in their 'Validate' instance. +-} + +module Hakyll.Shortcode.Types ( + module Hakyll.Shortcode.Validate, + + module Hakyll.Shortcode.Types.Css_Class_Name, + module Hakyll.Shortcode.Types.Domain_With_Scheme, + module Hakyll.Shortcode.Types.Hex_Color_Code, + module Hakyll.Shortcode.Types.Iso_639_1_Language_Code, + module Hakyll.Shortcode.Types.Letters_Numbers, + module Hakyll.Shortcode.Types.Letters_Numbers_Hyphens_Underscores, + module Hakyll.Shortcode.Types.MD5_Digest, + module Hakyll.Shortcode.Types.Natural_Number_Base_10, + module Hakyll.Shortcode.Types.RFC_3986_Unreserved_Uri_Characters, + module Hakyll.Shortcode.Types.YesNo, + + module Hakyll.Shortcode.Types.CommaSep +) where + + +import Hakyll.Shortcode.Validate + +import Hakyll.Shortcode.Types.Css_Class_Name +import Hakyll.Shortcode.Types.Domain_With_Scheme +import Hakyll.Shortcode.Types.Hex_Color_Code +import Hakyll.Shortcode.Types.Iso_639_1_Language_Code +import Hakyll.Shortcode.Types.Letters_Numbers +import Hakyll.Shortcode.Types.Letters_Numbers_Hyphens_Underscores +import Hakyll.Shortcode.Types.MD5_Digest +import Hakyll.Shortcode.Types.Natural_Number_Base_10 +import Hakyll.Shortcode.Types.RFC_3986_Unreserved_Uri_Characters +import Hakyll.Shortcode.Types.YesNo + +import Hakyll.Shortcode.Types.CommaSep diff --git a/src/Hakyll/Shortcode/Types/CommaSep.hs b/src/Hakyll/Shortcode/Types/CommaSep.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/CommaSep.hs @@ -0,0 +1,29 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.CommaSep ( + CommaSep() +) where + + +import Data.List (intercalate) +import Data.List.Split (splitOn) + +import Hakyll.Shortcode.Validate + + +-- | Comma-separated lists of valid strings. +data CommaSep t + = Make { unMake :: [t] } deriving Eq + +instance (Validate t) => Validate (CommaSep t) where + validate text = case sequence . map validate . splitOn "," $ text of + Left er -> Left $ er ++ " (Separated by commas.)" + Right x -> Right (Make x) + +instance (Validate t, Show t) => Show (CommaSep t) where + show = intercalate "," . map show . unMake diff --git a/src/Hakyll/Shortcode/Types/Css_Class_Name.hs b/src/Hakyll/Shortcode/Types/Css_Class_Name.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/Css_Class_Name.hs @@ -0,0 +1,34 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.Css_Class_Name ( + Css_Class_Name() +) where + + +import Text.Regex.Posix ((=~)) + +import Hakyll.Shortcode.Validate + + +{-------------------} +{- CSS Class Names -} +{-------------------} + +-- | Valid CSS class names: alphanumeric, hyphen, or underscore, but the first character must be alphanumeric. +-- Note: this type represents only a subset of all valid class names. +-- See the . +newtype Css_Class_Name + = Make { unMake :: String } deriving Eq + +instance Validate Css_Class_Name where + validate text = case text =~ "^[a-zA-Z][_a-zA-Z0-9-]*$" of + True -> Right $ Make text + False -> Left "Must be a letter, followed by zero or more alphanumeric characters, hyphens, or underscores." + +instance Show Css_Class_Name where + show = unMake diff --git a/src/Hakyll/Shortcode/Types/Domain_With_Scheme.hs b/src/Hakyll/Shortcode/Types/Domain_With_Scheme.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/Domain_With_Scheme.hs @@ -0,0 +1,29 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.Domain_With_Scheme ( + Domain_With_Scheme() +) where + + +import Text.Regex.Posix ((=~)) + +import Hakyll.Shortcode.Validate + + +-- | Matches domain names with the https scheme. +-- The regex for this match is very simple. +newtype Domain_With_Scheme + = Make { unMake :: String } deriving Eq + +instance Validate Domain_With_Scheme where + validate text = case text =~ "^https://[\\.a-zA-Z-]+$" of + True -> Right $ Make text + False -> Left "Must be a valid domain name with scheme." + +instance Show Domain_With_Scheme where + show = unMake diff --git a/src/Hakyll/Shortcode/Types/Hex_Color_Code.hs b/src/Hakyll/Shortcode/Types/Hex_Color_Code.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/Hex_Color_Code.hs @@ -0,0 +1,28 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.Hex_Color_Code ( + Hex_Color_Code() +) where + +import Text.Regex.Posix ((=~)) + +import Hakyll.Shortcode.Validate + + +-- | Strings of six hexadecimal digits. Case insensitive. +newtype Hex_Color_Code + = Make { unMake :: String } deriving Eq + +instance Validate Hex_Color_Code where + validate text = case text =~ "^[a-fA-F0-9][a-fA-F0-9][a-fA-F0-9][a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]$" of + True -> Right $ Make text + False -> Left "Must be six hexadecimal digits." + +instance Show Hex_Color_Code where + show = unMake + diff --git a/src/Hakyll/Shortcode/Types/Iso_639_1_Language_Code.hs b/src/Hakyll/Shortcode/Types/Iso_639_1_Language_Code.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/Iso_639_1_Language_Code.hs @@ -0,0 +1,48 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.Iso_639_1_Language_Code ( + Iso_639_1_Language_Code() +) where + +import Hakyll.Shortcode.Validate + +-- | ISO 639.1 two-letter language codes. +-- See . +-- Must be constructed with 'validate'. +newtype Iso_639_1_Language_Code + = Make { unMake :: String } deriving Eq + +instance Validate Iso_639_1_Language_Code where + validate text = if elem text codes + then Right $ Make text + else Left "Must be an ISO 639.1 two-letter language code." + where + codes = + [ "ab", "aa", "af", "ak", "sq", "am", "ar", "an", "hy", "as" + , "av", "ae", "ay", "az", "bm", "ba", "eu", "be", "bn", "bh" + , "bi", "bs", "br", "bg", "my", "ca", "ch", "ce", "ny", "zh" + , "cv", "kw", "co", "cr", "hr", "cs", "da", "dv", "nl", "dz" + , "en", "eo", "et", "ee", "fo", "fj", "fi", "fr", "ff", "gl" + , "ka", "de", "el", "gn", "gu", "ht", "ha", "he", "hz", "hi" + , "ho", "hu", "ia", "id", "ie", "ga", "ig", "ik", "io", "is" + , "it", "iu", "ja", "jv", "kl", "kn", "kr", "ks", "kk", "km" + , "ki", "rw", "ky", "kv", "kg", "ko", "ku", "kj", "la", "lb" + , "lg", "li", "ln", "lo", "lt", "lu", "lv", "gv", "mk", "mg" + , "ms", "ml", "mt", "mi", "mr", "mh", "mn", "na", "nv", "nd" + , "ne", "ng", "nb", "nn", "no", "ii", "nr", "oc", "oj", "cu" + , "om", "or", "os", "pa", "pi", "fa", "pl", "ps", "pt", "qu" + , "rm", "rn", "ro", "ru", "sa", "sc", "sd", "se", "sm", "sg" + , "sr", "gd", "sn", "si", "sk", "sl", "so", "st", "es", "su" + , "sw", "ss", "sv", "ta", "te", "tg", "th", "ti", "bo", "tk" + , "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk" + , "ur", "uz", "ve", "vi", "vo", "wa", "cy", "wo", "fy", "xh" + , "yi", "yo", "za", "zu" + ] + +instance Show Iso_639_1_Language_Code where + show = unMake diff --git a/src/Hakyll/Shortcode/Types/Letters_Numbers.hs b/src/Hakyll/Shortcode/Types/Letters_Numbers.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/Letters_Numbers.hs @@ -0,0 +1,31 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.Letters_Numbers ( + Letters_Numbers() +) where + + +import Text.Regex.Posix ((=~)) + +import Hakyll.Shortcode.Validate + + +-- | Strings consisting only of alphanumeric characters. +-- Must be constructed using 'validate'. +newtype Letters_Numbers + = Make { unMake :: String } deriving Eq + + +instance Validate Letters_Numbers where + validate text = case text =~ "^[a-zA-Z0-9]+$" of + True -> Right $ Make text + False -> Left "Must be one or more alphanumeric characters." + + +instance Show Letters_Numbers where + show = unMake diff --git a/src/Hakyll/Shortcode/Types/Letters_Numbers_Hyphens_Underscores.hs b/src/Hakyll/Shortcode/Types/Letters_Numbers_Hyphens_Underscores.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/Letters_Numbers_Hyphens_Underscores.hs @@ -0,0 +1,28 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.Letters_Numbers_Hyphens_Underscores ( + Letters_Numbers_Hyphens_Underscores() +) where + + +import Text.Regex.Posix ((=~)) + +import Hakyll.Shortcode.Validate + + +-- | Strings consisting only of a-z, A-Z, 0-9, -, and _. +newtype Letters_Numbers_Hyphens_Underscores + = Make { unMake :: String } deriving Eq + +instance Validate Letters_Numbers_Hyphens_Underscores where + validate text = case text =~ "^[_a-zA-Z0-9-]+$" of + True -> Right $ Make text + False -> Left "Must be one or more alphanumeric characters, hyphens, or underscores." + +instance Show Letters_Numbers_Hyphens_Underscores where + show = unMake diff --git a/src/Hakyll/Shortcode/Types/MD5_Digest.hs b/src/Hakyll/Shortcode/Types/MD5_Digest.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/MD5_Digest.hs @@ -0,0 +1,28 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.MD5_Digest ( + MD5_Digest() +) where + +import Hakyll.Shortcode.Validate + + +-- | Strings of 64 hexadecimal digits. Case insensitive. +newtype MD5_Digest + = Make { unMake :: String } deriving Eq + +instance Validate MD5_Digest where + validate text = + let hex_digits = "0123456789abcdefABCDEF" in + if (length text == 32) && (all (`elem` hex_digits) text) + then Right $ Make text + else Left "MD5 digest must be 32 hexadecimal digits." + +instance Show MD5_Digest where + show = unMake + diff --git a/src/Hakyll/Shortcode/Types/Natural_Number_Base_10.hs b/src/Hakyll/Shortcode/Types/Natural_Number_Base_10.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/Natural_Number_Base_10.hs @@ -0,0 +1,29 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.Natural_Number_Base_10 ( + Natural_Number_Base_10() +) where + + +import Text.Regex.Posix ((=~)) + +import Hakyll.Shortcode.Validate + + +-- | Either 0, or a nonempty string of decimal digits with no leading zeros. +newtype Natural_Number_Base_10 + = Make { unMake :: String } deriving Eq + +instance Validate Natural_Number_Base_10 where + validate "0" = Right $ Make "0" + validate text = case text =~ "^[1-9][0-9]*$" of + True -> Right $ Make text + False -> Left "Must be '0' or one or more decimal digits (0-9) with no leading zero." + +instance Show Natural_Number_Base_10 where + show = unMake diff --git a/src/Hakyll/Shortcode/Types/RFC_3986_Unreserved_Uri_Characters.hs b/src/Hakyll/Shortcode/Types/RFC_3986_Unreserved_Uri_Characters.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/RFC_3986_Unreserved_Uri_Characters.hs @@ -0,0 +1,32 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.RFC_3986_Unreserved_Uri_Characters ( + RFC_3986_Unreserved_Uri_Characters() +) where + + +import Text.Regex.Posix ((=~)) + +import Hakyll.Shortcode.Validate + + +-- | Strings consisting only of a-z, A-Z, 0-9, -, _, ., or ~ characters. +-- See [RFC 3986, Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3). +-- Must be constructed using 'validate'. +newtype RFC_3986_Unreserved_Uri_Characters + = Make { unMake :: String } deriving Eq + + +instance Validate RFC_3986_Unreserved_Uri_Characters where + validate text = case text =~ "^[-a-zA-Z0-9_\\.~]+$" of + True -> Right $ Make text + False -> Left "Must be one or more of a-z, A-Z, 0-9, -, ., _, or ~." + + +instance Show RFC_3986_Unreserved_Uri_Characters where + show = unMake diff --git a/src/Hakyll/Shortcode/Types/YesNo.hs b/src/Hakyll/Shortcode/Types/YesNo.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Types/YesNo.hs @@ -0,0 +1,20 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Types.YesNo ( + YesNo(Yes,No) +) where + + +-- | Type representing Yes or No options for a parameter. +-- A slightly more semantically meaningful version of 'Bool'. +data YesNo + -- | The Yes option. + = Yes + -- | The No option. + | No + deriving (Eq, Show) diff --git a/src/Hakyll/Shortcode/Validate.hs b/src/Hakyll/Shortcode/Validate.hs new file mode 100644 --- /dev/null +++ b/src/Hakyll/Shortcode/Validate.hs @@ -0,0 +1,25 @@ +{-| +Copyright : (c) Nathan Bloomfield, 2017 +License : GPL-3 +Maintainer : nbloomf@gmail.com +Stability : experimental +-} + +module Hakyll.Shortcode.Validate ( + Validate(..), + validateMaybe +) where + + +-- | The 'Validate' class lets us approximate subtypes +-- of 'String'. Instances should not expose a constructor. +class Validate t where + -- | 'validate' acts as a safe constructor. + validate :: String -> Either String t + + +-- | Apply 'validate', but map the error message to 'Nothing'. +validateMaybe :: (Validate t) => String -> Maybe t +validateMaybe x = case validate x of + Right y -> Just y + Left _ -> Nothing diff --git a/test/Tests/Main.hs b/test/Tests/Main.hs new file mode 100644 --- /dev/null +++ b/test/Tests/Main.hs @@ -0,0 +1,15 @@ +module Tests.Main where + +import Hakyll.Shortcode + +import Tests.Hakyll.Shortcode.Service.YouTube +import Tests.Hakyll.Shortcode.Service.GeoGebra + +import Test.Tasty +import Test.Tasty.HUnit + +main :: IO () +main = defaultMain $ testGroup "Shortcode Tests" + [ service_test_youtube + , service_test_geogebra + ]