diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f288702..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - 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/qsgen3 b/qsgen3 new file mode 100755 index 0000000..8b53d6d --- /dev/null +++ b/qsgen3 @@ -0,0 +1,1393 @@ +#!/usr/bin/zsh + +############################################################################### +############################################################################### +# +# Quick Site Generator 2 is a static website generator inspired by Nikola. +# It is written for the Z shell (zsh) because that's what I use and also because +# I like it better than Bash. +# +# This script is an almost complete rewrite of my old script because it became +# overly complicated and had way too many bugs, even though it worked on simple +# sites. +# +# https://github.com/kekePower/qsgen2/ +# +############################################################################### +############################################################################### + +VERSION="0.4.3" # Sat-2024-02-24 +QSGEN="Quick Site Generator 2" + +# Set to true or false +# This will show debug information from every function in this script +# You can also set debug=true in a single function if you want to debug only that specific one. +globaldebug=false + +# Use Zsh fpath to set the path to some extra functions +fpath=(${HOME}/bin/include/common ${HOME}/bin/include/qsgen2/lang $fpath) +# In this case, let's load the 'include' function +autoload include +autoload zini + +# Including some colors to the script +include common/colors + +echo "${magenta}${blue_bg} ${QSGEN} ${end}${bold_white}${blue_bg}${VERSION} ${end}" + +# Check for, and source, the config file for this specific website +if [[ -f $(pwd)/config ]]; then + if (${globaldebug}); then echo "${red}Config file found and sourced${end}\n${yellow} - $(pwd)/config${end}"; fi + zini $(pwd)/config +else + echo "${red}Cannot find configuration file.${end}" + echo "${yellow} - Please create the file 'config' in your project directory.${end}" + echo "${yellow} - See 'config.example' in the git source tree.${end}" + exit +fi + +# Load language as defined in config +typeset -A qsgenlang +lang_found=false +for dir in $fpath; do + if [[ -f "${dir}/${config[project_lang]}" ]]; then + # echo "Language file: ${dir}/${config[project_lang]}" + source "${dir}/${config[project_lang]}" + lang_found=true + break + fi +done +if [[ ${lang_found} == "false" ]]; then + # Fall back to en_US if defined language isn't found + echo "Defined language, ${config[project_lang]}, not found. Using en_US." + source "${HOME}/bin/include/qsgen2/lang/en_US" + fi + +if (${globaldebug}); then + qsconfig=$( cat $(pwd)/config | grep -v \# | awk '{print substr($0, index($0, " ") + 1)}' ) + echo "Content of Config file" + for qslines in ${qsconfig} + do + echo "${yellow}${qslines}${end}" + done +fi + +## +# @brief Display a message with specific formatting based on message type. +# @param type The type of message (e.g., std, info, debug, etc.) +# @param ... The keys or additional strings to be formatted and displayed. +function _msg() { + local type=$1 + shift # Remove the first argument so $@ now contains only keys or additional strings + + local full_msg="" + for arg in "$@"; do + if [[ -n "${qsgenlang[$arg]}" ]]; then + full_msg+="${qsgenlang[$arg]}" + else + full_msg+="$arg" + fi + done + + # Determine the color based on the type + local color="${end}" # Default to no color if type is unrecognized + case $type in + std) color="${green}" ;; + info) color="${yellow}" ;; + debug) color="${red}" ;; + other) color="${bold_yellow}" ;; + sub) color="${magenta}" ;; + main) color="${white}${green_bg}" ;; + esac + + # Use printf with %b to allow backslash escape interpretation + printf "${color}%b${end}\n" "${full_msg}" +} + +## +# @brief Display the version information of the script. +# @param ... Additional arguments (unused in this function). +function _version() { + _msg info "_qsgen2_msg_7" "-$(strftime "%Y")" + echo "${yellow}- https://github.com/kekePower/qsgen2/${end}" + _msg info "_qsgen2_msg_8" " '${1} help' " "_qsgen2_msg_8.1" + exit +} + +## +# @brief Display help information for the script. +# @param ... Additional arguments (unused in this function). +function _help() { + # This will also be translated some time in the future + echo "This is where I'll write the Help documentation." + exit +} + +if [[ "$1" == "version" || "$1" == "-v" || "$1" == "--version" ]]; then + _version ${0:t} +elif [[ "$1" == "help" || "$1" == "-h" || "$1" == "--help" ]]; then + _help ${0:t} +fi + +# Define cache files for blogs and pages +blog_cache_file="${config[project_root]}/.blog_cache" +pages_cache_file="${config[project_root]}/.pages_cache" + +# Let's check if qsgen2 can generate this site by checking if 'generator' is available +if [[ ! ${config[project_generator]} ]] || [[ -d $(pwd)/.git ]]; then + _msg debug "_qsgen2_msg_3" + exit +fi + +# We define the variable 'engine' based on what's in the 'config' file. +if [[ ${config[project_generator]} == "native" ]]; then + # Usage: ${engine} ${1} - Where 1 is the file you want to convert + engine=_qstags + export file_ext="qst" +elif [[ ${config[project_generator]} == "markdown" ]]; then + if [[ ! -f /usr/local/bin/pandoc ]]; then + _msg other "_qsgen2_msg_4" + _msg other "https://github.com/jgm/pandoc/releases" + exit + else + # Usage: ${engine} ${1} - Where 1 is the file you want parsed + engine="/usr/local/bin/pandoc" + engine_opts= + export file_ext="md" + fi +else + _msg debug "_qsgen2_msg_5" + exit +fi + +## +# @brief Run the configured engine to process the input file. +# @param input The input file to be processed. +function _run_engine() { + # Usage: _run_engine + local debug=false + + if [[ ${config[project_generator]} == "native" ]]; then + ${engine} ${1} + elif [[ ${config[project_generator]} == "markdown" ]]; then + echo "${1} | ${engine} ${engine_opts}" + else + _msg debug "ERROR running engine: ${engine}!" + _msg info "Usage: _run_engine " + exit + fi +} + +if (${globaldebug}); then _msg debug "_qsgen2_msg_6"; fi + +builtin cd ${config[project_root]} + +# Loading Zsh modules +zmodload zsh/files +zmodload zsh/datetime +zmodload zsh/regex + +# Let's put these here for now. +export today=$(strftime "%Y-%m-%d - %T") +export blogdate=$(strftime "%a-%Y-%b-%d") + +# Let's create arrays of all the files we'll be working on + +## +# @brief List all page files and store them in an array. +function _list_pages() { + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + # Initialize or clear the array to ensure it's empty before adding files + pages_file_array=() + + export no_pages_found=false + + # Temporarily set null_glob for this function + setopt local_options null_glob + + # Using an array to directly capture matching files + local -a pages_files=(*.${file_ext}) + + if (( ${#pages_files} == 0 )); then + if ${debug}; then _msg debug "${0:t}_msg_1" " ${file_ext}."; fi + export no_pages_found=true + return + else + for file in "${pages_files[@]}"; do + if ${debug}; then _msg debug "${0:t}_msg_2" " ${file}"; fi + pages_file_array+=("$file") + done + fi + +} + +## +# @brief List all blog files and store them in an array. +function _list_blogs() { + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + # Initialize or clear the blogs array to ensure it's empty before adding files + blogs_file_array=() + + export no_blogs_found=false + + # Temporarily set null_glob for this function + setopt local_options null_glob + + # Directly capture matching blog files into an array + local -a blog_files=(blog/*.blog(On)) + + if (( ${#blog_files[@]} == 0 )); then + if ${debug}; then _msg debug "${0:t}_msg_1"; fi + export no_blogs_found=true + return + else + for file in "${blog_files[@]}" + do + if ${debug}; then _msg debug "${0:t}_msg_2" " $file"; fi + blogs_file_array+=("$file") + done + fi + +} + + +## +# @brief Cache the state of blog files and identify changes. +function _blog_cache() { + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + _list_blogs + + # Create an associative array for the blog cache + typeset -A blog_cache + + # Load the existing blog cache + if [[ -f $blog_cache_file ]]; then + while IFS=':' read -r name hash; do + blog_cache[$name]=$hash + if (${debug}) _msg debug "${0:t}_msg_1" " ${blog_cache[${name}]}" + done < "$blog_cache_file" + fi + + # Initialize the array for storing blog files to process + make_blog_array=() + + # Process blog files + for blog_file in ${blogs_file_array[@]}; do + # Compute the current blog file hash + current_hash=$(md5sum "$blog_file" | awk '{print $1}') + + if (${debug}) _msg debug "${0:t}_msg_2" " ${blog_file}" + if (${debug}) _msg debug "${0:t}_msg_3" " ${current_hash}" + + # Check if the blog file is new or has changed + if [[ ${blog_cache[$blog_file]} != "$current_hash" ]]; then + if (${debug}) _msg debug "${0:t}_msg_4" " ${blog_file}" + if (${debug}) _msg debug "${0:t}_msg_5" " ${current_hash}" + # Blog file is new or has changed; add it to the processing array + make_blog_array+=("$blog_file") + + # Update the blog cache with the new hash + blog_cache[$blog_file]=$current_hash + fi + done + + # Rebuild the blog cache file from scratch + : >| "$blog_cache_file" # Truncate the file before writing + for name in "${(@k)blog_cache}"; do + echo "$name:${blog_cache[$name]}" >> "$blog_cache_file" + done + +} + + +## +# @brief Cache the state of page files and identify changes. +# @return Array of pages to be processed. +function _pages_cache() { + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + # Create an associative array for the pages cache + typeset -A pages_cache + + _list_pages + + # Load the existing pages cache + if [[ -f $pages_cache_file ]]; then + while IFS=':' read -r name hash; do + pages_cache[$name]=$hash + if (${debug}) _msg debug "${0:t}_msg_1" " ${pages_cache[${name}]}" + done < "$pages_cache_file" + fi + + # Initialize the array for storing pages files to process + pages_array=() + + # Process pages files + for file in ${pages_file_array[@]}; do + # Compute the current blog file hash + current_hash=$(md5sum "$file" | awk '{print $1}') + + if (${debug}) _msg debug "${0:t}_msg_2" " ${pages_cache[$file]}" + if (${debug}) _msg debug "${0:t}_msg_3" " current_cache: ${current_hash}" + + # Check if the pages file is new or has changed + if [[ ${pages_cache[$file]} != "$current_hash" ]]; then + if (${debug}) _msg debug "${0:t}_msg_4" " ${pages_cache[$file]}" + if (${debug}) _msg debug "${0:t}_msg_5" " current_cache: ${current_hash}" + + # Pages file is new or has changed; add it to the processing array + pages_array+=("$file") + + # Update the pages cache with the new hash + pages_cache[$file]=$current_hash + fi + done + + # Rebuild the pages cache file from scratch + : >| "$pages_cache_file" # Truncate the file before writing + for name in "${(@k)pages_cache}"; do + echo "$name:${pages_cache[$name]}" >> "$pages_cache_file" + done + +} + +## +# @brief Update #updated and #version tags in the provided content. +# @param content The content to be updated. +# @return The updated content. +function _last_updated() { + # This function updates #updated and #version tags in the provided string for buffers + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + local upd_msg="Last updated ${today} by ${QSGEN} ${VERSION}" + + if (${debug}); then _msg debug "${0:t}_msg_1"; fi + if (${debug}); then _msg debug "${0:t}_msg_2" " ${upd_msg}"; fi + + local content="${1}" + + # Perform the replacements + local updated_content=$(echo "${content}" | sed \ + -e "s|#updated|${upd_msg}|") + + # Return the updated content + echo "${updated_content}" + +} + +## +# @brief Update #updated and #version tags in the provided file. +# @param file_path The path to the file to be updated. +function _f_last_updated() { + # Updates #updated and #version tags in the provided file using Zsh + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + # local file_path="${1}" + local upd_msg="Last updated ${today} by ${QSGEN} ${VERSION}" + + if ${debug}; then + _msg debug "${0:t}_msg_1" " ${1}" + _msg debug "${0:t}_msg_2" " ${upd_msg}" + fi + + # Read the file content into a variable + local content="$(<${1})" + + # Perform the replacement + content="${content//#updated/${upd_msg}}" + + if [[ -f "${1}" ]]; then + sed -i -e "s|#updated|${upd_msg}|" "${1}" + else + _msg debug "${0:t}_msg_3" " '${1}' " "${0:t}_msg_3.1" + fi + +} + +## +# @brief Convert the filename to lowercase and replace spaces with dashes. +# @param filename The original filename. +# @return The modified filename. +function _file_to_lower() { + + local filename="${1}" + + # Replace spaces with dashes + filename="${filename// /-}" + + # Convert to lowercase and remove invalid characters + filename=$(echo "${filename}" | sed -e 's/^[^a-zA-Z0-9_.]+//g' -e 's/[^a-zA-Z0-9_-]+/-/g') + + echo ${filename} + +} + + +## +# @brief Generate all new and updated pages. +function _pages() { + # This function generates all the new and updated Pages + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + _msg main "${0:t}_msg_3" + + # Load the cache for Pages + if (${debug}) _msg debug "${0:t}_msg_1" + _pages_cache + + if [[ ${no_pages_found} == "true" ]]; then + _msg sub "${0:t}_msg_1" + return + fi + + if (( ${#pages_array[@]} > 0 )); then + + # If pages_array is not empty, we do work + if (${debug}) _msg debug "${0:t}_msg_4" + + for pages_in_array in ${pages_array[@]} + do + if (${debug}) _msg debug "${0:t}_msg_5" + local pages=${config[project_root]}/themes/${config[site_theme]}/pages.tpl + + # Let's check if we can access the pages.tpl file. + # It not, exit script. + if [[ ! -f ${pages} ]]; then + _msg info "${0:t}_msg_6" " ${pages}" + exit + else + # Read template once + if (${debug}) _msg debug "${0:t}_msg_7" + local pages_tpl="$(<${pages})" + fi + + # _msg std " - ${pages_in_array%.*}.html" + # Read the file once + if (${debug}) _msg debug "${0:t}_msg_9" " ${pages_in_array}" + local page_content="$(<${pages_in_array})" + + # Grab the title from the Page + if (${debug}) _msg debug "${0:t}_msg_10" + if [[ ${config[project_generator]} == "native" ]]; then + while read -r line + do + if [[ "$line" =~ ^#title=(.*) ]]; then + local page_title=${match[1]} + break + #local page_title=$( echo ${page_content} | head -2 | grep \#title | cut -d= -f2 ) + fi + done <<< "$page_content" + elif [[ ${config[project_generator]} == "markdown" ]]; then + while IFS= read -r line + do + # Check if the line starts with '#' and capture the line + if [[ "$line" == \#* ]]; then + # Remove all leading '#' characters and the first space (if present) + local page_title="${line#\#}" # Remove the first '#' character + page_title="${page_title#\#}" # Remove the second '#' character if present + page_title="${page_title#"${page_title%%[![:space:]]*}"}" # Trim leading whitespace + break # Exit the loop after finding the first heading + fi + done <<< ${page_content} + fi + _msg std " - ${page_title}" + if (${debug}) _msg debug "${0:t}_msg_11" " ${page_title}" + + # Remove the #title line from the buffer. No longer needed. + if (${debug}) _msg debug "${0:t}_msg_12" + page_content=$( echo ${page_content} | grep -v \#title ) + + # HTML'ify the page content + if (${debug}) _msg debug "${0:t}_msg_13" " ${pages_in_array}" + page_content=$( _run_engine "$page_content" ) + # Look for links, images and videos and convert them if present. + if (${debug}) _msg debug "${0:t}_msg_14" + if [[ $( echo ${page_content} | grep \#link ) ]]; then + if (${debug}) _msg debug "${0:t}_msg_15" + page_content=$( _link "${page_content}" ) + fi + if [[ $( echo ${page_content} | grep \#showimg ) ]]; then + if (${debug}) _msg debug "${0:t}_msg_16" + page_content=$( _image "${page_content}" ) + fi + if [[ $( echo ${page_content} | grep \#ytvideo ) ]]; then + if (${debug}) _msg debug "${0:t}_msg_17" + page_content=$( _youtube "${page_content}" ) + fi + + # Replace every #pagetitle in pages_tpl + if (${debug}) _msg debug "${0:t}_msg_18" + pages_tpl=$(echo "${pages_tpl}" | perl -pe "s|#pagetitle|${page_title}|gs; s|#tagline|${config[site_tagline]}|gs; s|#sitename|${config[site_name]}|gs") + + if (${debug}) _msg debug "${0:t}_msg_19" + # Use awk for multi-line and special character handling + pages_tpl=$( awk -v new_body="$page_content" '{sub(/BODY/, new_body)} 1' <(echo "${pages_tpl}") ) + + # Replace #updated with today's date and #version with Name and Version to footer + if (${debug}) _msg debug "${0:t}_msg_20" + pages_tpl=$( _last_updated ${pages_tpl} ) + + # Always use lowercase for file names + if (${debug}) _msg debug "${0:t}_msg_21" + pages_title_lower=$( _file_to_lower "${pages_in_array}" ) + + # Clean up unused tags, if any + if (${debug}) _msg debug "${0:t}_msg_22" + pages_tpl=$( _cleanup "${pages_tpl}" ) + + # Write pages_tpl to disk + # _msg std "Writing ${config[site_root]}/${pages_title_lower%.*}.html to disk." + echo "${pages_tpl}" > ${config[site_root]}/${pages_title_lower%.*}.html + + # Insert the blog to the front page is blog_in_index is true and the file in the array is index.file_ext + # and if index.tmp.html exist and is not empty + if [[ ${pages_in_array} == "index.${file_ext}" && ${config[site_blog]} == "true" && -s "${config[project_root]}/blog/index.tmp.html" ]]; then + if (${debug}) _msg sub "${0:t}_msg_23" " ${pages_in_array}" + if (${debug}) _msg sub "${0:t}_msg_24" " ${config[site_blog]}" + if (${debug}) _msg sub "${0:t}_msg_25" + if (${debug}) ls -l ${config[project_root]}/blog/index.tmp.html + _add_blog_list_to_index + fi + + done + + export new_updated_pages=true + + else + # Insert the blog to the front page is blog_in_index is true and the file in the array is index.file_ext + # and if index.tmp.html exist and is not empty + if [[ ${config[site_blog]} == "true" && -s "${config[project_root]}/blog/index.tmp.html" ]]; then + _msg std "${0:t}_msg_26" + if (${debug}) _msg sub "${0:t}_msg_27" " ${pages_in_array}" + if (${debug}) _msg sub "${0:t}_msg_28" " ${config[site_blog]}" + if (${debug}) _msg sub "${0:t}_msg_25" + if (${debug}) ls -l ${config[project_root]}/blog/index.tmp.html + _add_blog_list_to_index + fi + + _msg sub "${0:t}_msg_29" + export new_updated_pages=false + + fi + +} + +## +# @brief Generate or update blog files or export metadata based on argument. +function _blogs() { + # This function either generates blog files or exports metadata based on the argument + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + _msg main "${0:t}_msg_3" + + # Running function _list_blogs + if (${debug}) _msg debug "${0:t}_msg_1" + _list_blogs + + if [[ ${no_blogs_found} == "true" ]]; then + _msg sub "${0:t}_msg_2" + return + fi + + # Running function _blog_cache + if (${debug}) _msg debug "${0:t}_msg_4" + _blog_cache + + if (( ${#make_blog_array[@]} > 0 )); then + + # Declare the array to hold metadata strings for each blog + BLOG_META_STR_ARRAY=() + + # Regular blog creation process + + if [[ -f ${config[project_root]}/themes/${config[site_theme]}/blogs.tpl ]]; then + local blog_tpl=$(<"${config[project_root]}/themes/${config[site_theme]}/blogs.tpl") + else + _msg info "${0:t}_msg_5" + exit + fi + + for blog in "${make_blog_array[@]}"; do + if (${debug}) _msg info "*************************************************************************" + if (${debug}) _msg info "**************************FOR LOOP START*********************************" + if (${debug}) _msg info "*************************************************************************" + if (${debug}) _msg debug "${0:t}_msg_6" " ${blog}" + + local content="$(<"${blog}")" + local sdate btitle ingress body blog_index blog_dir blog_url + + # Initialize variables to track if DATE and BLOG_TITLE are found + local date_found=false + local title_found=false + + # Process content line by line + while IFS= read -r line + do + # Check for the DATE line + if [[ "${line}" == "DATE "* ]]; then + if (${debug}) _msg debug "${0:t}_msg_7" + date_found=true + fi + # Check for the BLOG_TITLE line + if [[ "${line}" == "BLOG_TITLE "* ]]; then + if (${debug}) _msg debug "${0:t}_msg_8" + title_found=true + fi + # If both DATE and BLOG_TITLE are found, no need to continue checking + if [[ "${date_found}" == true && "${title_found}" == true ]]; then + break + fi + done <<< "${content}" + + # Check if DATE or BLOG_TITLE metadata is missing and log message + if [[ "${date_found}" == false ]]; then + if (${debug}) _msg debug "${0:t}_msg_9" " ${blog}." + continue # Skip this file and move to the next + fi + if [[ "${title_found}" == false ]]; then + if (${debug}) _msg debug "${0:t}_msg_10" " ${blog}." + continue # Skip this file and move to the next + fi + + # Extract blog information + sdate=( $( echo ${content} | grep DATE | sed "s|DATE\ ||" | sed "s|\-|\ |g" ) ) + if [[ ${config[project_generator]} == "native" ]]; then + if (${debug}) _msg debug "* qstags: Fetching BLOG_TITLE" + while IFS= read -r line; do + if [[ "$line" == "BLOG_TITLE "* ]]; then + btitle="${line#BLOG_TITLE }" + break + fi + done <<< "$content" + elif [[ ${config[project_generator]} == "markdown" ]]; then + if (${debug}) _msg debug "* markdown: Fetching BLOG_TITLE" + while IFS= read -r line; do + if [[ "$line" == \#* ]]; then + btitle="${line#\#}" # Remove the first '#' character + btitle="${btitle#\#}" # Remove the second '#' character if present + btitle="${btitle#"${btitle%%[![:space:]]*}"}" # Trim leading whitespace + break # Exit the loop after finding the first heading + fi + done <<< "$content" + fi + if (${debug}) _msg debug "* Fetching INGRESS" + ingress=$( echo ${content} | sed "s/'/\\\'/g" | xargs | grep -Po "#INGRESS_START\K(.*?)#INGRESS_STOP" | sed "s|\ \#INGRESS_STOP||" | sed "s|^\ ||" ) + if (${debug}) _msg debug "* Fetching BODY" + body=$( echo ${content} | sed "s/'/\\\'/g" | xargs | grep -Po "#BODY_START\K(.*?)#BODY_STOP" | sed "s|\ \#BODY_STOP||" | sed "s|^\ ||" ) + + blog_index=$(echo "${btitle:l}" | sed 's/ /_/g; s/,//g; s/\.//g; s/://g; s/[()]//g') + + blog_dir="/blog/${sdate[2]}/${sdate[3]:l}/${sdate[4]}" + blog_url="${blog_dir}/${blog_index}.html" + + if (${debug}) _msg debug "${0:t}_msg_11" " ${blog} " "${0:t}_msg_11.1" + + # Concatenate all metadata into a single string for the current blog + local metadata_str="SDATE: ${sdate[@]}||BTITLE: ${btitle}||INGRESS: ${ingress}||URL: ${blog_url}" + # Append this metadata string to the array + BLOG_META_STR_ARRAY+=("${metadata_str}") + + if (${debug}) _msg debug "${0:t}_msg_12" " ${blog}" + + _msg std " - ${btitle}" + + # Prepare the blog template + if (${debug}) _msg debug "${0:t}_msg_14" " ${blog}" + local blog_content=$( + echo "${blog_tpl}" | \ + perl -pe "\ + s|BLOGTITLE|${btitle}|g; \ + s|BLOGURL|${blog_url}|g; \ + s|\QINGRESS\E|${ingress}|g; \ + s|\QBODY\E|${body}|g \ + ") + blog_content="${blog_content//CALNDAY/${sdate[4]}}" + blog_content="${blog_content//CALYEAR/${sdate[2]}}" + blog_content="${blog_content//CALMONTH/${sdate[3]}}" + blog_content="${blog_content//CALADAY/${sdate[1]}}" + + if (${debug}) _msg debug "${0:t}_msg_15" " ${engine} " "${0:t}_msg_15_1" " ${blog}" + blog_content=$( _run_engine "${blog_content}" ) + # Look for links, images and videos and convert them if present. + if (${debug}) _msg debug "${0:t}_msg_16" + if [[ $( echo ${blog_content} | grep \#link ) ]]; then + if (${debug}) _msg debug "${0:t}_msg_17" + blog_content=$(_link "${blog_content}") + fi + if [[ $( echo ${blog_content} | grep \#showimg ) ]]; then + if (${debug}) _msg debug "${0:t}_msg_18" + blog_content=$(_image "${blog_content}") + fi + if [[ $( echo ${blog_content} | grep \#ytvideo ) ]]; then + if (${debug}) _msg debug "${0:t}_msg_19" + blog_content=$(_youtube "${blog_content}") + fi + + # Replace every #tagline in blog_content + if (${debug}) _msg debug "${0:t}_msg_20" + blog_content=$( echo ${blog_content} | perl -pe "s|#tagline|${config[site_tagline]}|gs; s|#sitename|${config[site_name]}|gs; s|#pagetitle|${page_title}|gs" ) + + if (${debug}) _msg debug "* Running _last_updated" + blog_content=$(_last_updated "${blog_content}") + if (${debug}) _msg debug "* Running _cleanup" + blog_content=$(_cleanup "${blog_content}") + + # Create directory if it doesn't exist + if (${debug}) _msg debug "${0:t}_msg_21" " ${config[site_root]}${blog_dir}" + [[ ! -d "${config[site_root]}/${blog_dir}" ]] && mkdir -p "${config[site_root]}/${blog_dir}" + + # Write to file + if (${debug}) _msg debug "${0:t}_msg_22" " ${config[site_root]}${blog_url}" + echo "${blog_content}" > "${config[site_root]}${blog_url}" + + unset sdate btitle ingress body blog_index blog_dir blog_url + + done + # Now BLOG_META_STR_ARRAY contains the metadata string for each blog post + export BLOG_META_STR_ARRAY + if (${debug}) _msg debug "${0:t}_msg_23" + export new_updated_blogs=true + + else + _msg sub "${0:t}_msg_24" + export new_updated_blogs=false + fi + + if [[ ${new_updated_blogs} == "true" ]]; then + if (${debug}) _msg sub "${0:t}_msg_25" + _blog_idx_for_index + if (${debug}) _msg sub "${0:t}_msg_26" + _blog_index + fi + +} + +## +# @brief Generate the file blog/index.tmp.html. +function _blog_idx_for_index() { + # This function generates the file blog/index.tmp.html + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + _msg sub "${0:t}_msg_1" " ${config[project_root]}/blog/index.tmp.html" + + if (${debug}) _msg debug "${0:t}_msg_2" + + local blog_list_tpl=$(<${config[project_root]}/themes/${config[site_theme]}/blog_list.tpl) + local blog_list_content="" + + # Truncate file before writing new one + : >| "${config[project_root]}/blog/index.tmp.html" + + # if (${debug}) _msg debug "${0:t}_msg_3" " ${BLOG_META_STR_ARRAY[@]}" + + for meta_str in ${BLOG_META_STR_ARRAY[@]} + do + if (${debug}) _msg debug "${0:t}_msg_4" + if (${debug}) _msg debug "${0:t}_msg_5" " ${meta_str}" + + # Split meta_str into individual metadata components + local -a meta_array=("${(@s/||/)meta_str}") + + # Initialize variables to store each component + local sdate btitle ingress url + + # Iterate over each component and extract information + if (${debug}) _msg debug "${0:t}_msg_6" + for component in "${meta_array[@]}" + do + case "${component}" in + SDATE:*) sdate=${component#SDATE: } ;; + BTITLE:*) btitle=${component#BTITLE: } ;; + INGRESS:*) ingress=${component#INGRESS: } ;; + URL:*) url=${component#URL: } ;; + esac + + done + + local adate=( $( echo ${sdate} ) ) + local caladay="${adate[1]}" + local calyear="${adate[2]}" + local calmonth="${adate[3]}" + local calnday="${adate[4]}" + + local bdate="${adate[1]} - ${adate[4]}/${adate[3]}/${adate[2]}" + blog_list_content+=$( + echo "${blog_list_tpl}" | \ + perl -pe "\ + s|BLOGURL|${config[site_url]}${url}|g; \ + s|BLOGTITLE|${btitle}|g; \ + s|INGRESS|${ingress}|g; \ + s|BLOGDATE|${bdate}|g; \ + s|CALADAY|${caladay}|g; \ + s|CALNDAY|${calnday}|g; \ + s|CALMONTH|${calmonth}|g; \ + s|CALYEAR|${calyear}|g \ + ") + + unset sdate btitle ingress url adate caladay calyear calmonth calnday + + done + if (${debug}) _msg debug "${0:t}_msg_7" " ${engine} " "${0:t}_msg_7.1" + # Catch any QStags or Markdown in the Ingress + blog_list_content=$( _run_engine ${blog_list_content} ) + if (${debug}) _msg debug "${0:t}_msg_8" " ${config[project_root]}/blog/index.tmp.html" + #if (${debug}) _msg debug "${0:t}_msg_9" " ${blog_list_content}" + echo ${blog_list_content} > ${config[project_root]}/blog/index.tmp.html + +} + +## +# @brief Generate the www_root/blog/index.html file. +function _blog_index() { + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + # This function generates the www_root/blog/index.html file that gets its data from _blog_list_for_index() + # ${new_updated_blogs} comes from the function _blogs if anything new or updated is detected + if ([[ ${config[site_blog]} == "false" ]] && [[ ${new_updated_blogs} = "true" ]]); then + + if (${debug}) _msg debug "${0:t}_msg_1" "${config[site_blog]}" + if (${debug}) _msg debug "${0:t}_msg_2" "${new_updated_blogs}" + if (${debug}) _msg debug "${0:t}_msg_3" + if (${debug}) _msg debug "${0:t}_msg_4" " ${config[site_blog]}" + + _msg std "${0:t}_msg_5" " ${config[site_root]}/blog/index.html" + + local blog_index_tpl=$(<${config[project_root]}/themes/${config[site_theme]}/blog_index.tpl) + local blog_index_list=$(<${config[project_root]}/blog/index.tmp.html) + + if (${debug}) _msg debug "${0:t}_msg_6" + local blog_index_content=$(echo "${blog_index_tpl}" | perl -pe "s|#sitename|${config[site_name]}|gs; s|#tagline|${config[site_tagline]}|gs") + if (${debug}) _msg debug "${0:t}_msg_7" " ${config[project_root]}/blog/index.tmp.html" + blog_index_content=$( awk -v new_body="$blog_index_list" '{sub(/BODY/, new_body)} 1' <(echo "${blog_index_content}") ) + + if (${debug}); then + _msg debug "${0:t}_msg_8" " ${config[site_root]}/blog/index.html" + _msg debug "${0:t}_msg_9" " ${#blog_index_content}" + fi + echo "$blog_index_content" > ${config[site_root]}/blog/index.html + _f_last_updated ${config[site_root]}/blog/index.html + + fi + +} + +## +# @brief Add the blog list to the index file if blog_in_index is true. +function _add_blog_list_to_index() { + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + # Let's find the file 'index.qst' and add the blog if blog_in_index is true + if (${debug}) _msg debug "${0:t}_msg_1" + local blog_index_list=$(<${config[project_root]}/blog/index.tmp.html) + local site_index_file=$(<${config[site_root]}/index.html) + echo "${site_index_file}" | awk -v new_body="${blog_index_list}" '{sub(/BLOGINDEX/, new_body)} 1' > "${config[site_root]}/index.html" + +} + +## +# @brief Generate the sitemap files if conditions are met. +function _sitemap() { + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + # Check if sitemap is set to true and if there are updated Blogs or Pages before updating the sitemap.xml file. + if ([[ ${config[site_sitemap]} == "true" ]] && ( [[ ${new_updated_blogs} == "true" ]] || [[ ${new_updated_pages} == "true" ]] )) || [[ ${sitemap_force} == "true" ]]; then + + setopt extendedglob + + _msg main "${0:t}_msg_1" + + local sm_file="sitemap.xml" + local b_file="sitemap-blogs.xml" + local p_file="sitemap-pages.xml" + local sitemap_file="${config[site_root]}/${sm_file}" + local sitemap_blog="${config[site_root]}/${b_file}" + local sitemap_page="${config[site_root]}/${p_file}" + + # Find all HTML files and store them in an array + builtin cd ${config[site_root]} + local -a html_files=(**/[a-z]*.html(.)) + local -a blog_files=() + local -a page_files=() + for file in "${html_files[@]}"; do + if [[ $file == *blog* ]]; then + blog_files+=("$file") + else + page_files+=("$file") + fi + done + + # Start of the XML file for BLOGS + echo '' > ${sitemap_blog} + echo "" >> ${sitemap_blog} + echo "" >> ${sitemap_blog} + echo '> ${sitemap_blog} + echo ' xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"' >> ${sitemap_blog} + echo ' xmlns:xhtml="http://www.w3.org/1999/xhtml"' >> ${sitemap_blog} + echo ' xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"' >> ${sitemap_blog} + echo '>' >> ${sitemap_blog} + + # Add each URL to the sitemap + for file in "${blog_files[@]}" + do + # Remove www_root from the path and prepend site_url + local url="${config[site_url]}/${file}" + local lastmod=$(stat -c %y "${file}" 2>/dev/null | cut -d' ' -f1,2 | sed 's/ /T/' | sed 's/\..*$//') + + echo " " >> ${sitemap_blog} + echo " ${url}" >> ${sitemap_blog} + echo " " >> ${sitemap_blog} + echo " " >> ${sitemap_blog} + echo " " >> ${sitemap_blog} + echo " " >> ${sitemap_blog} + done + + # End of the XML file + echo '' >> "${sitemap_blog}" + _msg std " - ${b_file}" + + # Start of the XML file for PAGES + echo '' > ${sitemap_page} + echo "" >> ${sitemap_page} + echo "" >> ${sitemap_page} + echo '> ${sitemap_page} + echo ' xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"' >> ${sitemap_page} + echo ' xmlns:xhtml="http://www.w3.org/1999/xhtml"' >> ${sitemap_page} + echo ' xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"' >> ${sitemap_page} + echo '>' >> ${sitemap_page} + + # Add each URL to the sitemap + for file in "${page_files[@]}" + do + # Remove www_root from the path and prepend site_url + local url="${config[site_url]}/${file}" + local lastmod=$(stat -c %y "${file}" 2>/dev/null | cut -d' ' -f1,2 | sed 's/ /T/' | sed 's/\..*$//') + + echo " " >> ${sitemap_page} + echo " ${url}" >> ${sitemap_page} + echo " " >> ${sitemap_page} + echo " " >> ${sitemap_page} + echo " " >> ${sitemap_page} + echo " " >> ${sitemap_page} + done + + # End of the XML file + echo '' >> "${sitemap_page}" + _msg std " - ${p_file}" + + if (${debug}); then _msg debug "${0:t}_msg_2" " ${sitemap_file}"; fi + + # Start of the XML file for the main sitemap + echo '' > "${sitemap_file}" + echo "" >> "${sitemap_file}" + + # Add sitemap-blogs.xml to the sitemap + echo " " >> "${sitemap_file}" + echo " ${config[site_url]}/${b_file}" >> "${sitemap_file}" + local lastmod_b=$(stat -c %y "${b_file}" 2>/dev/null | cut -d' ' -f1,2 | sed 's/ /T/' | sed 's/\..*$//') + echo " ${lastmod_b}" >> "${sitemap_file}" + echo " " >> "${sitemap_file}" + + # Add sitemap-pages.xml to the sitemap + echo " " >> "${sitemap_file}" + echo " ${config[site_url]}/${p_file}" >> "${sitemap_file}" + local lastmod_p=$(stat -c %y "${p_file}" 2>/dev/null | cut -d' ' -f1,2 | sed 's/ /T/' | sed 's/\..*$//') + echo " ${lastmod_p}" >> "${sitemap_file}" + echo " " >> "${sitemap_file}" + + # End of the XML file + echo "" >> "${sitemap_file}" + _msg std " - ${sm_file}" + + builtin cd ${config[project_root]} + + fi + +} + +## +# @brief Convert #link tags to clickable HTML links. +# @param content The content containing #link tags. +# @return The content with #link tags replaced by HTML links. +function _link() { + # This converts #link tags to actual clickable links in a provided string + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + local content="${1}" + local modified_content="" + + # Process the content line by line + echo "${content}" | while IFS= read -r line; do + if [[ ${line} == *"#link"* ]]; then + if (${debug}) _msg debug "${0:t}_msg_1" " ${line}" + + # Extract the URL and the link text + local url_full=$(echo "${line}" | awk -F'#link ' '{print $2}' | awk -F'¤' '{print $1 "¤" $2}') + local url_dest=$(echo "${url_full}" | awk -F'¤' '{print $1}') + local url_txt=$(echo "${url_full}" | awk -F'¤' '{print $2}') + + if (${debug}) _msg debug "${0:t}_msg_2" " ${url_dest}" + if (${debug}) _msg debug "${0:t}_msg_3" " ${url_txt}" + + # Form the replacement HTML link + local modified_link="${url_txt}" + if [[ ${url_dest} =~ ^https?:// ]]; then + # Add external link icon for external URLs + modified_link+="\"External" + fi + modified_link+="" + line=${line//"#link ${url_full}"/${modified_link}} + fi + modified_content+="${line}\n" + done + + # Return the modified content + echo -e "${modified_content}" + +} + +## +# @brief Convert #showimg tags to HTML img tags. +# @param content The content containing #showimg tags. +# @return The content with #showimg tags replaced by HTML img tags. +function _image() { + # This replaces #showimg tags with actual HTML img tags in a provided string + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + local content="${1}" + local modified_content="" + + # Process the content line by line + echo "${content}" | while IFS= read -r line; do + if [[ ${line} == *"#showimg"* ]]; then + if (${debug}) _msg debug "${0:t}_msg_1" " ${line}" + + # Extract image link and alt text + local img_link=$(echo "${line}" | awk -F'#showimg ' '{print $2}') + local image=$(echo "${img_link}" | awk -F'¤' '{print $1}') + local img_alt=$(echo "${img_link}" | awk -F'¤' '{print $2}') + + # Determine the source of the image + local real_image="" + if [[ ${image} =~ ^https?:// ]]; then + real_image=${image} + elif [[ ${image} =~ ^\/ ]]; then + real_image=${image} + else + real_image="/images/${image}" + fi + + # Form the replacement HTML image tag + local img_tag="\"${img_alt}\"" + line=${line//"#showimg ${img_link}"/${img_tag}} + fi + modified_content+="${line}\n" + done + + # Return the modified content + echo -e "${modified_content}" + +} + +## +# @brief Embed a YouTube video in the provided content. +# @param content The content containing #ytvideo tags. +# @return The content with #ytvideo tags replaced by YouTube iframe embeds. +function _youtube() { + # This embeds a YouTube video in a provided string + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + local content="${1}" + local modified_content="" + + # Process the content line by line + echo "${content}" | while IFS= read -r line; do + if [[ ${line} == *"#ytvideo"* ]]; then + if (${debug}) _msg debug "${0:t}_msg_1" " ${line}" + + # Extract YouTube video ID + local yt_id=$(echo "${line}" | awk -F'#ytvideo ' '{print $2}') + + # Form the replacement YouTube iframe embed + local yt_iframe="" + line=${line//"#ytvideo ${yt_id}"/${yt_iframe}} + fi + modified_content+="${line}\n" + done + + # Return the modified content + echo -e "${modified_content}" + +} + +## +# @brief Remove leftover tags from the content. +# @param content The content to be cleaned. +# @return The cleaned content. +function _cleanup() { + # This removes tags used in the templates that may be left over for some reason + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + local content="${1}" + + if (${debug}) _msg debug "${0:t}_msg_1" + + # Perform the cleanup + # -e "s|BLOGINDEX\ ||g" + local cleaned_content=$(echo "${content}" | sed \ + -e "s|¤||g" \ + -e "s|#showimg\ ||g" \ + -e "s|#ytvideo\ ||g" \ + -e "s|#link\ ||g" \ + ) + + # Return the cleaned content + echo "${cleaned_content}" + +} + +## +# @brief Convert QStags to HTML using Perl. +# @param content The content containing QStags. +# @return The content with QStags converted to HTML. +function _p_qstags() { + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + local content="${1}" + + if ${debug}; then + _msg debug "${0:t}_msg_1" + fi + + # Use perl to convert QStags to HTML + perl -0777 -pe ' + BEGIN { + @qstags = ( + "#BR", "
\n", + "#BD", "", "#EBD", "", + "#I", "", "#EI", "\n", + "#P", "

