commit 7abc466b1617bc58e924a56183f38884a4c0ae69 Author: Himadri Bhattacharjee <107522312+lavafroth@users.noreply.github.com> Date: Thu Jan 26 19:10:16 2023 +0530 Initial commit diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5993f27 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,134 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[lavafroth@protonmail.com](mailto:lavafroth@protonmail.com). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1840fd9 --- /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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8f5af8 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# PwnPi - A More Offensive Redteam Appliance + +PwnPi Amora is a wireless keystroke injection tool built on the Raspberry Pi Pico W using MicroPython. + +## Quick Start +- Plug in your Raspberry Pi Pico W while pressing the `BOOTSEL` button. +- Drag and drop the `adafruit-circuitpython-raspberry_pi_pico_w-en_US-8.0.0-beta.6.uf2` image onto the newly visible drive. +- Copy all the files in this directory except for the `README.md`, `CODE_OF_CONDUCT.md` and `LICENSE` into the drive once it reloads with the label `CIRCUITPY` +- Modify the WiFi SSID and password in setttings.toml +- Save and the board must auto-reload +- Connect to this network and go to [`192.168.4.1`](http://192.168.4.1) diff --git a/boot.py b/boot.py new file mode 100644 index 0000000..083aa41 --- /dev/null +++ b/boot.py @@ -0,0 +1,7 @@ +import storage + +storage.remount( + "/", + readonly=False, + disable_concurrent_write_protection=True, # Change this to False during production +) diff --git a/code.py b/code.py new file mode 100644 index 0000000..8b520d5 --- /dev/null +++ b/code.py @@ -0,0 +1,70 @@ +import microcontroller +import wifi +import socketpool +import asyncio +import os +import json +from adafruit_httpserver.server import HTTPServer +from adafruit_httpserver.request import HTTPRequest +from adafruit_httpserver.response import HTTPResponse +from adafruit_httpserver.methods import HTTPMethod +from adafruit_httpserver.mime_type import MIMEType +from ducky import runScript + + +async def main(): + wifi.radio.start_ap( + ssid=os.getenv("AMORA_SSID"), password=os.getenv("AMORA_PASSWORD") + ) + pool = socketpool.SocketPool(wifi.radio) + server = HTTPServer(pool) + + @server.route("/") + def base(request: HTTPRequest): # pylint: disable=unused-argument + with HTTPResponse(request, content_type=MIMEType.TYPE_HTML) as response: + response.send_file("static/index.html") + + @server.route("/main.css") + def css(request: HTTPRequest): + with HTTPResponse(request, content_type=MIMEType.TYPE_HTML) as response: + response.send_file("static/main.css") + + @server.route("/script.js") + def js(request: HTTPRequest): + with HTTPResponse(request, content_type=MIMEType.TYPE_HTML) as response: + response.send_file("static/script.js") + + @server.route("/api", HTTPMethod.POST) + def api(request: HTTPRequest): + body = json.loads(request.body) + action = body["action"] + with HTTPResponse(request, content_type=MIMEType.TYPE_JSON) as response: + if action == "list": + response.send(json.dumps(os.listdir("payloads"))) + elif action == "load": + with open("payloads/" + body["filename"]) as h: + response.send(json.dumps({"contents": h.read()})) + elif action == "store": + with open(f"payloads/" + body["filename"], "wb") as h: + h.write(body["contents"].encode()) + elif action == "delete": + os.remove("payloads/" + body["filename"]) + elif action == "create": + with open(f"payloads/" + body["filename"], "wb") as h: + h.write(b"") + elif action == "run": + runScript(f"payloads/" + body["filename"]) + + server.start(str(wifi.radio.ipv4_address_ap)) + while True: + try: + server.poll() + except OSError as error: + print(error) + + +if __name__ == "__main__": + try: + asyncio.run(main()) + except NotImplementedError: + microcontroller.reset() diff --git a/ducky.py b/ducky.py new file mode 100644 index 0000000..3c1725a --- /dev/null +++ b/ducky.py @@ -0,0 +1,177 @@ +# License: GPLv3.0 +# copyright (c) 2023 Dave Bailey, Himadri Bhattacharjee +# Authors: Dave Bailey (dbisu, @daveisu); Himadri Bhattacharjee (lavafroth, @lavafroth) + +import usb_hid +from adafruit_hid.keyboard import Keyboard + +# comment out these lines for non_US keyboards +from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS as KeyboardLayout +from adafruit_hid.keycode import Keycode + +# uncomment these lines for non_US keyboards +# replace LANG with appropriate language +# from keyboard_layout_win_LANG import KeyboardLayout +# from keycode_win_LANG import Keycode + +import time +from board import LED +import asyncio + +kbd = Keyboard(usb_hid.devices) +layout = KeyboardLayout(kbd) + +defaultDelay = 0 + +duckyCommands = { + "WINDOWS": Keycode.WINDOWS, + "GUI": Keycode.GUI, + "APP": Keycode.APPLICATION, + "MENU": Keycode.APPLICATION, + "SHIFT": Keycode.SHIFT, + "ALT": Keycode.ALT, + "CONTROL": Keycode.CONTROL, + "CTRL": Keycode.CONTROL, + "DOWNARROW": Keycode.DOWN_ARROW, + "DOWN": Keycode.DOWN_ARROW, + "LEFTARROW": Keycode.LEFT_ARROW, + "LEFT": Keycode.LEFT_ARROW, + "RIGHTARROW": Keycode.RIGHT_ARROW, + "RIGHT": Keycode.RIGHT_ARROW, + "UPARROW": Keycode.UP_ARROW, + "UP": Keycode.UP_ARROW, + "BREAK": Keycode.PAUSE, + "PAUSE": Keycode.PAUSE, + "CAPSLOCK": Keycode.CAPS_LOCK, + "DELETE": Keycode.DELETE, + "END": Keycode.END, + "ESC": Keycode.ESCAPE, + "ESCAPE": Keycode.ESCAPE, + "HOME": Keycode.HOME, + "INSERT": Keycode.INSERT, + "NUMLOCK": Keycode.KEYPAD_NUMLOCK, + "PAGEUP": Keycode.PAGE_UP, + "PAGEDOWN": Keycode.PAGE_DOWN, + "PRINTSCREEN": Keycode.PRINT_SCREEN, + "ENTER": Keycode.ENTER, + "SCROLLLOCK": Keycode.SCROLL_LOCK, + "SPACE": Keycode.SPACE, + "TAB": Keycode.TAB, + "BACKSPACE": Keycode.BACKSPACE, + "A": Keycode.A, + "B": Keycode.B, + "C": Keycode.C, + "D": Keycode.D, + "E": Keycode.E, + "F": Keycode.F, + "G": Keycode.G, + "H": Keycode.H, + "I": Keycode.I, + "J": Keycode.J, + "K": Keycode.K, + "L": Keycode.L, + "M": Keycode.M, + "N": Keycode.N, + "O": Keycode.O, + "P": Keycode.P, + "Q": Keycode.Q, + "R": Keycode.R, + "S": Keycode.S, + "T": Keycode.T, + "U": Keycode.U, + "V": Keycode.V, + "W": Keycode.W, + "X": Keycode.X, + "Y": Keycode.Y, + "Z": Keycode.Z, + "F1": Keycode.F1, + "F2": Keycode.F2, + "F3": Keycode.F3, + "F4": Keycode.F4, + "F5": Keycode.F5, + "F6": Keycode.F6, + "F7": Keycode.F7, + "F8": Keycode.F8, + "F9": Keycode.F9, + "F10": Keycode.F10, + "F11": Keycode.F11, + "F12": Keycode.F12, +} + + +def convertLine(line): + newline = [] + # loop on each key - the filter removes empty values + for key in filter(None, line.split(" ")): + key = key.upper() + # find the keycode for the command in the list + command_keycode = duckyCommands.get(key, None) + if command_keycode is not None: + # if it exists in the list, use it + newline.append(command_keycode) + elif hasattr(Keycode, key): + # if it's in the Keycode module, use it (allows any valid keycode) + newline.append(getattr(Keycode, key)) + else: + # if it's not a known key name, show the error for diagnosis + print(f"Unknown key: <{key}>") + # print(newline) + return newline + + +def runScriptLine(line): + if ( + parse_line_header(["REM"], line, lambda _: _) + or parse_line_header(["DELAY"], line, lambda x: time.sleep(float(x) / 1000)) + or parse_line_header(["PRINT"], line, lambda x: print("[log]: " + x)) + or parse_line_header(["IMPORT"], line, runScript) + or parse_line_header(["DEFAULT_DELAY", "DEFAULTDELAY"], line, set_delay) + or parse_line_header(["LED"], line, invert_led) + or parse_line_header(["STRING"], line, layout.write) + ): + return + + for k in convertLine(line): + kbd.press(k) + kbd.release_all() + + +def parse_line_header(headers, line, func): + for header in headers: + if line.startswith(header): + func(line[len(header) + 1 :]) + return True + return False + + +def set_delay(delay): + global defaultDelay + defaultDelay = int(delay) * 10 + + +def invert_led(*args): + led.value ^= True + + +def runScript(duckyScriptPath: str): + global defaultDelay + + try: + with open(duckyScriptPath, "r", encoding="utf-8") as handle: + contents = handle.read() + except OSError as e: + print(f"Unable to open file {duckyScriptPath}: {e}") + return + + previous_line = None + for line in map(lambda x: x.rstrip(), filter(None, contents.splitlines())): + if line[0:6] == "REPEAT": + if not previous_line: + continue + for _ in range(int(line[7:])): + # repeat the last command + runScriptLine(previous_line) + else: + runScriptLine(line) + previous_line = line + time.sleep(float(defaultDelay) / 1000) diff --git a/lib/adafruit_hid/__init__.mpy b/lib/adafruit_hid/__init__.mpy new file mode 100644 index 0000000..8244b8c Binary files /dev/null and b/lib/adafruit_hid/__init__.mpy differ diff --git a/lib/adafruit_hid/consumer_control.mpy b/lib/adafruit_hid/consumer_control.mpy new file mode 100644 index 0000000..02cb9dc Binary files /dev/null and b/lib/adafruit_hid/consumer_control.mpy differ diff --git a/lib/adafruit_hid/consumer_control_code.mpy b/lib/adafruit_hid/consumer_control_code.mpy new file mode 100644 index 0000000..618edca Binary files /dev/null and b/lib/adafruit_hid/consumer_control_code.mpy differ diff --git a/lib/adafruit_hid/keyboard.mpy b/lib/adafruit_hid/keyboard.mpy new file mode 100644 index 0000000..1bc8e5d Binary files /dev/null and b/lib/adafruit_hid/keyboard.mpy differ diff --git a/lib/adafruit_hid/keyboard_layout_base.mpy b/lib/adafruit_hid/keyboard_layout_base.mpy new file mode 100644 index 0000000..7d759cf Binary files /dev/null and b/lib/adafruit_hid/keyboard_layout_base.mpy differ diff --git a/lib/adafruit_hid/keyboard_layout_us.mpy b/lib/adafruit_hid/keyboard_layout_us.mpy new file mode 100644 index 0000000..7b3398c Binary files /dev/null and b/lib/adafruit_hid/keyboard_layout_us.mpy differ diff --git a/lib/adafruit_hid/keycode.mpy b/lib/adafruit_hid/keycode.mpy new file mode 100644 index 0000000..8a5c631 Binary files /dev/null and b/lib/adafruit_hid/keycode.mpy differ diff --git a/lib/adafruit_hid/mouse.mpy b/lib/adafruit_hid/mouse.mpy new file mode 100644 index 0000000..9e09cc3 Binary files /dev/null and b/lib/adafruit_hid/mouse.mpy differ diff --git a/lib/adafruit_httpserver/__init__.mpy b/lib/adafruit_httpserver/__init__.mpy new file mode 100644 index 0000000..381c277 Binary files /dev/null and b/lib/adafruit_httpserver/__init__.mpy differ diff --git a/lib/adafruit_httpserver/headers.mpy b/lib/adafruit_httpserver/headers.mpy new file mode 100644 index 0000000..1e1681e Binary files /dev/null and b/lib/adafruit_httpserver/headers.mpy differ diff --git a/lib/adafruit_httpserver/methods.mpy b/lib/adafruit_httpserver/methods.mpy new file mode 100644 index 0000000..2cde619 Binary files /dev/null and b/lib/adafruit_httpserver/methods.mpy differ diff --git a/lib/adafruit_httpserver/mime_type.mpy b/lib/adafruit_httpserver/mime_type.mpy new file mode 100644 index 0000000..4264449 Binary files /dev/null and b/lib/adafruit_httpserver/mime_type.mpy differ diff --git a/lib/adafruit_httpserver/request.mpy b/lib/adafruit_httpserver/request.mpy new file mode 100644 index 0000000..46ebd25 Binary files /dev/null and b/lib/adafruit_httpserver/request.mpy differ diff --git a/lib/adafruit_httpserver/response.mpy b/lib/adafruit_httpserver/response.mpy new file mode 100644 index 0000000..29c45ec Binary files /dev/null and b/lib/adafruit_httpserver/response.mpy differ diff --git a/lib/adafruit_httpserver/route.mpy b/lib/adafruit_httpserver/route.mpy new file mode 100644 index 0000000..9eb6da8 Binary files /dev/null and b/lib/adafruit_httpserver/route.mpy differ diff --git a/lib/adafruit_httpserver/server.mpy b/lib/adafruit_httpserver/server.mpy new file mode 100644 index 0000000..4c22a97 Binary files /dev/null and b/lib/adafruit_httpserver/server.mpy differ diff --git a/lib/adafruit_httpserver/status.mpy b/lib/adafruit_httpserver/status.mpy new file mode 100644 index 0000000..0dc04dd Binary files /dev/null and b/lib/adafruit_httpserver/status.mpy differ diff --git a/lib/adafruit_ticks.mpy b/lib/adafruit_ticks.mpy new file mode 100644 index 0000000..75c902d Binary files /dev/null and b/lib/adafruit_ticks.mpy differ diff --git a/lib/asyncio/__init__.mpy b/lib/asyncio/__init__.mpy new file mode 100644 index 0000000..8d44bd4 Binary files /dev/null and b/lib/asyncio/__init__.mpy differ diff --git a/lib/asyncio/core.mpy b/lib/asyncio/core.mpy new file mode 100644 index 0000000..abdac29 Binary files /dev/null and b/lib/asyncio/core.mpy differ diff --git a/lib/asyncio/event.mpy b/lib/asyncio/event.mpy new file mode 100644 index 0000000..4095742 Binary files /dev/null and b/lib/asyncio/event.mpy differ diff --git a/lib/asyncio/funcs.mpy b/lib/asyncio/funcs.mpy new file mode 100644 index 0000000..6eb377e Binary files /dev/null and b/lib/asyncio/funcs.mpy differ diff --git a/lib/asyncio/lock.mpy b/lib/asyncio/lock.mpy new file mode 100644 index 0000000..4f3ca5f Binary files /dev/null and b/lib/asyncio/lock.mpy differ diff --git a/lib/asyncio/manifest.mpy b/lib/asyncio/manifest.mpy new file mode 100644 index 0000000..87a224e Binary files /dev/null and b/lib/asyncio/manifest.mpy differ diff --git a/lib/asyncio/stream.mpy b/lib/asyncio/stream.mpy new file mode 100644 index 0000000..89767c1 Binary files /dev/null and b/lib/asyncio/stream.mpy differ diff --git a/lib/asyncio/task.mpy b/lib/asyncio/task.mpy new file mode 100644 index 0000000..2464c85 Binary files /dev/null and b/lib/asyncio/task.mpy differ diff --git a/payloads/boot.py b/payloads/boot.py new file mode 100644 index 0000000..8cde2b5 --- /dev/null +++ b/payloads/boot.py @@ -0,0 +1 @@ +print(1+1) diff --git a/settings.toml b/settings.toml new file mode 100644 index 0000000..000065c --- /dev/null +++ b/settings.toml @@ -0,0 +1,2 @@ +AMORA_SSID="amora" +AMORA_PASSWORD="pwnpiamora" \ No newline at end of file diff --git a/static/index.html b/static/index.html new file mode 100644 index 0000000..511c15e --- /dev/null +++ b/static/index.html @@ -0,0 +1,31 @@ + + + + + + + + + amora + + + +
+
+
+ +
+ + +
+
+ + + + + + diff --git a/static/main.css b/static/main.css new file mode 100644 index 0000000..040c811 --- /dev/null +++ b/static/main.css @@ -0,0 +1,125 @@ +* { + padding: 0; + margin: 0; + font-family:Consolas,Monaco,Lucida Console,Liberation Mono,DejaVu Sans Mono,Bitstream Vera Sans Mono,Courier New, monospace; + font-weight: 100; + color: #fff; + +} + +body { + background: #222; + height: 100vh; +} + +.container { + height: calc(70vh); + display: flex; + flex-direction: row; +} + +.sidebar { + background-color: #222; + display: flex; + flex-direction: column; + border-right: #444 solid 0.1rem; +} + +.sidebar > div { + background-size: 1rem; + background-repeat: no-repeat; + background-position: center; + padding: 1rem; +} + +.footer { + height: calc(30vh - 2rem); + background: #000; + padding: 1rem; +} + +.files { + background: #111; + display: flex; + flex-direction: column; + width: 30vh; + overflow: scroll; +} + +.entry { + display: inline-flex; + gap: 0.5rem; + padding: 1rem; +} + +.run { + background: url('data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIwIDAgMjQgMjQiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHBhdGggZD0iTTUgNC45ODk1MUM1IDQuMDE4MzUgNSAzLjUzMjc3IDUuMjAyNDkgMy4yNjUxQzUuMzc4ODkgMy4wMzE5MSA1LjY0ODUyIDIuODg3NjEgNS45NDA0IDIuODcwMThDNi4yNzU0NCAyLjg1MDE3IDYuNjc5NDYgMy4xMTk1MyA3LjQ4NzUyIDMuNjU4MjNMMTguMDAzMSAxMC42Njg2QzE4LjY3MDggMTEuMTEzNyAxOS4wMDQ2IDExLjMzNjMgMTkuMTIwOSAxMS42MTY4QzE5LjIyMjcgMTEuODYyMSAxOS4yMjI3IDEyLjEzNzcgMTkuMTIwOSAxMi4zODNDMTkuMDA0NiAxMi42NjM1IDE4LjY3MDggMTIuODg2IDE4LjAwMzEgMTMuMzMxMkw3LjQ4NzUyIDIwLjM0MTVDNi42Nzk0NiAyMC44ODAyIDYuMjc1NDQgMjEuMTQ5NiA1Ljk0MDQgMjEuMTI5NkM1LjY0ODUyIDIxLjExMjIgNS4zNzg4OSAyMC45Njc5IDUuMjAyNDkgMjAuNzM0N0M1IDIwLjQ2NyA1IDE5Ljk4MTQgNSAxOS4wMTAzVjQuOTg5NTFaIiBzdHJva2U9IiNmZmYiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIi8+PC9zdmc+Cg=='); +} + +.documents { + background: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZD0iTTIgNC43NUMyIDMuNzg0IDIuNzg0IDMgMy43NSAzaDQuOTcxYy41OCAwIDEuMTIuMjg2IDEuNDQ3Ljc2NWwxLjQwNCAyLjA2M2MuMDQ2LjA2OS4xMjQuMTEuMjA3LjExaDguNDcxYy45NjYgMCAxLjc1Ljc4MyAxLjc1IDEuNzVWMTkuMjVBMS43NSAxLjc1IDAgMCAxIDIwLjI1IDIxSDMuNzVBMS43NSAxLjc1IDAgMCAxIDIgMTkuMjVabTEuNzUtLjI1YS4yNS4yNSAwIDAgMC0uMjUuMjV2MTQuNWMwIC4xMzguMTEyLjI1LjI1LjI1aDE2LjVhLjI1LjI1IDAgMCAwIC4yNS0uMjVWNy42ODdhLjI1LjI1IDAgMCAwLS4yNS0uMjVoLTguNDcxYTEuNzUgMS43NSAwIDAgMS0xLjQ0Ny0uNzY1TDguOTI4IDQuNjFhLjI1Mi4yNTIgMCAwIDAtLjIwOC0uMTFaIiBzdHJva2U9IiNmZmYiIHN0cm9rZS13aWR0aD0iMS41IiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiPjwvcGF0aD48L3N2Zz4K'); +} + + +.delete { + background: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZD0iTTkuMDM2IDcuOTc2YS43NS43NSAwIDAgMC0xLjA2IDEuMDZMMTAuOTM5IDEybC0yLjk2MyAyLjk2M2EuNzUuNzUgMCAxIDAgMS4wNiAxLjA2TDEyIDEzLjA2bDIuOTYzIDIuOTY0YS43NS43NSAwIDAgMCAxLjA2MS0xLjA2TDEzLjA2MSAxMmwyLjk2My0yLjk2NGEuNzUuNzUgMCAxIDAtMS4wNi0xLjA2TDEyIDEwLjkzOSA5LjAzNiA3Ljk3NloiIGZpbGw9IiNmZmYiPjwvcGF0aD48cGF0aCBkPSJNMTIgMWM2LjA3NSAwIDExIDQuOTI1IDExIDExcy00LjkyNSAxMS0xMSAxMVMxIDE4LjA3NSAxIDEyIDUuOTI1IDEgMTIgMVpNMi41IDEyYTkuNSA5LjUgMCAwIDAgOS41IDkuNSA5LjUgOS41IDAgMCAwIDkuNS05LjVBOS41IDkuNSAwIDAgMCAxMiAyLjUgOS41IDkuNSAwIDAgMCAyLjUgMTJaIiBmaWxsPSIjZmZmIj48L3BhdGg+PC9zdmc+Cg=='); + margin: 0.15rem 0 0 0; +} + +.icon { + min-width: 1rem; + min-height: 1rem; +} + +.add { + background: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMCAyMCI+PHBhdGggZD0iTTExLjc1IDQuNWEuNzUuNzUgMCAwIDEgLjc1Ljc1VjExaDUuNzVhLjc1Ljc1IDAgMCAxIDAgMS41SDEyLjV2NS43NWEuNzUuNzUgMCAwIDEtMS41IDBWMTIuNUg1LjI1YS43NS43NSAwIDAgMSAwLTEuNUgxMVY1LjI1YS43NS43NSAwIDAgMSAuNzUtLjc1WiIgZmlsbD0iI2ZmZiI+PC9wYXRoPjwvc3ZnPgo='); +} + + .editorarea { + display: flex; + flex-direction: column; + width: 100%; +} + +.editorarea > .title { + padding: 0.5rem 1rem; + color: #888; + background: #222; + outline: none; + border: none; + border-bottom: #444 solid 0.1rem; +} + +.editor { + background: #222; + border: none; + min-width: max-content; + height: calc(70vh - 3rem); + padding: 0.5rem; +} + +.hide { + width: 0; + transition: width 0.5s 0.25s; +} + +.show { + width: 30vw; + transition: width 0.5s; +} + +.show > div { + transition: opacity 250ms 500ms, visibility 250ms 500ms; + visibility: visible; + opacity: 1; +} + +.hide > div { + transition: opacity 250ms, visibility 250ms; + visibility: hidden; + opacity: 0; +} + +.editor:focus { + outline: none; +} \ No newline at end of file diff --git a/static/script.js b/static/script.js new file mode 100644 index 0000000..784793b --- /dev/null +++ b/static/script.js @@ -0,0 +1,91 @@ +function g(html) { + const template = document.createElement('template'); + template.innerHTML = html.trim(); + return template.content.children[0]; +} + +const waitTime = 500 +const files = document.querySelector(".files") +const editor = document.querySelector('.editor') +const documents_icon = document.querySelector('.documents') +const run_icon = document.querySelector('.run') +const add_icon = document.querySelector('.add') +const title = document.querySelector('.editorarea > .title') +let timer + +function doApi(message) { + return fetch('/api', { + method: 'POST', + headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, + body: JSON.stringify(message) + }) +} +editor.addEventListener('keyup', (_) => { + clearTimeout(timer); + timer = setTimeout(() => { + if (title.value != '') { + doApi({ 'action': 'store', 'filename': title.value, 'contents': editor.value }) + } + }, waitTime); +}); + +function reload_listing() { + doApi({ 'action': 'list' }).then(r => r.json()).then(b => { + files.innerHTML = '' + b.map(filename => { + var text = g(`
${filename}
`) + text.addEventListener('click', () => { + doApi({ 'action': 'load', 'filename': filename }).then(r => r.json()).then(b => { + editor.value = b["contents"] + title.value = filename + title.readOnly = true + }) + }) + var delete_button = g(`
`) + delete_button.addEventListener('click', () => { + doApi({ 'action': 'delete', 'filename': filename }) + editor.value = '' + title.value = '' + title.readOnly = false + }) + var entry = g(`
`) + entry.appendChild(text) + entry.appendChild(delete_button) + files.appendChild(entry) + }) + }) +} + +title.addEventListener('keypress', (e) => { + if (e.keyCode==13) { + title.readOnly = true + doApi({"action": "create", "filename": title.value}) + } +}) + +add_icon.addEventListener('click', () => { + editor.value = '' + title.value = '' + title.readOnly = false + title.focus() +}) + +documents_icon.addEventListener('click', () => { + const classList = files.classList + if (classList.contains("show")) { + files.classList.replace('show', 'hide') + } else if (classList.contains("hide")) { + files.classList.replace('hide', 'show') + } else { + files.classList.add('hide') + } +}); + +run_icon.addEventListener('click', () => { + if (title.value != "") { + doApi({"action": "run", "filename": title.value}) + } +}) + +reload_listing() +setInterval(reload_listing, 2000) \ No newline at end of file