commit 804a7961efa2f3b705586cef967bb70be83c7e7b Author: hal Date: Sat Oct 5 23:01:11 2024 +0200 initial commit diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..805e55a --- /dev/null +++ b/.dockerignore @@ -0,0 +1,6 @@ +* +!requirements.lock +!src/ +!templates/ +!static/ +static/**/*.xcf diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..0c46cce --- /dev/null +++ b/.editorconfig @@ -0,0 +1,13 @@ +root = true + +[**] +charset = utf-8 +end_of_line = lf +indent_size = 4 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true +max_line_length = 99 + +[{**.yml,**.yaml,**.html}] +indent_size = 2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e750333 --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +# Project +.idea/ +.vscode/ +.venv/ +.tests/ +.env +venv/ + +# Cache +__pycache__/ +*.py[cod] +.cache/ +.ruff_cache/ +.mypy_cache/ +.pytest_cache/ +.coverage/ + +# Build +env/ +build/ +_build/ +dist/ +site/ +*.egg-info/ +*.egg diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..455808f --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.12.4 diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..1688995 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,7 @@ +FROM python:3.12.4-alpine +WORKDIR /app +COPY requirements.lock ./ +RUN PYTHONDONTWRITEBYTECODE=1 pip install --no-cache-dir -r requirements.lock +COPY . . +CMD [ "uvicorn", "src.main:app", "--no-access-log", "--proxy-headers", \ + "--forwarded-allow-ips", "*", "--host", "0.0.0.0", "--port", "5758" ] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8162079 --- /dev/null +++ b/README.md @@ -0,0 +1,111 @@ +# 📖 Rural Dictionary + +> We're rural, not urban. + +Privacy-respecting, NoJS-supporting Urban Dictionary frontend. + +## 🌐 Instances + +| URL | Country | Owner name | Owner Website | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|------------|------------------------| +| + [Tor](http://rd.vernccvbvyi5qhfzyqengccj7lkove6bjot2xhh5kajhwvidqafczrad.onion) + [I2P](http://vern5cxiaufqvhv4hu5ypkvw3tiwvuinae4evdbqzrioql6s2sha.b32.i2p) | US | ~vern | | +| | RO | bloatcat | | +| | NL | thirtysix | | + +## ✨ Features + +Frontend supports all Urban Dictionary features and has endpoint-parity with it. +Available features include: + +- Word definitions +- Author pages +- Homepage with words of the day +- Random word definitions +- 404 page with words similar to search +- Pagination + +## 🚀 Deployment + +Clone repository: + +```sh +git clone https://git.vern.cc/cobra/rural-dict.git +cd rural-dict +``` + +### 🐳 With Docker + +```sh +docker build . -t rural-dict +docker compose up -d +``` + +### 💻 Without containerization + +```sh +python3 -m venv .venv +. .venv/bin/activate +pip install -r requirements.lock +uvicorn src.main:app --no-access-log --proxy-headers --forwarded-allow-ips '*' --host 0.0.0.0 --port 5758 +``` + +### 🛡️ Running behind a reverse proxy + +To run the app behind a reverse proxy, ensure that the appropriate proxy headers are added. +Below is a sample configuration for NGINX: + +```text +location / { + proxy_pass http://127.0.0.1:5758; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; +} +``` + +## 🔧 Development + +Install Rye by following +the [installation guide](https://rye.astral.sh/guide/installation/). + +Use `rye sync` to install dependencies and required Python version. + +Use `rye run dev` to start development server which will reload on every change to source code. + +Use `rye check --fix` and `rye fmt` to lint and format code. Assumed to be run before each commit +to guarantee code quality. + +Use `rye run basedpyright` to ensure typing is correct. + +## 🤝 Support + +Join our [Matrix room](https://mto.vern.cc/#/#cobra-frontends:vern.cc) for support and other +things related to Rural Dictionary. + +## 🔗 Redirection + +To use Rural Dictionary, simply replace an Urban Dictionary URL with a Rural Dictionary URL from +the instance list above. Auto-redirect browser extension +like [Redirector](https://github.com/einaregilsson/Redirector) can be used to achieve this. + +For example, change: + +`https://urbandictionary.com/define.php?term=kin` + +to: + +`https://rd.vern.cc/define.php?term=kin` + +**Note:** More endpoints are supported. + +## 👥 Contributors + +- [thirtysix](https://thirtysix.pw), rewrote project in a more modern libraries stack and + implemented missing Urban Dictionary features +- [zortazert](https://codeberg.org/zortazert), created the initial Urban Dictionary frontend using + JavaScript and helped develop Rural Dictionary + +## 📜 License + +This project is licensed under the AGPLv3+ license - see the [license file](LICENSE) for details. diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..626a28c --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,7 @@ +version: "3" +services: + rural-dict: + build: . + restart: unless-stopped + ports: + - "10.0.3.0:5758:5758" diff --git a/instances.json b/instances.json new file mode 100644 index 0000000..2ab52d6 --- /dev/null +++ b/instances.json @@ -0,0 +1,26 @@ +[ + { + "clearnet": "https://rd.vern.cc", + "tor": "http://rd.vernccvbvyi5qhfzyqengccj7lkove6bjot2xhh5kajhwvidqafczrad.onion", + "i2p": "http://vern5cxiaufqvhv4hu5ypkvw3tiwvuinae4evdbqzrioql6s2sha.b32.i2p", + "country": "US", + "owner_name": "~vern", + "owner_website": "https://vern.cc" + }, + { + "clearnet": "https://rd.bloat.cat", + "tor": null, + "i2p": null, + "country": "RO", + "owner_name": "bloatcat", + "owner_website": "https://bloat.cat" + }, + { + "clearnet": "https://rd.thirtysix.pw", + "tor": null, + "i2p": null, + "country": "NL", + "owner_name": "thirtysix", + "owner_website": "https://thirtysix.pw" + } +] diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..923d4e6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,84 @@ +[project] +name = "rural-dict" +version = "1.0.0" +description = "Privacy-respecting, NoJS-supporting Urban Dictionary frontend." +license = "AGPL-3.0-or-later" +readme = "README.md" +requires-python = ">=3.12" +authors = [ + { name = "Zubarev Grigoriy", email = "thirtysix@thirtysix.pw" }, + { name = "vlnst", email = "vlnst@bloat.cat" }, + { name = "Skylar Astaroth", email = "cobra@vern.cc" }, + { name = "zortazert", email = "zortazert@matthewevan.xyz" }, +] +dependencies = [ + "aiohttp~=3.10.3", + "selectolax~=0.3.21", + "fastapi~=0.112.1", + "uvicorn[standard]~=0.30.6", + "jinja2~=3.1.4", +] + +[tool.rye] +virtual = true +managed = true +universal = true +dev-dependencies = [ + "basedpyright>=1.16.0", +] + +[tool.rye.scripts] +dev = """uvicorn src.main:app --reload --reload-include 'src/**/*.py' +--reload-include 'templates/**/*.html' --reload-include 'static/**/*.css' --port 5758""" +start = """uvicorn src.main:app --no-access-log --proxy-headers +--forwarded-allow-ips '*' --host 0.0.0.0 --port 5758""" + +[tool.ruff] +target-version = "py312" +line-length = 99 +exclude = [ + ".git", + ".venv", + ".idea", + ".tests", + "build", + "dist", +] + +[tool.ruff.lint] +select = [ + "E", # pycodestyle errors + "W", # pycodestyle warnings + "F", # pyflakes + "I", # isort + "N", # pep8-naming + "S", # flake8-bandit + "B", # flake8-bugbear + "G", # flake8-logging-format + "C4", # flake8-comprehensions + "UP", # pyupgrade + "PLC", # pylint conventions + "PLE", # pylint errors + "SIM", # flake8-simplify + "RET", # flake8-return + "YTT", # flake8-2020 + "RUF", # ruff-specific rules + "TCH", # flake8-type-checking + "PTH", # flake8-use-pathlib + "ASYNC", # flake8-async +] + +[tool.basedpyright] +exclude = [ + ".git", + ".venv", + ".idea", + ".tests", + "build", + "dist", +] +typeCheckingMode = "standard" +pythonPlatform = "All" +pythonVersion = "3.12" +reportMissingImports = true +reportMissingTypeStubs = false diff --git a/requirements-dev.lock b/requirements-dev.lock new file mode 100644 index 0000000..010cb53 --- /dev/null +++ b/requirements-dev.lock @@ -0,0 +1,74 @@ +# generated by rye +# use `rye lock` or `rye sync` to update this lockfile +# +# last locked with the following flags: +# pre: false +# features: [] +# all-features: false +# with-sources: false +# generate-hashes: false +# universal: true + +aiohappyeyeballs==2.3.6 + # via aiohttp +aiohttp==3.10.3 +aiosignal==1.3.1 + # via aiohttp +annotated-types==0.7.0 + # via pydantic +anyio==4.4.0 + # via starlette + # via watchfiles +attrs==24.2.0 + # via aiohttp +basedpyright==1.16.0 +click==8.1.7 + # via uvicorn +colorama==0.4.6 ; platform_system == 'Windows' or sys_platform == 'win32' + # via click + # via uvicorn +fastapi==0.112.1 +frozenlist==1.4.1 + # via aiohttp + # via aiosignal +h11==0.14.0 + # via uvicorn +httptools==0.6.1 + # via uvicorn +idna==3.7 + # via anyio + # via yarl +jinja2==3.1.4 +markupsafe==2.1.5 + # via jinja2 +multidict==6.0.5 + # via aiohttp + # via yarl +nodejs-wheel-binaries==20.16.0 + # via basedpyright +pydantic==2.8.2 + # via fastapi +pydantic-core==2.20.1 + # via pydantic +python-dotenv==1.0.1 + # via uvicorn +pyyaml==6.0.2 + # via uvicorn +selectolax==0.3.21 +sniffio==1.3.1 + # via anyio +starlette==0.38.2 + # via fastapi +typing-extensions==4.12.2 + # via fastapi + # via pydantic + # via pydantic-core +uvicorn==0.30.6 +uvloop==0.20.0 ; platform_python_implementation != 'PyPy' and sys_platform != 'cygwin' and sys_platform != 'win32' + # via uvicorn +watchfiles==0.23.0 + # via uvicorn +websockets==12.0 + # via uvicorn +yarl==1.9.4 + # via aiohttp diff --git a/requirements.lock b/requirements.lock new file mode 100644 index 0000000..61f79ad --- /dev/null +++ b/requirements.lock @@ -0,0 +1,71 @@ +# generated by rye +# use `rye lock` or `rye sync` to update this lockfile +# +# last locked with the following flags: +# pre: false +# features: [] +# all-features: false +# with-sources: false +# generate-hashes: false +# universal: true + +aiohappyeyeballs==2.3.6 + # via aiohttp +aiohttp==3.10.3 +aiosignal==1.3.1 + # via aiohttp +annotated-types==0.7.0 + # via pydantic +anyio==4.4.0 + # via starlette + # via watchfiles +attrs==24.2.0 + # via aiohttp +click==8.1.7 + # via uvicorn +colorama==0.4.6 ; platform_system == 'Windows' or sys_platform == 'win32' + # via click + # via uvicorn +fastapi==0.112.1 +frozenlist==1.4.1 + # via aiohttp + # via aiosignal +h11==0.14.0 + # via uvicorn +httptools==0.6.1 + # via uvicorn +idna==3.7 + # via anyio + # via yarl +jinja2==3.1.4 +markupsafe==2.1.5 + # via jinja2 +multidict==6.0.5 + # via aiohttp + # via yarl +pydantic==2.8.2 + # via fastapi +pydantic-core==2.20.1 + # via pydantic +python-dotenv==1.0.1 + # via uvicorn +pyyaml==6.0.2 + # via uvicorn +selectolax==0.3.21 +sniffio==1.3.1 + # via anyio +starlette==0.38.2 + # via fastapi +typing-extensions==4.12.2 + # via fastapi + # via pydantic + # via pydantic-core +uvicorn==0.30.6 +uvloop==0.20.0 ; platform_python_implementation != 'PyPy' and sys_platform != 'cygwin' and sys_platform != 'win32' + # via uvicorn +watchfiles==0.23.0 + # via uvicorn +websockets==12.0 + # via uvicorn +yarl==1.9.4 + # via aiohttp diff --git a/src/main.py b/src/main.py new file mode 100644 index 0000000..79d3b04 --- /dev/null +++ b/src/main.py @@ -0,0 +1,125 @@ +import re +from contextlib import asynccontextmanager +from datetime import datetime +from json import JSONDecodeError + +import aiohttp +from fastapi import FastAPI, Request +from fastapi.responses import HTMLResponse, RedirectResponse +from fastapi.staticfiles import StaticFiles +from fastapi.templating import Jinja2Templates +from selectolax.parser import HTMLParser, Node + + +@asynccontextmanager +async def lifespan(app: FastAPI): + """Establishing an aiohttp ClientSession for the duration of the app's lifecycle.""" + global session + session = aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(10)) + yield + await session.close() + + +app = FastAPI(lifespan=lifespan, docs_url=None, redoc_url=None) +app.mount("/static", StaticFiles(directory="static"), name="static") +templates = Jinja2Templates(directory="templates") +session: aiohttp.ClientSession = None # pyright: ignore[reportAssignmentType] + + +def remove_classes(node: Node) -> Node: + """Recursively remove all classes from all nodes.""" + if "class" in node.attributes: + del node.attrs["class"] # pyright: ignore [reportIndexIssue] + for child in node.iter(): + remove_classes(child) + return node + + +@app.get("/{path:path}", response_class=HTMLResponse) +async def catch_all(response: Request): + """Handle all routes on Urban Dictionary and perform redirection if necessary.""" + path_without_host = ( + f"{response.url.path}{f'?{response.url.query}' if response.url.query else ''}" + ) + url = f"https://www.urbandictionary.com{path_without_host}" + term = response.query_params.get("term") + + async with session.get(url) as dict_response: + if dict_response.history: + return RedirectResponse(str(dict_response.url.relative()), status_code=301) + html = await dict_response.text() + parser = HTMLParser(html) + if dict_response.status != 200: + similar_words = None + if (try_this := parser.css_first("div.try-these")) is not None: + similar_words = [remove_classes(word).html for word in try_this.css("li a")] + return templates.TemplateResponse( + "404.html", + { + "request": response, + "similar_words": similar_words, + "term": term, + "site_title": f"Rural Dictionary: {term}", + "site_description": ( + "View on Rural Dictionary, an alternative private " + "frontend to Urban Dictionary." + ), + }, + status_code=404, + ) + + results = [] + definitions = parser.css("div[data-defid]") + try: + thumbs_api_url = ( + f'https://api.urbandictionary.com/v0/uncacheable?ids=' + f'{",".join(d.attributes["data-defid"] or "-1" for d in definitions)}' + ) + async with session.get(thumbs_api_url) as thumbs_response: + thumbs_json = await thumbs_response.json() + thumbs_data = {el["defid"]: el for el in thumbs_json["thumbs"]} + except (KeyError, JSONDecodeError, TimeoutError): + thumbs_data = {} + + site_description = None + for definition in definitions: + word = definition.css_first("a.word").text() + meaning_node = remove_classes(definition.css_first("div.meaning")) + if site_description is None: + site_description = re.sub(r"\s+", " ", meaning_node.text(strip=True, separator=" ")) + meaning = meaning_node.html + example = remove_classes(definition.css_first("div.example")).html + contributor = remove_classes(definition.css_first("div.contributor")).html + definition_id = int(definition.attributes["data-defid"] or "-1") + definition_thumbs = thumbs_data.get(definition_id, {}) + thumbs_up = definition_thumbs.get("up") + thumbs_down = definition_thumbs.get("down") + results.append( + [definition_id, word, meaning, example, contributor, thumbs_up, thumbs_down] + ) + if (pagination := parser.css_first("div.pagination")) is not None: + pagination = remove_classes(pagination) + pagination.attrs["class"] = "pagination" # pyright: ignore [reportIndexIssue] + pagination = pagination.html + + term = term or results[0][1] + site_title = "Rural Dictionary" + match response.url.path: + case "/": + # add current date for page with words of the day + site_title += f', {datetime.now().strftime("%d %B")}' + case "/random.php": + term = "Random words" + site_title += f": {term}" + + return templates.TemplateResponse( + "index.html", + { + "request": response, + "results": results, + "pagination": pagination, + "term": term, + "site_title": site_title, + "site_description": site_description, + }, + ) diff --git a/static/css/main.css b/static/css/main.css new file mode 100644 index 0000000..9211ca3 --- /dev/null +++ b/static/css/main.css @@ -0,0 +1,48 @@ +body { + font-family: DejaVu Sans Mono, monospace; + margin: 20px auto; + max-width: 800px; + line-height: 1.5em; + font-size: 1.1em; + background-color: #282828; + color: #d5c4a1; + padding: 0 10px; + hyphens: auto; +} + +img { + max-width: 80vw; +} + +a { + color: #83a598; + text-decoration: none; + border-bottom: #c9b999 0.125em none; +} +a:hover { + color: #e0ac16; + text-decoration: none; + border-bottom: #83a598 0.125em dotted; +} + +h2 { + display: inline; + line-height: 1.2; + color: #e0ac16; + font-size: 1.2em; +} + +input { + background-color: #282828; + color: #d5c4a1; +} + +.pagination { + margin-right: 1ch; + text-align: center; +} +.pagination ul > li { + list-style: none; + display: inline-block; + padding-left: 1ch; +} diff --git a/static/img/favicon.png b/static/img/favicon.png new file mode 100644 index 0000000..4b1d17b Binary files /dev/null and b/static/img/favicon.png differ diff --git a/static/img/favicon.png_og b/static/img/favicon.png_og new file mode 100644 index 0000000..e38cf61 Binary files /dev/null and b/static/img/favicon.png_og differ diff --git a/static/img/favicon.xcf b/static/img/favicon.xcf new file mode 100644 index 0000000..62b11fe Binary files /dev/null and b/static/img/favicon.xcf differ diff --git a/static/img/logo.png b/static/img/logo.png new file mode 100644 index 0000000..df26beb Binary files /dev/null and b/static/img/logo.png differ diff --git a/static/img/logo.png_og b/static/img/logo.png_og new file mode 100644 index 0000000..f1b33d9 Binary files /dev/null and b/static/img/logo.png_og differ diff --git a/static/img/logo.xcf b/static/img/logo.xcf new file mode 100644 index 0000000..a27dba9 Binary files /dev/null and b/static/img/logo.xcf differ diff --git a/templates/404.html b/templates/404.html new file mode 100644 index 0000000..b3ebc3a --- /dev/null +++ b/templates/404.html @@ -0,0 +1,12 @@ +{% extends "base.html" %} {% block content %} +
+

