commit dd50e4f95dc26757cbdc058141a6b1bde0c7f6b8 Author: Jenga Phoenix Date: Wed May 22 00:56:16 2019 -0500 Init diff --git a/COPYING.txt b/COPYING.txt new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/COPYING.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..5a7ed0a --- /dev/null +++ b/README.txt @@ -0,0 +1,37 @@ +=============================================================================== +DISTRIBUTE-COIN Seize the tokens ♥ +=============================================================================== + +distribute-coin's a privacy-focused image-uploading and URL-shortening +service. It doesn't have bells and whistles like accounts or cookies, +JS or tracking… which you might consider good things. +I think they're awful. + +Probably the one bell it has is that it's backed up by IPFS. Whenever you +upload a file, it's 'added' to IPFS and pinned to the gateway. Then, a +shortened URL (containing the file-name you chose/came with the file) is +created that redirects to the actual IPFS URL. + + +---------------------------------------- +USAGE +---------------------------------------- +Just use `quicklisp` (pop this in your "~/quicklisp/local-projects/", +and you're good). +There is one thing that isn't in quicklisp that this needs, though: + * ipfs-gno (https://git.eunichx.us/ipfs-gno.git) + +Once you've loaded :distribute-coin into your REPL, just run: + (distribute-coin:server) + +You might wanna look at the docstrings for more information, esp. +on usage of #'server. + + +---------------------------------------- +BORING STUFF +---------------------------------------- +License is AGPLv3-- check COPYING.txt. +Author is Jaidyn Ann +Permanent instance over at https://coinsh.red +Sauce is at https://git.eunichx.us/distribute-coin.git diff --git a/distribute-coin.asd b/distribute-coin.asd new file mode 100755 index 0000000..5147b4c --- /dev/null +++ b/distribute-coin.asd @@ -0,0 +1,15 @@ +(defsystem "distribute-coin" + :version "0.1" + :author "Jaidyn Ann " + :license "Cooperative Software License" + :depends-on ("hunchentoot" "translate" "html-template" "ipfs-gno") + :components ((:module "src" + :components + ((:file "package") + (:file "util") + (:file "sanitize") + (:file "handle-requests") + (:file "main")))) + + :description + "An IPFS-backed file-uploading & URL-shortening website.") diff --git a/res/css/style.css b/res/css/style.css new file mode 100644 index 0000000..437d06f --- /dev/null +++ b/res/css/style.css @@ -0,0 +1,105 @@ +body +{ + background-color: #FAE3E3; + + margin: 0 0 0 0; + + font-style: sans; + font-family: 'ConnectionRegular'; + font-weight: normal; + + text-align: center; +} + +footer +{ + background-color: #F7D4BC; + position: fixed; + left: 0; + bottom: 0; + padding-top: 5px; + width: 100%; +} + +img +{ + width: 280px; +} + +main +{ + padding-top: 20px; + padding-bottom: 20px; +} + +.menu h2 a +{ + color: #000000; + text-decoration: none; +} + + + + +.basic-text +{ + width: 300px; +} + + + +.menu +{ + background-color: #C98BB9; + + width: 100%; + margin: 0; + padding-bottom: 5px; +} + +.menu h1, .menu h2, .menu h3 +{ + margin: 0; + background-color: #CFA5B4; +} + +.menu ul +{ + overflow:hidden + +} + +.menu li +{ + width: 25%; + display: block; + float: left; +} + +.top-menu li +{ + font-size: 20px; + width: 50%; +} + +#duck +{ + margin-left: 10px; + margin-top: 10px; + width: 25px; +} + +article +{ + max-width: 800px; + text-align: justify; + text-indent: 15px; + margin: auto; +} + +article h1,h2 +{ + text-align: center; +} + + diff --git a/res/html/coin/beam.php b/res/html/coin/beam.php new file mode 100644 index 0000000..afaf937 --- /dev/null +++ b/res/html/coin/beam.php @@ -0,0 +1,17 @@ +
" + method="post" enctype="multipart/form-data"> +

+ +

+ +

+ +

+ + + " name="submit"> +
diff --git a/res/html/coin/celebrate.php b/res/html/coin/celebrate.php new file mode 100644 index 0000000..dd20bb3 --- /dev/null +++ b/res/html/coin/celebrate.php @@ -0,0 +1,8 @@ +

