diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 0000000..46ff6af --- /dev/null +++ b/COPYING.md @@ -0,0 +1,675 @@ +# GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . \ No newline at end of file diff --git a/Gemfile b/Gemfile index 71f5b3b..8077a1e 100644 --- a/Gemfile +++ b/Gemfile @@ -1,3 +1,16 @@ +=begin +Copyright (C) 2024 Hexaitos +This file is part of "Predator Pics" + +Predator Pics 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. + +Predator Pics 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 Foobar. If not, see . + +Contact: me@bateleur.org, me@hexaitos.com. +=end + source 'https://rubygems.org' gem 'json' diff --git a/README.md b/README.md new file mode 100644 index 0000000..2826d6f --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Predator Pics (birds.bateleur.org) +Predator Pics is a website that uses the API of Wikimedia Common to display a random image of a bird of prey. There is a Mastodon / Fediverse bot called “Bot of Prey” that uses the API of this website as its backend. + +## How it works +1. The program choses a random category from the `categories.txt` file located in this repository +2. It then sends an API request to receive a list of all (<= 500) photos located within that category on Wikimedia Commons +3. It then chooses one of the photos it received at random, saves important metadata (like author, license and description) and displays it on the webpage + +## How to run and install it +If you wish to run your own instance of Predator Pics, you must have Ruby installed (tested on Ruby 3.2.2); you‘ll also need the `bundler` gem that you can install by running `gem install bundler` after having installed Ruby. It is generally recommended to __not__ install Ruby through your distributions package manager – rather, install Ruby through a Ruby version manager like `rbenv` (https://rbenv.org). + +Then clone this repository and install the required gems by running `bundle install` from your terminal within the cloned repository. Afterwards, start the server by running `ruby server.rb`. The server (usually `thin`) will then start in `production` mode and serve the website on `localhost:4567`. + +## Reverse proxy +If you wish to make Predator Pics accessible via the Internet, you‘ll want to use a reverse proxy. My preferred method of doing that is by using Caddy. First, install Caddy and then remove everything located in the `/etc/caddy/Caddyfile` file and paste the following into it, replacing `example.com` with your actual domain name: + +``` +example.com { + encode zstd gzip + + reverse_proxy :4567 +} +``` \ No newline at end of file diff --git a/get_images_by_category.rb b/get_images_by_category.rb index 94af7ae..9591e38 100644 --- a/get_images_by_category.rb +++ b/get_images_by_category.rb @@ -1,5 +1,19 @@ +=begin +Copyright (C) 2024 Hexaitos +This file is part of "Predator Pics" + +Predator Pics 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. + +Predator Pics 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 Foobar. If not, see . + +Contact: me@bateleur.org, me@hexaitos.com. +=end + def get_images_by_category(categories) random_category = categories.sample + if random_category.include?("https://commons.wikimedia.org/wiki/Category:") then random_category = random_category.gsub("https://commons.wikimedia.org/wiki/Category:", "") elsif random_category.include?("Category:") then @@ -11,34 +25,30 @@ def get_images_by_category(categories) photos = [] conn = Faraday.new(url: 'https://commons.wikimedia.org/w/api.php') do |faraday| - faraday.adapter Faraday.default_adapter # Use the default adapter (Net::HTTP) + faraday.adapter Faraday.default_adapter end - # Define the parameters for the request params = { action: 'query', list: 'categorymembers', - cmtitle: "Category:#{random_category}", # Specify the category title + cmtitle: "Category:#{random_category}", cmlimit: 500, cmtype: 'file', - format: 'json' # Request response in JSON format + format: 'json' } - # Send the GET request response = conn.get do |req| req.params = params end - # Parse the response as JSON data = JSON.parse(response.body) - - # Handle and print the response - if data['query'] && data['query']['categorymembers'] + + begin category_members = data['query']['categorymembers'] category_members.each do |member| - photos << member['title'] + photos << member['title'] end - else + rescue puts "No data found or error in API request" end diff --git a/get_random_image.rb b/get_random_image.rb index e085db6..a259d04 100644 --- a/get_random_image.rb +++ b/get_random_image.rb @@ -1,17 +1,30 @@ +=begin +Copyright (C) 2024 Hexaitos +This file is part of "Predator Pics" + +Predator Pics 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. + +Predator Pics 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 Foobar. If not, see . + +Contact: me@bateleur.org, me@hexaitos.com. +=end + def get_random_image(photos) random_photo = photos.sample conn = Faraday.new(url: 'https://commons.wikimedia.org/w/api.php') do |faraday| - faraday.adapter Faraday.default_adapter # Use the default adapter (Net::HTTP) + faraday.adapter Faraday.default_adapter end params = { action: 'query', prop: 'imageinfo', - titles: "#{random_photo}", # Specify the category title + titles: "#{random_photo}", iiprop: 'url|user|extmetadata', iiurlwidth: 1000, - format: 'json' # Request response in JSON format + format: 'json' } response = conn.get do |req| diff --git a/public/css/styles.css b/public/css/styles.css index 835e4b0..3f7f05c 100755 --- a/public/css/styles.css +++ b/public/css/styles.css @@ -1 +1,468 @@ -@font-face{font-family:"Merriweather";font-style:normal;font-weight:400;src:url("/assets/fonts/merriweather-v21-latin-regular.eot");src:local("Merriweather Regular"),local("Merriweather-Regular"),url("/assets/fonts/merriweather-v21-latin-regular.eot?#iefix") format("embedded-opentype"),url("/assets/fonts/merriweather-v21-latin-regular.woff2") format("woff2"),url("/assets/fonts/merriweather-v21-latin-regular.woff") format("woff"),url("/assets/fonts/merriweather-v21-latin-regular.ttf") format("truetype"),url("/assets/fonts/merriweather-v21-latin-regular.svg#Merriweather") format("svg");font-display:swap}@font-face{font-family:"Merriweather";font-style:italic;font-weight:400;src:url("/assets/fonts/merriweather-v21-latin-italic.eot");src:local("Merriweather Italic"),local("Merriweather-Italic"),url("/assets/fonts/merriweather-v21-latin-italic.eot?#iefix") format("embedded-opentype"),url("/assets/fonts/merriweather-v21-latin-italic.woff2") format("woff2"),url("/assets/fonts/merriweather-v21-latin-italic.woff") format("woff"),url("/assets/fonts/merriweather-v21-latin-italic.ttf") format("truetype"),url("/assets/fonts/merriweather-v21-latin-italic.svg#Merriweather") format("svg");font-display:swap}@font-face{font-family:"Merriweather Sans";font-style:normal;font-weight:400;src:url("/assets/fonts/merriweather-sans-v13-latin-regular.eot");src:local(""),url("/assets/fonts/merriweather-sans-v13-latin-regular.eot?#iefix") format("embedded-opentype"),url("/assets/fonts/merriweather-sans-v13-latin-regular.woff2") format("woff2"),url("/assets/fonts/merriweather-sans-v13-latin-regular.woff") format("woff"),url("/assets/fonts/merriweather-sans-v13-latin-regular.ttf") format("truetype"),url("/assets/fonts/merriweather-sans-v13-latin-regular.svg#MerriweatherSans") format("svg");font-display:swap}@font-face{font-family:"Merriweather Sans";font-style:italic;font-weight:400;src:url("/assets/fonts/merriweather-sans-v13-latin-italic.eot");src:local(""),url("/assets/fonts/merriweather-sans-v13-latin-italic.eot?#iefix") format("embedded-opentype"),url("/assets/fonts/merriweather-sans-v13-latin-italic.woff2") format("woff2"),url("/assets/fonts/merriweather-sans-v13-latin-italic.woff") format("woff"),url("/assets/fonts/merriweather-sans-v13-latin-italic.ttf") format("truetype"),url("/assets/fonts/merriweather-sans-v13-latin-italic.svg#MerriweatherSans") format("svg");font-display:swap}:root{--body-bg: #9f9287;--main-bg: #cdcac4;--menu-bg: #2b2623;--foot-bg: #2b2623;--btn-col: #dba047;--btn-hov: #ae4e26}*{font-family:Merriweather,Merriweather Sans}q{quotes:"“" "”" "‘" "’";font-family:Merriweather}q::before{content:open-quote}q::after{content:close-quote}body{margin-left:10%;margin-right:10%;padding:10px;background-color:var(--body-bg)}.main h1,h2,h3{font-variant:small-caps;padding:.3em .3em}.main h1{border-top:5px double #a72f14;border-bottom:5px double #a72f14;text-align:center}.main h2{border-bottom:5px solid #a72f14}.main p{font-size:16px;text-align:justify}.main img{max-width:100%}div.pfp{padding:.5em}div.main{background-color:var(--main-bg);padding:2em;border-radius:10px;min-height:500px}.pfp img{border:5px double #a72f14;border-radius:10px;max-width:150px;display:block;margin-left:auto;margin-right:auto}.pfp p{text-align:center;font-style:italic;font-size:12px}div.menu{background:var(--menu-bg);padding:.5em;margin-bottom:2em;overflow:hidden;text-align:center;border-radius:10px;min-height:3em;height:auto}.menu p{color:#fff;text-decoration:none;padding:.5em .5em;margin-left:.5em;text-align:right;border-radius:10px}.menu a{color:#fff;text-decoration:none;padding:.8em .8em;margin-right:1em;margin-left:1em;min-width:100px;text-align:center;background-color:var(--btn-col);display:inline-block;font-size:medium;border-radius:10px;margin-bottom:.5em;margin-top:.5em}.menu a:hover,.contact a:hover,a.webring-btn:hover{background-color:var(--btn-hov)}.main a{color:#ae4e26}.main a:hover{text-decoration:none}div.contact{text-align:center}.contact a{color:#fff;text-decoration:none;padding:.8em .8em;text-align:center;background-color:var(--btn-col);display:grid;font-size:medium;border-radius:10px;margin-bottom:1em}a.webring-btn{color:#fff;text-decoration:none;padding:.5em .5em;margin-right:.5em;margin-left:.5em;min-width:75px;text-align:center;background-color:var(--btn-col);display:inline-block;font-size:medium;border-radius:10px}div.webring{border-top:2px solid var(--btn-hov);border-bottom:2px solid var(--btn-hov);text-align:right;display:flex;align-items:center;height:50px;justify-content:space-between;margin-top:5px}.webring span{float:left;padding:auto 0}footer{background:var(--foot-bg);padding:1em;margin-top:2em;overflow:hidden;text-align:center;height:auto;border-radius:10px;min-height:3em}footer p{color:#fff}footer p:first-of-type{float:left}footer p:last-of-type{float:right}@media only screen and (max-width: 900px){.menu a{font-size:medium;min-width:90px}div.menu{padding:.5em;height:auto}body{margin-left:5%;margin-right:5%}}@media only screen and (max-width: 700px){.menu a{font-size:smaller;min-width:80px;margin-left:.1em;margin-right:.1em}footer p:first-of-type,footer p:last-of-type{float:none}}div.art{display:flex;justify-content:center}div.gallery{border:5px double rgba(167,47,20,.3)}div.gallery:hover{border:5px double #dba047}div.gallery img{width:100%;height:200px;object-fit:scale-down}div.desc{padding:10px;text-align:center}*{box-sizing:border-box}.responsive{padding:0 6px;float:left;width:24.99999%}section.colour-cols{display:flex;flex-direction:column;justify-content:space-around;text-align:center}div[class*=colour-col-]{display:flex;justify-content:center}div[class*=colour-col-]>div{height:75px;width:25%}div[class*=colour-col-][class*="1"] :nth-child(1){background-color:#2b2623}div[class*=colour-col-][class*="1"] :nth-child(2){background-color:#db9f47}div[class*=colour-col-][class*="1"] :nth-child(3){background-color:#ae4e26}div[class*=colour-col-][class*="1"] :nth-child(4){background-color:#a72f14}div[class*=colour-col-][class*="2"] :nth-child(1){background-color:#fff}div[class*=colour-col-][class*="2"] :nth-child(2){background-color:#133042}div[class*=colour-col-][class*="2"] :nth-child(3){background-color:#2b2623}div[class*=colour-col-][class*="3"] :nth-child(1){background-color:#c0b6ad}div[class*=colour-col-][class*="3"] :nth-child(2){background-color:#9f9387}div[class*=colour-col-][class*="3"] :nth-child(3){background-color:#2b2623}div[class*=colour-col-][class*="3"] :nth-child(4){background-color:#894518}div[class*=hex-code-col-]{display:flex;justify-content:center;flex-direction:row;margin-bottom:15px}div[class*=hex-code-col-]>span{width:25%;display:inline;text-align:center;font-family:monospace}span.colour-heading{margin-bottom:5px;font-size:large}img.refsheet{width:100%}@media only screen and (max-width: 700px){.responsive{width:49.99999%;margin:6px 0}div.art{display:inherit;justify-content:inherit}}@media only screen and (max-width: 500px){.responsive{width:100%}div.art{display:inherit;justify-content:inherit}a.webring-btn{min-width:40px;margin-right:.2em;margin-left:.2em}}.clearfix:after{content:"";display:table;clear:both}code{font-family:monospace;background-color:#d3d3d3;border:1px gray}@media(prefers-color-scheme: dark){:root{--body-bg: rgb(49, 49, 49);--main-bg: #191919;--menu-bg: #191919;--foot-bg: #191919;--btn-hov: #dba047;--btn-col: #ae4e26}code{background-color:#a9a9a9}div.gallery{border:5px double #a72f14}.main a{color:#dba047}.contact a,li,span,a.webring-btn,div.desc,p,h1,h2,h3,b{color:#fff}}/*# sourceMappingURL=styles.css.map */ \ No newline at end of file +/* +Copyright (C) 2024 Hexaitos +This file is part of "Predator Pics" + +Predator Pics 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. + +Predator Pics 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 Foobar. If not, see . + +Contact: me@bateleur.org, me@hexaitos.com. +*/ + +@font-face { + font-family: "Merriweather"; + font-style: normal; + font-weight: 400; + src: url("/assets/fonts/merriweather-v21-latin-regular.eot"); + src: local("Merriweather Regular"), local("Merriweather-Regular"), url("/assets/fonts/merriweather-v21-latin-regular.eot?#iefix") format("embedded-opentype"), url("/assets/fonts/merriweather-v21-latin-regular.woff2") format("woff2"), url("/assets/fonts/merriweather-v21-latin-regular.woff") format("woff"), url("/assets/fonts/merriweather-v21-latin-regular.ttf") format("truetype"), url("/assets/fonts/merriweather-v21-latin-regular.svg#Merriweather") format("svg"); + font-display: swap +} + +@font-face { + font-family: "Merriweather"; + font-style: italic; + font-weight: 400; + src: url("/assets/fonts/merriweather-v21-latin-italic.eot"); + src: local("Merriweather Italic"), local("Merriweather-Italic"), url("/assets/fonts/merriweather-v21-latin-italic.eot?#iefix") format("embedded-opentype"), url("/assets/fonts/merriweather-v21-latin-italic.woff2") format("woff2"), url("/assets/fonts/merriweather-v21-latin-italic.woff") format("woff"), url("/assets/fonts/merriweather-v21-latin-italic.ttf") format("truetype"), url("/assets/fonts/merriweather-v21-latin-italic.svg#Merriweather") format("svg"); + font-display: swap +} + +@font-face { + font-family: "Merriweather Sans"; + font-style: normal; + font-weight: 400; + src: url("/assets/fonts/merriweather-sans-v13-latin-regular.eot"); + src: local(""), url("/assets/fonts/merriweather-sans-v13-latin-regular.eot?#iefix") format("embedded-opentype"), url("/assets/fonts/merriweather-sans-v13-latin-regular.woff2") format("woff2"), url("/assets/fonts/merriweather-sans-v13-latin-regular.woff") format("woff"), url("/assets/fonts/merriweather-sans-v13-latin-regular.ttf") format("truetype"), url("/assets/fonts/merriweather-sans-v13-latin-regular.svg#MerriweatherSans") format("svg"); + font-display: swap +} + +@font-face { + font-family: "Merriweather Sans"; + font-style: italic; + font-weight: 400; + src: url("/assets/fonts/merriweather-sans-v13-latin-italic.eot"); + src: local(""), url("/assets/fonts/merriweather-sans-v13-latin-italic.eot?#iefix") format("embedded-opentype"), url("/assets/fonts/merriweather-sans-v13-latin-italic.woff2") format("woff2"), url("/assets/fonts/merriweather-sans-v13-latin-italic.woff") format("woff"), url("/assets/fonts/merriweather-sans-v13-latin-italic.ttf") format("truetype"), url("/assets/fonts/merriweather-sans-v13-latin-italic.svg#MerriweatherSans") format("svg"); + font-display: swap +} + +:root { + --body-bg: #9f9287; + --main-bg: #cdcac4; + --menu-bg: #2b2623; + --foot-bg: #2b2623; + --btn-col: #dba047; + --btn-hov: #ae4e26; +} + +* { + font-family: Merriweather, Merriweather Sans +} + +q { + quotes: "“" "”" "‘" "’"; + font-family: Merriweather +} + +q::before { + content: open-quote +} + +q::after { + content: close-quote +} + +body { + margin-left: 10%; + margin-right: 10%; + padding: 10px; + background-color: var(--body-bg) +} + +.main h1, +h2, +h3 { + font-variant: small-caps; + padding: .3em .3em +} + +.main h1 { + border-top: 5px double #a72f14; + border-bottom: 5px double #a72f14; + text-align: center +} + +.main h2 { + border-bottom: 5px solid #a72f14 +} + +.main p { + font-size: 16px; + text-align: justify +} + +.main img { + max-width: 100% +} + +div.pfp { + padding: .5em +} + +div.main { + background-color: var(--main-bg); + padding: 2em; + border-radius: 10px; + min-height: 500px +} + +.pfp img { + border: 5px double #a72f14; + border-radius: 10px; + max-width: 150px; + display: block; + margin-left: auto; + margin-right: auto +} + +.pfp p { + text-align: center; + font-style: italic; + font-size: 12px +} + +div.menu { + background: var(--menu-bg); + padding: .5em; + margin-bottom: 2em; + overflow: hidden; + text-align: center; + border-radius: 10px; + min-height: 3em; + height: auto +} + +.menu p { + color: #fff; + text-decoration: none; + padding: .5em .5em; + margin-left: .5em; + text-align: right; + border-radius: 10px +} + +.menu a { + color: #fff; + text-decoration: none; + padding: .8em .8em; + margin-right: 1em; + margin-left: 1em; + min-width: 100px; + text-align: center; + background-color: var(--btn-col); + display: inline-block; + font-size: medium; + border-radius: 10px; + margin-bottom: .5em; + margin-top: .5em +} + +.menu a:hover, +.contact a:hover, +a.webring-btn:hover { + background-color: var(--btn-hov); +} + +.main a, footer a { + color: #ae4e26; +} + +.main a:hover, footer a:hover { + text-decoration: none; +} + +div.contact { + text-align: center; +} + +.contact a { + color: #fff; + text-decoration: none; + padding: .8em .8em; + text-align: center; + background-color: var(--btn-col); + display: grid; + font-size: medium; + border-radius: 10px; + margin-bottom: 1em +} + +a.webring-btn { + color: #fff; + text-decoration: none; + padding: .5em .5em; + margin-right: .5em; + margin-left: .5em; + min-width: 75px; + text-align: center; + background-color: var(--btn-col); + display: inline-block; + font-size: medium; + border-radius: 10px +} + +div.webring { + border-top: 2px solid var(--btn-hov); + border-bottom: 2px solid var(--btn-hov); + text-align: right; + display: flex; + align-items: center; + height: 50px; + justify-content: space-between; + margin-top: 5px +} + +.webring span { + float: left; + padding: auto 0 +} + +footer { + background: var(--foot-bg); + padding: 1em; + margin-top: 2em; + overflow: hidden; + text-align: center; + height: auto; + border-radius: 10px; + min-height: 3em +} + +footer p { + color: #fff +} + +footer p:first-of-type { + float: left +} + +footer p:last-of-type { + float: right +} + +@media only screen and (max-width: 900px) { + .menu a { + font-size: medium; + min-width: 90px + } + div.menu { + padding: .5em; + height: auto + } + body { + margin-left: 5%; + margin-right: 5% + } +} + +@media only screen and (max-width: 700px) { + .menu a { + font-size: smaller; + min-width: 80px; + margin-left: .1em; + margin-right: .1em + } + footer p:first-of-type, + footer p:last-of-type { + float: none + } +} + +div.art { + display: flex; + justify-content: center +} + +div.gallery { + border: 5px double rgba(167, 47, 20, .3) +} + +div.gallery:hover { + border: 5px double #dba047 +} + +div.gallery img { + width: 100%; + height: 200px; + object-fit: scale-down +} + +div.desc { + padding: 10px; + text-align: center +} + +* { + box-sizing: border-box +} + +.responsive { + padding: 0 6px; + float: left; + width: 24.99999% +} + +section.colour-cols { + display: flex; + flex-direction: column; + justify-content: space-around; + text-align: center +} + +div[class*=colour-col-] { + display: flex; + justify-content: center +} + +div[class*=colour-col-]>div { + height: 75px; + width: 25% +} + +div[class*=colour-col-][class*="1"] :nth-child(1) { + background-color: #2b2623 +} + +div[class*=colour-col-][class*="1"] :nth-child(2) { + background-color: #db9f47 +} + +div[class*=colour-col-][class*="1"] :nth-child(3) { + background-color: #ae4e26 +} + +div[class*=colour-col-][class*="1"] :nth-child(4) { + background-color: #a72f14 +} + +div[class*=colour-col-][class*="2"] :nth-child(1) { + background-color: #fff +} + +div[class*=colour-col-][class*="2"] :nth-child(2) { + background-color: #133042 +} + +div[class*=colour-col-][class*="2"] :nth-child(3) { + background-color: #2b2623 +} + +div[class*=colour-col-][class*="3"] :nth-child(1) { + background-color: #c0b6ad +} + +div[class*=colour-col-][class*="3"] :nth-child(2) { + background-color: #9f9387 +} + +div[class*=colour-col-][class*="3"] :nth-child(3) { + background-color: #2b2623 +} + +div[class*=colour-col-][class*="3"] :nth-child(4) { + background-color: #894518 +} + +div[class*=hex-code-col-] { + display: flex; + justify-content: center; + flex-direction: row; + margin-bottom: 15px +} + +div[class*=hex-code-col-]>span { + width: 25%; + display: inline; + text-align: center; + font-family: monospace +} + +span.colour-heading { + margin-bottom: 5px; + font-size: large +} + +img.refsheet { + width: 100% +} + +@media only screen and (max-width: 700px) { + .responsive { + width: 49.99999%; + margin: 6px 0 + } + div.art { + display: inherit; + justify-content: inherit + } +} + +@media only screen and (max-width: 500px) { + .responsive { + width: 100% + } + div.art { + display: inherit; + justify-content: inherit + } + a.webring-btn { + min-width: 40px; + margin-right: .2em; + margin-left: .2em + } +} + +.clearfix:after { + content: ""; + display: table; + clear: both +} + +code { + font-family: monospace; + background-color: #d3d3d3; + border: 1px gray +} + +@media(prefers-color-scheme: dark) { + :root { + --body-bg: rgb(49, 49, 49); + --main-bg: #191919; + --menu-bg: #191919; + --foot-bg: #191919; + --btn-hov: #dba047; + --btn-col: #ae4e26; + } + code { + background-color: #a9a9a9 + } + div.gallery { + border: 5px double #a72f14 + } + .main a, footer a { + color: #dba047 + } + .contact a, + li, + span, + a.webring-btn, + div.desc, + p, + h1, + h2, + h3, + b { + color: #fff + } +} \ No newline at end of file diff --git a/public/css/styles.css.map b/public/css/styles.css.map deleted file mode 100644 index 5bbdff2..0000000 --- a/public/css/styles.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"sourceRoot":"","sources":["styles.scss"],"names":[],"mappings":"CACA,WACE,2BACA,kBACA,gBACA,4DACA,2cAMA,kBAIF,WACE,2BACA,kBACA,gBACA,2DACA,ocAMA,kBAIF,WACE,gCACA,kBACA,gBACA,iEACA,sbAMA,kBAIF,WACE,gCACA,kBACA,gBACA,gEACA,ibAMA,kBAGF,MACE,mBACA,mBACA,mBACA,mBACA,mBACA,mBAGF,EACE,2CAGF,EACE,uBACA,yBAGF,UACI,mBAGJ,SACI,oBAGJ,KAGE,gBACA,iBACA,aACA,gCAGF,eACE,wBACA,kBAGF,SACE,8BACA,iCACA,kBAGF,SACE,gCAGF,QACE,eACA,mBAGF,UACE,eAGF,QACE,aAGF,SACE,gCACA,YACA,mBACA,iBAGF,SACE,0BACA,mBACA,gBACA,cACA,iBACA,kBAGF,OACE,kBACA,kBACA,eAGF,SAEE,0BACA,aACA,kBACA,gBACA,kBACA,mBACA,eACA,YAGF,QACE,WACA,qBACA,kBACA,iBACA,iBACA,mBAGF,QACE,WACA,qBACA,kBACA,iBACA,gBACA,gBACA,kBACA,gCACA,qBACA,iBACA,mBACA,mBACA,gBAGF,mDACE,gCAGF,QACE,cAGF,cACE,qBAGF,YACE,kBAGF,WACE,WACA,qBACA,kBACA,kBACA,gCACA,aACA,iBACA,mBACA,kBAOF,cACE,WACA,qBACA,kBACA,kBACA,iBACA,eACA,kBACA,gCACA,qBACA,iBACA,mBAOF,YACE,oCACA,uCACA,iBACA,aACA,mBACA,YACA,8BACA,eAGF,cACE,WACA,eAGF,OAEE,0BACA,YACA,eACA,gBACA,kBACA,YACA,mBACA,eAGF,SACE,WAGF,uBACE,WAGF,sBACE,YAIF,0CACE,QACE,iBACA,eAGF,SACE,aACA,YAGF,KACE,eACA,iBAIJ,0CACE,QACE,kBACA,eACA,iBACA,kBAGF,6CACE,YAMJ,QACE,aACA,uBAGF,YACE,qCAGF,kBACE,0BAGF,gBACE,WACA,aACA,sBAGF,SACE,aACA,kBAGF,EACE,sBAGF,YACE,cACA,WACA,gBAGF,oBACE,aACA,sBACA,6BACA,kBAGF,wBACE,aACA,uBAEA,4BACE,YACA,UAIA,2EACA,2EACA,2EACA,2EAIA,wEACA,2EACA,2EAIA,2EACA,2EACA,2EACA,2EAIJ,0BACE,aACA,uBACA,mBACA,mBAEA,+BACE,UACA,eACA,kBACA,sBAIJ,oBACE,kBACA,gBAGF,aACE,WAGF,0CACE,YACE,gBACA,aAGF,QACE,gBACA,yBAIJ,0CACE,YACE,WAGF,QACE,gBACA,wBAGF,cACE,eACA,kBACA,kBAIJ,gBACE,WACA,cACA,WAGF,KACE,sBACA,yBACA,gBAGF,mCACE,MACE,2BACA,mBACA,mBACA,mBACA,mBACA,mBAGF,KACE,yBAGF,YACE,0BAGF,QACE,cAGF,uDACE","sourcesContent":["/* merriweather-regular - latin */\n@font-face {\n font-family: 'Merriweather';\n font-style: normal;\n font-weight: 400;\n src: url('/assets/fonts/merriweather-v21-latin-regular.eot'); /* IE9 Compat Modes */\n src: local('Merriweather Regular'), local('Merriweather-Regular'),\n url('/assets/fonts/merriweather-v21-latin-regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */\n url('/assets/fonts/merriweather-v21-latin-regular.woff2') format('woff2'), /* Super Modern Browsers */\n url('/assets/fonts/merriweather-v21-latin-regular.woff') format('woff'), /* Modern Browsers */\n url('/assets/fonts/merriweather-v21-latin-regular.ttf') format('truetype'), /* Safari, Android, iOS */\n url('/assets/fonts/merriweather-v21-latin-regular.svg#Merriweather') format('svg'); /* Legacy iOS */\n font-display: swap;\n}\n\n/* merriweather-italic - latin */\n@font-face {\n font-family: 'Merriweather';\n font-style: italic;\n font-weight: 400;\n src: url('/assets/fonts/merriweather-v21-latin-italic.eot'); /* IE9 Compat Modes */\n src: local('Merriweather Italic'), local('Merriweather-Italic'),\n url('/assets/fonts/merriweather-v21-latin-italic.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */\n url('/assets/fonts/merriweather-v21-latin-italic.woff2') format('woff2'), /* Super Modern Browsers */\n url('/assets/fonts/merriweather-v21-latin-italic.woff') format('woff'), /* Modern Browsers */\n url('/assets/fonts/merriweather-v21-latin-italic.ttf') format('truetype'), /* Safari, Android, iOS */\n url('/assets/fonts/merriweather-v21-latin-italic.svg#Merriweather') format('svg'); /* Legacy iOS */\n font-display: swap;\n}\n\n/* merriweather-sans-regular - latin */\n@font-face {\n font-family: 'Merriweather Sans';\n font-style: normal;\n font-weight: 400;\n src: url('/assets/fonts/merriweather-sans-v13-latin-regular.eot'); /* IE9 Compat Modes */\n src: local(''),\n url('/assets/fonts/merriweather-sans-v13-latin-regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */\n url('/assets/fonts/merriweather-sans-v13-latin-regular.woff2') format('woff2'), /* Super Modern Browsers */\n url('/assets/fonts/merriweather-sans-v13-latin-regular.woff') format('woff'), /* Modern Browsers */\n url('/assets/fonts/merriweather-sans-v13-latin-regular.ttf') format('truetype'), /* Safari, Android, iOS */\n url('/assets/fonts/merriweather-sans-v13-latin-regular.svg#MerriweatherSans') format('svg'); /* Legacy iOS */\n font-display: swap;\n}\n\n/* merriweather-sans-italic - latin */\n@font-face {\n font-family: 'Merriweather Sans';\n font-style: italic;\n font-weight: 400;\n src: url('/assets/fonts/merriweather-sans-v13-latin-italic.eot'); /* IE9 Compat Modes */\n src: local(''),\n url('/assets/fonts/merriweather-sans-v13-latin-italic.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */\n url('/assets/fonts/merriweather-sans-v13-latin-italic.woff2') format('woff2'), /* Super Modern Browsers */\n url('/assets/fonts/merriweather-sans-v13-latin-italic.woff') format('woff'), /* Modern Browsers */\n url('/assets/fonts/merriweather-sans-v13-latin-italic.ttf') format('truetype'), /* Safari, Android, iOS */\n url('/assets/fonts/merriweather-sans-v13-latin-italic.svg#MerriweatherSans') format('svg'); /* Legacy iOS */\n font-display: swap;\n}\n\n:root {\n --body-bg: #9f9287;\n --main-bg: #cdcac4; \n --menu-bg: #2b2623;\n --foot-bg: #2b2623; \n --btn-col: #dba047; \n --btn-hov: #ae4e26;\n}\n\n* {\n font-family: Merriweather, Merriweather Sans; \n}\n\nq {\n quotes: \"“\" \"”\" \"‘\" \"’\";\n font-family: Merriweather;\n}\n\nq::before {\n content: open-quote;\n}\n\nq::after {\n content: close-quote;\n}\n\nbody {\n /* border: 2px solid rgba(167, 47, 20, 1); */\n /* border-radius: 25px; */\n margin-left: 10%;\n margin-right: 10%;\n padding: 10px;\n background-color: var(--body-bg);\n}\n\n.main h1, h2, h3 {\n font-variant: small-caps;\n padding: .3em .3em;\n}\n\n.main h1 {\n border-top: 5px double rgba(167, 47, 20, 1);\n border-bottom: 5px double rgba(167, 47, 20, 1);\n text-align: center;\n}\n\n.main h2 {\n border-bottom: 5px solid rgba(167, 47, 20, 1);\n}\n\n.main p {\n font-size: 16px;\n text-align: justify;\n}\n\n.main img {\n max-width: 100%;\n}\n\ndiv.pfp {\n padding: .5em;\n}\n\ndiv.main {\n background-color: var(--main-bg);\n padding: 2em;\n border-radius: 10px;\n min-height: 500px;\n}\n\n.pfp img {\n border: 5px double rgba(167, 47, 20, 1);\n border-radius: 10px;\n max-width: 150px;\n display: block;\n margin-left: auto;\n margin-right: auto;\n}\n\n.pfp p {\n text-align: center;\n font-style: italic;\n font-size: 12px; \n}\n\ndiv.menu {\n /* background: #ae4e26; */\n background: var(--menu-bg); \n padding: .5em;\n margin-bottom: 2em;\n overflow: hidden;\n text-align: center;\n border-radius: 10px;\n min-height: 3em;\n height: auto;\n}\n\n.menu p {\n color: white;\n text-decoration: none;\n padding: .5em .5em; \n margin-left: .5em;\n text-align: right;\n border-radius: 10px;\n}\n\n.menu a {\n color: white;\n text-decoration: none;\n padding: .8em .8em;\n margin-right: 1em;\n margin-left: 1em;\n min-width: 100px;\n text-align: center;\n background-color: var(--btn-col);\n display:inline-block;\n font-size: medium;\n border-radius: 10px;\n margin-bottom: .5em;\n margin-top: .5em;\n}\n\n.menu a:hover, .contact a:hover, a.webring-btn:hover {\n background-color: var(--btn-hov);\n}\n\n.main a {\n color: #ae4e26;\n}\n\n.main a:hover {\n text-decoration: none;\n}\n\ndiv.contact {\n text-align: center;\n}\n\n.contact a {\n color: white;\n text-decoration: none;\n padding: .8em .8em;\n text-align: center;\n background-color: var(--btn-col);\n display:grid;\n font-size: medium;\n border-radius: 10px;\n margin-bottom: 1em;\n}\n\n/*.contact a:last-child {\n min-width: 94%;\n} */\n\na.webring-btn {\n color: white;\n text-decoration: none;\n padding: .5em .5em;\n margin-right: 0.5em;\n margin-left: 0.5em;\n min-width: 75px;\n text-align: center;\n background-color: var(--btn-col);\n display: inline-block;\n font-size: medium;\n border-radius: 10px;\n}\n\ndiv.webring-btn-container {\n \n}\n\ndiv.webring {\n border-top: 2px solid var(--btn-hov);\n border-bottom: 2px solid var(--btn-hov);\n text-align: right;\n display: flex;\n align-items: center;\n height: 50px;\n justify-content: space-between;\n margin-top: 5px;\n}\n\n.webring span {\n float: left;\n padding: auto 0;\n}\n\nfooter {\n /* background: #ae4e26; */\n background: var(--foot-bg); \n padding: 1em;\n margin-top: 2em;\n overflow: hidden;\n text-align: center;\n height: auto;\n border-radius: 10px;\n min-height: 3em;\n}\n\nfooter p {\n color: white;\n}\n\nfooter p:first-of-type {\n float: left;\n}\n\nfooter p:last-of-type {\n float: right;\n}\n\n/* Responsive design stuff */\n@media only screen and (max-width: 900px) {\n .menu a {\n font-size: medium;\n min-width: 90px;\n }\n\n div.menu {\n padding: .5em;\n height: auto;\n }\n\n body {\n margin-left: 5%;\n margin-right: 5%;\n }\n}\n\n@media only screen and (max-width: 700px) {\n .menu a {\n font-size: smaller;\n min-width: 80px;\n margin-left: 0.1em;\n margin-right: 0.1em;\n }\n\n footer p:first-of-type, footer p:last-of-type {\n float: none;\n }\n}\n\n/* CSS gallery from w3schools.com */\n\ndiv.art {\n display: flex;\n justify-content: center;\n}\n\ndiv.gallery {\n border: 5px double rgba(167, 47, 20, 0.3);\n}\n\ndiv.gallery:hover {\n border: 5px double #dba047;\n}\n\ndiv.gallery img {\n width: 100%;\n height: 200px;\n object-fit: scale-down;\n}\n\ndiv.desc {\n padding: 10px;\n text-align: center;\n}\n\n* {\n box-sizing: border-box;\n}\n\n.responsive {\n padding: 0 6px;\n float: left;\n width: 24.99999%;\n}\n\nsection.colour-cols {\n display:flex;\n flex-direction: column;\n justify-content: space-around;\n text-align: center;\n}\n\ndiv[class*=\"colour-col-\"] {\n display: flex;\n justify-content: center;\n\n > div {\n height: 75px;\n width: 25%;\n }\n\n &[class*=\"1\"] {\n :nth-child(1) { background-color: #2b2623; }\n :nth-child(2) { background-color: #db9f47; }\n :nth-child(3) { background-color: #ae4e26; }\n :nth-child(4) { background-color: #a72f14; }\n }\n\n &[class*=\"2\"] {\n :nth-child(1) { background-color: #ffffff; }\n :nth-child(2) { background-color: #133042; }\n :nth-child(3) { background-color: #2b2623; }\n }\n\n &[class*=\"3\"] {\n :nth-child(1) { background-color: #c0b6ad; }\n :nth-child(2) { background-color: #9f9387; }\n :nth-child(3) { background-color: #2b2623; }\n :nth-child(4) { background-color: #894518; }\n }\n}\n\ndiv[class*=\"hex-code-col-\"] {\n display: flex;\n justify-content: center;\n flex-direction: row;\n margin-bottom: 15px;\n\n > span {\n width: 25%;\n display: inline;\n text-align: center;\n font-family: monospace;\n }\n}\n\nspan.colour-heading {\n margin-bottom: 5px;\n font-size: large;\n}\n\nimg.refsheet {\n width: 100%;\n}\n\n@media only screen and (max-width: 700px) {\n .responsive {\n width: 49.99999%;\n margin: 6px 0;\n }\n \n div.art {\n display: inherit;\n justify-content: inherit\n }\n}\n\n@media only screen and (max-width: 500px) {\n .responsive {\n width: 100%;\n }\n\n div.art {\n display: inherit;\n justify-content: inherit\n }\n\n a.webring-btn {\n min-width: 40px;\n margin-right: 0.2em;\n margin-left: 0.2em;\n }\n}\n\n.clearfix:after {\n content: \"\";\n display: table;\n clear: both;\n}\n\ncode {\n font-family: monospace;\n background-color: lightgrey;\n border: 1px grey;\n}\n\n@media (prefers-color-scheme: dark) {\n :root {\n --body-bg: rgb(49, 49, 49);\n --main-bg: #191919; \n --menu-bg: #191919;\n --foot-bg: #191919; \n --btn-hov: #dba047; \n --btn-col: #ae4e26;\n }\n\n code {\n background-color: darkgray;\n }\n\n div.gallery {\n border: 5px double rgba(167, 47, 20, 1);\n }\n\n .main a {\n color: #dba047;\n }\n\n .contact a, li, span, a.webring-btn, div.desc, p, h1, h2, h3, b {\n color: white; \n }\n}"],"file":"styles.css"} \ No newline at end of file diff --git a/server.rb b/server.rb index 258fd6c..4ccaecb 100644 --- a/server.rb +++ b/server.rb @@ -1,3 +1,16 @@ +=begin +Copyright (C) 2024 Hexaitos +This file is part of "Predator Pics" + +Predator Pics 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. + +Predator Pics 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 Foobar. If not, see . + +Contact: me@bateleur.org, me@hexaitos.com. +=end + require 'bundler/setup' require 'json' @@ -16,7 +29,7 @@ categories = File.readlines("categories.txt") # Index get '/' do - image = get_random_image(get_images_by_category(categories)) + puts image = get_random_image(get_images_by_category(categories)) erb :index, locals: { image: image } end @@ -26,6 +39,7 @@ get '/about' do erb :about end +# API information get '/about-api' do erb :api end diff --git a/views/about.erb b/views/about.erb index 53abde1..5390b4c 100644 --- a/views/about.erb +++ b/views/about.erb @@ -1,2 +1,15 @@ + +

About this website

This website is still a work in progress. It randomly selects a photo of a bird of prey from Wikimedia and displays it on the homepage.

\ No newline at end of file diff --git a/views/api.erb b/views/api.erb index 4ed26c2..2dcf83a 100644 --- a/views/api.erb +++ b/views/api.erb @@ -1,3 +1,16 @@ + +

About the API

There is, at the moment, a very rudimentary API available.