Definition not found: {{ term }}

+ {% if similar_words %} + {% for word in similar_words %} +

{{ word | safe }}

+ {% endfor %} + {% else %} +

There are no similar words. Try correcting your search.

+ {% endif %} +
+{% endblock %} diff --git a/templates/base.html b/templates/base.html new file mode 100644 index 0000000..88ec342 --- /dev/null +++ b/templates/base.html @@ -0,0 +1,44 @@ + + + + + + + + + {{ site_title }} + + + + + + + + + + + + +
+ + logo + + + Random | Source Code +
+
+ {% block content %}{% endblock %} + + diff --git a/templates/index.html b/templates/index.html new file mode 100644 index 0000000..8d3056a --- /dev/null +++ b/templates/index.html @@ -0,0 +1,23 @@ +{% extends "base.html" %} +{% block content %} +{% for definition_id, word, meaning, example, contributor, thumbs_up, thumbs_down in results %} +
+ +

{{ word }}

+ +
+

{{ meaning | safe }}

+

{{ example | safe }}

+
+
{{ contributor | safe }}
+ {% if thumbs_up is not none and thumbs_down is not none %} +

+ 👍{{ thumbs_up }} + 👎{{ thumbs_down }} +

+ {% endif %} +
+
+{% endfor %} +{% if pagination %}{{ pagination | safe }}{% endif %} +{% endblock %}