Thanks for feeding me; it'll be in safe hands

+ +

Your coin's ">over here

+ +

+ +

It's meta-stuff (or lack thereof) is + ">here

diff --git a/res/html/coin/death-1.html b/res/html/coin/death-1.html new file mode 100644 index 0000000..627b00b --- /dev/null +++ b/res/html/coin/death-1.html @@ -0,0 +1,2 @@ +

You didn't upload anything, dope.

+

Try again.

diff --git a/res/html/coin/death-2.html b/res/html/coin/death-2.html new file mode 100644 index 0000000..3896b9d --- /dev/null +++ b/res/html/coin/death-2.html @@ -0,0 +1 @@ +

Er, that coin already exists— try a different file-name.

diff --git a/res/html/coin/death.html b/res/html/coin/death.html new file mode 100644 index 0000000..60a385f --- /dev/null +++ b/res/html/coin/death.html @@ -0,0 +1,2 @@ +

What the hell just happened? :o

+

I dunno, but maybe you should give it another go?

diff --git a/res/html/coin_index.html b/res/html/coin_index.html new file mode 100644 index 0000000..28702b8 --- /dev/null +++ b/res/html/coin_index.html @@ -0,0 +1,21 @@ +
+

+ +

+ +

+ +

+ + + +
+ A big & yellow coin lying before a coin-slot + diff --git a/res/html/foot.html b/res/html/foot.html new file mode 100644 index 0000000..13617a3 --- /dev/null +++ b/res/html/foot.html @@ -0,0 +1,22 @@ + + + + + + diff --git a/res/html/head.html b/res/html/head.html new file mode 100644 index 0000000..5a38da4 --- /dev/null +++ b/res/html/head.html @@ -0,0 +1,35 @@ + + + + + + + + + + + + + +<!-- TMPL_VAR site-name --> + + + + diff --git a/res/html/i-index.html b/res/html/i-index.html new file mode 100644 index 0000000..dbf6175 --- /dev/null +++ b/res/html/i-index.html @@ -0,0 +1,6 @@ +

Info

+ + + + + diff --git a/res/html/i-privacy.html b/res/html/i-privacy.html new file mode 100644 index 0000000..1ce6581 --- /dev/null +++ b/res/html/i-privacy.html @@ -0,0 +1,62 @@ +
+
+

Privacy Policy

+

No data based on visits are recorded, period. No logs are stored, no IP + addresses are recorded, and no-one can be tied to any specific file-upload. +

+ +

The only data saved is what you explicitly provide: +

    +
  • Metadata embedded in the file
  • +
  • The file-name you provide
  • +
  • The optional “Source” text
  • +
+

+ +No cookies are used, except for the “LANG” cookie, which is only +created when you manually change the language from the default as detected. +You'll be warned when that happens, ofc. +
+ +
+ +
+

Privacy Tips

+

