diff --git a/LICENSE b/LICENSE new file mode 100644 --- /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 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# emanote + +[![AGPL](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://en.wikipedia.org/wiki/Affero_General_Public_License) +[![built with nix](https://img.shields.io/badge/Built_With-Nix-5277C3.svg?logo=nixos&labelColor=73C3D5)](https://builtwithnix.org) +[![Matrix](https://img.shields.io/matrix/ema:matrix.org)](https://app.element.io/#/room/#ema:matrix.org "Chat on Matrix") + +Spiritual successor to [neuron](https://neuron.zettel.page), based on [Ema](https://ema.srid.ca). + +Create beautiful websites -- such as personal webpage, blog, wiki, Zettelkasten, notebook, knowledge-base, documentation, etc. from future-proof plain-text notes and arbitrary data -- with live preview that updates in real-time. + +## Installing and using + +https://emanote.srid.ca/start/install + +### Examples + +https://emanote.srid.ca/examples + +## Developing + +Emanote is written in Haskell. Thanks to Nix, this repository is pre-configured to provide a delightful development experience with full IDE support in Visual Studio Code. Follow these steps: + +- [Install Nix](https://nixos.org/download.html) & [enable Flakes](https://nixos.wiki/wiki/Flakes#Installing_flakes) +- Run `nix develop -c haskell-language-server` to sanity check your environment (Expect it to download and build a bunch of things the first time) +- Open the repository [as single-folder workspace](https://code.visualstudio.com/docs/editor/workspaces#_singlefolder-workspaces) in Visual Studio Code + - Install the [workspace recommended](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions) extensions + - Ctrl+Shift+P to run command "Nix-Env: Select Environment" and select `shell.nix`. The extension will ask you to reload VSCode at the end. +- Press Ctrl+Shift+B in VSCode, or run `bin/run` in terminal, to launch the dev version Emanote on `./docs`, then navigate to http://localhost:9010/ + - Changing the Haskell sources will recompile and reload this instance automatically. + +All but the final step need to be done only once. See [architecture.md](docs/architecture.md) for a high-level overview of the codebase. + +## Discussion + +To discuss the emanote project, [join Matrix][matrix] or post in [GitHub Discussions][ghdiscuss]. + +[matrix]: https://matrix.to/#/#ema:matrix.org +[ghdiscuss]: https://github.com/srid/emanote/discussions diff --git a/default/_emanote-bin/compile-css b/default/_emanote-bin/compile-css new file mode 100644 --- /dev/null +++ b/default/_emanote-bin/compile-css @@ -0,0 +1,4 @@ +#!/usr/bin/env bash +set -xe + +echo "Deprecation Warning: this script should not be used anymore" diff --git a/default/_emanote-live-server/tailwind/2.2.2/tailwind.min.css b/default/_emanote-live-server/tailwind/2.2.2/tailwind.min.css new file mode 100644 # file too large to diff: default/_emanote-live-server/tailwind/2.2.2/tailwind.min.css diff --git a/default/_emanote-static/emanote-logo.svg b/default/_emanote-static/emanote-logo.svg new file mode 100644 --- /dev/null +++ b/default/_emanote-static/emanote-logo.svg @@ -0,0 +1,92 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/default/_emanote-static/fonts/Work_Sans/WorkSans-Italic-VariableFont_wght.ttf b/default/_emanote-static/fonts/Work_Sans/WorkSans-Italic-VariableFont_wght.ttf new file mode 100644 Binary files /dev/null and b/default/_emanote-static/fonts/Work_Sans/WorkSans-Italic-VariableFont_wght.ttf differ diff --git a/default/_emanote-static/fonts/Work_Sans/WorkSans-VariableFont_wght.ttf b/default/_emanote-static/fonts/Work_Sans/WorkSans-VariableFont_wght.ttf new file mode 100644 Binary files /dev/null and b/default/_emanote-static/fonts/Work_Sans/WorkSans-VariableFont_wght.ttf differ diff --git a/default/_emanote-static/inverted-tree.css b/default/_emanote-static/inverted-tree.css new file mode 100644 --- /dev/null +++ b/default/_emanote-static/inverted-tree.css @@ -0,0 +1,118 @@ +/* Adapted from https://neuron.zettel.page/uplink-tree + Originally from https://codepen.io/philippkuehn/pen/QbrOaN +*/ + +body .tree.flipped { + -webkit-transform: rotate(180deg); + -moz-transform: rotate(180deg); + -ms-transform: rotate(180deg); + -o-transform: rotate(180deg); + transform: rotate(180deg); +} +body .tree { + overflow: auto; + /* See more-head.tpl */ + font-family: 'WorkSans', sans-serif; + font-variation-settings: 'wght' 475; + + font-size: 0.8em; +} +body .tree ul.root { + padding-top: 0px; + margin-top: 0px; +} +body .tree ul { + position: relative; + padding: 1em 0px 0px 0px; + white-space: nowrap; + margin: 0px auto 0px auto; + text-align: center; +} +body .tree ul::after { + content: ""; + display: table; + clear: both; +} +body .tree ul:last-child { + padding-bottom: 0.1em; +} +body .tree li { + display: inline-block; + vertical-align: top; + text-align: center; + list-style-type: none; + position: relative; + padding: 1em 0.5em 0em 0.5em; +} +body .tree li::before { + content: ""; + position: absolute; + top: 0px; + right: 50%; + border-top: solid 2px #cccccc; + width: 60%; + height: 1.19999em; +} +body .tree li::after { + content: ""; + position: absolute; + top: 0px; + right: 50%; + border-top: solid 2px #cccccc; + width: 50%; + height: 1.19999em; +} +body .tree li::after { + right: auto; + left: 50%; + border-left: solid 2px #cccccc; +} +body .tree li:only-child { + padding-top: 0em; +} +body .tree li:only-child::after { + display: none; +} +body .tree li:only-child::before { + display: none; +} +body .tree li:first-child::before { + border-style: none; + border-width: 0px; +} +body .tree li:first-child::after { + border-radius: 5px 0px 0px 0px; +} +body .tree li:last-child::after { + border-style: none; + border-width: 0px; +} +body .tree li:last-child::before { + border-right: solid 2px #cccccc; + border-radius: 0px 5px 0px 0px; +} +body .tree ul ul::before { + content: ""; + position: absolute; + top: 0px; + left: 50%; + border-left: solid 2px #cccccc; + width: 0px; + height: 1.19999em; +} +body .tree li div.forest-link { + border: solid 2px #cccccc; + padding: 0.2em 0.29999em 0.2em 0.29999em; + text-decoration: none; + display: inline-block; + border-radius: 5px 5px 5px 5px; + position: relative; + top: 2px; +} +body .tree.flipped li div.forest-link { + -webkit-transform: rotate(180deg); + -moz-transform: rotate(180deg); + -ms-transform: rotate(180deg); + -o-transform: rotate(180deg); + transform: rotate(180deg); +} diff --git a/default/_emanote-static/stork/flat.css b/default/_emanote-static/stork/flat.css new file mode 100644 --- /dev/null +++ b/default/_emanote-static/stork/flat.css @@ -0,0 +1,191 @@ +.stork-wrapper-flat { + position: relative; + font-family: inherit; + box-sizing: border-box; + font-size: 1em; + + --stork-blue-2: #a5d8ff; + --stork-blue-3: #74c0fc; + --stork-blue-4: #4dabf7; + --stork-blue-5: #339af0; + --stork-blue-7: #1c7ed6; + --stork-gray-8: #343a40; + --stork-gray-9: #212529; + --stork-yellow-2: #ffec99; + + --stork-border-color: hsl(0, 0%, 80%); + --stork-background-color: hsla(0, 0%, 97%); + --stork-text-color: var(--stork-gray-9); + + --stork-input-height: 2.4em; +} + +.stork-wrapper-flat *, +.stork-wrapper-flat *:before, +.stork-wrapper-flat *:after { + box-sizing: border-box; +} + +.stork-wrapper-flat .stork-input { + width: 100%; + height: var(--stork-input-height); + font-size: 1em; + padding: 0.4em 0.8em; + position: relative; + border: 2px solid var(--stork-border-color); + border-radius: calc(var(--stork-input-height) / 2); + background-color: var(--stork-background-color); + color: var(--stork-text-color); + font-family: inherit; +} + +.stork-wrapper-flat .stork-input:focus { + outline: none; +} + +.stork-wrapper-flat .stork-progress { + position: absolute; + display: block; + content: ""; + bottom: 1px; + background-color: var(--stork-blue-5); + box-shadow: 0 0 8px var(--stork-blue-4); + height: 1px; + transition: width 0.25s ease, opacity 0.4s ease 0.4s; + margin-left: calc(var(--stork-input-height) / 2); + max-width: calc(100% - var(--stork-input-height)); +} + +.stork-wrapper-flat .stork-output { + position: absolute; + width: 100%; + margin-top: 0.5em; + border-radius: 6px; + display: flex; + flex-direction: column; + z-index: 100; + color: var(--stork-text-color); + font-weight: 400; + font-family: inherit; +} + +.stork-wrapper-flat .stork-attribution a:link, +.stork-wrapper-flat .stork-attribution a:visited { + color: var(--stork-blue-7); +} + +.stork-wrapper-flat .stork-output-visible { + border: 2px solid var(--stork-border-color); + background: var(--stork-background-color); +} + +.stork-wrapper-flat .stork-message { + width: 100%; + padding: 0.5em 1em; + color: var(--stork-text-color); +} + +.stork-wrapper-flat .stork-attribution { + width: 100%; + padding: 0.5em 1em; + font-size: 0.8em; + color: var(--stork-text-color); +} + +.stork-wrapper-flat .stork-results { + margin: 0; + padding: 0; + width: 100%; + list-style-type: none; + max-height: 25em; + overflow-y: scroll; + border-top: 1px solid var(--stork-border-color); + border-bottom: 1px solid var(--stork-border-color); +} + +.stork-wrapper-flat .stork-result:not(:last-child) { + border-bottom: 1px solid var(--stork-border-color); +} + +.stork-wrapper-flat .stork-result.selected { + background: var(--stork-blue-2); +} + +.stork-wrapper-flat .stork-result a:link { + padding: 1em; + display: block; + color: currentcolor; + text-decoration: none; +} + +.stork-wrapper-flat .stork-result p { + margin: 0; +} + +.stork-wrapper-flat .stork-title { + font-weight: bold; + font-size: 0.95em; + margin: 0; + color: var(--stork-text-color); + + /* Flexbox container for the title and the score, when debugging */ + display: flex; + justify-content: space-between; +} + +.stork-wrapper-flat .stork-excerpt-container { + margin-top: 0.75em; +} + +.stork-wrapper-flat .stork-excerpt { + font-size: 0.8em; + line-height: 1; + margin: 0; + color: var(--stork-gray-8); + + /* Flexbox container for the title and the score, when debugging */ + display: flex; + justify-content: space-between; +} + +.stork-wrapper-flat .stork-excerpt:not(:last-of-type) { + margin-bottom: 0.6em; +} + +.stork-wrapper-flat .stork-highlight { + background-color: var(--stork-yellow-2); + padding: 0 0.1em; +} + +.stork-wrapper-flat .stork-error { + outline: 2px solid #c92a2a; +} + +.stork-wrapper-flat .stork-close-button { + position: absolute; + right: 0; + margin: 0.5em 0.5em; + height: 1.4em; + width: 1.4em; + padding: 0px; + background: hsl(0, 0%, 85%); + border: 1px solid hsla(0, 0%, 70%); + font-size: 1em; + color: hsl(0, 0%, 50%); + border-radius: 50%; + line-height: 1; +} + +.stork-wrapper-flat .stork-close-button svg { + width: 11px; + height: 11px; +} + +.stork-wrapper-flat .stork-close-button:hover { + background: hsla(0, 0%, 78%); + cursor: pointer; +} + +.stork-wrapper-flat .stork-close-button:active { + background: hsla(0, 0%, 65%); +} diff --git a/default/_emanote-static/stork/stork.js b/default/_emanote-static/stork/stork.js new file mode 100644 --- /dev/null +++ b/default/_emanote-static/stork/stork.js @@ -0,0 +1,2 @@ +var stork;(()=>{"use strict";var e={214:(e,t,n)=>{let r;n.r(t),n.d(t,{default:()=>_,wasm_register_index:()=>v,wasm_search:()=>y,wasm_stork_version:()=>w});const o=new Array(32).fill(void 0);function s(e){return o[e]}o.push(void 0,null,!0,!1);let i=o.length;let a=0,l=null;function u(){return null!==l&&l.buffer===r.memory.buffer||(l=new Uint8Array(r.memory.buffer)),l}let c=new TextEncoder("utf-8");const d="function"==typeof c.encodeInto?function(e,t){return c.encodeInto(e,t)}:function(e,t){const n=c.encode(e);return t.set(n),{read:e.length,written:n.length}};function h(e,t,n){if(void 0===n){const n=c.encode(e),r=t(n.length);return u().subarray(r,r+n.length).set(n),a=n.length,r}let r=e.length,o=t(r);const s=u();let i=0;for(;i127)break;s[o+i]=t}if(i!==r){0!==i&&(e=e.slice(i)),o=n(o,r,r=i+3*e.length);const t=u().subarray(o+i,o+r);i+=d(e,t).written}return a=i,o}let f=null;function g(){return null!==f&&f.buffer===r.memory.buffer||(f=new Int32Array(r.memory.buffer)),f}let p=new TextDecoder("utf-8",{ignoreBOM:!0,fatal:!0});function m(e,t){return p.decode(u().subarray(e,e+t))}function v(e,t){try{const d=r.__wbindgen_add_to_stack_pointer(-16);var n=h(e,r.__wbindgen_malloc,r.__wbindgen_realloc),o=a,s=function(e,t){const n=t(1*e.length);return u().set(e,n/1),a=e.length,n}(t,r.__wbindgen_malloc),i=a;r.wasm_register_index(d,n,o,s,i);var l=g()[d/4+0],c=g()[d/4+1];return m(l,c)}finally{r.__wbindgen_add_to_stack_pointer(16),r.__wbindgen_free(l,c)}}function y(e,t){try{const c=r.__wbindgen_add_to_stack_pointer(-16);var n=h(e,r.__wbindgen_malloc,r.__wbindgen_realloc),o=a,s=h(t,r.__wbindgen_malloc,r.__wbindgen_realloc),i=a;r.wasm_search(c,n,o,s,i);var l=g()[c/4+0],u=g()[c/4+1];return m(l,u)}finally{r.__wbindgen_add_to_stack_pointer(16),r.__wbindgen_free(l,u)}}function w(){try{const n=r.__wbindgen_add_to_stack_pointer(-16);r.wasm_stork_version(n);var e=g()[n/4+0],t=g()[n/4+1];return m(e,t)}finally{r.__wbindgen_add_to_stack_pointer(16),r.__wbindgen_free(e,t)}}p.decode();const _=async function e(t){void 0===t&&(t=new URL("stork_bg.wasm",function(e){const t=n.p;let r="";return(!t||t.indexOf("://")<0)&&(r+=window.location.protocol+"//"+window.location.host),r+=t||"/",r+e}("node_modules/stork-search/stork.js")));const l={wbg:{}};l.wbg.__wbg_new_693216e109162396=function(){return function(e){i===o.length&&o.push(o.length+1);const t=i;return i=o[t],o[t]=e,t}(new Error)},l.wbg.__wbg_stack_0ddaca5d1abfb52f=function(e,t){var n=h(s(t).stack,r.__wbindgen_malloc,r.__wbindgen_realloc),o=a;g()[e/4+1]=o,g()[e/4+0]=n},l.wbg.__wbg_error_09919627ac0992f5=function(e,t){try{console.error(m(e,t))}finally{r.__wbindgen_free(e,t)}},l.wbg.__wbindgen_object_drop_ref=function(e){!function(e){const t=s(e);(function(e){e<36||(o[e]=i,i=e)})(e)}(e)},("string"==typeof t||"function"==typeof Request&&t instanceof Request||"function"==typeof URL&&t instanceof URL)&&(t=fetch(t));const{instance:u,module:c}=await async function(e,t){if("function"==typeof Response&&e instanceof Response){if("function"==typeof WebAssembly.instantiateStreaming)try{return await WebAssembly.instantiateStreaming(e,t)}catch(t){if("application/wasm"==e.headers.get("Content-Type"))throw t;console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n",t)}const n=await e.arrayBuffer();return await WebAssembly.instantiate(n,t)}{const n=await WebAssembly.instantiate(e,t);return n instanceof WebAssembly.Instance?{instance:n,module:e}:n}}(await t,l);return r=u.exports,e.__wbindgen_wasm_module=c,r}},914:(e,t,n)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.calculateOverriddenConfig=t.defaultConfig=void 0;var r=n(445),o=n(466);t.defaultConfig={showProgress:!0,printIndexInfo:!1,showScores:!1,showCloseButton:!0,minimumQueryLength:3,forceOverwrite:!1,resultNoun:{singular:"file",plural:"files"},onQueryUpdate:void 0,onResultSelected:void 0,onResultsHidden:void 0,onInputCleared:void 0,transformResultUrl:function(e){return e}},t.calculateOverriddenConfig=function(e){var n=(0,o.difference)(Object.keys(e),Object.keys(t.defaultConfig));if(n.length>0){var s=(0,o.plural)(n.length,"key","keys"),i=JSON.stringify(n);return new r.default("Invalid ".concat(s," in config object: ").concat(i))}for(var a=Object.assign({},t.defaultConfig),l=0,u=Object.keys(t.defaultConfig);l{Object.defineProperty(t,"__esModule",{value:!0}),t.existsBeyondContainerBounds=t.setText=t.clear=t.add=t.create=void 0,t.create=function(e,t){var n=document.createElement(e);return t.classNames&&n.setAttribute("class",t.classNames.join(" ")),n},t.add=function(e,t,n){n.insertAdjacentElement(t,e)},t.clear=function(e){for(;e&&e.firstChild;)e.removeChild(e.firstChild)},t.setText=function(e,t){var n=document.createTextNode(t);e&&e.firstChild?e.replaceChild(n,e.firstChild):e&&e.appendChild(n)},t.existsBeyondContainerBounds=function(e,t){var n=e.getBoundingClientRect(),r=t.getBoundingClientRect();return n.bottom>r.bottom||n.top{Object.defineProperty(t,"__esModule",{value:!0}),t.Entity=void 0;var r=n(139),o=n(771),s=n(214),i=n(445),a=function(){function e(e,t,n){var r=this;this._state="initialized",this.downloadProgress=0,this.results=[],this.totalResultCount=0,this.eventListenerFunctions={},this.highlightedResult=0,this.resultsVisible=!1,this.hoverSelectEnabled=!0,this.setDownloadProgress=function(e){r.state="loading",r.downloadProgress=e,r.config.showProgress&&r.render()},this.name=e,this.url=t,this.config=n}return Object.defineProperty(e.prototype,"state",{get:function(){return this._state},set:function(e){this._state=e,this.render()},enumerable:!1,configurable:!0}),e.prototype.getCurrentMessage=function(){if(!this.domManager)return null;var e=this.domManager.getQuery();return"error"===this.state?"Error! Check the browser console.":"ready"!=this.state?"Loading...":(null==e?void 0:e.length){Object.defineProperty(t,"__esModule",{value:!0}),t.EntityDom=void 0;var r=n(227),o=n(9),s={results:[],resultsVisible:!1,showScores:!1,message:null,showProgress:!1,progress:1,state:"ready"},i=function(){function e(e,t){var n,o,i=this;this.scrollAnchorPoint="end",this.entity=t;var a=[{selector:'input[data-stork="'.concat(e,'"]'),elementName:"input"},{selector:'div[data-stork="'.concat(e,'-output"]'),elementName:"output"}].map((function(t){var n=document.querySelector(t.selector);if(!n)throw new Error('Could not register search box "'.concat(e,'": ').concat(t.elementName," element not found. Make sure an element matches the query selector `").concat(t.selector,"`"));return n})),l=a[0],u=a[1];this.elements={input:l,output:u,list:(0,r.create)("ul",{classNames:["stork-results"]}),attribution:(0,r.create)("div",{classNames:["stork-attribution"]}),progress:(0,r.create)("div",{classNames:["stork-progress"]}),message:(0,r.create)("div",{classNames:["stork-message"]}),closeButton:(0,r.create)("button",{classNames:["stork-close-button"]})},this.elements.input.removeEventListener("input",this.entity.eventListenerFunctions.inputInputEvent),this.elements.input.removeEventListener("keydown",this.entity.eventListenerFunctions.inputKeydownEvent),this.entity.eventListenerFunctions={inputInputEvent:function(e){i.handleInputEvent(e)},inputKeydownEvent:function(e){i.handleKeyDownEvent(e)}},this.elements.input.addEventListener("input",this.entity.eventListenerFunctions.inputInputEvent),this.elements.input.addEventListener("keydown",this.entity.eventListenerFunctions.inputKeydownEvent),null===(n=this.elements.list)||void 0===n||n.addEventListener("mousemove",(function(){i.hoverSelectEnabled=!0})),this.elements.attribution.innerHTML='Powered by Stork',this.elements.closeButton.innerHTML='\n\n\n\n\n\n\n\n',this.entity.config.showProgress&&(0,r.add)(this.elements.progress,"afterend",this.elements.input),null===(o=this.elements.closeButton)||void 0===o||o.addEventListener("click",(function(){i.elements.input.value="",i.elements.input.focus(),i.render(s);var e=[i.entity.config.onInputCleared,i.entity.config.onResultsHidden],t=e[0],n=e[1];t&&t(),n&&n()}))}return e.prototype.clearDom=function(){var e;(0,r.clear)(this.elements.output),(0,r.clear)(this.elements.list),null===(e=this.elements.closeButton)||void 0===e||e.remove(),this.elements.output.classList.remove("stork-output-visible")},e.prototype.render=function(e){var t,n=this,s=this.elements.input.value;if(this.clearDom(),this.lastRenderState=e,e.showProgress){var i=function(){switch(e.state){case"ready":case"error":return 1;case"initialized":case"loading":return.9*e.progress+.05}}();i<1?(this.elements.progress.style.width="".concat(100*i,"%"),this.elements.progress.style.opacity="1"):(this.elements.progress.style.width="100%",this.elements.progress.style.opacity="0")}if("error"===e.state&&this.elements.input.classList.add("stork-error"),this.getQuery().length>0&&e.resultsVisible&&(this.elements.output.classList.add("stork-output-visible"),(0,r.add)(this.elements.message,"beforeend",this.elements.output)),e.message&&(0,r.setText)(this.elements.message,e.message),(null===(t=e.results)||void 0===t?void 0:t.length)>0&&e.resultsVisible){(0,r.add)(this.elements.list,"beforeend",this.elements.output);for(var a=function(t){var s=e.results[t],i={selected:t===l.highlightedResult,showScores:e.showScores},a=(0,o.resultToListItem)(s,i);(0,r.add)(a,"beforeend",l.elements.list),a.addEventListener("mousemove",(function(){n.hoverSelectEnabled&&t!==n.highlightedResult&&n.changeHighlightedResult({to:t,shouldScrollTo:!1})})),a.addEventListener("mouseleave",(function(){n.hoverSelectEnabled&&t===n.highlightedResult&&n.changeHighlightedResult({to:-1,shouldScrollTo:!1})})),a.addEventListener("click",(function(e){e.preventDefault(),n.selectResult()}))},l=this,u=0;u0&&this.entity.config.showCloseButton&&(0,r.add)(this.elements.closeButton,"afterend",this.elements.input)},e.prototype.selectResult=function(){if(null!=this.highlightedResult){var e=this.entity.results[this.highlightedResult];this.entity.config.onResultSelected?Promise.resolve(this.entity.config.onResultSelected(this.getQuery(),e)).finally((function(){window.location.assign(e.entry.url)})):window.location.assign(e.entry.url)}},e.prototype.changeHighlightedResult=function(e){var t,n=this.highlightedResult,o=Math.max(-1,Math.min(this.entity.results.length-1,e.to));this.highlightedResult=o,this.scrollAnchorPoint=(n||0)0){var n;this.elements.input.value="",this.render(s),(n=this.entity.config.onInputCleared)&&n()}break;default:return}},e.prototype.handleInputEvent=function(e){this.entity.performSearch(e.target.value)},e.prototype.getQuery=function(){return this.elements.input.value},e}();t.EntityDom=i},129:function(e,t,n){var r=this&&this.__assign||function(){return r=Object.assign||function(e){for(var t,n=1,r=arguments.length;n{Object.defineProperty(t,"__esModule",{value:!0}),t.loadIndexFromUrl=void 0,t.loadIndexFromUrl=function(e,t){var n=new XMLHttpRequest;n.addEventListener("load",(function(e){var n=e.target,r=n.status,o=n.response;0!==r?r<200||r>299?t.error():t.load(o):t.progress(e.loaded/e.total)})),n.addEventListener("error",(function(){t.error()})),n.addEventListener("progress",(function(e){t.progress(e.loaded/e.total)})),n.responseType="arraybuffer",n.open("GET",e),n.send()}},480:function(e,t,n){var r=this&&this.__assign||function(){return r=Object.assign||function(e){for(var t,n=1,r=arguments.length;n{Object.defineProperty(t,"__esModule",{value:!0}),t.highlight=void 0,t.highlight=function(e,t){function n(e,t,n){return e.substr(0,t)+n+e.substr(t)}for(var r=0,o=0,s=t;o',l="";e=n(e,i.beginning+r,a),r+=a.length,e=n(e,i.end+r,l),r+=l.length}return e}},9:(e,t,n)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.resultToListItem=void 0;var r=n(112);t.resultToListItem=function(e,t){var n=document.createElement("template");return n.innerHTML='\n
  • \n \n
    \n

    ').concat((0,r.highlight)(e.entry.title,e.title_highlight_ranges||[]),"

    \n ").concat(t.showScores?"".concat(e.score,""):"","\n
    \n ").concat(e.excerpts.length>0?'
    ':"","\n ").concat(e.excerpts.map((function(e){return'

    \n ...'.concat((0,r.highlight)(e.text,e.highlight_ranges||[]),"...\n

    \n ").concat(t.showScores?"".concat(e.score,""):"","\n
    ")})).join(""),"\n ").concat(e.excerpts.length>0?"
    ":"","\n     \n
    • "),n.content.firstElementChild}},139:(e,t,n)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.resolveSearch=void 0;var r=n(214),o=n(445);t.resolveSearch=function(e,t){var n=null,s=null;try{n=(0,r.wasm_search)(e,t),s=JSON.parse(n)}catch(e){throw new o.default("Could not parse data from wasm_search. If you see this, please file a bug: https://jil.im/storkbug "+n)}if(!s)throw new o.default("Data was an empty object");if(s.error)throw new o.default("Could not perform search: the WASM binary failed to return search results.\n You might not be serving your search index properly.\n If you think this is an error, please file a bug: https://jil.im/storkbug\n \n The WASM binary came back with:\n ".concat(s.error));return s}},445:function(e,t){var n,r=this&&this.__extends||(n=function(e,t){return n=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var n in t)Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n])},n(e,t)},function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Class extends value "+String(t)+" is not a constructor or null");function r(){this.constructor=e}n(e,t),e.prototype=null===t?Object.create(t):(r.prototype=t.prototype,new r)});Object.defineProperty(t,"__esModule",{value:!0});var o=function(e){function t(t){var n=e.call(this,t)||this;return n.name="StorkError",n}return r(t,e),t}(Error);t.default=o},466:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.plural=t.difference=t.htmlToElement=void 0,t.htmlToElement=function(e){var t=document.createElement("template");return e=e.trim(),t.innerHTML=e,t.content.firstChild},t.difference=function(e,t){var n=new Set(e),r=new Set(t),o=new Set(Array.from(n).filter((function(e){return!r.has(e)})));return Array.from(o)},t.plural=function(e,t,n){return 1==e?t:n}},34:(e,t,n)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.validateIndexParams=void 0;var r=n(445);t.validateIndexParams=function(e,t){return"string"!=typeof e?new r.default("Index registration name must be a string."):"string"!=typeof t?new r.default("URL must be a string."):null}},258:(e,t,n)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.debug=t.loadWasm=t.runAfterWasmLoaded=void 0;var r=n(214),o=n(445),s="https://files.stork-search.net/releases/v".concat("1.5.0","/stork.wasm"),i=null,a=null,l=[],u=[];t.loadWasm=function(e){if(void 0===e&&(e=null),a)return a;var t=e||s;i=t;var n=(0,r.default)(t).then((function(){return c(),t})).catch((function(){throw d(),new o.default("Error while loading WASM at ".concat(t))}));return a=n,n},t.runAfterWasmLoaded=function(e,t){return a?(a.then((function(){return e()})).catch((function(){return t()})),a):(l.push(e),u.push(t),null)};var c=function(){l.forEach((function(e){e()})),l=[]},d=function(){u.forEach((function(e){e()})),u=[]};t.debug=function(){return{wasmSourceUrl:i,wasmLoadPromise:a,queueLength:l.length}}}},t={};function n(r){var o=t[r];if(void 0!==o)return o.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,n),s.exports}n.d=(e,t)=>{for(var r in t)n.o(t,r)&&!n.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},(()=>{var e;n.g.importScripts&&(e=n.g.location+"");var t=n.g.document;if(!e&&t&&(t.currentScript&&(e=t.currentScript.src),!e)){var r=t.getElementsByTagName("script");r.length&&(e=r[r.length-1].src)}if(!e)throw new Error("Automatic publicPath is not supported in this browser");e=e.replace(/#.*$/,"").replace(/\?.*$/,"").replace(/\/[^\/]+$/,"/"),n.p=e})();var r=n(480);stork=r})(); +//# sourceMappingURL=stork.js.map diff --git a/default/_emanote-static/stork/stork.wasm b/default/_emanote-static/stork/stork.wasm new file mode 100644 Binary files /dev/null and b/default/_emanote-static/stork/stork.wasm differ diff --git a/default/favicon.svg b/default/favicon.svg new file mode 100644 --- /dev/null +++ b/default/favicon.svg @@ -0,0 +1,92 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/default/index.md b/default/index.md new file mode 100644 --- /dev/null +++ b/default/index.md @@ -0,0 +1,7 @@ +# My Emanote Site + +Welcome to [Emanote](https://emanote.srid.ca/). + +Your notes should be visible in the sidebar (to the left), or in the [index](-/all) page (see sidebar & footer). To get rid of this message, add a file named `index.md` (or `index.org`). + +#emanote/default-layer diff --git a/default/index.yaml b/default/index.yaml new file mode 100644 --- /dev/null +++ b/default/index.yaml @@ -0,0 +1,128 @@ +# These variables are made globally available in the HTML templates. +# Make sure that they do not conflict with HTML tag names. +# You can override them on a per-note or per-directory basis by creating the +# associated .yaml file. + +# Order is used by Emanote to determine the sidebar order of notes. +order: 0 + +tags: [] + +# TODO: How to design this when generating RSS feeds? +template: + # Which template to use to render notes. The filepath without the .tpl extension. + name: /templates/layouts/book + # Layout specific settings + layout: + # For base.tpl + base: + # The class to apply for element when using base.tpl (used by note and book layouts) + bodyClass: bg-gray-400 overflow-y-scroll + note: + containerClass: container mx-auto max-w-prose + error: + containerClass: container mx-auto max-w-prose + uptree: + # Class to apply for uptree's nodes + nodeClass: text-gray-900 + # List of available colors: https://v2.tailwindcss.com/docs/customizing-colors#default-color-palette + theme: blue + # Value of the tag. + baseUrl: / + # Change this to 'pretty' if you want URLs without the '.html' suffix. + urlStrategy: direct + iconUrl: ${ema:homeUrl}favicon.svg + sidebar: + # Whether this node in the sidebar tree should remain collapsed by default + # (unless a route in it is active) + collapsed: true + +pandoc: + # Rewrite the class specified in Pandoc's Div and Span nodes. You can specify the class using + # https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/attributes.md + # + # This feature is useful when managing a "library" of CSS styling to use on + # Markdown text, especially when using Tailwind. + rewriteClass: + # How to style inline tags. Tag-specific styles can be applied as well. + emanote:inline-tag: font-bold bg-gray-100 py-0.5 px-2 rounded-lg + # This style is used by `#a/red/tag` in addition to the generic style above. + # As this class comes *after* the generic class, it can override the styles + # in the generic class. + emanote:inline-tag:a/red/tag: bg-red-100 + emanote:placeholder-message: text-gray-400 border-t-2 inline-block pt-0.5 + emanote:error: text-l bg-red-100 p-2 border-2 border-black m-2 font-mono + emanote:error:aside: font-mono align-top text-xs mr-1 tracking-tighter opacity-50 hover:opacity-100 + # You can also add your own class -> style mappings. We provide a sample below. + sticky-note: px-3 py-1 rounded shadow bg-yellow-100 mx-2 transform -skew-y-1 scale-95 hover:scale-100 hover:border-yellow-400 hover:shadow-lg border-t-8 border-yellow-200 mb-8 mt-8 + note: p-2 mb-3 rounded shadow bg-gray-100 w-full float-none md:float-right md:w-1/2 md:clear-both + highlight-block: px-3 py-1 mb-3 rounded bg-${theme}-100 hover:border-${theme}-400 hover:shadow border-t-8 border-${theme}-200 + highlight-inline: bg-yellow-200 px-2 py-0.5 rounded-xl + center: flex justify-center items-center mx-auto + +# Put page-specific metadata here. Override them in Markdown frontmatter or +# per-folder YAML as necessary. +page: + siteTitle: My Emanote Site + # Desription is expected to be set on a per-page basis. + # By default, the first paragraph is used for description. + # Used for https://ogp.me/ + description: "" + + # Image URL for previews. + # By default, the first image URL is used. Note: wikilink are not yet + # supported. + # Used for https://ogp.me/ + image: "" + + # Put anything that should go in of these routes here: + # You can reference other metadata keys using + # Or use the JS behaviour library below. + headHtml: | + + +# Builtin JS behaviour library. Use them in `page.headHtml` of your .yaml or .md +# frontmatter. +js: + # Syntax highlighting using prism.js + prism: | + + + + + # Syntax highlighting using highlight.js + highlightjs: | + + + + + + + + + + highlightjs-ver: 11.6.0 # Ref: https://cdnjs.com/libraries/highlight.js + # Diagrams using mermaid.js + mermaid: | + + + + mathjax: | + + + +emanote: + # Whether to automatically treat folder notes as a folgezettel parent of its contents + folder-folgezettel: true diff --git a/default/templates/base.tpl b/default/templates/base.tpl new file mode 100644 --- /dev/null +++ b/default/templates/base.tpl @@ -0,0 +1,51 @@ + + + + + + + + <ema:titleFull /> + + + + + + + + + + + + + + + + + + + + + + + + + + + +w-4 h-4 flex-shrink-0 + + + + + + + + + diff --git a/default/templates/components/backlinks.tpl b/default/templates/components/backlinks.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/backlinks.tpl @@ -0,0 +1,18 @@ + +
    +
    Links to this page
    + +
    +     diff --git a/default/templates/components/breadcrumbs.tpl b/default/templates/components/breadcrumbs.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/breadcrumbs.tpl @@ -0,0 +1,47 @@ + diff --git a/default/templates/components/checkbox-checked.tpl b/default/templates/components/checkbox-checked.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/checkbox-checked.tpl @@ -0,0 +1,4 @@ +☑ + + + diff --git a/default/templates/components/checkbox-unchecked.tpl b/default/templates/components/checkbox-unchecked.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/checkbox-unchecked.tpl @@ -0,0 +1,4 @@ +☐ + + + diff --git a/default/templates/components/context.tpl b/default/templates/components/context.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/context.tpl @@ -0,0 +1,24 @@ +
    + +
    + + + + + + + + + + + + + + + + + + +
    +     +
    diff --git a/default/templates/components/footer.tpl b/default/templates/components/footer.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/footer.tpl @@ -0,0 +1,46 @@ + diff --git a/default/templates/components/metadata.tpl b/default/templates/components/metadata.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/metadata.tpl @@ -0,0 +1,16 @@ + +
    + + + + + # + + + +
    +     diff --git a/default/templates/components/note-body.tpl b/default/templates/components/note-body.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/note-body.tpl @@ -0,0 +1,5 @@ +
    + + + +
    diff --git a/default/templates/components/note-title.tpl b/default/templates/components/note-title.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/note-title.tpl @@ -0,0 +1,6 @@ +

    + + + +

    diff --git a/default/templates/components/note-uptree-recurse.tpl b/default/templates/components/note-uptree-recurse.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/note-uptree-recurse.tpl @@ -0,0 +1,16 @@ +
  • + +
    + + + +
    + + +
      + + + +
    +     +
    • diff --git a/default/templates/components/note-uptree.tpl b/default/templates/components/note-uptree.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/note-uptree.tpl @@ -0,0 +1,17 @@ + + + + + diff --git a/default/templates/components/pandoc.tpl b/default/templates/components/pandoc.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/pandoc.tpl @@ -0,0 +1,108 @@ + + +

    + +

    +     + + + + + + + + + + + + + + + + +
    +
    + +
    +
    + +
    + +
    +
    + +
    + +
    +
    + +
    +
    +     +
    +     +
    +     + + + + + + + + +
    +
    Footnotes
    + +
    +
    + . +
    +
    + +
    +
    +     +
    +     + + +
      + +
    • + +
      • +       +
    +     + +
      + +
    • + +
      • +       +
    +     + +
    +     + + + + + + + +
    +

    +

    +

    +

    +

    +
    +
    + +     diff --git a/default/templates/components/sidebar-tree.tpl b/default/templates/components/sidebar-tree.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/sidebar-tree.tpl @@ -0,0 +1,80 @@ + + + font-bold text-${theme}-600 hover:underline + + + + font-bold hover:underline + + hover:underline + + + hover:underline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + + + + + + + + + + +
    + + + + + + + +
    diff --git a/default/templates/components/stork/stork-icon.tpl b/default/templates/components/stork/stork-icon.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/stork/stork-icon.tpl @@ -0,0 +1,5 @@ + + + diff --git a/default/templates/components/stork/stork-search-head.tpl b/default/templates/components/stork/stork-search-head.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/stork/stork-search-head.tpl @@ -0,0 +1,64 @@ + + + + + + + + + + + diff --git a/default/templates/components/stork/stork-search.tpl b/default/templates/components/stork/stork-search.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/stork/stork-search.tpl @@ -0,0 +1,12 @@ + diff --git a/default/templates/components/timeline.tpl b/default/templates/components/timeline.tpl new file mode 100644 --- /dev/null +++ b/default/templates/components/timeline.tpl @@ -0,0 +1,19 @@ + +
    +
    🗓️ Timeline
    + +
    +     diff --git a/default/templates/error.tpl b/default/templates/error.tpl new file mode 100644 --- /dev/null +++ b/default/templates/error.tpl @@ -0,0 +1,39 @@ + + + + + + +
    +
    +
    +
    +
    +

    + + + +

    +
    + Your notebook has an issue. +
    +
    + +
    +
    +
    Fix it (this page will reload), or go + to /. +
    +
    +
    + + +
    +
    +
    +
    +
    +
    +     +     diff --git a/default/templates/experimental.tpl b/default/templates/experimental.tpl new file mode 100644 --- /dev/null +++ b/default/templates/experimental.tpl @@ -0,0 +1,5 @@ +
    + Experimental + feature ! +
    diff --git a/default/templates/filters/embed-image.tpl b/default/templates/filters/embed-image.tpl new file mode 100644 --- /dev/null +++ b/default/templates/filters/embed-image.tpl @@ -0,0 +1,1 @@ +${ema:alt} diff --git a/default/templates/filters/embed-note.tpl b/default/templates/filters/embed-note.tpl new file mode 100644 --- /dev/null +++ b/default/templates/filters/embed-note.tpl @@ -0,0 +1,11 @@ +
    +
    + + + +
    +
    + +
    +
    diff --git a/default/templates/filters/embed-pdf.tpl b/default/templates/filters/embed-pdf.tpl new file mode 100644 --- /dev/null +++ b/default/templates/filters/embed-pdf.tpl @@ -0,0 +1,4 @@ + + Open pdf + diff --git a/default/templates/filters/embed-video.tpl b/default/templates/filters/embed-video.tpl new file mode 100644 --- /dev/null +++ b/default/templates/filters/embed-video.tpl @@ -0,0 +1,6 @@ + diff --git a/default/templates/filters/query-default.tpl b/default/templates/filters/query-default.tpl new file mode 100644 --- /dev/null +++ b/default/templates/filters/query-default.tpl @@ -0,0 +1,23 @@ + diff --git a/default/templates/filters/query-timeline.tpl b/default/templates/filters/query-timeline.tpl new file mode 100644 --- /dev/null +++ b/default/templates/filters/query-timeline.tpl @@ -0,0 +1,25 @@ + + diff --git a/default/templates/hooks/after-note.tpl b/default/templates/hooks/after-note.tpl new file mode 100644 --- /dev/null +++ b/default/templates/hooks/after-note.tpl @@ -0,0 +1,1 @@ + diff --git a/default/templates/hooks/before-note.tpl b/default/templates/hooks/before-note.tpl new file mode 100644 --- /dev/null +++ b/default/templates/hooks/before-note.tpl @@ -0,0 +1,1 @@ + diff --git a/default/templates/hooks/more-head.tpl b/default/templates/hooks/more-head.tpl new file mode 100644 --- /dev/null +++ b/default/templates/hooks/more-head.tpl @@ -0,0 +1,49 @@ + + + + diff --git a/default/templates/hooks/note-end.tpl b/default/templates/hooks/note-end.tpl new file mode 100644 --- /dev/null +++ b/default/templates/hooks/note-end.tpl @@ -0,0 +1,1 @@ + diff --git a/default/templates/layouts/book.tpl b/default/templates/layouts/book.tpl new file mode 100644 --- /dev/null +++ b/default/templates/layouts/book.tpl @@ -0,0 +1,82 @@ + + + +
    + + + +
    + + + + +
    +
    + + +
    + + +
    + + +
    +
    +
    + +
    +     +     diff --git a/default/templates/layouts/note.tpl b/default/templates/layouts/note.tpl new file mode 100644 --- /dev/null +++ b/default/templates/layouts/note.tpl @@ -0,0 +1,41 @@ + + + + + + + + + + + +
    +
    + + +
    + +
    + + + +
    +
    +
    + + +
    + + +
    + + +
    +
    +
    + +
    +
    +     +     diff --git a/default/templates/special/base.tpl b/default/templates/special/base.tpl new file mode 100644 --- /dev/null +++ b/default/templates/special/base.tpl @@ -0,0 +1,18 @@ + + +
    +
    +

    + +

    + + 50 + +
    + +
    +
    + +
    +     +     diff --git a/default/templates/special/index.tpl b/default/templates/special/index.tpl new file mode 100644 --- /dev/null +++ b/default/templates/special/index.tpl @@ -0,0 +1,9 @@ + + +
    + + + +
    +     +     diff --git a/default/templates/special/tagindex.tpl b/default/templates/special/tagindex.tpl new file mode 100644 --- /dev/null +++ b/default/templates/special/tagindex.tpl @@ -0,0 +1,75 @@ + + +
    + +
    + + +
    + + + + + + + + + + + (+) + + + +
    +     +     + + +
    + + + + + + + + + +
    +     +     +
    +
    +     +     diff --git a/default/templates/special/tasks.tpl b/default/templates/special/tasks.tpl new file mode 100644 --- /dev/null +++ b/default/templates/special/tasks.tpl @@ -0,0 +1,51 @@ + + +
    +
    + + +
    +
    + + +
  • + + + + \ +
    • +     +     + +
    + + + +
    +
    +
    + + +
    + + + + + + + + + + +
    +     +     +
    +
    +     +     +
    +
    +     +     diff --git a/emanote.cabal b/emanote.cabal new file mode 100644 --- /dev/null +++ b/emanote.cabal @@ -0,0 +1,214 @@ +cabal-version: 2.4 +name: emanote +version: 0.8.0.0 +license: AGPL-3.0-only +copyright: 2022 Sridhar Ratnakumar +maintainer: srid@srid.ca +author: Sridhar Ratnakumar +category: Web +synopsis: Emanate a structured view of your plain-text notes +description: + Create beautiful websites -- such as personal webpage, blog, wiki, Zettelkasten, notebook, knowledge-base, documentation, etc. from future-proof plain-text notes and arbitrary data -- with live preview that updates in real-time. + +-- A URL where users can report bugs. +bug-reports: https://github.com/EmaApps/emanote/issues +extra-source-files: + LICENSE + README.md + +data-dir: default +data-files: + _emanote-bin/compile-css + _emanote-live-server/**/*.css + _emanote-static/**/*.ttf + _emanote-static/*.css + _emanote-static/*.svg + _emanote-static/stork/flat.css + _emanote-static/stork/stork.js + _emanote-static/stork/stork.wasm + favicon.svg + index.md + index.yaml + templates/**/*.tpl + +common haskell-common + ghc-options: + -Wall -Wincomplete-record-updates -Wincomplete-uni-patterns + -Wmissing-deriving-strategies -Wunused-foralls -Wunused-foralls + -fprint-explicit-foralls -fprint-explicit-kinds + + default-extensions: + NoImplicitPrelude + NoStarIsType + BangPatterns + ConstraintKinds + DataKinds + DeriveDataTypeable + DeriveFoldable + DeriveFunctor + DeriveGeneric + DeriveLift + DeriveTraversable + DerivingStrategies + DerivingVia + EmptyCase + EmptyDataDecls + EmptyDataDeriving + ExistentialQuantification + ExplicitForAll + FlexibleContexts + FlexibleInstances + GADTSyntax + GeneralisedNewtypeDeriving + ImportQualifiedPost + KindSignatures + LambdaCase + MultiParamTypeClasses + MultiWayIf + NumericUnderscores + OverloadedStrings + PolyKinds + PostfixOperators + RankNTypes + ScopedTypeVariables + StandaloneDeriving + StandaloneKindSignatures + TupleSections + TypeApplications + TypeFamilies + TypeOperators + ViewPatterns + +common library-common + import: haskell-common + default-language: Haskell2010 + + -- TODO: We could use the ghcid flag trick in neuron.cabal to avoid rebuilds. + hs-source-dirs: src + build-depends: + , aeson + , aeson-extra + , aeson-optics + , async + , base >=4.14 && <5 + , blaze-html + , bytestring + , commonmark + , commonmark-extensions + , commonmark-pandoc + , commonmark-simple + , containers + , data-default + , dependent-sum + , directory + , ema >=0.8.2 + , filepath + , filepattern + , fsnotify + , hedgehog + , heist-emanote >=1.2.1 + , heist-extra + , hspec + , hspec-hedgehog + , ixset-typed >=0.5.1.0 + , lvar + , map-syntax + , megaparsec + , monad-logger + , monad-logger-extras + , mtl + , neat-interpolation + , optics-core + , optics-th + , optparse-applicative + , pandoc + , pandoc-link-context >=1.4.0 + , pandoc-types + , parsec + , path-tree >=0.2 + , process-extras + , profunctors + , relude >=1.0 + , shower + , some + , stm + , tagged + , tagtree + , tailwind >=0.3 + , text + , time + , tomland + , unionmount >=0.2 + , unliftio + , unordered-containers + , uri-encode + , url-slug + , uuid + , which + , with-utf8 + , xmlhtml + , yaml + + hs-source-dirs: src + +library + import: library-common + exposed-modules: + Emanote + Emanote.CLI + Emanote.Model + Emanote.Model.Calendar + Emanote.Model.Graph + Emanote.Model.Link.Rel + Emanote.Model.Link.RelSpec + Emanote.Model.Link.Resolve + Emanote.Model.Meta + Emanote.Model.Note + Emanote.Model.Note.Filter + Emanote.Model.Query + Emanote.Model.QuerySpec + Emanote.Model.SData + Emanote.Model.StaticFile + Emanote.Model.Stork + Emanote.Model.Stork.Index + Emanote.Model.Task + Emanote.Model.Title + Emanote.Model.Type + Emanote.Pandoc.BuiltinFilters + Emanote.Pandoc.Link + Emanote.Pandoc.Markdown.Parser + Emanote.Pandoc.Markdown.Syntax.HashTag + Emanote.Pandoc.Markdown.Syntax.Highlight + Emanote.Pandoc.Markdown.Syntax.WikiLink + Emanote.Pandoc.Renderer + Emanote.Pandoc.Renderer.Embed + Emanote.Pandoc.Renderer.Query + Emanote.Pandoc.Renderer.Url + Emanote.Prelude + Emanote.Route + Emanote.Route.Ext + Emanote.Route.ModelRoute + Emanote.Route.R + Emanote.Route.SiteRoute + Emanote.Route.SiteRoute.Class + Emanote.Route.SiteRoute.Type + Emanote.Source.Dynamic + Emanote.Source.Loc + Emanote.Source.Patch + Emanote.Source.Pattern + Emanote.View + Emanote.View.Common + Emanote.View.Export + Emanote.View.LiveServerFiles + Emanote.View.TagIndex + Emanote.View.TaskIndex + Emanote.View.Template + Paths_emanote + Spec + + autogen-modules: Paths_emanote + +executable emanote + import: library-common + main-is: Main.hs + ghc-options: -threaded -rtsopts -with-rtsopts=-N diff --git a/src/Emanote.hs b/src/Emanote.hs new file mode 100644 --- /dev/null +++ b/src/Emanote.hs @@ -0,0 +1,160 @@ +{-# LANGUAGE RecordWildCards #-} +{-# OPTIONS_GHC -Wno-orphans #-} + +module Emanote + ( run, + defaultEmanoteConfig, + ) +where + +import Control.Monad.Logger (LogLevel (LevelError), runStderrLoggingT, runStdoutLoggingT) +import Control.Monad.Logger.Extras (Logger (Logger), logToStderr, runLoggerLoggingT) +import Control.Monad.Writer.Strict (MonadWriter (tell), WriterT (runWriterT)) +import Data.Default (def) +import Data.Dependent.Sum (DSum ((:=>))) +import Data.Map.Strict qualified as Map +import Ema + ( EmaSite (..), + IsRoute (..), + fromPrism_, + runSiteWithCli, + toPrism_, + ) +import Ema.CLI qualified +import Ema.Dynamic (Dynamic (Dynamic)) +import Emanote.CLI qualified as CLI +import Emanote.Model.Link.Rel (ResolvedRelTarget (..)) +import Emanote.Model.Type (modelCompileTailwind) +import Emanote.Model.Type qualified as Model +import Emanote.Pandoc.Renderer +import Emanote.Pandoc.Renderer.Embed qualified as PF +import Emanote.Pandoc.Renderer.Query qualified as PF +import Emanote.Pandoc.Renderer.Url qualified as PF +import Emanote.Prelude (log, logE, logW) +import Emanote.Route.ModelRoute (LMLRoute, lmlRouteCase) +import Emanote.Route.SiteRoute.Class (emanoteGeneratableRoutes, emanoteRouteEncoder) +import Emanote.Route.SiteRoute.Type (SiteRoute) +import Emanote.Source.Dynamic (EmanoteConfig (..), emanoteSiteInput) +import Emanote.View.Common (generatedCssFile) +import Emanote.View.Export qualified as Export +import Emanote.View.Template qualified as View +import Optics.Core ((%), (.~), (^.)) +import Relude +import System.FilePath (()) +import UnliftIO (MonadUnliftIO) +import Web.Tailwind qualified as Tailwind + +instance IsRoute SiteRoute where + type RouteModel SiteRoute = Model.ModelEma + routePrism = toPrism_ . emanoteRouteEncoder + routeUniverse = emanoteGeneratableRoutes + +instance EmaSite SiteRoute where + type SiteArg SiteRoute = EmanoteConfig + siteInput = emanoteSiteInput + siteOutput = View.emanoteSiteOutput + +defaultEmanoteConfig :: CLI.Cli -> EmanoteConfig +defaultEmanoteConfig cli = + EmanoteConfig cli id defaultEmanotePandocRenderers False + +run :: EmanoteConfig -> IO () +run cfg@EmanoteConfig {..} = do + case CLI.cmd _emanoteConfigCli of + CLI.Cmd_Ema emaCli -> + Ema.runSiteWithCli @SiteRoute emaCli cfg + >>= postRun cfg + CLI.Cmd_Export -> do + Dynamic (unModelEma -> model0, _) <- + flip runLoggerLoggingT oneOffLogger $ + siteInput @SiteRoute (Ema.CLI.action def) cfg + putLBSLn $ Export.renderGraphExport model0 + where + -- A logger suited for running one-off commands. + oneOffLogger = + logToStderr + & allowLogLevelFrom LevelError + where + allowLogLevelFrom :: LogLevel -> Logger -> Logger + allowLogLevelFrom minLevel (Logger f) = Logger $ \loc src level msg -> + if level >= minLevel + then f loc src level msg + else pass + +postRun :: EmanoteConfig -> (Model.ModelEma, DSum Ema.CLI.Action Identity) -> IO () +postRun EmanoteConfig {..} = \case + (unModelEma -> model0, Ema.CLI.Generate outPath :=> Identity genPaths) -> do + when (model0 ^. modelCompileTailwind) $ + compileTailwindCss (outPath generatedCssFile) genPaths + checkBrokenLinks _emanoteConfigCli $ Export.modelRels model0 + checkBadMarkdownFiles $ Model.modelNoteErrors model0 + _ -> + pass + +unModelEma :: Model.ModelEma -> Model.Model +unModelEma m = Model.withRoutePrism (fromPrism_ $ routePrism @SiteRoute m) m + +checkBadMarkdownFiles :: Map LMLRoute [Text] -> IO () +checkBadMarkdownFiles noteErrs = runStderrLoggingT $ do + forM_ (Map.toList noteErrs) $ \(noteRoute, errs) -> do + logW $ "Bad markdown file: " <> show noteRoute + forM_ errs $ \err -> do + logE $ " - " <> err + unless (null noteErrs) $ do + logE "Errors found." + exitFailure + +checkBrokenLinks :: CLI.Cli -> Map LMLRoute [Export.Link] -> IO () +checkBrokenLinks cli modelRels = runStderrLoggingT $ do + ((), res :: Sum Int) <- runWriterT $ + forM_ (Map.toList modelRels) $ \(noteRoute, rels) -> + forM_ (sortNub rels) $ \(Export.Link urt rrt) -> + case rrt of + RRTFound _ -> pass + RRTMissing -> do + logW $ "Broken link: " <> show (lmlRouteCase noteRoute) <> " -> " <> show urt + tell 1 + RRTAmbiguous ls -> do + logW $ "Ambiguous link: " <> show (lmlRouteCase noteRoute) <> " -> " <> show urt <> " ambiguities: " <> show ls + tell 1 + if res == 0 + then do + log "No broken links detected." + else unless (CLI.allowBrokenLinks cli) $ do + logE $ "Found " <> show (getSum res) <> " broken links! Emanote generated the site, but the generated site has broken links." + log "(Tip: use `--allow-broken-links` to ignore this check.)" + exitFailure + +compileTailwindCss :: MonadUnliftIO m => FilePath -> [FilePath] -> m () +compileTailwindCss cssPath genPaths = do + runStdoutLoggingT $ do + log $ "Running Tailwind CSS v3 compiler to generate: " <> toText cssPath + Tailwind.runTailwind $ + def + & Tailwind.tailwindConfig % Tailwind.tailwindConfigContent .~ genPaths + & Tailwind.tailwindOutput .~ cssPath + & Tailwind.tailwindMode .~ Tailwind.Production + +defaultEmanotePandocRenderers :: EmanotePandocRenderers Model.Model LMLRoute +defaultEmanotePandocRenderers = + let blockRenderers = + PandocRenderers + [ PF.embedInlineWikiLinkResolvingSplice, -- embedInlineWikiLinkResolvingSplice should be first to recognize inline Link elements first + PF.urlResolvingSplice + ] + [ PF.embedBlockWikiLinkResolvingSplice, + PF.embedBlockRegularLinkResolvingSplice, + PF.queryResolvingSplice + ] + inlineRenderers = + PandocRenderers + [ PF.embedInlineWikiLinkResolvingSplice, -- embedInlineWikiLinkResolvingSplice should be first to recognize inline Link elements first + PF.urlResolvingSplice + ] + mempty + linkInlineRenderers = + PandocRenderers + [ PF.plainifyWikiLinkSplice + ] + mempty + in EmanotePandocRenderers {..} diff --git a/src/Emanote/CLI.hs b/src/Emanote/CLI.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/CLI.hs @@ -0,0 +1,71 @@ +{-# LANGUAGE ApplicativeDo #-} +{-# LANGUAGE RecordWildCards #-} + +module Emanote.CLI + ( Cli (..), + Cmd (..), + parseCli, + cliParser, + ) +where + +import Data.Text qualified as T +import Data.Version (showVersion) +import Ema.CLI qualified +import Options.Applicative hiding (action) +import Paths_emanote qualified +import Relude +import UnliftIO.Directory (getCurrentDirectory) + +data Cli = Cli + { layers :: NonEmpty FilePath, + test :: Bool, + allowBrokenLinks :: Bool, + cmd :: Cmd + } + +data Cmd + = Cmd_Ema Ema.CLI.Cli + | Cmd_Export + +cliParser :: FilePath -> Parser Cli +cliParser cwd = do + layers <- pathList (one cwd) + test <- switch (long "test" <> help "Run tests") + allowBrokenLinks <- switch (long "allow-broken-links" <> help "Report but do not fail on broken links") + cmd <- + fmap Cmd_Ema Ema.CLI.cliParser + <|> subparser (command "export" (info (pure Cmd_Export) (progDesc "Export metadata JSON"))) + pure Cli {..} + where + pathList defaultPath = do + option pathListReader $ + mconcat + [ long "layers", + short 'L', + metavar "LAYERS", + value defaultPath, + help "List of (semicolon delimited) notebook folders to 'union mount', with the left-side folders being overlaid on top of the right-side ones. The default layer is implicitly included at the end of this list." + ] + pathListReader :: ReadM (NonEmpty FilePath) + pathListReader = + maybeReader $ \paths -> + nonEmpty $ fmap toString $ T.split (== ';') . toText $ paths + +parseCli' :: FilePath -> ParserInfo Cli +parseCli' cwd = + info + (versionOption <*> cliParser cwd <**> helper) + ( fullDesc + <> progDesc "Emanote - A spiritual successor to Neuron" + <> header "Emanote" + ) + where + versionOption = + infoOption + (showVersion Paths_emanote.version) + (long "version" <> help "Show version") + +parseCli :: IO Cli +parseCli = + execParser . parseCli' =<< getCurrentDirectory diff --git a/src/Emanote/Model.hs b/src/Emanote/Model.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/Model.hs @@ -0,0 +1,3 @@ +module Emanote.Model (module X) where + +import Emanote.Model.Type as X diff --git a/src/Emanote/Model/Calendar.hs b/src/Emanote/Model/Calendar.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/Model/Calendar.hs @@ -0,0 +1,46 @@ +-- | A primitive module to eventually pave way towards first-class "calendar" +-- (daily notes, etc.) support in Emanote; either built-in or as plugin. +module Emanote.Model.Calendar where + +import Data.Time.Calendar (Day, fromGregorianValid) +import Emanote.Model.Note qualified as N +import Emanote.Model.Title (Title) +import Emanote.Model.Type (Model, modelLookupTitle) +import Emanote.Route (LMLRoute) +import Emanote.Route qualified as R +import Relude +import Text.Megaparsec qualified as M +import Text.Megaparsec.Char qualified as M + +-- HACK: This is so that calendar backlinks are sorted properly. +backlinkSortKey :: Model -> LMLRoute -> Down Title +backlinkSortKey model = + Down . flip modelLookupTitle model + +-- HACK: Until we have a proper search support. This sorts query results for +-- timeline +noteSortKey :: N.Note -> (Down (Maybe Text), LMLRoute) +noteSortKey note = + (Down $ N.lookupMeta @Text (one "date") note, N._noteRoute note) + +isDailyNote :: LMLRoute -> Bool +isDailyNote = + isJust . parseRouteDay + +parseRouteDay :: LMLRoute -> Maybe Day +parseRouteDay = + M.parseMaybe parse . R.withLmlRoute R.routeBaseName + where + parse :: M.Parsec Void Text Day + parse = do + let asInt = maybe (fail "Not an int") pure . readMaybe + -- Year + year <- asInt =<< replicateM 4 M.digitChar + void $ M.string "-" + -- Month + month <- asInt =<< replicateM 2 M.digitChar + void $ M.string "-" + -- Day + day <- asInt =<< replicateM 2 M.digitChar + maybe (fail "Not a date") pure $ + fromGregorianValid year (fromInteger month) (fromInteger day) diff --git a/src/Emanote/Model/Graph.hs b/src/Emanote/Model/Graph.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/Model/Graph.hs @@ -0,0 +1,115 @@ +module Emanote.Model.Graph where + +import Data.IxSet.Typed ((@+), (@=)) +import Data.IxSet.Typed qualified as Ix +import Data.Map.Strict qualified as Map +import Data.Set qualified as Set +import Data.Tree (Forest, Tree (Node)) +import Emanote.Model.Calendar qualified as Calendar +import Emanote.Model.Link.Rel qualified as Rel +import Emanote.Model.Link.Resolve qualified as Resolve +import Emanote.Model.Meta (lookupRouteMeta) +import Emanote.Model.Note qualified as MN +import Emanote.Model.Type (Model, modelRels, resolveLmlRoute) +import Emanote.Pandoc.Markdown.Syntax.WikiLink qualified as WL +import Emanote.Route qualified as R +import Emanote.Route.ModelRoute (ModelRoute) +import Optics.Operators as Lens ((^.)) +import Relude hiding (empty) +import Text.Pandoc.Definition qualified as B + +-- TODO: Do breadth-first instead of depth-first +modelFolgezettelAncestorTree :: ModelRoute -> Model -> Forest R.LMLRoute +modelFolgezettelAncestorTree r0 model = + fst $ usingState mempty $ go r0 + where + go :: MonadState (Set ModelRoute) m => ModelRoute -> m (Forest R.LMLRoute) + go r = do + let folgezettelBacklinks = + backlinkRels r model + & filter (isFolgezettel . (^. Rel.relTo)) + <&> (^. Rel.relFrom) + -- Handle reverse folgezettel links here + folgezettelFrontlinks = + frontlinkRels r model + & mapMaybe (lookupWikiLink <=< selectReverseFolgezettel . (^. Rel.relTo)) + -- Folders are automatically made a folgezettel + folgezettelFolder = + maybeToList $ do + lmlR <- leftToMaybe (R.modelRouteCase r) + guard $ lookupRouteMeta True ("emanote" :| ["folder-folgezettel"]) lmlR model + parentLmlRoute model lmlR + folgezettelParents = + mconcat + [ folgezettelBacklinks, + folgezettelFrontlinks, + folgezettelFolder + ] + fmap catMaybes . forM folgezettelParents $ \parentR -> do + let parentModelR = R.ModelRoute_LML parentR + gets (parentModelR `Set.member`) >>= \case + True -> pure Nothing + False -> do + modify $ Set.insert parentModelR + sub <- go parentModelR + pure $ Just $ Node parentR sub + isFolgezettel = \case + Rel.URTWikiLink (WL.WikiLinkBranch, _wl) -> + True + _ -> + False + selectReverseFolgezettel :: Rel.UnresolvedRelTarget -> Maybe WL.WikiLink + selectReverseFolgezettel = \case + Rel.URTWikiLink (WL.WikiLinkTag, wl) -> Just wl + _ -> Nothing + lookupWikiLink :: WL.WikiLink -> Maybe R.LMLRoute + lookupWikiLink wl = do + note <- leftToMaybe <=< getFound $ Resolve.resolveWikiLinkMustExist model wl + pure $ note ^. MN.noteRoute + getFound :: Rel.ResolvedRelTarget a -> Maybe a + getFound = \case + Rel.RRTFound x -> Just x + _ -> Nothing + +-- | Return the route to parent folder (unless indexRoute is passed). +-- +-- This will return the existing note (.org or .md) if possible. Otherwise +-- fallback to .md even if missing. +parentLmlRoute :: Model -> R.LMLRoute -> Maybe R.LMLRoute +parentLmlRoute model r = do + pr <- do + let lmlR = R.lmlRouteCase r + -- Root index do not have a parent folder. + guard $ lmlR /= Left R.indexRoute && lmlR /= Right R.indexRoute + -- Consider the index route as parent folder for all + -- top-level notes. + pure $ fromMaybe R.indexRoute $ R.withLmlRoute R.routeParent r + pure $ resolveLmlRoute model . coerce $ pr + +modelLookupBacklinks :: ModelRoute -> Model -> [(R.LMLRoute, NonEmpty [B.Block])] +modelLookupBacklinks r model = + sortOn (Calendar.backlinkSortKey model . fst) $ + groupNE $ + backlinkRels r model <&> \rel -> + (rel ^. Rel.relFrom, rel ^. Rel.relCtx) + where + groupNE :: forall a b. Ord a => [(a, b)] -> [(a, NonEmpty b)] + groupNE = + Map.toList . foldl' f Map.empty + where + f :: Map a (NonEmpty b) -> (a, b) -> Map a (NonEmpty b) + f m (x, y) = + case Map.lookup x m of + Nothing -> Map.insert x (one y) m + Just ys -> Map.insert x (ys <> one y) m + +backlinkRels :: ModelRoute -> Model -> [Rel.Rel] +backlinkRels r model = + let allPossibleLinks = Rel.unresolvedRelsTo r + in Ix.toList $ (model ^. modelRels) @+ allPossibleLinks + +frontlinkRels :: ModelRoute -> Model -> [Rel.Rel] +frontlinkRels r model = + maybeToMonoid $ do + lmlR <- leftToMaybe $ R.modelRouteCase r + pure $ Ix.toList $ (model ^. modelRels) @= lmlR diff --git a/src/Emanote/Model/Link/Rel.hs b/src/Emanote/Model/Link/Rel.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/Model/Link/Rel.hs @@ -0,0 +1,144 @@ +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE TemplateHaskell #-} + +module Emanote.Model.Link.Rel where + +import Data.Aeson (ToJSON) +import Data.IxSet.Typed (Indexable (..), IxSet, ixFun, ixList) +import Data.IxSet.Typed qualified as Ix +import Data.List.NonEmpty qualified as NEL +import Data.Map.Strict qualified as Map +import Data.Text qualified as T +import Emanote.Model.Note (Note, noteDoc, noteRoute) +import Emanote.Pandoc.Markdown.Syntax.WikiLink qualified as WL +import Emanote.Route (LMLRoute, ModelRoute) +import Emanote.Route qualified as R +import Emanote.Route.SiteRoute.Type qualified as SR +import Optics.Operators as Lens ((^.)) +import Optics.TH (makeLenses) +import Relude +import System.FilePath (normalise, ()) +import Text.Pandoc.Definition qualified as B +import Text.Pandoc.LinkContext qualified as LC + +-- | A relation from one note to anywhere in the model. +-- +-- Target will remain unresolved in the `Rel`, and can be resolved at a latter +-- time (eg: during rendering). +data Rel = Rel + { -- The note containing this relation + _relFrom :: LMLRoute, + -- The target of the relation (can be a note or anything) + _relTo :: UnresolvedRelTarget, + -- | The relation context in LML + _relCtx :: [B.Block] + } + deriving stock (Eq, Ord, Show) + +-- | A link target that has not been resolved (using model) yet. +-- +-- Resolving this may or may not result in a resource in the model. The ADT +-- constructors capture the different possible types of links the user is +-- allowed to link to. +data UnresolvedRelTarget + = URTWikiLink (WL.WikiLinkType, WL.WikiLink) + | URTResource ModelRoute + | URTVirtual SR.VirtualRoute + deriving stock (Eq, Show, Ord, Generic) + deriving anyclass (ToJSON) + +type RelIxs = '[LMLRoute, UnresolvedRelTarget] + +type IxRel = IxSet RelIxs Rel + +instance Indexable RelIxs Rel where + indices = + ixList + (ixFun $ one . _relFrom) + (ixFun $ one . _relTo) + +makeLenses ''Rel + +noteRels :: Note -> IxRel +noteRels note = + extractLinks . LC.queryLinksWithContext $ note ^. noteDoc + where + extractLinks :: Map Text (NonEmpty ([(Text, Text)], [B.Block])) -> IxRel + extractLinks m = + Ix.fromList $ + flip concatMap (Map.toList m) $ \(url, instances) -> do + flip mapMaybe (toList instances) $ \(attrs, ctx) -> do + let parentR = R.withLmlRoute R.routeParent $ note ^. noteRoute + (target, _manchor) <- parseUnresolvedRelTarget parentR attrs url + pure $ Rel (note ^. noteRoute) target ctx + +unresolvedRelsTo :: ModelRoute -> [UnresolvedRelTarget] +unresolvedRelsTo r = + let wls = either (R.withLmlRoute WL.allowedWikiLinks) WL.allowedWikiLinks $ R.modelRouteCase r + in (URTWikiLink <$> toList wls) + <> [URTResource r] + +-- | Parse a relative URL string for later resolution. +-- +-- TODO: Need tests for this function. +parseUnresolvedRelTarget :: Maybe (R.R 'R.Folder) -> [(Text, Text)] -> Text -> Maybe (UnresolvedRelTarget, Maybe WL.Anchor) +parseUnresolvedRelTarget baseDir attrs url = do + (wlRes, manchor) <- WL.delineateLink attrs url + res <- case wlRes of + Left wl -> + pure $ URTWikiLink wl + Right fp -> + fmap URTVirtual (SR.decodeVirtualRoute fp) + <|> fmap + URTResource + ( fp + & relocateRelUrlUnder (R.encodeRoute <$> baseDir) + & R.mkModelRouteFromFilePath + ) + pure (res, manchor) + +relocateRelUrlUnder :: Maybe FilePath -> FilePath -> FilePath +relocateRelUrlUnder mbase fp = + normalizeIgnoringSymlinks $ + case mbase of + Nothing -> fp + Just x -> x fp + +-- | Like `System.FilePath.normalise` but also normalises '..' +normalizeIgnoringSymlinks :: FilePath -> FilePath +normalizeIgnoringSymlinks = dropDotDot . normalise + +-- Remove '..' from path component. +-- +-- `System.FilePath.normalize` ought to do this already, but it doesn't due to +-- symlinks (which we don't use anyway.) +-- +-- See https://github.com/haskell/filepath/issues/87 +dropDotDot :: FilePath -> FilePath +dropDotDot = + let go :: Int -> NonEmpty Text -> [Text] + go n = \case + (".." :| xs) -> maybe [] (go $ n + 1) $ nonEmpty xs + (x :| xs) | n == 0 -> x : maybe [] (go 0) (nonEmpty xs) + x -> maybe [] (go 0) $ nonEmpty $ NEL.drop n x + in toString . T.intercalate "/" . maybe [] (reverse . go 0 . NEL.reverse) . nonEmpty . T.splitOn "/" . toText + +-- | An `UnresolvedRelTarget` that has been resolved. +-- +-- See @Model.Link.Resolve@ for actual resolution logic. +data ResolvedRelTarget a + = RRTMissing + | RRTAmbiguous (NonEmpty a) + | RRTFound a + deriving stock (Eq, Show, Ord, Functor, Generic) + deriving anyclass (ToJSON) + +resolvedRelTargetFromCandidates :: [a] -> ResolvedRelTarget a +resolvedRelTargetFromCandidates xs = + case nonEmpty xs of + Nothing -> + RRTMissing + Just (x :| []) -> + RRTFound x + Just xs' -> + RRTAmbiguous xs' diff --git a/src/Emanote/Model/Link/RelSpec.hs b/src/Emanote/Model/Link/RelSpec.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/Model/Link/RelSpec.hs @@ -0,0 +1,32 @@ +module Emanote.Model.Link.RelSpec where + +import Emanote.Model.Link.Rel +import Hedgehog +import Relude +import Test.Hspec +import Test.Hspec.Hedgehog + +spec :: Spec +spec = do + describe "dropDotDot" $ do + it "simple" . hedgehog $ do + dropDotDot "foo/bar/qux" === "foo/bar/qux" + dropDotDot "foo/../qux" === "qux" + dropDotDot "bar/foo/../qux" === "bar/qux" + dropDotDot "bar/foo/.." === "bar" + it "dotInfix" . hedgehog $ do + dropDotDot "bar/foo/../../qux" === "qux" + dropDotDot "bar/foo/../../qux/../foo" === "foo" + it "dotPrefix" . hedgehog $ do + dropDotDot "../../foo" === "foo" + dropDotDot "../foo" === "foo" + dropDotDot "./../foo" === "foo" + dropDotDot "./foo" === "./foo" + it "dotSuffix" . hedgehog $ do + dropDotDot "foo/.." === "" + dropDotDot "foo/bar/.." === "foo" + dropDotDot "foo/bar/../.." === "" + +-- https://github.com/hedgehogqa/haskell-hedgehog/issues/121 +once :: PropertyT IO () -> Property +once = withTests 1 . property diff --git a/src/Emanote/Model/Link/Resolve.hs b/src/Emanote/Model/Link/Resolve.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/Model/Link/Resolve.hs @@ -0,0 +1,45 @@ +module Emanote.Model.Link.Resolve where + +import Emanote.Model.Link.Rel qualified as Rel +import Emanote.Model.Note qualified as MN +import Emanote.Model.StaticFile qualified as SF +import Emanote.Model.Type (Model) +import Emanote.Model.Type qualified as M +import Emanote.Pandoc.Markdown.Syntax.WikiLink qualified as WL +import Emanote.Route qualified as R +import Emanote.Route.SiteRoute qualified as SR +import Relude + +resolveUnresolvedRelTarget :: + Model -> + Rel.UnresolvedRelTarget -> + Rel.ResolvedRelTarget SR.SiteRoute +resolveUnresolvedRelTarget model = \case + Rel.URTWikiLink (_wlType, wl) -> do + resolveWikiLinkMustExist model wl + <&> resourceSiteRoute + Rel.URTResource r -> + resolveModelRoute model r + <&> resourceSiteRoute + Rel.URTVirtual virtualRoute -> do + Rel.RRTFound $ + SR.SiteRoute_VirtualRoute + virtualRoute + +resolveWikiLinkMustExist :: + Model -> WL.WikiLink -> Rel.ResolvedRelTarget (Either MN.Note SF.StaticFile) +resolveWikiLinkMustExist model wl = + Rel.resolvedRelTargetFromCandidates $ M.modelWikiLinkTargets wl model + +resolveModelRoute :: + Model -> R.ModelRoute -> Rel.ResolvedRelTarget (Either MN.Note SF.StaticFile) +resolveModelRoute model lr = + bitraverse + (`M.modelLookupNoteByRoute` model) + (`M.modelLookupStaticFileByRoute` model) + (R.modelRouteCase lr) + & maybe Rel.RRTMissing Rel.RRTFound + +resourceSiteRoute :: Either MN.Note SF.StaticFile -> SR.SiteRoute +resourceSiteRoute = + either SR.noteFileSiteRoute SR.staticFileSiteRoute diff --git a/src/Emanote/Model/Meta.hs b/src/Emanote/Model/Meta.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/Model/Meta.hs @@ -0,0 +1,43 @@ +module Emanote.Model.Meta + ( lookupRouteMeta, + getEffectiveRouteMeta, + getEffectiveRouteMetaWith, + ) +where + +import Data.Aeson (FromJSON) +import Data.Aeson qualified as Aeson +import Data.IxSet.Typed qualified as Ix +import Emanote.Model (ModelT, modelLookupNoteByRoute, modelSData) +import Emanote.Model.Note (_noteMeta) +import Emanote.Model.SData (sdataValue) +import Emanote.Model.SData qualified as SData +import Emanote.Route qualified as R +import Optics.Operators as Lens ((^.)) +import Relude + +-- | Look up a specific key in the meta for a given route. +lookupRouteMeta :: FromJSON a => a -> NonEmpty Text -> R.LMLRoute -> ModelT f -> a +lookupRouteMeta x k r = + SData.lookupAeson x k . getEffectiveRouteMeta r + +-- | Get the (final) metadata of a note at the given route, by merging it with +-- the defaults specified in parent routes all the way upto index.yaml. +getEffectiveRouteMeta :: R.LMLRoute -> ModelT f -> Aeson.Value +getEffectiveRouteMeta mr model = + let mNote = modelLookupNoteByRoute mr model + in getEffectiveRouteMetaWith (maybe Aeson.Null _noteMeta mNote) mr model + +getEffectiveRouteMetaWith :: Aeson.Value -> R.LMLRoute -> ModelT f -> Aeson.Value +getEffectiveRouteMetaWith frontmatter mr model = + let defaultFiles = R.routeInits @'R.Yaml (R.withLmlRoute coerce mr) + defaults = flip mapMaybe (toList defaultFiles) $ \r -> do + v <- getYamlMeta r model + guard $ v /= Aeson.Null + pure v + metas = defaults <> maybe mempty one (guard (frontmatter /= Aeson.Null) >> pure frontmatter) + in maybe Aeson.Null SData.mergeAesons $ nonEmpty metas + +getYamlMeta :: R.R 'R.Yaml -> ModelT f -> Maybe Aeson.Value +getYamlMeta r model = + fmap (^. sdataValue) . Ix.getOne . Ix.getEQ r $ model ^. modelSData diff --git a/src/Emanote/Model/Note.hs b/src/Emanote/Model/Note.hs new file mode 100644 --- /dev/null +++ b/src/Emanote/Model/Note.hs @@ -0,0 +1,345 @@ +{-# LANGUAGE BangPatterns #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TemplateHaskell #-} + +module Emanote.Model.Note where + +import Control.Monad.Logger (MonadLogger) +import Control.Monad.Writer (MonadWriter (tell), WriterT, runWriterT) +import Data.Aeson qualified as Aeson +import Data.Aeson.Optics qualified as AO +import Data.Default (Default (def)) +import Data.IxSet.Typed (Indexable (..), IxSet, ixFun, ixList) +import Data.IxSet.Typed qualified as Ix +import Data.Map.Strict qualified as Map +import Data.Text qualified as T +import Emanote.Model.Note.Filter (applyPandocFilters) +import Emanote.Model.SData qualified as SData +import Emanote.Model.Title qualified as Tit +import Emanote.Pandoc.Markdown.Parser qualified as Markdown +import Emanote.Pandoc.Markdown.Syntax.HashTag qualified as HT +import Emanote.Pandoc.Markdown.Syntax.WikiLink (plainify) +import Emanote.Pandoc.Markdown.Syntax.WikiLink qualified as WL +import Emanote.Route (FileType (Folder), R) +import Emanote.Route qualified as R +import Network.URI.Slug (Slug) +import Optics.Core ((%), (.~)) +import Optics.TH (makeLenses) +import Relude +import System.FilePath (()) +import Text.Pandoc (runPure) +import Text.Pandoc.Builder qualified as B +import Text.Pandoc.Definition (Pandoc (..)) +import Text.Pandoc.Readers.Org (readOrg) +import Text.Pandoc.Walk qualified as W + +data Note = Note + { _noteRoute :: R.LMLRoute, + _noteDoc :: Pandoc, + _noteMeta :: Aeson.Value, + _noteTitle :: Tit.Title, + _noteErrors :: [Text] + } + deriving stock (Eq, Ord, Show, Generic) + deriving anyclass (Aeson.ToJSON) + +newtype RAncestor = RAncestor {unRAncestor :: R 'R.Folder} + deriving stock (Eq, Ord, Show, Generic) + deriving anyclass (Aeson.ToJSON) + +type NoteIxs = + '[ -- Route to this note + R.LMLRoute, + -- Allowed ways to wiki-link to this note. + WL.WikiLink, + -- HTML route for this note + R 'R.Html, + -- Ancestor folder routes + RAncestor, + -- Parent folder + R 'R.Folder, + -- Tag + HT.Tag, + -- Alias route for this note. Can be "foo" or "foo/bar". + NonEmpty Slug + ] + +type IxNote = IxSet NoteIxs Note + +instance Indexable NoteIxs Note where + indices = + ixList + (ixFun $ one . _noteRoute) + (ixFun $ toList . noteSelfRefs) + (ixFun $ one . noteHtmlRoute) + (ixFun noteAncestors) + (ixFun $ maybeToList . noteParent) + (ixFun noteTags) + (ixFun $ maybeToList . noteSlug) + +-- | All possible wiki-links that refer to this note. +noteSelfRefs :: Note -> NonEmpty WL.WikiLink +noteSelfRefs = + routeSelfRefs + . _noteRoute + where + routeSelfRefs :: R.LMLRoute -> NonEmpty WL.WikiLink + routeSelfRefs = + fmap snd + . R.withLmlRoute WL.allowedWikiLinks + +noteAncestors :: Note -> [RAncestor] +noteAncestors = + maybe [] (toList . fmap RAncestor . R.routeInits) . noteParent + +noteParent :: Note -> Maybe (R 'R.Folder) +noteParent = R.withLmlRoute R.routeParent . _noteRoute + +hasChildNotes :: R 'Folder -> IxNote -> Bool +hasChildNotes r = + not . Ix.null . Ix.getEQ r + +noteTags :: Note -> [HT.Tag] +noteTags = + fmap HT.Tag . maybeToMonoid . lookupMeta (one "tags") + +noteSlug :: Note -> Maybe (NonEmpty Slug) +noteSlug note = do + slugPath :: Text <- lookupMeta (one "slug") note + fmap R.unRoute $ R.mkRouteFromFilePath @_ @'R.AnyExt $ toString slugPath + +lookupMeta :: Aeson.FromJSON a => NonEmpty Text -> Note -> Maybe a +lookupMeta k = + SData.lookupAeson Nothing k . _noteMeta + +queryNoteTitle :: R.LMLRoute -> Pandoc -> Aeson.Value -> (Pandoc, Tit.Title) +queryNoteTitle r doc meta = + let yamlNoteTitle = fromString <$> SData.lookupAeson Nothing (one "title") meta + fileNameTitle = Tit.fromRoute r + notePandocTitle = do + case r of + R.LMLRoute_Md _ -> + getPandocTitle doc + R.LMLRoute_Org _ -> + getPandocMetaTitle doc + in fromMaybe (doc, fileNameTitle) $ + fmap (doc,) yamlNoteTitle <|> fmap (withoutH1 doc,) notePandocTitle + where + getPandocTitle :: Pandoc -> Maybe Tit.Title + getPandocTitle = + fmap Tit.fromInlines . getPandocH1 + where + getPandocH1 :: Pandoc -> Maybe [B.Inline] + getPandocH1 (Pandoc _ (B.Header 1 _ inlines : _rest)) = + Just inlines + getPandocH1 _ = + Nothing + getPandocMetaTitle :: Pandoc -> Maybe Tit.Title + getPandocMetaTitle (Pandoc docMeta _) = do + B.MetaInlines inlines <- B.lookupMeta "title" docMeta + pure $ Tit.fromInlines inlines + withoutH1 :: B.Pandoc -> B.Pandoc + withoutH1 (B.Pandoc m (B.Header 1 _ _ : rest)) = + B.Pandoc m rest + withoutH1 x = + x + +-- | The HTML route intended by user for this note. +noteHtmlRoute :: Note -> R 'R.Html +noteHtmlRoute note@Note {..} = + -- Favour slug if one exists, otherwise use the full path. + case noteSlug note of + Nothing -> + R.withLmlRoute coerce _noteRoute + Just slugs -> + R.mkRouteFromSlugs slugs + +lookupNotesByHtmlRoute :: R 'R.Html -> IxNote -> [Note] +lookupNotesByHtmlRoute htmlRoute = + Ix.toList . Ix.getEQ htmlRoute + +lookupNotesByRoute :: HasCallStack => R.LMLRoute -> IxNote -> Maybe Note +lookupNotesByRoute r ix = do + res <- nonEmpty $ Ix.toList $ Ix.getEQ r ix + case res of + note :| [] -> pure note + _ -> error $ "ambiguous notes for route " <> show r + +ancestorPlaceholderNote :: R.R 'Folder -> Note +ancestorPlaceholderNote r = + let placeHolder = + [ folderListingQuery, + -- TODO: Ideally, we should use semantic tags, like