commit 030d3c805966fc080828e0c0110e2aec0caaf589 Author: Holger Sielaff Date: Wed Jul 3 21:41:03 2024 +0200 initial diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..589faa0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/filestore +__pycache__ +.idea +venv +*.sqlite3 \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/content/__init__.py b/content/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/content/admin.py b/content/admin.py new file mode 100644 index 0000000..1fe08dd --- /dev/null +++ b/content/admin.py @@ -0,0 +1,73 @@ +from django.contrib import admin +from django.utils.safestring import mark_safe + +from content.models import Link, MediaFile, Question, QuestionVersion, Level, Label +from lib.utils import color_label + + +@admin.register(Level) +class LevelAdmin(admin.ModelAdmin): + search_fields = ('name', 'value',) + list_display = ('name', 'value', 'color') + list_editable = ('color',) + + +@admin.register(Label) +class LabelAdmin(admin.ModelAdmin): + search_fields = ('name',) + list_display = ('name', 'color') + list_editable = ('color',) + + +@admin.register(Question) +class QuestionAdmin(admin.ModelAdmin): + autocomplete_fields = ('medias', 'links', 'labels',) + list_display = ('name', 'list_labels', 'list_level', 'author') + search_fields = ('name', 'question', 'awnser', 'description', 'label__name', 'level__value', 'level__name',) + + def list_labels(self, instance): + return mark_safe(', '.join([color_label(l, value=l.name) for l in instance.labels.all()])) + + def list_level(self, instance): + return mark_safe(color_label(instance.level, value=str(instance.level))) + + list_level.short_description = 'Level' + list_labels.short_description = 'Labels' + + """ + fieldsets = [ + ('Basic', {'fields': [('name', 'author',)]}), + ('Question', {'fields': ('question', 'awnser',), }), + ('Meta', {'fields': ('level', 'labels', 'description'), }), + ('Media and Links', {'fields': ('medias', 'links'), }, + ) + ] + """ + + +@admin.register(MediaFile) +class MediaFileAdmin(admin.ModelAdmin): + search_fields = ('name', 'file__name') + list_display = ('name', 'file') + + +@admin.register(Link) +class LinkAdmin(admin.ModelAdmin): + search_fields = ('url',) + + +@admin.register(QuestionVersion) +class QuestionVersionAdmin(admin.ModelAdmin): + def has_add_permission(self, request): + """If a group right is not set :) + Allways be able to create a version + """ + return True + + def has_change_permission(self, request, obj=None): + """Versions are immutable """ + return False + + def has_delete_permission(self, request, obj=None): + """Versions are immutable """ + return False diff --git a/content/apps.py b/content/apps.py new file mode 100644 index 0000000..273d169 --- /dev/null +++ b/content/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class ContentConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'content' diff --git a/content/migrations/0001_initial.py b/content/migrations/0001_initial.py new file mode 100644 index 0000000..42fa4ca --- /dev/null +++ b/content/migrations/0001_initial.py @@ -0,0 +1,46 @@ +# Generated by Django 4.2.13 on 2024-06-29 12:58 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='Link', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('url', models.URLField(unique=True)), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ], + ), + migrations.CreateModel( + name='MediaFile', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('file', models.FileField(upload_to='content/media')), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ], + ), + migrations.CreateModel( + name='Question', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.CharField(max_length=500, unique=True)), + ('question', models.TextField()), + ('awnser', models.TextField()), + ('description', models.TextField(blank=True, null=True)), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ('links', models.ManyToManyField(to='content.link')), + ('medias', models.ManyToManyField(to='content.mediafile')), + ], + ), + ] diff --git a/content/migrations/0002_mediafile_author_question_author_and_more.py b/content/migrations/0002_mediafile_author_question_author_and_more.py new file mode 100644 index 0000000..98bab5d --- /dev/null +++ b/content/migrations/0002_mediafile_author_question_author_and_more.py @@ -0,0 +1,100 @@ +# Generated by Django 4.2.13 on 2024-06-30 07:20 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('content', '0001_initial'), + ] + + operations = [ + migrations.AddField( + model_name='mediafile', + name='author', + field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL), + ), + migrations.AddField( + model_name='question', + name='author', + field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL), + ), + migrations.AlterField( + model_name='mediafile', + name='file', + field=models.FileField(upload_to='filestore/media'), + ), + migrations.AlterField( + model_name='question', + name='awnser', + field=models.TextField(db_index=True), + ), + migrations.AlterField( + model_name='question', + name='links', + field=models.ManyToManyField(blank=True, to='content.link'), + ), + migrations.AlterField( + model_name='question', + name='medias', + field=models.ManyToManyField(blank=True, to='content.mediafile'), + ), + migrations.AlterField( + model_name='question', + name='name', + field=models.CharField(db_index=True, max_length=500, unique=True), + ), + migrations.AlterField( + model_name='question', + name='question', + field=models.TextField(db_index=True), + ), + migrations.CreateModel( + name='QuestionVersion', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('data', models.JSONField()), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ('author', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)), + ('question', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='content.question')), + ], + ), + migrations.CreateModel( + name='Level', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.CharField(db_index=True, max_length=25, unique=True)), + ('value', models.IntegerField(db_index=True, unique=True)), + ('description', models.TextField(blank=True, null=True)), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ('author', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)), + ], + ), + migrations.CreateModel( + name='Label', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.CharField(db_index=True, max_length=25, unique=True)), + ('description', models.TextField(blank=True, null=True)), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ('author', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)), + ], + ), + migrations.AddField( + model_name='question', + name='labels', + field=models.ManyToManyField(blank=True, null=True, to='content.label'), + ), + migrations.AddField( + model_name='question', + name='level', + field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='content.level'), + ), + ] diff --git a/content/migrations/0003_alter_question_labels.py b/content/migrations/0003_alter_question_labels.py new file mode 100644 index 0000000..d75e885 --- /dev/null +++ b/content/migrations/0003_alter_question_labels.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2.13 on 2024-06-30 07:20 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('content', '0002_mediafile_author_question_author_and_more'), + ] + + operations = [ + migrations.AlterField( + model_name='question', + name='labels', + field=models.ManyToManyField(blank=True, to='content.label'), + ), + ] diff --git a/content/migrations/0004_mediafile_name.py b/content/migrations/0004_mediafile_name.py new file mode 100644 index 0000000..9fbee75 --- /dev/null +++ b/content/migrations/0004_mediafile_name.py @@ -0,0 +1,19 @@ +# Generated by Django 4.2.13 on 2024-06-30 17:14 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('content', '0003_alter_question_labels'), + ] + + operations = [ + migrations.AddField( + model_name='mediafile', + name='name', + field=models.CharField(db_index=True, default='N.N.', max_length=25, unique=True), + preserve_default=False, + ), + ] diff --git a/content/migrations/0005_question_buzzword.py b/content/migrations/0005_question_buzzword.py new file mode 100644 index 0000000..f94c29d --- /dev/null +++ b/content/migrations/0005_question_buzzword.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2.13 on 2024-07-01 08:27 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('content', '0004_mediafile_name'), + ] + + operations = [ + migrations.AddField( + model_name='question', + name='buzzword', + field=models.CharField(blank=True, max_length=25, null=True), + ), + ] diff --git a/content/migrations/0006_link_author_link_description_link_name_and_more.py b/content/migrations/0006_link_author_link_description_link_name_and_more.py new file mode 100644 index 0000000..8743516 --- /dev/null +++ b/content/migrations/0006_link_author_link_description_link_name_and_more.py @@ -0,0 +1,48 @@ +# Generated by Django 4.2.13 on 2024-07-02 06:53 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion +import filer.fields.file + + +class Migration(migrations.Migration): + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('filer', '0017_image__transparent'), + ('content', '0005_question_buzzword'), + ] + + operations = [ + migrations.AddField( + model_name='link', + name='author', + field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL), + ), + migrations.AddField( + model_name='link', + name='description', + field=models.TextField(blank=True, null=True), + ), + migrations.AddField( + model_name='link', + name='name', + field=models.CharField(blank=True, db_index=True, max_length=25, null=True), + ), + migrations.AddField( + model_name='mediafile', + name='description', + field=models.TextField(blank=True, null=True), + ), + migrations.AlterField( + model_name='link', + name='url', + field=models.URLField(db_index=True, unique=True), + ), + migrations.AlterField( + model_name='mediafile', + name='file', + field=filer.fields.file.FilerFileField(on_delete=django.db.models.deletion.RESTRICT, related_name='media_file', to='filer.file'), + ), + ] diff --git a/content/migrations/0007_alter_label_author_alter_level_author.py b/content/migrations/0007_alter_label_author_alter_level_author.py new file mode 100644 index 0000000..4b20f2b --- /dev/null +++ b/content/migrations/0007_alter_label_author_alter_level_author.py @@ -0,0 +1,27 @@ +# Generated by Django 4.2.13 on 2024-07-02 08:04 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion +import lib.middleware.current_user + + +class Migration(migrations.Migration): + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('content', '0006_link_author_link_description_link_name_and_more'), + ] + + operations = [ + migrations.AlterField( + model_name='label', + name='author', + field=models.ForeignKey(default=lib.middleware.current_user.get_current_user, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL), + ), + migrations.AlterField( + model_name='level', + name='author', + field=models.ForeignKey(default=lib.middleware.current_user.get_current_user, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL), + ), + ] diff --git a/content/migrations/0008_alter_link_author_alter_mediafile_author.py b/content/migrations/0008_alter_link_author_alter_mediafile_author.py new file mode 100644 index 0000000..f0d722c --- /dev/null +++ b/content/migrations/0008_alter_link_author_alter_mediafile_author.py @@ -0,0 +1,27 @@ +# Generated by Django 4.2.13 on 2024-07-02 08:09 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion +import lib.middleware.current_user + + +class Migration(migrations.Migration): + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('content', '0007_alter_label_author_alter_level_author'), + ] + + operations = [ + migrations.AlterField( + model_name='link', + name='author', + field=models.ForeignKey(default=lib.middleware.current_user.get_current_user, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL), + ), + migrations.AlterField( + model_name='mediafile', + name='author', + field=models.ForeignKey(default=lib.middleware.current_user.get_current_user, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL), + ), + ] diff --git a/content/migrations/0009_label_color.py b/content/migrations/0009_label_color.py new file mode 100644 index 0000000..a211257 --- /dev/null +++ b/content/migrations/0009_label_color.py @@ -0,0 +1,19 @@ +# Generated by Django 4.2.13 on 2024-07-02 12:27 + +import colorfield.fields +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('content', '0008_alter_link_author_alter_mediafile_author'), + ] + + operations = [ + migrations.AddField( + model_name='label', + name='color', + field=colorfield.fields.ColorField(default='#666666', image_field=None, max_length=25, samples=None), + ), + ] diff --git a/content/migrations/0010_level_color.py b/content/migrations/0010_level_color.py new file mode 100644 index 0000000..b769e64 --- /dev/null +++ b/content/migrations/0010_level_color.py @@ -0,0 +1,19 @@ +# Generated by Django 4.2.13 on 2024-07-02 12:28 + +import colorfield.fields +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('content', '0009_label_color'), + ] + + operations = [ + migrations.AddField( + model_name='level', + name='color', + field=colorfield.fields.ColorField(default='#F90F90', image_field=None, max_length=25, samples=None), + ), + ] diff --git a/content/migrations/__init__.py b/content/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/content/models.py b/content/models.py new file mode 100644 index 0000000..dfd2195 --- /dev/null +++ b/content/models.py @@ -0,0 +1,150 @@ +import json +import logging +import os + +from colorfield.fields import ColorField +from django.contrib.auth.models import User +from django.db import models +from django.dispatch import receiver +from django.forms.models import model_to_dict +from django.utils.safestring import mark_safe +from filer.fields.file import FilerFileField + +from lib import get_current_user + + +class MediaFile(models.Model): + name = models.CharField(max_length=25, unique=True, db_index=True) + # https://django-filer.readthedocs.io/en/latest/extending_filer.html + # https://pypi.org/project/django-thumbnails/ + file = FilerFileField(on_delete=models.RESTRICT, related_name='media_file') + description = models.TextField(null=True, blank=True) + author = models.ForeignKey(User, on_delete=models.SET_NULL, null=True, default=get_current_user) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + def __str__(self): + return self.name + + def __repr__(self): + return self.file.name + + +class Link(models.Model): + name = models.CharField(max_length=25, null=True, blank=True, db_index=True) + url = models.URLField(unique=True, db_index=True) + description = models.TextField(null=True, blank=True) + author = models.ForeignKey(User, on_delete=models.SET_NULL, null=True, default=get_current_user) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + def __str__(self): + return self.url + + def __repr__(self): + return self.url + + +class Level(models.Model): + name = models.CharField(max_length=25, unique=True, db_index=True) + value = models.IntegerField(unique=True, db_index=True) + description = models.TextField(null=True, blank=True) + color = ColorField(default='#F90F90') + author = models.ForeignKey(User, on_delete=models.SET_NULL, null=True, default=get_current_user) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + def __str__(self): + return f'{self.value} - {self.name}' + + def __repr__(self): + return f'{self.value}' + + +class Label(models.Model): + name = models.CharField(max_length=25, unique=True, db_index=True) + description = models.TextField(null=True, blank=True) + color = ColorField(default='#666666') + author = models.ForeignKey(User, on_delete=models.SET_NULL, null=True, default=get_current_user) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + def __str__(self): + return self.name + + def __repr__(self): + return self.name + + +class Question(models.Model): + name = models.CharField(max_length=500, unique=True, db_index=True) + question = models.TextField(db_index=True) + buzzword = models.CharField(max_length=25, null=True, blank=True) + awnser = models.TextField(db_index=True) + level = models.ForeignKey(Level, on_delete=models.SET_NULL, null=True) + description = models.TextField(null=True, blank=True) + labels = models.ManyToManyField(Label, blank=True) + medias = models.ManyToManyField(MediaFile, blank=True) + links = models.ManyToManyField(Link, blank=True) + author = models.ForeignKey(User, on_delete=models.SET_NULL, null=True) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + def __str__(self): + return self.name + + def __repr__(self): + return self.name + + def to_view(self, for_players: bool = False): + ret = {} + ret['name'] = '{}{}'.format(self.name, f'({self.buzzword})' if self.buzzword else '') + ret['question'] = self.question + if self.description: + ret['question'] += ' \n\n------------------------------\n\n' + self.description + ret['awnser'] = self.awnser + ret['level'] = self.level.value + ret['medias'] = [] + ret['links'] = [] + for media in self.medias.all(): + ret.setdefault('medias', []).append(os.path.basename(media.file.path)) + for link in self.links.all(): + ret.setdefault('links', []).append(link.url) + ret['question'] = mark_safe(ret['question'].replace('\n', '\n
')) + logging.error(ret) + return ret + + +def default_json(o): + if isinstance(o, (MediaFile,)): + return str(o) + return json.dumps(model_to_dict(o)) + + +class QuestionVersion(models.Model): + question = models.ForeignKey(Question, on_delete=models.SET_NULL, null=True) + data = models.JSONField() + author = models.ForeignKey(User, on_delete=models.SET_NULL, null=True) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + def __str__(self): + return f'{self.question} - {self.created_at}' if self.question else f'{self.data.name} - {self.created_at}' + + +@receiver(models.signals.post_save, sender=Question) +def versionize_question(sender, instance: Question, *args, **kwargs): + data = model_to_dict(instance) + + # to be able to json.dumps in model + data['medias'] = [{'id': m.id, '__str__': str(m)} for m in data['medias']] + data['links'] = [{'id': m.id, '__str__': str(m)} for m in data['links']] + data['labels'] = [{'id': m.id, '__str__': str(m)} for m in data['labels']] + + QuestionVersion.objects.create( + question=instance, + data=data, + # https://django-crum.readthedocs.io/en/latest/ + # from crum import get_current_user + # author=get_current_user(), + ) diff --git a/content/tests.py b/content/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/content/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/content/views.py b/content/views.py new file mode 100644 index 0000000..91ea44a --- /dev/null +++ b/content/views.py @@ -0,0 +1,3 @@ +from django.shortcuts import render + +# Create your views here. diff --git a/lib/__init__.py b/lib/__init__.py new file mode 100644 index 0000000..3880c03 --- /dev/null +++ b/lib/__init__.py @@ -0,0 +1 @@ +from .middleware.current_user import get_current_user \ No newline at end of file diff --git a/lib/core/__init__.py b/lib/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/lib/middleware/__init__.py b/lib/middleware/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/lib/middleware/current_user.py b/lib/middleware/current_user.py new file mode 100644 index 0000000..edcd677 --- /dev/null +++ b/lib/middleware/current_user.py @@ -0,0 +1,26 @@ +from threading import local + +from django.utils.deprecation import MiddlewareMixin + +_user = local() +_request = local() + + +class CurrentUserMiddleware(MiddlewareMixin): + def process_request(self, request): + _user.value = request.user + _request.value = request + + +def get_current_user(): + try: + return _user.value + except AttributeError: + return None + + +def get_current_request(): + try: + return _request.value + except AttributeError: + return None diff --git a/lib/utils.py b/lib/utils.py new file mode 100644 index 0000000..4285981 --- /dev/null +++ b/lib/utils.py @@ -0,0 +1,58 @@ +import logging +import math +import re + +import matplotlib +from django.db import models +from django.utils.safestring import mark_safe + +re_hex = re.compile("^([0-9a-f]{3,6})(\W)?", re.IGNORECASE) + + +def hex2rgb(hexval): + return matplotlib.colors.to_rgb(hexval) + + +def light_or_dark(rgbColor, colors: tuple = ('#FFFFFF', '#333333')): + if isinstance(rgbColor, str): + rgbColor = hex2rgb(rgbColor) + [r, g, b] = rgbColor + val = 0.299 * (r * r) + 0.587 * (g * g) + 0.114 * (b * b) + hsp = math.sqrt(val) + # logging.error([rgbColor, val, hsp]) + # if hsp > 127.5: + if hsp > .5: + # light + return colors[1] + else: + # dark + return colors[0] + + +def invert_hex(hexval: str): + def _invert(content): + + text = content.group(1).lower() + code = {} + l1 = "0123456789abcdef" + l2 = "fedcba9876543210" + for i in range(len(l1)): + code[l1[i]] = l2[i] + inverted = "" + for j in text: + inverted += code[j] + return inverted + + prepend_hash = '' + if hexval.startswith('#'): + hexval = hexval[1:] + prepend_hash = '#' + return prepend_hash + re_hex.sub(_invert, hexval) + + +def color_label(instance: models.Model, value:str=None): + value = value or instance.color + return mark_safe(f'
{value}
') diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..07603a0 --- /dev/null +++ b/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + """Run administrative tasks.""" + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tablequizwiki.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/quiz/__init__.py b/quiz/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/quiz/admin.py b/quiz/admin.py new file mode 100644 index 0000000..e984331 --- /dev/null +++ b/quiz/admin.py @@ -0,0 +1,18 @@ +from django.contrib import admin + +from quiz.models import Quiz, Question + + +class QuizQuestionInlineAdmin(admin.StackedInline): + model = Question + + +@admin.register(Quiz) +class QuizAdmin(admin.ModelAdmin): + inlines = (QuizQuestionInlineAdmin,) + list_display = ('name', 'download_urls') + search_fields = ( + 'name', 'question__question__name', 'question__question__question', + 'question__question__awnser', 'question__question__level__value', + 'question__question__label_name', + ) diff --git a/quiz/apps.py b/quiz/apps.py new file mode 100644 index 0000000..3dc8afe --- /dev/null +++ b/quiz/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class QuizConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'quiz' diff --git a/quiz/migrations/0001_initial.py b/quiz/migrations/0001_initial.py new file mode 100644 index 0000000..bc927f1 --- /dev/null +++ b/quiz/migrations/0001_initial.py @@ -0,0 +1,40 @@ +# Generated by Django 4.2.13 on 2024-07-01 08:27 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ('content', '0005_question_buzzword'), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ] + + operations = [ + migrations.CreateModel( + name='Quiz', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ('author', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)), + ], + ), + migrations.CreateModel( + name='Question', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('points', models.DecimalField(decimal_places=1, default=1.0, max_digits=10)), + ('order', models.IntegerField(default=1)), + ('description', models.TextField(blank=True, null=True)), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ('question', models.ForeignKey(on_delete=django.db.models.deletion.RESTRICT, related_name='content_question', to='content.question')), + ('quiz', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='quiz.quiz')), + ], + ), + ] diff --git a/quiz/migrations/0002_quiz_name.py b/quiz/migrations/0002_quiz_name.py new file mode 100644 index 0000000..54a9031 --- /dev/null +++ b/quiz/migrations/0002_quiz_name.py @@ -0,0 +1,19 @@ +# Generated by Django 4.2.13 on 2024-07-01 09:08 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('quiz', '0001_initial'), + ] + + operations = [ + migrations.AddField( + model_name='quiz', + name='name', + field=models.CharField(default='Moepquiz', max_length=250), + preserve_default=False, + ), + ] diff --git a/quiz/migrations/0003_alter_quiz_author.py b/quiz/migrations/0003_alter_quiz_author.py new file mode 100644 index 0000000..c3cd40e --- /dev/null +++ b/quiz/migrations/0003_alter_quiz_author.py @@ -0,0 +1,22 @@ +# Generated by Django 4.2.13 on 2024-07-02 08:09 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion +import lib.middleware.current_user + + +class Migration(migrations.Migration): + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('quiz', '0002_quiz_name'), + ] + + operations = [ + migrations.AlterField( + model_name='quiz', + name='author', + field=models.ForeignKey(default=lib.middleware.current_user.get_current_user, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL), + ), + ] diff --git a/quiz/migrations/__init__.py b/quiz/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/quiz/models.py b/quiz/models.py new file mode 100644 index 0000000..3c98eb1 --- /dev/null +++ b/quiz/models.py @@ -0,0 +1,135 @@ +import csv +import json +import os.path +import zipfile + +import pdfkit +import requests +from django.contrib.auth.models import User +from django.db import models +from django.template.loader import render_to_string +from django.utils.safestring import mark_safe + +from content.models import Question as QuestionContent +from lib import get_current_user +from tablequizwiki.settings import BASE_DIR + + +class Quiz(models.Model): + name = models.CharField(max_length=250) + author = models.ForeignKey(User, on_delete=models.SET_NULL, null=True, default=get_current_user) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + def __str__(self): + return self.name + + @property + def download_urls(self): + return mark_safe( + f'Tabelle' + ' | ' + f'CSV' + ' | ' + f'PDF' + ' | ' + f'ZIP' + ) + + def to_view(self, for_players: bool = False): + data = { + 'name': self.name, + 'items': [], + 'json': '', + } + for _q in self.question_set.prefetch_related('question').order_by('order').all(): + data['items'].append(_q.to_view(for_players=for_players)) + data['json'] = json.dumps(data['items'], indent=4, default=repr) + return data + + def to_pdf(self, fh=None): + html = render_to_string('quiz/as_table.html', {'print': True, **self.to_view(), }) + + pdfkit.from_string( + html, + self.pdfpath, + options={ + 'orientation': 'landscape', + } + ) + return self.pdfpath + + def to_csv(self, fh=None): + with open(self.csvpath, 'w') as cf: + items = self.to_view()['items'] + keys = items[0].keys() + dw = csv.DictWriter(cf, fieldnames=list(keys)) + dw.writeheader() + dw.writerows(items) + return self.csvpath + + def to_zip(self, fh=None): + with zipfile.ZipFile(self.zippath, 'w') as zf: + zf.write(self.to_pdf(), arcname=os.path.basename(self.pdfpath)) + zf.write(self.to_csv(), arcname=os.path.basename(self.csvpath)) + medias = set(list(self.medias)) + links = set(list(self.links)) + for media in medias: + zf.write(media, arcname='media/' + os.path.basename(media)) + for link in links: + filename = link.replace('/', '-').split('?')[0].strip(' \n/') + '.html' + with open(f'/tmp/{filename}', 'w') as htmlfile: + txt = '' + try: + response = requests.get(link) + if response.ok: + htmlfile.write(response.text) + else: + htmlfile.write(f"Could not download {link} - {response}") + except Exception as e: + htmlfile.write(f"Could not download {link} - {e}") + zf.write(f'/tmp/{filename}', arcname='links/' + filename) + + return self.zippath + + @property + def links(self): + for q in self.question_set.all(): + for link in q.question.links.all(): + yield link.url + + @property + def medias(self): + for q in self.question_set.all(): + for media in q.question.medias.all(): + yield media.file.path + + @property + def zippath(self): + return str(BASE_DIR) + f'/filestore/zip/quiz.{self.id}.zip' + + @property + def pdfpath(self): + return str(BASE_DIR) + f'/filestore/pdf/quiz.{self.id}.pdf' + + @property + def csvpath(self): + return str(BASE_DIR) + f'/filestore/csv/quiz.{self.id}.csv' + + +class Question(models.Model): + question = models.ForeignKey(QuestionContent, on_delete=models.RESTRICT, related_name='content_question') + quiz = models.ForeignKey(Quiz, on_delete=models.CASCADE) + points = models.DecimalField(max_digits=10, decimal_places=1, default=1.0) + order = models.IntegerField(default=1) + description = models.TextField(null=True, blank=True) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + def __str__(self): + return str(self.question) + + def to_view(self, for_players: bool = False): + ret = self.question.to_view(for_players=for_players) + ret['points'] = self.points + return ret diff --git a/quiz/templatetags/__init__.py b/quiz/templatetags/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/quiz/templatetags/strings.py b/quiz/templatetags/strings.py new file mode 100644 index 0000000..e9eb099 --- /dev/null +++ b/quiz/templatetags/strings.py @@ -0,0 +1,14 @@ +import re + +from django import template +from django.template.defaultfilters import stringfilter + +register = template.Library() + + +@register.filter(name='replace') +@stringfilter +def replace(value: str, args: str): + args = re.sub('( +| *, *| *; *)', '§', args) + args = args.split('§') + return value.replace(args[0], args[1]) diff --git a/quiz/tests.py b/quiz/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/quiz/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/quiz/urls.py b/quiz/urls.py new file mode 100644 index 0000000..10c1135 --- /dev/null +++ b/quiz/urls.py @@ -0,0 +1,10 @@ +from django.urls import path + +from quiz.views import quiz_as_table, quiz_as_pdf, quiz_as_csv, quiz_as_zip + +urlpatterns = [ + path('as_table//', quiz_as_table, name='quiz-as-table'), + path('as_pdf//', quiz_as_pdf, name='quiz-as-pdf'), + path('as_csv//', quiz_as_csv, name='quiz-as-csv'), + path('as_zip//', quiz_as_zip, name='quiz-as-zip'), +] diff --git a/quiz/views.py b/quiz/views.py new file mode 100644 index 0000000..65a2e37 --- /dev/null +++ b/quiz/views.py @@ -0,0 +1,51 @@ +from mimetypes import guess_type + +from django.contrib.auth.decorators import login_required +from django.http.response import HttpResponseNotFound, HttpResponse +from django.shortcuts import render + +from quiz.models import Quiz + + +def quiz_as_file(request, id: int, filetype: str): + try: + assert filetype in ('pdf', 'csv', 'zip') + quiz = Quiz.objects.get(id=int(id)) + except AssertionError: + return HttpResponseNotFound('Wrong filetype') + except Quiz.DoesNotExist: + return HttpResponseNotFound('Not found') + + mimetype, __ = guess_type(f'/tmp/a.{filetype}') + + _path = getattr(quiz, f'to_{filetype}')() + + with open(_path, 'rb') as _content: + response = HttpResponse(content_type=mimetype) + response['Content-Disposition'] = f'attachment; filename=quiz.{id}.{filetype}' + response.write(_content.read()) + return response + + +@login_required(login_url='/admin/login/') +def quiz_as_table(request, id): + try: + quiz = Quiz.objects.get(id=int(id)) + except Quiz.DoesNotExist: + return HttpResponseNotFound('Not found') + return render(request, 'quiz/as_table.html', quiz.to_view()) + + +@login_required(login_url='/admin/login/') +def quiz_as_pdf(request, id): + return quiz_as_file(request, id, 'pdf') + + +@login_required(login_url='/admin/login/') +def quiz_as_csv(request, id): + return quiz_as_file(request, id, 'csv') + + +@login_required(login_url='/admin/login/') +def quiz_as_zip(request, id): + return quiz_as_file(request, id, 'zip') diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7ac0d1b --- /dev/null +++ b/requirements.txt @@ -0,0 +1,15 @@ +asgiref==3.8.1 +backports.zoneinfo==0.2.1 +Django==4.2.13 +typing_extensions==4.12.2 +psycopg2 +pdfkit +django-filer +easy_thumbnails +Pillow +django-polymorphic +django-colorfield +django-thumbnails +matplotlib +django-jazzmin +requests \ No newline at end of file diff --git a/tablequizwiki/__init__.py b/tablequizwiki/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tablequizwiki/asgi.py b/tablequizwiki/asgi.py new file mode 100644 index 0000000..f02d07b --- /dev/null +++ b/tablequizwiki/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for tablequizwiki project. + +It exposes the ASGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tablequizwiki.settings') + +application = get_asgi_application() diff --git a/tablequizwiki/settings.py b/tablequizwiki/settings.py new file mode 100644 index 0000000..477f0d5 --- /dev/null +++ b/tablequizwiki/settings.py @@ -0,0 +1,189 @@ +""" +Django settings for tablequizwiki project. + +Generated by 'django-admin startproject' using Django 4.2.13. + +For more information on this file, see +https://docs.djangoproject.com/en/4.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/4.2/ref/settings/ +""" + +from pathlib import Path + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-bmucyo%pmyu&s8yi$*1k9#0q2hvdfx-g91(+3+$ere_j2zro@+' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + +# Application definition + +INSTALLED_APPS = [ + 'jazzmin', + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'thumbnails', + 'easy_thumbnails', + 'colorfield', + 'filer', + 'content', + 'quiz', +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', + 'lib.middleware.current_user.CurrentUserMiddleware', +] + +ROOT_URLCONF = 'tablequizwiki.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [BASE_DIR / 'templates'] + , + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'tablequizwiki.wsgi.application' + +# Database +# https://docs.djangoproject.com/en/4.2/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + +# Password validation +# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + +# Internationalization +# https://docs.djangoproject.com/en/4.2/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_TZ = True + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/4.2/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' +FILER_STORAGES = { + 'public': { + 'main': { + 'ENGINE': 'filer.storage.PublicFileSystemStorage', + 'OPTIONS': { + 'location': str(BASE_DIR) + '/filestore/media', + 'base_url': '/media/', + }, + 'UPLOAD_TO': 'filer.utils.generate_filename.randomized', + # 'UPLOAD_TO_PREFIX': 'filer_public', + }, + 'thumbnails': { + 'ENGINE': 'filer.storage.PublicFileSystemStorage', + 'OPTIONS': { + 'location': str(BASE_DIR) + '/filestore/media/thumbnails', + 'base_url': '/media/thumbnails/', + }, + }, + }, +} + +THUMBNAILS = { + 'METADATA': { + 'BACKEND': 'thumbnails.backends.metadata.DatabaseBackend', + }, + 'STORAGE': { + 'BACKEND': 'django.core.files.storage.FileSystemStorage', + }, + 'SIZES': { + 'small': { + 'PROCESSORS': [ + {'PATH': 'thumbnails.processors.resize', 'width': 150, 'height': 150}, + # {'PATH': 'thumbnails.processors.crop', 'width': 80, 'height': 80} + ], + }, + 'medium': { + 'PROCESSORS': [ + {'PATH': 'thumbnails.processors.resize', 'width': 350, 'height': 350}, + # {'PATH': 'thumbnails.processors.crop', 'width': 80, 'height': 80} + ], + # 'POST_PROCESSORS': [ + # { + # 'PATH': 'thumbnails.post_processors.optimize', + # 'png_command': 'optipng -force -o7 "%(filename)s"', + # 'jpg_command': 'jpegoptim -f --strip-all "%(filename)s"', + # }, + # ], + }, + 'large': { + 'PROCESSORS': [ + {'PATH': 'thumbnails.processors.resize', 'width': 1028, 'height': 1028}, + # {'PATH': 'thumbnails.processors.flip', 'direction': 'horizontal'} + ], + }, + # 'watermarked': { + # 'PROCESSORS': [ + # {'PATH': 'thumbnails.processors.resize', 'width': 20, 'height': 20}, + # # Only supports PNG. File must be of the same size with thumbnail (20 x 20 in this case) + # {'PATH': 'thumbnails.processors.add_watermark', 'watermark_path': 'watermark.png'} + # ], + # } + } +} diff --git a/tablequizwiki/urls.py b/tablequizwiki/urls.py new file mode 100644 index 0000000..a09c118 --- /dev/null +++ b/tablequizwiki/urls.py @@ -0,0 +1,25 @@ +""" +URL configuration for tablequizwiki project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/4.2/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) +""" +from django.contrib import admin +from django.urls import path, include + +import quiz.urls as quizurls + +urlpatterns = [ + path('admin/', admin.site.urls), + path('quiz/', include(quizurls)) +] diff --git a/tablequizwiki/wsgi.py b/tablequizwiki/wsgi.py new file mode 100644 index 0000000..49979b5 --- /dev/null +++ b/tablequizwiki/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for tablequizwiki project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tablequizwiki.settings') + +application = get_wsgi_application() diff --git a/templates/quiz/as_table.html b/templates/quiz/as_table.html new file mode 100644 index 0000000..f2182c2 --- /dev/null +++ b/templates/quiz/as_table.html @@ -0,0 +1,84 @@ +{% load strings %} + + + + + + + +

{{ name.title }}

+{% if not print %} + + + + + + + +
Download:ZIP (with all medias)PDFCSV
+
+{% endif %} + + + + {% for key in items.0.keys %} + + {% endfor %} + + {% for row in items %} + + + {% for name, val in row.items %} + + {% endfor %} + + {% endfor %} +
#{{ key.title }}
{{ forloop.counter }} + {% if name != 'medias' and name != 'links' %} + {{ val }} + {% else %} + {% for it in val %} +
  • {{ it }}
    • + {% endfor %} + {% endif %} +
    + + + \ No newline at end of file