commit 003f4eec726360c00d13b4f3cc09d310ea50de77 Author: jetstream0 <49297268+jetstream0@users.noreply.github.com> Date: Sun Jul 30 14:28:18 2023 -0700 templating (ryuji) done diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..df2e8ca --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +node_modules +build +*.js +!static/*.js \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ca7beca --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +## Hedgeblog +My personal blog. + +# Makoto +Makoto is the markdown-to-html parser. + +# Ryuji +Ryuji is a simple templating system. + +# Saki +Saki is the build system that puts it all together and creates the blog's static html. diff --git a/endosulfan.ts b/endosulfan.ts new file mode 100644 index 0000000..eb6e852 --- /dev/null +++ b/endosulfan.ts @@ -0,0 +1,40 @@ + +export let total_tests: number = 0; +export let failed_tests: number = 0; +export let passed_tests: number = 0; + +export function test_assert(condition: boolean, test_name: string): boolean { + total_tests++; + if (condition) { + passed_tests++; + console.log(`\x1B[32mTEST PASS\x1B[m ${test_name}`); + return true; + } else { + failed_tests++; + console.log(`\x1B[31mTEST FAIL\x1B[m ${test_name}`); + return false; + } +} + +//items will probably be strings or numbers, +//but any object that is comparable after a JSON.stringify() should be fine +export function test_assert_equal(first_item: any, second_item: any, test_name: string, silent: boolean=false) { + if (typeof first_item !== typeof second_item) { + throw Error("Cannot compare two items of different types!"); + } + //if the items are objects (including arrays) + if (typeof first_item === "object") { + first_item = JSON.stringify(first_item); + second_item = JSON.stringify(second_item); + } + let passed = test_assert(first_item === second_item, test_name); + if (!silent && !passed) { + //log info for debugging purposes + //log both items + console.log(`${test_name}:\n========\n${first_item}\n========\n${second_item}\n========`); + } +} + +export function log_test_results() { + console.log(`Total Passed: \x1B[32m${passed_tests}/${total_tests}\x1B[m\nTotal Failed: \x1B[31m${failed_tests}/${total_tests}\x1B[m`); +} diff --git a/index.ts b/index.ts new file mode 100644 index 0000000..e69de29 diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..e09f438 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,30 @@ +{ + "name": "hedgeblog", + "version": "0.0.1", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "hedgeblog", + "version": "0.0.1", + "license": "AGPL-3.0", + "dependencies": { + "makoto": "^1.0.0" + }, + "devDependencies": { + "@types/node": "^20.4.5" + } + }, + "node_modules/@types/node": { + "version": "20.4.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.4.5.tgz", + "integrity": "sha512-rt40Nk13II9JwQBdeYqmbn2Q6IVTA5uPhvSO+JVqdXw/6/4glI6oR9ezty/A9Hg5u7JH4OmYmuQ+XvjKm0Datg==", + "dev": true + }, + "node_modules/makoto": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/makoto/-/makoto-1.0.0.tgz", + "integrity": "sha512-Zl2GWYNrPqpSXZajf2rBcgOD6rtwi3gT/sc0pbjGJSPvad9uoJ0z6iMTZowfohbYHhTLeR2x3E20CQ//myyrqg==" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..bc16ecf --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "name": "hedgeblog", + "version": "0.0.1", + "description": "blog", + "main": "index.js", + "scripts": { + "build": "tsc -p . && node saki.js", + "test": "tsc -p . && node tests.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/jetstream0/hedgeblog.git" + }, + "author": "jetstream0/prussia", + "license": "AGPL-3.0", + "bugs": { + "url": "https://github.com/jetstream0/hedgeblog/issues" + }, + "homepage": "https://github.com/jetstream0/hedgeblog#readme", + "dependencies": { + "makoto": "^1.0.0" + }, + "devDependencies": { + "@types/node": "^20.4.5" + } +} diff --git a/posts/_metadata.json b/posts/_metadata.json new file mode 100644 index 0000000..df5cf46 --- /dev/null +++ b/posts/_metadata.json @@ -0,0 +1,10 @@ +{ + "example": { + "title": "Example!", + "slug": "example", + "filename": "example", + "date": "30/12/1999", + "author": "Prussia", + "tags": [] + } +} \ No newline at end of file diff --git a/posts/example.md b/posts/example.md new file mode 100644 index 0000000..8c8913c --- /dev/null +++ b/posts/example.md @@ -0,0 +1,19 @@ +Hello! This is an **example** post *not meant* to be actually served on the blog. Go to the `gh-pages` branch of the repo for the actual blog posts and stuff. + +[look its a link](https://example.com) + +![and an image too??? no way](/favicon.ico) + +## Wow a header + +```js +console.log("code block!!!"); +//todo: syntax highlighting +``` + +> ## woah a blockquote +> Yeehaw ^[1]^ + +=== + +- [1]: Source? Me. diff --git a/ryuji.ts b/ryuji.ts new file mode 100644 index 0000000..504d88d --- /dev/null +++ b/ryuji.ts @@ -0,0 +1,217 @@ +import { readFileSync } from 'fs'; + +export const SYNTAX_REGEX = /\[\[ [a-zA-Z0-9.:\-_]+ \]\]/g; + +export type file_extension = `.${string}`; + +export interface ForLoopInfo { + index: number, + total: number, + current: number, + var_value: any, //value we are looping over + iter_var_name?: string, +} + +export class Renderer { + templates_dir: string; + components_dir: string; + file_extension: file_extension; + + constructor(templates_dir: string, components_dir: string, file_extension: file_extension=".html") { + this.templates_dir = templates_dir; + this.components_dir = components_dir; + this.file_extension = file_extension + } + + static remove_empty_lines(text: string): string { + let lines: string[] = text.split("\n"); + let new_lines: string[] = []; + for (let i=0; i < lines.length; i++) { + if (lines[i].trim() === "") continue; + new_lines.push(lines[i]); + } + return new_lines.join("\n"); + } + + static concat_path(path1: string, path2: string): string { + if (path1.endsWith("/") && path2.startsWith("/")) { + return `${path1.slice(0, path1.length-1)}${path2}`; + } else if ((!path1.endsWith("/") && path2.startsWith("/")) || (path1.endsWith("/") && !path2.startsWith("/"))) { + return `${path1}${path2}`; + } else if (!path1.endsWith("/") && !path2.startsWith("/")) { + return `${path1}/${path2}`; + } + } + + static sanitize(non_html: string): string { + return non_html.replaceAll("<", "<").replaceAll(">", ">"); + } + + static check_var_name_legality(var_name: string, dot_allowed: boolean=true) { + //I try to avoid regex if I can + let legal_chars: string[] = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "_", "."]; + if (!dot_allowed) legal_chars.pop(); + let legal_var_name: boolean = var_name.toLowerCase().split("").every((char) => legal_chars.includes(char)); + if (!legal_var_name) throw Error(`Variable name "${var_name}" has illegal characters`); + } + + static get_var(var_name: string, vars?: any): any { //probably a string but guarantee + if (typeof vars === "undefined") throw Error(`Variable "${var_name}" is undefined`); + Renderer.check_var_name_legality(var_name); + let splitted: string[] = var_name.split(".") + let var_value = vars; + for (let i=0; i < splitted.length; i++) { + var_value = var_value?.[splitted[i]]; + } + if (typeof var_value === "undefined") throw Error(`Variable "${var_name}" is undefined`); + return var_value; + } + + render(template_contents: string, vars?: any, recursion_layer: number=0): string { + let matches = [...template_contents.matchAll(SYNTAX_REGEX)]; + if (matches.length === 0) { + return template_contents; + } + let _iterations: number = 0; + let rendered: string = template_contents.slice(0, matches[0].index); + let index: number = 0; + let for_loops: ForLoopInfo[] = []; + //let offset: number = 0; //I guess we don't need the offset + while (true) { + if (index === matches.length) break; + if (_iterations > 200) return; //safeguard, todo: remove + let match = matches[index]; + //[[ content ]] + let exp_parts = match[0].slice(3, match[0].length-3).split(":"); + if (exp_parts[0] === "component") { + //we do not want get into an infinite recursion loop with components referring to each other + if (recursion_layer > 5) throw Error("Components more than 5 layers deep, components may be referencing each other in infinite loop."); + if (typeof exp_parts[1] !== "string") throw Error("`component:` statement missing component file name afterwards"); + let file_name: string = exp_parts[1]; + rendered += this.render_template(Renderer.concat_path(this.components_dir, `${file_name}${this.file_extension}`), vars, recursion_layer+1); + } else if (exp_parts[0] === "for") { + if (for_loops[for_loops.length-1]?.index === index) { + //for loop already exists, just continue and do nothing + } else { + //variables in for loops are not scoped because that would be too much work + if (typeof exp_parts[1] !== "string") throw Error("`for:` statement missing variable name to loop over afterwards"); + let var_name: string = exp_parts[1]; + let var_value = Renderer.get_var(var_name, vars); + //set iter variable (optional) (you know, the "post" in "for post in posts") + //(I don't know what the actual name of that thing is) + if (typeof exp_parts[2] === "string") { + let iter_var_name: string = exp_parts[2]; + Renderer.check_var_name_legality(iter_var_name, false); + vars[iter_var_name] = var_value[0]; + } + //add to for loops + for_loops.push({ + index, + total: var_value.length, + current: 0, + var_value, + iter_var_name: exp_parts[2], + }); + //make sure thing we are iterating over isn't empty + if (var_value.length === 0) { + //skip straight to the endfor + //todo: remove + /*let new_index: number = matches.slice(index, matches.length).findIndex((match) => match[0] === "[[ endfor ]]"); + if (new_index === -1) throw Error("for statement missing an `[[ endfor ]]`"); + index += new_index; + continue;*/ + let sliced = matches.slice(index+1, matches.length); + let new_index: number; + let extra_forss: number = 0; + for (let i=0; i < sliced.length; i++) { + if (sliced[i][0].startsWith("[[ for:")) { + extra_forss++; + } else if (sliced[i][0] === "[[ endfor ]]") { + if (extra_forss === 0) { + new_index = i; + break; + } + extra_forss--; + } + } + if (typeof new_index === "undefined") throw Error("if statement missing an `[[ endif ]]`"); + index += new_index+1; + continue; + } + } + } else if (exp_parts[0] === "endfor") { + //check if for loop is over, if not, go back to for + let current_loop: ForLoopInfo = for_loops[for_loops.length-1]; + current_loop.current++; + if (current_loop.current >= current_loop.total) { + //for loop ended, onwards! oh yeah, also remove the current for loop info + for_loops.pop(); + } else { + //update iter var + if (current_loop.iter_var_name) { + vars[current_loop.iter_var_name] = current_loop.var_value[current_loop.current]; + } + //go back to start of for loop index + index = current_loop.index; + continue; + } + } else if (exp_parts[0] === "if") { + if (typeof exp_parts[1] !== "string") throw Error("`if:` statement missing variable name afterwards"); + let var_name: string = exp_parts[1]; + let var_value = Renderer.get_var(var_name, vars); + if (var_value) { + //yup, nothing here + } else { + //skip to the endif + let sliced = matches.slice(index+1, matches.length); + let new_index: number; + let extra_ifs: number = 0; + for (let i=0; i < sliced.length; i++) { + if (sliced[i][0].startsWith("[[ if:")) { + extra_ifs++; + } else if (sliced[i][0] === "[[ endif ]]") { + if (extra_ifs === 0) { + new_index = i; + break; + } + extra_ifs--; + } + } + if (typeof new_index === "undefined") throw Error("if statement missing an `[[ endif ]]`"); + index += new_index+1; + continue; + } + } else if (exp_parts[0] === "endif") { + //yup, nothing here + } else { //html: or + //variable + let var_name: string; + if (exp_parts[0] === "html") { + if (typeof exp_parts[1] !== "string") throw Error("`html:` statement missing variable name afterwards"); + var_name = exp_parts[1]; + } else { + var_name = exp_parts[0]; + } + let var_value = Renderer.get_var(var_name, vars); + if (exp_parts[0] === "html") { + //variable but not sanitized + rendered += var_value; + } else { + rendered += Renderer.sanitize(var_value); + } + //offset += var_value.length-match[0].length; + } + //add the html that comes after this, up until the next template syntax match thing + rendered += template_contents.slice(match.index+match[0].length, matches[index+1]?.index ? matches[index+1].index : template_contents.length); + index++; + _iterations++; + } + return rendered; + } + + render_template(template_name: string, vars?: any, recursion_layer: number=0): string { + let path_to_template: string = Renderer.concat_path(this.templates_dir, template_name); + const template_contents: string = readFileSync(path_to_template, "utf-8"); + return this.render(template_contents, vars, recursion_layer); + } +} diff --git a/saki.ts b/saki.ts new file mode 100644 index 0000000..5b696a6 --- /dev/null +++ b/saki.ts @@ -0,0 +1,19 @@ +import { readFileSync, writeFileSync } from 'fs'; +import { Renderer } from './ryuji'; +import { parse_md_to_html } from 'makoto'; + +export interface PostMetadata { + title: string, + slug: string, + filename: string, + date: string, + author: string, + tags: string[], +} + +export interface Post extends PostMetadata { + md: string, + html: string, +} + +// diff --git a/templates/components/post-listing.html b/templates/components/post-listing.html new file mode 100644 index 0000000..2d7b0ec --- /dev/null +++ b/templates/components/post-listing.html @@ -0,0 +1 @@ +
  • [[ post.title ]]
    • \ No newline at end of file diff --git a/templates/components/return.html b/templates/components/return.html new file mode 100644 index 0000000..1179c04 --- /dev/null +++ b/templates/components/return.html @@ -0,0 +1 @@ +<- Get me outta here! \ No newline at end of file diff --git a/templates/index.html b/templates/index.html new file mode 100644 index 0000000..58d4c74 --- /dev/null +++ b/templates/index.html @@ -0,0 +1,20 @@ + + + + + + prussia fan club + + +
    +
      + [[ for:posts:post ]] + [[ component:post-listing ]] + [[ endfor ]] +
    +
    +
    +

    This is my blog. I also have a portfolio, retro style personal website, and a place where you can hire me.

    +
    + + \ No newline at end of file diff --git a/templates/post.html b/templates/post.html new file mode 100644 index 0000000..bdea0d1 --- /dev/null +++ b/templates/post.html @@ -0,0 +1,26 @@ + + + + + + [[ post.title ]] + + + [[ component:return ]] +
    +
    +

    [[ post.title ]]

    +
    + By [[ post.author ]] | [[ post.date ]] +
    +
    + +
    + [[ html:post.html ]] +
    +
    + [[ post.md ]] +
    +
    + + \ No newline at end of file diff --git a/tests.ts b/tests.ts new file mode 100644 index 0000000..8b1e168 --- /dev/null +++ b/tests.ts @@ -0,0 +1,119 @@ +import { Renderer } from './ryuji'; +import { test_assert_equal, log_test_results } from './endosulfan'; + +//tests for ryuji + +let renderer = new Renderer("./templates", "/components"); + +test_assert_equal( + renderer.render( + "

    [[ a ]]

    \n

    lorem ipsum dolorum

    \n
    \n c: [[ html:c ]] ff: [[ d.ee.ff ]]\n
    ", + { + a: "yee haw", + b: 1, + c: "yee haw", + d: { + dd: "cheeseburgers", + ee: { + ff: "a" + }, + }, + } + ), + "

    yee haw

    \n

    lorem ipsum dolorum

    \n
    \n c: yee haw ff: <i>a</i>\n
    ", + "simple variable test" +); + +test_assert_equal( + renderer.render( + "
    \n

    abcd

    \n extra text: [[ if:extra_text ]][[ extra_text ]][[ endif ]]\n [[ if:extra_text2 ]][[ extra_text2 ]][[ endif ]]\n
    ", + { + editable_paragraph: true, + extra_text: "", + extra_text2: "this is extra text", + } + ), + "
    \n

    abcd

    \n extra text: \n this is extra text\n
    ", + "if statement test" +); + +test_assert_equal( + renderer.render( + "[[ if:a ]][[ if:b ]]a and b are true[[ endif ]][[ endif ]], yay![[ if:c ]][[ if:d.a ]]but this will not show up[[ endif ]][[ endif ]]", + { + a: true, + b: true, + c: false, + d: { + a: false, + }, + } + ), + "a and b are true, yay!", + "nested if statement test" +); + +test_assert_equal( + renderer.render( + "
      \n [[ for:loop_over ]][[ endfor ]]\n
    \n

    [[ for:loop_over:item ]][[ endfor ]]

    ", + { + loop_over: [], + } + ), + "
      \n \n
    \n

    ", + "empty for loop test" +); + +test_assert_equal( + renderer.render( + "[[ for:letters:letter ]][[ if:letter.show ]]

    [[ letter.letter ]]

    [[ endif ]][[ endfor ]]", + { + letters: [ + { + letter: "a", + show: true, + }, + { + letter: "b", + show: false, + }, + { + letter: "c", + show: true, + }, + { + letter: "d", + show: false, + }, + ], + } + ), + "

    a

    c

    ", + "nested for loop with if statement test" +); + +//for loop and template +test_assert_equal( + Renderer.remove_empty_lines( + renderer.render( + "
    \n
      \n [[ for:posts:post ]]\n [[ component:post-listing ]]\n
    • [[ for:numbers ]]abc[[ endfor ]]
      • \n [[ endfor ]]\n
    \n
    ", + { + numbers: [1, 2, 3], + posts: [ + { + slug: "abc", + title: "Abc!", + }, + { + slug: "san-shi-san", + title: "San Shi San", + } + ] + } + ) + ), + "
    \n \n
    ", + "for loop with template test" +); + +log_test_results(); diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..527dd20 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "target": "esnext", + "module": "commonjs", + "moduleResolution": "node", + "typeRoots": [ + "./node_modules/@types", + ], + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "resolveJsonModule": true + }, + "exclude": [ + "node_modules", + ".build" + ] +} \ No newline at end of file