commit 3302ee99483ece1f563e906e0ef54bfbc9685041 Author: RunasSudo Date: Sat Jun 20 16:25:02 2020 +1000 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e91bb0b --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/data +/index.pickle +__pycache__ + +/wikinote/markup_custom.py diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/COPYING @@ -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/run.sh b/run.sh new file mode 100755 index 0000000..e545cbb --- /dev/null +++ b/run.sh @@ -0,0 +1,18 @@ +#!/usr/bin/bash +# WikiNote3 +# Copyright © 2020 Lee Yingtong Li (RunasSudo) +# +# 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 . + +FLASK_APP=wikinote FLASK_ENV=development python -m flask run -h 127.0.0.1 -p 5001 --extra-files index.pickle diff --git a/wikinote/__init__.py b/wikinote/__init__.py new file mode 100644 index 0000000..db52f88 --- /dev/null +++ b/wikinote/__init__.py @@ -0,0 +1,203 @@ +# WikiNote3 +# Copyright © 2020 Lee Yingtong Li (RunasSudo) +# +# 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 . + +from .markup import WNMarkdown + +import flask + +import os +import pickle + +app = flask.Flask(__name__, template_folder='jinja2') + +if os.path.exists('index.pickle'): + try: + with open('index.pickle', 'rb') as f: + index = pickle.load(f) + except: + print('Error loading index.pickle') + import traceback; traceback.print_exc() + +@app.route('/') +def index_page(): + children = [] + for child in os.listdir('./data/pages'): + if child.endswith('.md'): + children.append(child[:-3]) + else: + children.append(child) + children.sort() + + if not os.path.exists('./data/pages/Home.md'): + return flask.render_template('page_404.html', page={ + 'path': '', + 'title': 'Home', + 'children': children + }) + + with(open(fname, 'r')) as f: + page_source = f.read() + + md = WNMarkdown() + page_content = md.convert(page_source) + + return flask.render_template('page_rendered.html', page={ + 'path': '', + 'title': 'Home', + 'content': page_content, + 'toc': md.toc_tokens, + 'meta': md.meta, + 'children': children + }) + +@app.route('/page/') +def page_view(path): + fname = flask.safe_join('./data/pages', path) + '.md' + + children = [] + if os.path.isdir(flask.safe_join('./data/pages', path)): + for child in os.listdir(flask.safe_join('./data/pages', path)): + if child.startswith('_'): + continue + if child.endswith('.md'): + children.append(child[:-3]) + else: + children.append(child) + children.sort() + + if not os.path.exists(fname): + return flask.render_template('page_404.html', page={ + 'path': path, + 'title': path.split('/')[-1], + 'children': children + }) + + with(open(fname, 'r')) as f: + page_source = f.read() + + md = WNMarkdown() + page_content = md.convert(page_source) + + return flask.render_template('page_rendered.html', page={ + 'path': path, + 'title': path.split('/')[-1], + 'content': page_content, + 'toc': md.toc_tokens, + 'meta': md.meta, + 'children': children + }) + +@app.route('/toc/') +def page_toc(path): + fname = flask.safe_join('./data/pages', path) + '.md' + + if not os.path.exists(fname): + return flask.render_template('page_404.html', page={ + 'path': path, + 'title': path.split('/')[-1], + 'children': [] + }) + + with(open(fname, 'r')) as f: + page_source = f.read() + + md = WNMarkdown() + page_content = md.convert(page_source) + + return flask.render_template('page_toc.html', page={ + 'path': path, + 'title': path.split('/')[-1], + 'toc': md.toc_tokens + }) + +@app.route('/image/') +def image_view(name): + fname = flask.safe_join(os.getcwd(), './data/images', name[0].upper(), name) + return flask.send_file(fname) + +@app.route('/image//about') +def image_about(name): + fname = flask.safe_join(os.getcwd(), './data/images', name[0].upper(), os.path.splitext(name)[0] + '.md') + + with(open(fname, 'r')) as f: + page_source = f.read() + + md = WNMarkdown() + page_content = md.convert(page_source) + + return flask.render_template('image_about.html', page={ + 'path': name, + 'title': name, + 'content': page_content, + 'meta': md.meta + }) + +@app.route('/tag/') +def tags_list(): + return flask.render_template('tags_list.html', tags=sorted(index['tags'].keys())) + +@app.route('/tag/') +def tag_view(name): + pages = index['tags'][name] + pages.sort(key=lambda p: p['kind']) + pages.sort(key=lambda p: p['path']) + return flask.render_template('tag_view.html', name=name, pages=pages) + +@app.cli.command('index') +def cli_index(): + app.config['SERVER_NAME'] = 'localhost' + + with app.app_context(): + tags = {} + + base_path = './data/pages' + for dirpath, dirnames, filenames in os.walk(base_path): + for fname in filenames: + if fname.endswith('.md'): + page_path = dirpath[len(base_path)+1:] + '/' + fname[:-3] + + with(open(flask.safe_join(dirpath, fname), 'r')) as f: + page_source = f.read() + md = WNMarkdown() + md.convert(page_source) + + for tag in md.meta.get('tags', []): + if tag not in tags: + tags[tag] = [] + tags[tag].append({'kind': 'page', 'path': page_path}) + + base_path = './data/images' + for dirpath, dirnames, filenames in os.walk(base_path): + for fname in filenames: + if fname.endswith('.md'): + continue + + md_path = flask.safe_join(dirpath, os.path.splitext(fname)[0] + '.md') + if os.path.exists(md_path): + with(open(md_path, 'r')) as f: + page_source = f.read() + md = WNMarkdown() + md.convert(page_source) + + for tag in md.meta.get('tags', []): + if tag not in tags: + tags[tag] = [] + tags[tag].append({'kind': 'image', 'path': fname}) + + with open('index.pickle', 'wb') as f: + pickle.dump({ + 'tags': tags + }, f) diff --git a/wikinote/jinja2/base.html b/wikinote/jinja2/base.html new file mode 100644 index 0000000..a210c85 --- /dev/null +++ b/wikinote/jinja2/base.html @@ -0,0 +1,44 @@ +{# + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +#} + + + + + + {% block title %}{% endblock %} + + + + + + +
+
+ {% block content %}{% endblock %} +
+ + + + +
+ + diff --git a/wikinote/jinja2/image_about.html b/wikinote/jinja2/image_about.html new file mode 100644 index 0000000..fec1d1f --- /dev/null +++ b/wikinote/jinja2/image_about.html @@ -0,0 +1,40 @@ +{# + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +#} + +{% extends 'page_base.html' %} + +{% block page_content %} + + + {{ page.content|safe }} +{% endblock %} + +{% block leftbox %} + {% if page.meta.tags %} +
+ {% if page.meta.tags %} +

+ Tags: + {% for tag in page.meta.tags %} + {{ tag }}{% if not loop.last %},{% endif %} + {% endfor %} +

+ {% endif %} +
+ {% endif %} +{% endblock %} diff --git a/wikinote/jinja2/page_404.html b/wikinote/jinja2/page_404.html new file mode 100644 index 0000000..a055878 --- /dev/null +++ b/wikinote/jinja2/page_404.html @@ -0,0 +1,35 @@ +{# + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +#} + +{% extends 'page_base.html' %} + +{% block page_content %} +
+ There is no page with the name {{ page.title }}. +
+ + {% if page.children %} +

Children

+ +
    + {% for child in page.children %} +
  • {{ child }}
    • + {% endfor %} +
+ {% endif %} +{% endblock %} diff --git a/wikinote/jinja2/page_base.html b/wikinote/jinja2/page_base.html new file mode 100644 index 0000000..fb0b392 --- /dev/null +++ b/wikinote/jinja2/page_base.html @@ -0,0 +1,39 @@ +{# + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +#} + +{% extends 'base.html' %} + +{% block title %}{{ page.title }} • WikiNote{% endblock %} + +{% block content %} + {% if page.path %} + {% set bits = page.path.split('/') %} + + {% endif %} + +

{{ page.title }}

+ + {% block page_content %}{% endblock %} +{% endblock %} diff --git a/wikinote/jinja2/page_rendered.html b/wikinote/jinja2/page_rendered.html new file mode 100644 index 0000000..7b3cfe1 --- /dev/null +++ b/wikinote/jinja2/page_rendered.html @@ -0,0 +1,46 @@ +{# + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +#} + +{% extends 'page_base.html' %} + +{% block page_content %} + {{ page.content|safe }} +{% endblock %} + +{% block leftbox %} + {% if page.toc or page.meta.tags %} +
+ {% if page.toc %} + + {% endif %} + + {% if page.meta.tags %} +

+ Tags: + {% for tag in page.meta.tags %} + {{ tag }}{% if not loop.last %},{% endif %} + {% endfor %} +

+ {% endif %} +
+ {% endif %} +{% endblock %} diff --git a/wikinote/jinja2/page_toc.html b/wikinote/jinja2/page_toc.html new file mode 100644 index 0000000..e23156c --- /dev/null +++ b/wikinote/jinja2/page_toc.html @@ -0,0 +1,31 @@ +{# + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +#} + +{% extends 'base.html' %} + +{% block title %}{{ page.title }} • WikiNote{% endblock %} + +{% block content %} + {% if page.toc %} + + {% endif %} +{% endblock %} diff --git a/wikinote/jinja2/tag_view.html b/wikinote/jinja2/tag_view.html new file mode 100644 index 0000000..84e4664 --- /dev/null +++ b/wikinote/jinja2/tag_view.html @@ -0,0 +1,44 @@ +{# + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +#} + +{% extends 'base.html' %} + +{% block title %}Tag: {{ name }} • WikiNote{% endblock %} + +{% block content %} + + +

{{ name }}

+ + +{% endblock %} diff --git a/wikinote/jinja2/tags_list.html b/wikinote/jinja2/tags_list.html new file mode 100644 index 0000000..5b51217 --- /dev/null +++ b/wikinote/jinja2/tags_list.html @@ -0,0 +1,36 @@ +{# + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +#} + +{% extends 'base.html' %} + +{% block title %}Tags • WikiNote{% endblock %} + +{% block content %} + + +

Tags

+ +
    + {% for tag in tags %} +
  • {{ tag }}
    • + {% endfor %} +
+{% endblock %} diff --git a/wikinote/markup.py b/wikinote/markup.py new file mode 100644 index 0000000..fec71f3 --- /dev/null +++ b/wikinote/markup.py @@ -0,0 +1,416 @@ +# WikiNote3 +# Copyright © 2020 Lee Yingtong Li (RunasSudo) +# +# 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 . + +import markdown +import markdown.extensions.extra, markdown.extensions.footnotes, markdown.extensions.attr_list + +import re +import xml.etree.ElementTree as ET + +from .mdx_urlize import UrlizeExtension + +directives = {} +roles = {} + +class WNMarkdown(markdown.Markdown): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.registerExtensions([FootnoteExtension(), UrlizeExtension(), 'toc', 'tables'], {}) + + self.meta = {} + + # Markdown in HTML + self.preprocessors['html_block'].markdown_in_raw = True + self.parser.blockprocessors.register(markdown.extensions.extra.MarkdownInHtmlProcessor(self.parser), 'markdown_block', 105) + self.parser.blockprocessors.tag_counter = -1 + self.parser.blockprocessors.contain_span_tags = re.compile(r'^(p|h[1-6]|li|dd|dt|td|th|legend|address)$', re.IGNORECASE) + + # Override default Markdown processors + self.preprocessors.register(NormalizeWhitespace(self), 'normalize_whitespace', 30) + self.parser.blockprocessors.register(HashHeaderProcessor(self.parser), 'hashheader', 70) + self.treeprocessors.register(AttrListTreeprocessor(self), 'attr_list', 8) + + # Our own processors + self.parser.blockprocessors.register(DirectiveProcessor(self.parser), 'directive', 95) + self.parser.blockprocessors.register(AdmonitionProcessor(self.parser), 'admonition', 105) + self.inlinePatterns.register(BlueProcessor(self.parser), 'blue_em', 65) + self.inlinePatterns.register(RoleProcessor(self.parser), 'role', 500) + self.treeprocessors.register(WrapSectionProcessor(self), 'wrap_sections', 100) + + # Override + def reset(self): + super().reset() + self.meta = {} + return self + + # Based on Markdown.convert + def parse(self, source): + if not source.strip(): + return '' + self.lines = source.split('\n') + for prep in self.preprocessors: + self.lines = prep.run(self.lines) + + root = self.parser.parseDocument(self.lines).getroot() + + for treeprocessor in self.treeprocessors: + newRoot = treeprocessor.run(root) + if newRoot is not None: + root = newRoot + + return root + + # Based on Markdown.convert + def convert(self, source): + root = self.parse(source) + + output = self.serializer(root) + + if self.stripTopLevelTags: + try: + start = output.index('<{}>'.format(self.doc_tag)) + len(self.doc_tag) + 2 + end = output.rindex(''.format(self.doc_tag)) + output = output[start:end].strip() + except ValueError: + if output.strip().endswith('<{} />'.format(self.doc_tag)): + output = '' + + for pp in self.postprocessors: + output = pp.run(output) + + return output.strip() + + def detab(self, text): + newtext = [] + lines = text.split('\n') + for line in lines: + if line.startswith(' '*self.tab_length): + newtext.append(line[self.tab_length:]) + elif line.startswith('\t'): + newtext.append(line[1:]) + elif not line.strip(): + newtext.append('') + else: + break + return '\n'.join(newtext), '\n'.join(lines[len(newtext):]) + +class HashHeaderProcessor(markdown.blockprocessors.HashHeaderProcessor): + # Override to add 1 to level + def run(self, parent, blocks): + block = blocks.pop(0) + m = self.RE.search(block) + before = block[:m.start()] + after = block[m.end():] + if before: + self.parser.parseBlocks(parent, [before]) + h = ET.SubElement(parent, 'h{}'.format(len(m.group('level')) + 1)) # Add 1 to level + h.text = m.group('header').strip() + if after: + blocks.insert(0, after) + +class NormalizeWhitespace(markdown.preprocessors.Preprocessor): + # Override to retain tabs + def run(self, lines): + source = '\n'.join(lines) + source = source.replace(markdown.util.STX, "").replace(markdown.util.ETX, "") + source = source.replace("\r\n", "\n").replace("\r", "\n") + "\n\n" + source = re.sub(r'(?<=\n) +\n', '\n', source) + return source.split('\n') + +class DirectiveProcessor(markdown.blockprocessors.BlockProcessor): + RE = re.compile(r'^.. +(?P[a-zA-Z0-9_-]+?)::(?: +(?P.*?))?(?:\n|$)') + + def test(self, parent, block): + return bool(self.RE.search(block)) + + def run(self, parent, blocks): + block = blocks.pop(0) + m = self.RE.search(block) + + # Get directive content + if '\n' in block: + content = block[block.index('\n') + 1:] + else: + content = '' + for b in blocks[:]: + if b.startswith('\t'): + blocks.pop(0) + content += b + + content, theRest = self.parser.md.detab(content) + + directive = directives[m.group('name')](self.parser.md, arg=m.group('arg') or '', content=content) + el = directive.render() + el.directive = directive + parent.append(el) + + if theRest: + blocks.insert(0, theRest) + +class RoleProcessor(markdown.inlinepatterns.InlineProcessor): + def __init__(self, md): + super().__init__(r':(?P[^:]+?):`(?P[^`]+?)`', md) + + def handleMatch(self, m, data): + role = roles[m.group('name')](self.md, m.group('content')) + el = role.render() + el.role = role + return el, m.start(0), m.end(0) + +class BlueProcessor(markdown.inlinepatterns.InlineProcessor): + def __init__(self, md): + super().__init__(r'!!(.+?)!!', md) + + def handleMatch(self, m, data): + el = ET.Element('span') + el.text = m.group(1) + el.set('class', 'blue') + return el, m.start(0), m.end(0) + +class WrapSectionProcessor(markdown.treeprocessors.Treeprocessor): + def run(self, root): + section = ET.Element('section') + + for child in list(root): + if child.tag in ('h1', 'h2', 'h3'): + if len(section) > 0: + root.insert(list(root).index(child), section) + section = ET.Element('section') + else: + section.append(child) + root.remove(child) + + if len(section) > 0: + root.append(section) + +# Adapted from Python-Markdown +# Allow tabs +class AdmonitionProcessor(markdown.blockprocessors.BlockProcessor): + CLASSNAME = 'admonition' + CLASSNAME_TITLE = 'admonition-title' + RE = re.compile(r'(?:^|\n)!!! ?([\w\-]+(?: +[\w\-]+)*)(?: +"(.*?)")? *(?:\n|$)') + RE_SPACES = re.compile(' +|\t+') + + def test(self, parent, block): + sibling = self.lastChild(parent) + return self.RE.search(block) or \ + ((block.startswith(' ' * self.tab_length) or block.startswith('\t')) and sibling is not None and + sibling.get('class', '').find(self.CLASSNAME) != -1) + + def run(self, parent, blocks): + sibling = self.lastChild(parent) + block = blocks.pop(0) + m = self.RE.search(block) + + if m: + block = block[m.end():] # removes the first line + + block, theRest = self.parser.md.detab(block) + + if m: + klass, title = self.get_class_and_title(m) + div = ET.SubElement(parent, 'div') + div.set('class', '{} {}'.format(self.CLASSNAME, klass)) + if title: + p = ET.SubElement(div, 'p') + p.text = title + p.set('class', self.CLASSNAME_TITLE) + else: + div = sibling + + self.parser.parseChunk(div, block) + + if theRest: + # This block contained unindented line(s) after the first indented + # line. Insert these lines as the first block of the master blocks + # list for future processing. + blocks.insert(0, theRest) + + def get_class_and_title(self, match): + klass, title = match.group(1).lower(), match.group(2) + klass = self.RE_SPACES.sub(' ', klass) + if title is None: + # no title was provided, use the capitalized classname as title + # e.g.: `!!! note` will render + # `

Note

` + title = klass.split(' ', 1)[0].capitalize() + elif title == '': + # an explicit blank title should not be rendered + # e.g.: `!!! warning ""` will *not* render `p` with a title + title = None + return klass, title + +# Adapted from Python-Markdown +# Fix for tables +class AttrListTreeprocessor(markdown.treeprocessors.Treeprocessor): + BASE_RE = r'\{\:?([^\}\n]*)\}' + HEADER_RE = re.compile(r'[ ]+%s[ ]*$' % BASE_RE) + BLOCK_RE = re.compile(r'\n[ ]*%s[ ]*$' % BASE_RE) + INLINE_RE = re.compile(r'^%s' % BASE_RE) + NAME_RE = re.compile(r'[^A-Z_a-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u02ff' + r'\u0370-\u037d\u037f-\u1fff\u200c-\u200d' + r'\u2070-\u218f\u2c00-\u2fef\u3001-\ud7ff' + r'\uf900-\ufdcf\ufdf0-\ufffd' + r'\:\-\.0-9\u00b7\u0300-\u036f\u203f-\u2040]+') + + def run(self, doc): + for elem in doc.iter(): + if self.md.is_block_level(elem.tag): + # Block level: check for attrs on last line of text + RE = self.BLOCK_RE + if markdown.extensions.attr_list.isheader(elem) or elem.tag == 'dt': + # header or def-term: check for attrs at end of line + RE = self.HEADER_RE + if len(elem) and elem.tag == 'li': + # special case list items. children may include a ul or ol. + pos = None + # find the ul or ol position + for i, child in enumerate(elem): + if child.tag in ['ul', 'ol']: + pos = i + break + if pos is None and elem[-1].tail: + # use tail of last child. no ul or ol. + m = RE.search(elem[-1].tail) + if m: + self.assign_attrs(elem, m.group(1)) + elem[-1].tail = elem[-1].tail[:m.start()] + elif pos is not None and pos > 0 and elem[pos-1].tail: + # use tail of last child before ul or ol + m = RE.search(elem[pos-1].tail) + if m: + self.assign_attrs(elem, m.group(1)) + elem[pos-1].tail = elem[pos-1].tail[:m.start()] + elif elem.text: + # use text. ul is first child. + m = RE.search(elem.text) + if m: + self.assign_attrs(elem, m.group(1)) + elem.text = elem.text[:m.start()] + elif len(elem) and elem.tag == 'table' and len(elem[-1]) and len(elem[-1][-1]) and elem[-1][-1][0].text: + # SPECIAL CASE table, use last row + RE = self.INLINE_RE + m = RE.search(elem[-1][-1][0].text) # tbody -> tr -> td + if m: + self.assign_attrs(elem, m.group(1)) + # Remove last row + elem[-1].remove(elem[-1][-1]) # tbody -> tr + elif len(elem) and elem[-1].tail: + # has children. Get from tail of last child + m = RE.search(elem[-1].tail) + if m: + self.assign_attrs(elem, m.group(1)) + elem[-1].tail = elem[-1].tail[:m.start()] + if markdown.extensions.attr_list.isheader(elem): + # clean up trailing #s + elem[-1].tail = elem[-1].tail.rstrip('#').rstrip() + elif elem.text: + # no children. Get from text. + m = RE.search(elem.text) + if not m and elem.tag == 'td': + m = re.search(self.BASE_RE, elem.text) + if m: + self.assign_attrs(elem, m.group(1)) + elem.text = elem.text[:m.start()] + if markdown.extensions.attr_list.isheader(elem): + # clean up trailing #s + elem.text = elem.text.rstrip('#').rstrip() + else: + # inline: check for attrs at start of tail + if elem.tail: + m = self.INLINE_RE.match(elem.tail) + if m: + self.assign_attrs(elem, m.group(1)) + elem.tail = elem.tail[m.end():] + + def assign_attrs(self, elem, attrs): + """ Assign attrs to element. """ + for k, v in markdown.extensions.attr_list.get_attrs(attrs): + if k == '.': + # add to class + cls = elem.get('class') + if cls: + elem.set('class', '{} {}'.format(cls, v)) + else: + elem.set('class', v) + else: + # assign attr k with v + elem.set(self.sanitize_name(k), v) + + def sanitize_name(self, name): + """ + Sanitize name as 'an XML Name, minus the ":"'. + See https://www.w3.org/TR/REC-xml-names/#NT-NCName + """ + return self.NAME_RE.sub('_', name) + +# Footnotes + +class FootnoteExtension(markdown.extensions.footnotes.FootnoteExtension): + # Override + def extendMarkdown(self, md): + md.registerExtension(self) + self.parser = md.parser + self.md = md + md.preprocessors.register(markdown.extensions.footnotes.FootnotePreprocessor(self), 'footnote', 15) + FOOTNOTE_RE = r'\[\^([^\]]*)\]' # blah blah [^1] blah + md.inlinePatterns.register(FootnoteInlineProcessor(FOOTNOTE_RE, self), 'footnote', 175) + md.treeprocessors.register(markdown.extensions.footnotes.FootnoteTreeprocessor(self), 'footnote', 50) + + # Override to omit backlinks + def makeFootnotesDiv(self, root): + if not list(self.footnotes.keys()): + return None + + div = ET.Element("div") + div.set('class', 'footnote') + ol = ET.SubElement(div, "ol") + surrogate_parent = ET.Element("div") + + for index, id in enumerate(self.footnotes.keys(), start=1): + li = ET.SubElement(ol, "li") + li.set("id", self.makeFootnoteId(id)) + self.parser.parseChunk(surrogate_parent, self.footnotes[id]) + for el in list(surrogate_parent): + li.append(el) + surrogate_parent.remove(el) + return div + +class FootnoteInlineProcessor(markdown.extensions.footnotes.FootnoteInlineProcessor): + # Override to handle commas + def handleMatch(self, m, data): + id = m.group(1).rstrip(',') + if id in self.footnotes.footnotes.keys(): + sup = ET.Element("sup") + sup.set('class', 'footnote-ref') + a = ET.SubElement(sup, "a") + sup.set('id', self.footnotes.makeFootnoteRefId(id, found=True)) + a.set('href', '#' + self.footnotes.makeFootnoteId(id)) + a.text = str(list(self.footnotes.footnotes.keys()).index(id) + 1) + if m.group(1).endswith(','): + a.tail = ',' + return sup, m.start(0), m.end(0) + else: + return None, None, None + +# Custom directives and roles +try: + from . import markup_custom + directives.update(markup_custom.directives) + roles.update(markup_custom.roles) +except ImportError: + pass diff --git a/wikinote/mdx_urlize.py b/wikinote/mdx_urlize.py new file mode 100644 index 0000000..22849f6 --- /dev/null +++ b/wikinote/mdx_urlize.py @@ -0,0 +1,51 @@ +# Adapted from: +# Copyright (c) 2014 Rowan Nairn. All rights reserved. Licensed under the 2-clause BSD licence +# https://github.com/r0wb0t/markdown-urlize + +import markdown + +# Global Vars +URLIZE_RE = '(%s)' % '|'.join([ + r'<(?:f|ht)tps?://[^>]*>', + r'\b(?:f|ht)tps?://[^)<>\s]+[^.,)<>\s]', + r'\bwww\.[^)<>\s]+[^.,)<>\s]', + r'[^(<\s]+\.(?:(?:com|net|org)(?:\.au)?)\b', + r'doi: *(?:[^ ]+)' +]) + +class UrlizePattern(markdown.inlinepatterns.Pattern): + """ Return a link Element given an autolink (`http://example/com`). """ + def handleMatch(self, m): + url = m.group(2) + + if url.startswith('<'): + url = url[1:-1] + + text = url + + if not url.split('://')[0] in ('http','https','ftp'): + if '@' in url and not '/' in url: + url = 'mailto:' + url + elif url.startswith('doi:'): + url = 'https://doi-org.ezproxy.lib.monash.edu.au/' + url[4:].strip() + else: + url = 'http://' + url + + el = markdown.util.etree.Element("a") + el.set('href', url) + el.text = markdown.util.AtomicString(text) + return el + +class UrlizeExtension(markdown.Extension): + """ Urlize Extension for Python-Markdown. """ + + def extendMarkdown(self, md, md_globals): + """ Replace autolink with UrlizePattern """ + md.inlinePatterns['autolink'] = UrlizePattern(URLIZE_RE, md) + +def makeExtension(*args, **kwargs): + return UrlizeExtension(*args, **kwargs) + +if __name__ == "__main__": + import doctest + doctest.testmod() diff --git a/wikinote/static/css/main.css b/wikinote/static/css/main.css new file mode 100644 index 0000000..bd7ae5a --- /dev/null +++ b/wikinote/static/css/main.css @@ -0,0 +1,330 @@ +/* + WikiNote3 + Copyright © 2020 Lee Yingtong Li (RunasSudo) + + 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 . +*/ + +html, body { + font-family: 'Source Sans Pro', Helvetica, Arial, sans-serif; + font-size: 12pt; /* 10.5pt */ +} + +@media screen and (min-width: 37cm) { + article.page { + width: 21cm; + + box-sizing: border-box; + margin: 0.5cm 0 0.5cm 0; + padding: 1cm; + + border: 2px solid #ccc; + box-shadow: 4px 4px 4px #777; + } +} + +@media screen and (max-width: 37cm) { + body { + padding: 1cm; + } +} + +/* Left/right boxes */ + +@media screen and (min-width: 37cm) { + div.page-container { + display: flex; + justify-content: center; + align-items: flex-start; + } + + aside.leftbox, aside.rightbox { + width: 7cm; + } + + aside.leftbox > div, aside.rightbox > div { + width: 7cm; + box-sizing: border-box; + padding: 0.5cm; + border: 1px solid #ccc; + } + + aside.leftbox { + position: relative; + order: -1; + margin: 0.5cm 1cm 0.5cm auto; + } + + aside.rightbox { + position: relative; + margin: 0.5cm auto 0.5cm 1cm; + } + + aside.leftbox > div, aside.rightbox > div { + position: fixed; + overflow-y: auto; + max-height: calc(100% - 1cm); + } + + aside.leftbox > div :last-child, aside.rightbox > div :last-child { + margin-bottom: 0; + } +} + +@media screen and (max-width: 37cm) { + aside.leftbox > div, aside.rightbox > div { + border-top: 2px solid #ccc; + margin-top: 0.5cm; + padding-top: 0.5cm; + } +} + +@media print { + aside.leftbox, aside.rightbox { + display: none; + } +} + +/* Table of contents */ + +ul.toc { + padding: 0; +} + +ul.toc li { + list-style-type: none; +} + +/* Breadcrumbs */ + +nav.breadcrumbs { + font-size: 0.8rem; + margin-bottom: 0.25cm; + color: #555753ff; +} + +nav.breadcrumbs img { + height: 0.9em; +} + +/* Page content styling */ + +h1, h2, h3, h4, h5, h6 { + color: #204a87ff; + font-weight: 600; + margin-bottom: 0.25cm; +} +h1 { + font-size: 1.33rem; /* 14pt */ + margin-top: 0; +} +h2 { + font-size: 1.14rem; /* 12pt */ + margin-top: 0.4cm; +} +h3 { + font-size: 1rem; /* 10.5pt */ + margin-top: 0.4cm; +} +h4, h5, h6 { + font-size: 1rem; /* 10.5pt */ + margin-top: 0.4cm; + font-weight: normal; +} + +p { + margin-top: 0; + margin-bottom: 0.25cm; +} +p, ul { + line-height: 1.4; +} + +ul, ol { + margin-top: 0; + padding-left: 1.8rem; +} +section > ul, section > ol { + margin-bottom: 0.25cm; +} +ul > li { + list-style-type: '\2022 '; +} +ul > li > ul > li { + list-style-type: '\25e6 '; +} +ol p { + margin: 0; +} + +section > div:not(:last-child) { + margin-bottom: 0.25cm; +} + +table { + border-collapse: collapse; + margin-bottom: 0.25cm; + width: 100%; +} +table td, table th { + border-top: 0.5pt solid black; + border-bottom: 0.5pt solid black; + padding: 0.5mm 1mm; +} +table th { + font-weight: 600; + text-align: left; +} +table tr.heading th { + text-align: center; +} + +span.blue { + color: #204a87; + font-weight: 600; + font-style: normal; +} + +a { + color: #3465a4; + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.redlink { + color: #cc0000ff !important; +} + +div.two-columns { + display: flex; +} +div.two-columns > aside { + flex-grow: 1; +} +div.two-columns > aside:not(:last-of-type) { + margin-right: 1em; +} + +/* Remove trailing margins */ + +div.admonition > p:last-child, +td > ul:last-child { + margin-bottom: 0; +} + +/* Admonitions */ + +div.admonition { + padding: 0.5em; + margin-bottom: 0.25cm; + background-color: #eee; +} +div.admonition.warning { + background-color: #fef7b8ff; +} +div.admonition.error { + background-color: #fcd4d4ff; +} +p.admonition-title { + font-weight: 600; +} + +div.admonition.pharm { + background-color: #d9f1f3; +} +div.admonition.pharm .drug-circle { + height: 1.8rem; + width: 1.8rem; + border-radius: 0.9rem; + + color: #2e3436ff; + background-color: white; + + display: flex; + justify-content: center; + align-items: center; + + font-size: 0.8rem; + + margin: -0.15cm 0; +} +div.admonition.pharm .drug-circle.drug-circle-pm { + font-size: 1.2rem; +} +div.admonition.pharm a.drug { + color: black; + font-weight: 600; +} +div.admonition.pharm span.alt-drugs { + color: #888a85; + text-decoration: underline; + text-decoration-style: dashed; + cursor: pointer; +} + +/* Tooltips */ +.tooltip { + position: relative; + display: inline-block; +} +.tooltip .tooltip-content { + display: none; + position: absolute; + background-color: white; + border: 1px solid #d3d7cfff; + border-radius: 8px; + padding: 8px; + color: black; +} +.tooltip:hover .tooltip-content { + display: block; +} + +/* Steps */ + +span.step { + font-weight: 600; +} +span.step .step-circle { + height: 1.8rem; + width: 1.8rem; + border-radius: 0.9rem; + + color: white; + background-color: #2e3436ff; + + display: inline-flex; + justify-content: center; + align-items: center; + + margin-right: 1ex; +} + +/* Footnotes */ + +sup.footnote-ref, sup.footnote-ref a { + color: #888a85; + text-decoration: none; +} +div.footnote { + font-size: small; + + border-top: 2px solid #444; + padding-top: 0.25cm; + margin-top: 0.25cm; +} +div.footnote ol { + margin: 0; +} diff --git a/wikinote/static/img/icons/home.svg b/wikinote/static/img/icons/home.svg new file mode 100644 index 0000000..a731638 --- /dev/null +++ b/wikinote/static/img/icons/home.svg @@ -0,0 +1 @@ + \ No newline at end of file