", "#EP", "

\n", + "#Q", "
", "#EQ", "
\n", + "#C", "", "#EC", "\n", + "#H1", "

", "#EH1", "

\n", + "#H2", "

", "#EH2", "

\n", + "#H3", "

", "#EH3", "

\n", + "#H4", "

", "#EH4", "

\n", + "#H5", "
", "#EH5", "
\n", + "#H6", "
", "#EH6", "
\n", + "#STRONG", "", "#ESTRONG", "\n", + "#EM", "", "#SEM", "\n", + "#DV", "
", "#EDV", "
\n", + "#SPN", "", "#ESPN", "\n", + "#UL", "
    ", "#EUL", "
\n", + "#OL", "
    ", "#EOL", "
\n", + "#LI", "
  • ", "#ELI", "
    • \n", + "#UD", "", "#EUD", "\n", + "#TBL", "", "#ETBL", "
    \n", + "#TR", "", "#ETR", "\n", + "#TD", "", "#ETD", "\n", + "#TH", "", "#ETH", "\n", + "#ART", "
    ", "#EART", "
    \n", + "#SEC", "
    ", "#ESEC", "
    \n", + "#ASIDE", "\n", + "#NAV", "\n", + "#BTN", "\n", + "#SEL", "\n", + "#OPT", "\n", + "#LT", "<", "#GT", ">", "#NUM", "#" + ); + } + + for (my $i = 0; $i < $#qstags; $i += 2) { + my $qstag = $qstags[$i]; + my $html = $qstags[$i + 1]; + s/\Q$qstag\E/$html/g; + } + ' <<< "$content" + +} + +## +# @brief Convert QStags to HTML using Zsh regex module. +# @param content The content containing QStags. +# @return The content with QStags converted to HTML. +function _qstags() { + + # This function uses the regex module from Zsh to parse the QStags + + if [[ ${globaldebug} == "true" ]]; then + local debug=true + else + local debug=false + fi + + local content="${1}" + + if ${debug}; then + _msg debug "${0:t}_msg_1" + fi + + # Load regex module + # zmodload zsh/regex + + # Define tag replacements as an associative array + typeset -A qstags=( + "#BR" "
    \n" + "#BD" "" "#EBD" "" + "#I" "" "#EI" "\n" + "#P" "

    " "#EP" "

    \n" + "#Q" "
    " "#EQ" "
    \n" + "#C" "" "#EC" "\n" + "#H1" "

    " "#EH1" "

    \n" + "#H2" "

    " "#EH2" "

    \n" + "#H3" "

    " "#EH3" "

    \n" + "#H4" "

    " "#EH4" "

    \n" + "#H5" "
    " "#EH5" "
    \n" + "#H6" "
    " "#EH6" "
    \n" + "#STRONG" "" "#ESTRONG" "\n" + "#EM" "" "#SEM" "\n" + "#DV" "
    " "#EDV" "
    \n" + "#SPN" "" "#ESPN" "\n" + "#UL" "
      " "#EUL" "
    \n" + "#OL" "
      " "#EOL" "
    \n" + "#LI" "
  • " "#ELI" "
    • \n" + "#UD" "" "#EUD" "\n" + "#TBL" "" "#ETBL" "
    \n" + "#TR" "" "#ETR" "\n" + "#TD" "" "#ETD" "\n" + "#TH" "" "#ETH" "\n" + "#ART" "
    " "#EART" "
    \n" + "#SEC" "
    " "#ESEC" "
    \n" + "#ASIDE" "\n" + "#NAV" "\n" + "#BTN" "\n" + "#SEL" "\n" + "#OPT" "\n" + "#LT" "<" "#GT" ">" "#NUM" "#" + ) + + #for qstag html (${(kv)qstags}) + # do + # # Escape tag for regex use + # local escapedTag=$(printf '%s' "$qstag" | sed 's/[].\[^$*]/\\&/g') + # if [[ "$content" =~ "$escapedTag" ]]; then + # content=${content//($qstag)/$html} + # fi + #done + for qstag html (${(kv)qstags}); do + # Direct replacement without regex check + content=${content//${qstag}/${html}} + done + + echo "${content}" + +} + + +case ${1} in + force) + _msg sub "_qsgen2_msg_2" + : >| "$blog_cache_file" # Truncate the blog cache before doing update + : >| "$pages_cache_file" # Truncate the page cache before doing update + ;; + sitemap) + _msg sub "Updating sitemaps" + export sitemap_force=true + _sitemap + exit + ;; + *) + # Nothing + ;; +esac + +_blogs +_pages +_sitemap