To keep safe on coinsh.red (and, y'know, the web in general), try some of +this:

+
    +
  • Use Tor + and Tor Browser +
      +
    • coinsh.red has a Tor hidden service you + can use + + here +
    • +
    +
  • +
  • Run LiGNUx, instead of + Windows or + + OSX +
  • +
  • Scrape metadata from files you upload whenever possible +
      +
    • Including here. PNG and JPG files are + automatically scraped, but you'll need to + manually take care of other filetypes +
    • +
    +
  • +
+ +

That's really just some bare-bones stuff.

+

You should probably check out the Raddle Wiki + Basic Security + (Onion) + guide for some more in-depth stuff. +

+
+
+ diff --git a/res/html/i-tos.html b/res/html/i-tos.html new file mode 100644 index 0000000..7f9df5f --- /dev/null +++ b/res/html/i-tos.html @@ -0,0 +1,25 @@ +
+

The “Terms”

+ +

Basically anything you upload is fair game.

+ +

If I get a letter from authorities or what have you (DMCA, etc.), though, + there's a good chance I'll remove the alias to your file, and unpin it + from my IPFS gateway. +

+ +

You might wanna check out the privacy policy page, + while you're at it. +

+ + +
+ + diff --git a/res/html/i-what.html b/res/html/i-what.html new file mode 100644 index 0000000..253bf06 --- /dev/null +++ b/res/html/i-what.html @@ -0,0 +1,29 @@ +
+
+

Er, what is this?

+ +

Another generic, privacy-centered file-host.

+

Well, except that this one is backed by IPFS, +the Interplanetary File System-- so your files are permanent and distributed! +Whenever you upload a file, you get an alias (AKA, shortened URL) that redirects +to the file on IPFS.

+ +
+ +
+ +
+

And the software?

+

coinsh.red runs on what I call + distribute-coin, + a libre/copyleft web service (licensed under the GNU AGPLv3) + written in Common Lisp. It's the successor to + insert-coin, which + just suckeddd. +

+
+
+ + + + diff --git a/res/html/mask/celebrate.php b/res/html/mask/celebrate.php new file mode 100644 index 0000000..ca7b90f --- /dev/null +++ b/res/html/mask/celebrate.php @@ -0,0 +1,6 @@ +

Thanks for feeding me; it'll be in safe hands

+ +

Your 's + ">over here

+ +

diff --git a/res/html/mask/create.php b/res/html/mask/create.php new file mode 100644 index 0000000..135106c --- /dev/null +++ b/res/html/mask/create.php @@ -0,0 +1,15 @@ +
" + method="post" enctype="multipart/form-data"> +

+ +

+ +

+ +

+ + " name="submit"> +
diff --git a/res/html/mask/death-1.html b/res/html/mask/death-1.html new file mode 100644 index 0000000..a811af5 --- /dev/null +++ b/res/html/mask/death-1.html @@ -0,0 +1,2 @@ +

You didn't type in anything...

+

Come on, you can do better than that. :s

diff --git a/res/html/mask/death-2.php b/res/html/mask/death-2.php new file mode 100644 index 0000000..c7db159 --- /dev/null +++ b/res/html/mask/death-2.php @@ -0,0 +1,2 @@ +

Er, that + already exists, try a different alias.

diff --git a/res/html/mask/death-3.html b/res/html/mask/death-3.html new file mode 100644 index 0000000..1eb3891 --- /dev/null +++ b/res/html/mask/death-3.html @@ -0,0 +1,2 @@ +

Now, mate, that wasn't an actual URL.

+

You had one job!...

diff --git a/res/html/mask/death.html b/res/html/mask/death.html new file mode 100644 index 0000000..60a385f --- /dev/null +++ b/res/html/mask/death.html @@ -0,0 +1,2 @@ +

What the hell just happened? :o

+

I dunno, but maybe you should give it another go?

diff --git a/res/html/menu.php b/res/html/menu.php new file mode 100644 index 0000000..960af55 --- /dev/null +++ b/res/html/menu.php @@ -0,0 +1,15 @@ + diff --git a/res/html/nav.html b/res/html/nav.html new file mode 100644 index 0000000..97473c1 --- /dev/null +++ b/res/html/nav.html @@ -0,0 +1,17 @@ + + + diff --git a/res/html/p-already-exists.html b/res/html/p-already-exists.html new file mode 100644 index 0000000..dda661f --- /dev/null +++ b/res/html/p-already-exists.html @@ -0,0 +1,4 @@ +

Er, a file with that name already exists— try a different name.

+ + + diff --git a/res/html/p-index.html b/res/html/p-index.html new file mode 100644 index 0000000..fb09755 --- /dev/null +++ b/res/html/p-index.html @@ -0,0 +1,15 @@ +
+

+ +

+ + + +
+ A big & yellow coin lying before a coin-slot + diff --git a/res/html/p-no-data.html b/res/html/p-no-data.html new file mode 100644 index 0000000..6f10dd6 --- /dev/null +++ b/res/html/p-no-data.html @@ -0,0 +1,5 @@ +

404

+

Either that doesn't exist, or I couldn't manage to conjure it + into existence.

+

Try again.

+ diff --git a/res/html/p-success.html b/res/html/p-success.html new file mode 100644 index 0000000..f810d34 --- /dev/null +++ b/res/html/p-success.html @@ -0,0 +1,13 @@ +

Your coin's + over here.

+ +

u/

+ +

u/

+ + +
/ipfs/
+
https://ipfs.io/ipfs/
+ + + diff --git a/res/html/u-already-exists.html b/res/html/u-already-exists.html new file mode 100644 index 0000000..a5a855b --- /dev/null +++ b/res/html/u-already-exists.html @@ -0,0 +1,5 @@ +

409

+

Er, that mask already exists-- try a different alias.

+ + + diff --git a/res/html/u-index.html b/res/html/u-index.html new file mode 100644 index 0000000..d7a3aac --- /dev/null +++ b/res/html/u-index.html @@ -0,0 +1,17 @@ +
+

+ +

+ +

+ +

+ + +
+ A big, funny mask with a stupid mustache and glasses. diff --git a/res/html/u-no-data.html b/res/html/u-no-data.html new file mode 100644 index 0000000..cb535d7 --- /dev/null +++ b/res/html/u-no-data.html @@ -0,0 +1,5 @@ +

404

+

No such URL or alias!

+

Come on, you can do better than that. :s

+ + diff --git a/res/html/u-success.html b/res/html/u-success.html new file mode 100644 index 0000000..2f4cc4a --- /dev/null +++ b/res/html/u-success.html @@ -0,0 +1,12 @@ +

Your mask is + over here.

+ +

+

+

u/

+ + +

u/

+ + + diff --git a/res/img/coin-big.png b/res/img/coin-big.png new file mode 100644 index 0000000..006c4c1 Binary files /dev/null and b/res/img/coin-big.png differ diff --git a/res/img/coin.png b/res/img/coin.png new file mode 100644 index 0000000..5b2f325 Binary files /dev/null and b/res/img/coin.png differ diff --git a/res/img/coin_die-big.png b/res/img/coin_die-big.png new file mode 100644 index 0000000..3352b14 Binary files /dev/null and b/res/img/coin_die-big.png differ diff --git a/res/img/coin_die.png b/res/img/coin_die.png new file mode 100644 index 0000000..6a55ea9 Binary files /dev/null and b/res/img/coin_die.png differ diff --git a/res/img/coin_win-big.png b/res/img/coin_win-big.png new file mode 100644 index 0000000..0c7f0d1 Binary files /dev/null and b/res/img/coin_win-big.png differ diff --git a/res/img/coin_win.png b/res/img/coin_win.png new file mode 100644 index 0000000..1a11112 Binary files /dev/null and b/res/img/coin_win.png differ diff --git a/res/img/logo.png b/res/img/logo.png new file mode 100644 index 0000000..da15960 Binary files /dev/null and b/res/img/logo.png differ diff --git a/res/img/mask-big.png b/res/img/mask-big.png new file mode 100644 index 0000000..321ec4d Binary files /dev/null and b/res/img/mask-big.png differ diff --git a/res/img/mask.png b/res/img/mask.png new file mode 100644 index 0000000..c7cd373 Binary files /dev/null and b/res/img/mask.png differ diff --git a/res/img/mask_die-big.png b/res/img/mask_die-big.png new file mode 100644 index 0000000..358aaa2 Binary files /dev/null and b/res/img/mask_die-big.png differ diff --git a/res/img/mask_die.png b/res/img/mask_die.png new file mode 100644 index 0000000..3aa355e Binary files /dev/null and b/res/img/mask_die.png differ diff --git a/res/img/mask_win-big.png b/res/img/mask_win-big.png new file mode 100644 index 0000000..4543532 Binary files /dev/null and b/res/img/mask_win-big.png differ diff --git a/res/img/mask_win.png b/res/img/mask_win.png new file mode 100644 index 0000000..ca8bd5c Binary files /dev/null and b/res/img/mask_win.png differ diff --git a/res/img/nohup.out b/res/img/nohup.out new file mode 100644 index 0000000..eddd992 --- /dev/null +++ b/res/img/nohup.out @@ -0,0 +1,68 @@ + +(firefox:1809): Gtk-WARNING **: 12:54:17.007: Theme parsing error: gtk-keys.css:12:4: Failed to parse binding set. + +(firefox:1809): Gtk-WARNING **: 12:54:17.007: Theme parsing error: gtk-keys.css:12:4: Expected semicolon + +(firefox:1809): Gtk-WARNING **: 12:54:17.009: Theme parsing error: gtk-keys.css:14:4: Failed to parse binding set. + +(firefox:1809): Gtk-WARNING **: 12:54:17.010: Theme parsing error: gtk-keys.css:14:4: Expected semicolon + +(firefox:1809): Gtk-WARNING **: 12:54:17.012: Theme parsing error: gtk-keys.css:16:4: Failed to parse binding set. + +(firefox:1809): Gtk-WARNING **: 12:54:17.013: Theme parsing error: gtk-keys.css:16:4: Expected semicolon + +(firefox:1809): Gtk-WARNING **: 12:54:17.014: Theme parsing error: gtk-keys.css:18:4: Failed to parse binding set. + +(firefox:1809): Gtk-WARNING **: 12:54:17.016: Theme parsing error: gtk-keys.css:18:4: Expected semicolon + +(firefox:1809): Gtk-WARNING **: 12:54:17.017: Theme parsing error: gtk-keys.css:20:4: Failed to parse binding set. + +(firefox:1809): Gtk-WARNING **: 12:54:17.019: Theme parsing error: gtk-keys.css:20:4: Expected semicolon + +(firefox:1809): Gtk-WARNING **: 12:54:17.020: Theme parsing error: gtk-keys.css:26:4: Failed to parse binding set. + +(firefox:1809): Gtk-WARNING **: 12:54:17.022: Theme parsing error: gtk-keys.css:26:4: Expected semicolon + +(firefox:1809): Gtk-WARNING **: 12:54:17.023: Theme parsing error: gtk-keys.css:28:4: Failed to parse binding set. + +(firefox:1809): Gtk-WARNING **: 12:54:17.025: Theme parsing error: gtk-keys.css:28:4: Expected semicolon + +(firefox:1809): Gtk-WARNING **: 12:54:17.027: Theme parsing error: gtk-keys.css:33:18: The 'gtk-key-bindings' property has been renamed to '-gtk-key-bindings' + +(firefox:1809): Gtk-WARNING **: 12:54:17.028: Theme parsing error: gtk-keys.css:37:18: The 'gtk-key-bindings' property has been renamed to '-gtk-key-bindings' + +(firefox:1809): Gtk-WARNING **: 12:54:17.029: Theme parsing error: gtk-keys.css:41:18: The 'gtk-key-bindings' property has been renamed to '-gtk-key-bindings' + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.347: Theme parsing error: gtk-keys.css:12:4: Failed to parse binding set. + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.349: Theme parsing error: gtk-keys.css:12:4: Expected semicolon + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.350: Theme parsing error: gtk-keys.css:14:4: Failed to parse binding set. + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.351: Theme parsing error: gtk-keys.css:14:4: Expected semicolon + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.353: Theme parsing error: gtk-keys.css:16:4: Failed to parse binding set. + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.354: Theme parsing error: gtk-keys.css:16:4: Expected semicolon + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.356: Theme parsing error: gtk-keys.css:18:4: Failed to parse binding set. + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.357: Theme parsing error: gtk-keys.css:18:4: Expected semicolon + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.359: Theme parsing error: gtk-keys.css:20:4: Failed to parse binding set. + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.360: Theme parsing error: gtk-keys.css:20:4: Expected semicolon + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.361: Theme parsing error: gtk-keys.css:26:4: Failed to parse binding set. + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.363: Theme parsing error: gtk-keys.css:26:4: Expected semicolon + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.364: Theme parsing error: gtk-keys.css:28:4: Failed to parse binding set. + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.366: Theme parsing error: gtk-keys.css:28:4: Expected semicolon + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.367: Theme parsing error: gtk-keys.css:33:18: The 'gtk-key-bindings' property has been renamed to '-gtk-key-bindings' + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.369: Theme parsing error: gtk-keys.css:37:18: The 'gtk-key-bindings' property has been renamed to '-gtk-key-bindings' + +(/usr/local/lib/firefox/firefox:16947): Gtk-WARNING **: 17:54:18.370: Theme parsing error: gtk-keys.css:41:18: The 'gtk-key-bindings' property has been renamed to '-gtk-key-bindings' diff --git a/res/img/war_duck.png b/res/img/war_duck.png new file mode 100644 index 0000000..4057531 Binary files /dev/null and b/res/img/war_duck.png differ diff --git a/src/handle-requests.lisp b/src/handle-requests.lisp new file mode 100644 index 0000000..7842ddc --- /dev/null +++ b/src/handle-requests.lisp @@ -0,0 +1,67 @@ +(in-package :distribute-coin) + +;; ------------------------------------- +;; handler-creation + +(defmacro create-regex-dispatcher (regex page-function) + "Just like tbnl:create-regex-dispatcher except it passes the entire + uri split into a list by slashes. + I.E., '/d/b/123/4' would pass arguments 'd', 'b', '123', and '4'. + Based on: + http://uint32t.blogspot.com/2007/12/restful-handlers-with-hunchentoot.html" + `(push (let ((scanner (cl-ppcre:create-scanner ,regex))) + (lambda (request) + (multiple-value-bind (whole-match matched-registers) + (cl-ppcre:scan-to-strings scanner (tbnl:script-name request)) + (when whole-match + (lambda () + (apply ,page-function + (cdr (cl-ppcre:split "/" (tbnl:script-name request))))))))) + hunchentoot:*dispatch-table*)) + + +;; ------------------------------------- + +;; LIST-OF-PATHS (LIST) → STRING +(defun template (templates &optional (env '())) + "Return the output of several (or one) templates as a simple string." +;; (if env (setq env (concatenate 'list env *default-env*)) +;; (setq env *default-env*)) + (let ((output (make-string-output-stream)) + (new-env (concatenate 'list env *default-env*))) + (mapcar (lambda (template) + (html-template:fill-and-print-template + template new-env + :stream output)) + templates) + (get-output-stream-string output))) + +;; ------------------------------------- + +;; STRING (STRING) → STRING +(defun template-request (prefix &optional file (env '())) + "Returns the templated-version of a given request. + When given, for example, 'i' and 'what', it returns the template- + processed version of 'res/html/i-what.html', merged with the + 'head.html' and 'foot.html' templates." + (when (not file) (setq file "index")) + + (let* ((template (pathname (string+ prefix "-" file ".html"))) + (template-path (string+ *html-dir* template)) + (new-env (concatenate + 'list env `(:site-name ,*site-name* + :hostname ,*hostname* + ,(if *onion-hostname* :onion-hostname) + ,(if *onion-hostname* *onion-hostname*) + :ipfs-hostname ,*ipfs-hostname*)))) + + (cond ((uiop:file-exists-p template-path) + (template (list #p"head.html" template #p"foot.html") new-env)) + ('T + (template (list #p"head.html" template #p"foot.html") new-env))))) + + +;; STRING STRING → NIL +(defmacro standard-file-request (prefix file) + "Return a simple, static file to the client." + `(hunchentoot:handle-static-file (string+ ,prefix ,file))) diff --git a/src/main.lisp b/src/main.lisp new file mode 100644 index 0000000..54086b0 --- /dev/null +++ b/src/main.lisp @@ -0,0 +1,183 @@ +(in-package :distribute-coin) + +;; ------------------------------------- +;; globals + +(defparameter *img-dir* #p"res/img/") +(defparameter *html-dir* #p"res/html/") +(defparameter *css-dir* #p"res/css/") +(defparameter *upload-dir* #p"p/") +(defparameter *alias-dir* #p"u/") +(defparameter *default-env* '(:depth "/")) +(defparameter *hostname* nil) +(defparameter *protocol* nil) +(defparameter *ipfs-hostname* nil) +(defparameter *onion-hostname* nil) +(defparameter *site-name* "distribute-coin ☭") + + +(defun root-request (&rest ignored) + (template-request "p" "index")) + +;; ------------------------------------- +;; file-upload/download etc + +;; STRING {STRING} → STRING +(defun p-request (p &optional file) + "Handle a /p/* request appropriately." + (if file + (file-request p file) + (template-request p))) + + +;; STRING STRING → STRING/VARYING +(defun file-request (p GET-filename) + "Handle a /p/ file-request-- I.E., either return a pre-existing uploaded + file, or upload and create a new file. Or return an error. W/e." + (let* ((upload-pair (hunchentoot:post-parameter "file")) + (pair-filename (name-sanitize (ignore-errors (second upload-pair)))) + (POST-filename (name-sanitize + (hunchentoot:post-parameter "filename"))) + (filename (choose-new-file-name pair-filename POST-filename + (name-sanitize GET-filename))) + (hash nil) + (env `(:filename ,filename))) + + (cond + ((and upload-pair (alias-exists-p filename)) + (setf (hunchentoot:return-code*) hunchentoot:+http-conflict+) + (template-request "p" "already-exists" env)) + (upload-pair + (setq hash (file-upload (car upload-pair) filename)) + (setq new-env (concatenate 'list `(:hash ,hash) env)) + (template-request "p" "success" new-env)) + ((alias-exists-p filename) + (alias-execute filename)) + ('T + (setf (hunchentoot:return-code*) hunchentoot:+http-not-found+) + (template-request "p" "no-data"))))) + + +(defun file-upload (temp-location file-name) + (let ((hash (ipfs-gno:add temp-location))) + (alias-create file-name (ipfs-uri hash)) + hash)) + +(defun ipfs-uri (hash) + (string+ *ipfs-hostname* "/ipfs/" hash)) + +(defun ipns-uri (hash) + (string+ *ipfs-hostname* "/ipns/" hash)) + +;; ------------------------------------- +;; url alias/shortening + +;; STRING {STRING} → STRING +(defun u-request (u &optional alias) + "Handle a /u/* request appropriately." + (if alias + (alias-request u alias) + (template-request u))) + +;; STRING STRING → STRING +(defun alias-request (u GET-alias-name) + "Handle a /u/ alias-request. I.E., either redirect to another URL-- as per + the alias, or create a new redirect/alias. Or error… tiel la mondo iras." + (let* ((POST-alias-name (name-sanitize + (hunchentoot:post-parameter "alias-name"))) + (alias-name (if (zerop (length POST-alias-name)) + (name-sanitize GET-alias-name) POST-alias-name)) + (POST-target (uri-sanitize (hunchentoot:post-parameter "target"))) + (env `(:alias-name ,alias-name :target ,POST-target))) + + (cond + ((and alias-name POST-target (alias-exists-p alias-name)) + (setf (hunchentoot:return-code*) hunchentoot:+http-conflict+) + (template-request "u" "already-exists" env)) + ((and alias-name POST-target) + (alias-create alias-name POST-target) + (template-request "u" "success" env)) + ((alias-exists-p alias-name) + (alias-execute alias-name)) + ('T + (setf (hunchentoot:return-code*) hunchentoot:+http-not-found+) + (template-request "u" "no-data"))))) + + +;; STRING → NIL +(defun alias-execute (alias) + "Actually 'execute' a given alias; I.E., redirect the client to the URL + written in the pathname respective to the given alias-name." + (hunchentoot:redirect (uiop:read-file-line (alias-pathname alias)))) + +;; STRING STRING → NIL +(defun alias-create (alias target) + "Create an alias to a given URL." + (with-open-file (alias-file (alias-pathname alias) :direction :output + :if-does-not-exist :create) + (format alias-file target))) + +;; STRING → BOOLEAN +(defun alias-exists-p (alias) + "Return whether or not an alias of the given name exists." + (uiop:file-exists-p (alias-pathname alias))) + +;; STRING → PATHNAME +(defun alias-pathname (alias) + "Return the pathname an alias of the given name would use." + (pathname (string+ *alias-dir* "/" alias))) + + +;; ------------------------------------- + +;; STRING STRING → VARYING +(defun res-css-request (r css) + "Serve a CSS resource file." + (standard-file-request *css-dir* css)) + +;; STRING STRING → VARYING +(defun res-img-request (r image) + "Serve a resource image." + (standard-file-request *img-dir* image)) + + +;; ------------------------------------- + + +;; :NUMBER :PATHNAME :PATHNAME :PATHNAME :PATHNAME → ACCEPTOR +(defun server (&key (hostname nil) + (onion-hostname nil) + (ipfs-hostname nil) + (ipfs-api nil) + (port 80) (upload-dir #p"p/") (alias-dir #p"u/") + (html-dir #p"res/html/") (css-dir #p"res/css/") + (img-dir #p"res/img/") (site-name "distribute-coin ☭")) + "Start the `insert-coin` server. :upload-dir, :html-dir, + and css-dir must contain relative paths to their + respective directories. The :upload-dir must be + writable to the server; the rest must only be + readable." + (setq html-template:*default-template-pathname* html-dir) + (setf *html-dir* html-dir) + (setf *img-dir* img-dir) + (setf *css-dir* css-dir) + + (setf *site-name* site-name) + + (setf *hostname* (or hostname (string+ "http://127.0.0.1:" port))) + (setf *onion-hostname* onion-hostname) + (setf *ipfs-hostname* (or ipfs-hostname "http://127.0.0.1:8080")) + (setf ipfs-gno:*api-host* (or ipfs-api "http://127.0.0.1:5001")) + + (setf *alias-dir* alias-dir) + (setf *upload-dir* upload-dir) + (setf *alias-dir* alias-dir) + + (create-regex-dispatcher "/i/.*" #'template-request) + (create-regex-dispatcher "/r/.*\.png" #'res-img-request) + (create-regex-dispatcher "/r/.*\.css" #'res-css-request) + (create-regex-dispatcher "/p/.*" #'p-request) + (create-regex-dispatcher "/u/.*" #'u-request) + (create-regex-dispatcher "^/$" #'root-request) + + (hunchentoot:start (make-instance 'hunchentoot:easy-acceptor :port port))) diff --git a/src/package.lisp b/src/package.lisp new file mode 100644 index 0000000..9597f85 --- /dev/null +++ b/src/package.lisp @@ -0,0 +1,7 @@ +(defpackage :distribute-coin + (:use :cl) + (:export + :server + :template)) + +(in-package :distribute-coin) diff --git a/src/sanitize.lisp b/src/sanitize.lisp new file mode 100644 index 0000000..28fc16c --- /dev/null +++ b/src/sanitize.lisp @@ -0,0 +1,28 @@ +(in-package :distribute-coin) + +(defun valid-name-p (string) + (not (cl-ppcre:scan "^null$" string))) + +(defun name-sanitize (string) + (if (valid-name-p string) + (replace-all string + '("\.html" "\.html\.txt") + '("\\!" "_") '("\\?" "_") + '("\\" "_") '("/" "_") + '("\\~" "_") '("\\*" "_") + '("\\$" "_") '("\&" "_") + '("\\=" "_") '("\\+" "_") + '("{" "_") '("}" "_") + '("\\[" "_") '("\\]" "_") + '("\\(" "_") '("\\)" "_") + '("<" "_") '(">" "_") + '(" " "_")))) + +(defun valid-uri-p (string) + (not (zerop (length string)))) + +(defun uri-sanitize (string) + (if (valid-uri-p string) + (if (not (cl-ppcre:scan "://" string)) + (string+ "https://" string) + string))) diff --git a/src/util.lisp b/src/util.lisp new file mode 100644 index 0000000..e2f36ac --- /dev/null +++ b/src/util.lisp @@ -0,0 +1,52 @@ +(in-package :distribute-coin) + +;; STRING → BOOLEAN +(defun onion-url (url) + "Return whether or not a given URL is for an onion site." + (cl-ppcre:scan "\.onion" url)) + + +;; STRING PATTERN-PAIR … PATTERN-PAIR → STRING +(defun replace-all (string &rest replace-pairs) + "Apply several sets of regex replacements to a string, + with each replacement in the form of a 'replacement-pair': + '(TARGET REPLACEMENT) + I.E., to replace 'a', you'd use + '('a' 'replacement-of-a')" + + (mapcar (lambda (pair) + (setq string + (cl-ppcre:regex-replace-all + (first pair) string (second pair)))) + replace-pairs) + string) + + +;; STRING → STRING +(defun file-type (filename) + "Return the file extension of a given filename." + (setq type-string (cl-ppcre:regex-replace-all ".*\\." filename "\.")) + (if (or (zerop (length type-string)) + (not (cl-ppcre:scan "\\." filename))) + nil + type-string)) + + +(defun choose-new-file-name (original new-a new-b) + (setq new-name + (cond ((or (and (zerop (length new-a)) (zerop (length new-b))) + (and (not new-a) (not new-b))) + original) + ((zerop (length new-a)) + new-b) + ('T new-a))) + (if (equal new-name "nil") (setq new-name original)) + (if (not (file-type new-name)) + (string+ new-name (file-type original)) + new-name)) + + +;; STRING-A STRING-B … STRING-N → STRING +(defun string+ (&rest strings) + "Combine an arbitrary amount of strings into a single string." + (reduce (lambda (a b) (format nil "~A~A" a b)) strings))