commit d8bda8824744045e5647ecece8348c37ddf2793e Author: simon Date: Fri Apr 29 17:48:25 2022 +0700 cleanup to upload diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c60b7ce --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +# personal +.vscode/ + +# secrets +config.json +postgres.env +tubearchivist.env + +# example hooks +docker-hook.json +github-hook.json +roadmap-hook.json diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..21950f8 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Tube Archivist Server +All code for www.tubearchivist.com. + +# Important +Webhook API endpoints aren't verified proberly. Don't publish until that's done. diff --git a/deploy.sh b/deploy.sh new file mode 100755 index 0000000..6319fd5 --- /dev/null +++ b/deploy.sh @@ -0,0 +1,40 @@ +#!/bin/bash +# deploy the tube archivist website + +test_host="tubearchivist-website.local" +public_host="www.tubearchivist.com" + +function rebuild_test { + echo "rebuild testing environment" + rsync -a --progress --delete docker-compose_testing.yml $public_host:docker/docker-compose.yml + rsync -a --progress --delete docker-compose.yml $test_host:docker + rsync -a --progress --delete tubearchivist $test_host:docker + rsync -a --progress --delete env $test_host:docker + + ssh "$test_host" 'docker-compose -f docker/docker-compose.yml up -d --build' +} + +function docker_publish { + echo "publish to production" + + rsync -a --progress --delete docker-compose_production.yml $public_host:docker/docker-compose.yml + rsync -a --progress --delete tubearchivist $public_host:docker + rsync -a --progress --delete env $public_host:docker + + ssh "$public_host" 'docker compose -f docker/docker-compose.yml build tubearchivist' + ssh "$public_host" 'docker compose -f docker/docker-compose.yml up -d' +} + +# check package versions in requirements.txt for updates +python version_check.py + +if [[ $1 == "test" ]]; then + rebuild_test +elif [[ $1 == "docker" ]]; then + docker_publish +else + echo "valid options are: test | docker " +fi + +## +exit 0 diff --git a/docker-compose_production.yml b/docker-compose_production.yml new file mode 100644 index 0000000..e164dde --- /dev/null +++ b/docker-compose_production.yml @@ -0,0 +1,56 @@ +version: '3.3' + +services: + nginx-proxy: + image: nginxproxy/nginx-proxy + container_name: nginx-proxy + ports: + - 80:80 + - 443:443 + volumes: + - ./volume/nginx-proxy/certs:/etc/nginx/certs + - ./volume/nginx-proxy/vhost:/etc/nginx/vhost.d + - ./volume/nginx-proxy/html:/usr/share/nginx/html + - /var/run/docker.sock:/tmp/docker.sock:ro + nginx-proxy-acme: + image: nginxproxy/acme-companion + container_name: nginx-proxy-acme + volumes: + - ./volume/nginx-proxy/certs:/etc/nginx/certs + - ./volume/nginx-proxy/vhost:/etc/nginx/vhost.d + - ./volume/nginx-proxy/html:/usr/share/nginx/html + - ./volume/nginx-proxy/acme:/etc/acme.sh + - /var/run/docker.sock:/var/run/docker.sock:ro + environment: + - NGINX_PROXY_CONTAINER=nginx-proxy + nginx: + build: ./tubearchivist/nginx + container_name: backend_nginx + restart: always + expose: + - "8000" + depends_on: + - tubearchivist + environment: + - VIRTUAL_HOST=tubearchivist.com,www.tubearchivist.com + - LETSENCRYPT_HOST=tubearchivist.com,www.tubearchivist.com + # main flask site + tubearchivist: + container_name: tubearchivist + build: ./tubearchivist/web + restart: always + env_file: + - ./env/tubearchivist.env + expose: + - "8080" + # backend postgres + postgres: + image: postgres:14 + container_name: postgres + restart: always + volumes: + - ./volume/postgres:/var/lib/postgresql/data/ + env_file: + - ./env/postgres.env + expose: + - "5432" diff --git a/docker-compose_testing.yml b/docker-compose_testing.yml new file mode 100644 index 0000000..3c8fd1f --- /dev/null +++ b/docker-compose_testing.yml @@ -0,0 +1,31 @@ +version: '3.3' + +services: + nginx: + build: ./tubearchivist/nginx + container_name: backend_nginx + restart: always + ports: + - "80:80" + depends_on: + - tubearchivist + # main flask site + tubearchivist: + container_name: tubearchivist + build: ./tubearchivist/web + restart: always + env_file: + - ./env/tubearchivist.env + expose: + - "8080" + # backend postgres + postgres: + image: postgres:14 + container_name: postgres + restart: always + volumes: + - ./volume/postgres:/var/lib/postgresql/data/ + env_file: + - ./env/postgres.env + expose: + - "5432" diff --git a/env/postgres.sample.env b/env/postgres.sample.env new file mode 100644 index 0000000..02fb0f3 --- /dev/null +++ b/env/postgres.sample.env @@ -0,0 +1,3 @@ +POSTGRES_USER=archivist +POSTGRES_PASSWORD=******** +POSTGRES_DB=archivist \ No newline at end of file diff --git a/env/tubearchivist.sample.env b/env/tubearchivist.sample.env new file mode 100644 index 0000000..017515e --- /dev/null +++ b/env/tubearchivist.sample.env @@ -0,0 +1,3 @@ +REDDIT_HOOK_URL=https://discordapp.com/api/webhooks/000000000000000000/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +ROADMAP_HOOK_URL=https://discordapp.com/api/webhooks/000000000000000000/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +DOCKER_UNSTABLE_HOOK_URL=https://discordapp.com/api/webhooks/000000000000000000/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa diff --git a/tubearchivist/nginx/Dockerfile b/tubearchivist/nginx/Dockerfile new file mode 100644 index 0000000..e60bd5b --- /dev/null +++ b/tubearchivist/nginx/Dockerfile @@ -0,0 +1,8 @@ +# Use the Nginx image +FROM nginx + +# Remove the default nginx.conf +RUN rm /etc/nginx/conf.d/default.conf + +# Replace with our own nginx.conf +COPY nginx.conf /etc/nginx/conf.d/ diff --git a/tubearchivist/nginx/nginx.conf b/tubearchivist/nginx/nginx.conf new file mode 100644 index 0000000..560e041 --- /dev/null +++ b/tubearchivist/nginx/nginx.conf @@ -0,0 +1,10 @@ +server { + + listen 80; + + location / { + include uwsgi_params; + uwsgi_pass tubearchivist:8080; + } + +} diff --git a/tubearchivist/postgres/indexsetup.sql b/tubearchivist/postgres/indexsetup.sql new file mode 100644 index 0000000..34705e6 --- /dev/null +++ b/tubearchivist/postgres/indexsetup.sql @@ -0,0 +1,24 @@ +-- create ta_docker_stats table +CREATE TABLE ta_docker_stats ( + id SERIAL NOT NULL PRIMARY KEY, + time_stamp INT NOT NULL, + time_stamp_human VARCHAR(20) NOT NULL, + last_updated INT NOT NULL, + last_updated_human VARCHAR(20) NOT NULL, + stars SMALLINT NOT NULL, + pulls INT NOT NULL +); + +-- index for time_stamp where queries +CREATE INDEX docker_time_stamp ON ta_docker_stats (time_stamp DESC); + +-- create release history table +CREATE TABLE ta_release ( + id SERIAL NOT NULL PRIMARY KEY, + time_stamp INT NOT NULL, + time_stamp_human VARCHAR(20) NOT NULL, + release_version VARCHAR(10) NOT NULL, + release_is_latest BOOLEAN NOT NULL, + breaking_changes BOOLEAN NOT NULL, + release_notes TEXT NOT NULL +); diff --git a/tubearchivist/web/Dockerfile b/tubearchivist/web/Dockerfile new file mode 100644 index 0000000..03cb5a3 --- /dev/null +++ b/tubearchivist/web/Dockerfile @@ -0,0 +1,16 @@ +FROM python:3.10.4-slim-bullseye + +RUN apt-get clean && apt-get -y update && \ + apt-get -y install --no-install-recommends \ + python3-dev libpq-dev build-essential \ + vim htop bmon net-tools iputils-ping procps + +COPY requirements.txt /requirements.txt +RUN pip install --no-cache-dir -r /requirements.txt --src /usr/local/src + +COPY . /srv/flask_app +WORKDIR /srv/flask_app + +RUN chmod +x ./start.sh + +CMD ["./start.sh"] diff --git a/tubearchivist/web/config.sample.json b/tubearchivist/web/config.sample.json new file mode 100644 index 0000000..c23b539 --- /dev/null +++ b/tubearchivist/web/config.sample.json @@ -0,0 +1,8 @@ +{ + "postgres": { + "db_host": "postgres", + "db_database": "archivist", + "db_user": "archivist", + "db_password": "********" + } +} \ No newline at end of file diff --git a/tubearchivist/web/requirements.txt b/tubearchivist/web/requirements.txt new file mode 100644 index 0000000..efa29ca --- /dev/null +++ b/tubearchivist/web/requirements.txt @@ -0,0 +1,6 @@ +flask==2.1.2 +ipython==8.2.0 +markdown==3.3.6 +psycopg2==2.9.3 +requests==2.27.1 +uWSGI==2.0.20 diff --git a/tubearchivist/web/src/__init__.py b/tubearchivist/web/src/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tubearchivist/web/src/api_docker.py b/tubearchivist/web/src/api_docker.py new file mode 100644 index 0000000..982d133 --- /dev/null +++ b/tubearchivist/web/src/api_docker.py @@ -0,0 +1,60 @@ +"""hourly docker stats backup""" + + +from datetime import datetime +from src.db import DatabaseConnect + +import requests + + +class DockerBackup: + """handle docker backup and storage""" + + URL = "https://hub.docker.com/v2/repositories/bbilly1/tubearchivist/" + TABLE = "ta_docker_stats" + + def __init__(self): + self.image_stats = False + self.query = False + + def run_backup(self): + """public method to run""" + self._get_image_stats() + self._build_query() + self._insert_line() + + def _get_image_stats(self): + """return dict for image""" + response = requests.get(self.URL).json() + now = datetime.now() + + last_updated = response["last_updated"] + updated = datetime.fromisoformat(last_updated.split(".")[0]) + + image_stats = { + "time_stamp": int(now.strftime("%s")), + "time_stamp_human": now.strftime("%Y-%m-%d %H:%M"), + "last_updated": int(updated.strftime("%s")), + "last_updated_human": updated.strftime("%Y-%m-%d %H:%M"), + "stars": response["star_count"], + "pulls": response["pull_count"] + } + + self.image_stats = image_stats + + def _build_query(self): + """build ingest query for postgres""" + keys = self.image_stats.keys() + values = tuple(self.image_stats.values()) + keys_str = ", ".join(keys) + valid = ", ".join(["%s" for i in keys]) + query = ( + f"INSERT INTO {self.TABLE} ({keys_str}) VALUES ({valid});", values + ) + self.query = query + + def _insert_line(self): + """add line to postgres""" + handler = DatabaseConnect() + handler.db_execute(self.query) + handler.db_close() diff --git a/tubearchivist/web/src/api_reddit.py b/tubearchivist/web/src/api_reddit.py new file mode 100644 index 0000000..dfe941e --- /dev/null +++ b/tubearchivist/web/src/api_reddit.py @@ -0,0 +1,80 @@ +"""monitor reddit for new posts and comments""" + +from os import environ +import requests + + +class MonitorReddit: + """holds reddit connection""" + + headers = {"User-Agent": "r/tubeArchivist discord bot monitor"} + posts = "https://www.reddit.com/r/tubeArchivist/new.json" + comments = "https://www.reddit.com/r/tubeArchivist/comments.json" + + HOOK_URL = environ.get("REDDIT_HOOK_URL") + + + def send_last_comment(self): + """testing to send only last comment to hook""" + comments = self.get_comments() + comment = comments[0]["data"] + message = self.build_comment_message(comment) + status = self.send_hook(message) + print(status) + + @staticmethod + def build_post_message(post): + """build comment message str""" + post_message = post.get("selftext") + if len(post_message) > 200: + post_message = post_message[:200] + " ..." + + url = post.get("url") + print(url) + + @staticmethod + def build_comment_message(comment): + """build comment message str""" + comment_message = comment.get("body") + link_permalink = comment.get("link_permalink") + + if len(comment_message) > 200: + comment_message = comment_message[:200] + " ..." + + message = ( + "**New comment:**\n" + + f"{comment_message}\n" + + f"[link]({link_permalink})" + ) + + return message + + def send_hook(self, message): + """send the message to discord""" + data = { + "content": message + } + response = requests.post(self.HOOK_URL, json=data) + if not response.ok: + print(response.json()) + return {"success": False} + + return {"success": True} + + def get_comments(self): + """get a list of latest comments""" + return self._get_children(self.comments) + + def get_posts(self): + """get a list of newest posts""" + return self._get_children(self.posts) + + def _get_children(self, url): + """return a list of children from url""" + response = requests.get(url, headers=self.headers) + if response.ok: + children = response.json()["data"]["children"] + else: + children = False + + return children diff --git a/tubearchivist/web/src/db.py b/tubearchivist/web/src/db.py new file mode 100644 index 0000000..9812295 --- /dev/null +++ b/tubearchivist/web/src/db.py @@ -0,0 +1,48 @@ +"""handle postgres integration""" + +import psycopg2 +import psycopg2.extras +from src.ta_config import get_config + + +class DatabaseConnect: + """ handle db """ + + CONFIG = get_config() + + def __init__(self): + self.conn, self.cur = self._db_connect() + + def _db_connect(self): + """returns connection and curser""" + # Connect to database + conn = psycopg2.connect( + host=self.CONFIG['postgres']['db_host'], + database=self.CONFIG['postgres']['db_database'], + user=self.CONFIG['postgres']['db_user'], + password=self.CONFIG['postgres']['db_password'] + ) + # Open a cursor to perform database operations + cur = conn.cursor(cursor_factory = psycopg2.extras.RealDictCursor) + return conn, cur + + def db_execute(self, query): + """run a query""" + if isinstance(query, str): + self.cur.execute( + query + ) + rows = self.cur.fetchall() + elif isinstance(query, tuple): + self.cur.execute( + query[0], query[1] + ) + rows = False + + return rows + + def db_close(self): + """clean close the conn and curser""" + self.conn.commit() + self.cur.close() + self.conn.close() diff --git a/tubearchivist/web/src/ta_config.py b/tubearchivist/web/src/ta_config.py new file mode 100644 index 0000000..e30f725 --- /dev/null +++ b/tubearchivist/web/src/ta_config.py @@ -0,0 +1,15 @@ +"""read out config file""" + +import json + + +def get_config(): + """ read config file """ + config_path = "config.json" + + with open(config_path, "r", encoding="utf-8") as config_file: + data = config_file.read() + + config = json.loads(data) + + return config diff --git a/tubearchivist/web/src/webhook_docker.py b/tubearchivist/web/src/webhook_docker.py new file mode 100644 index 0000000..df14e15 --- /dev/null +++ b/tubearchivist/web/src/webhook_docker.py @@ -0,0 +1,59 @@ +"""parse and forward docker webhooks""" + +from os import environ +import requests + + +class DockerHook: + """parse docker webhook and forward to discord""" + + HOOK_URL = environ.get("DOCKER_UNSTABLE_HOOK_URL") + COMMITS_URL = "https://api.github.com/repos/bbilly1/tubearchivist/commits" + + def __init__(self, docker_hook): + self.docker_hook = docker_hook + self.docker_hook_details = self.docker_hook_parser() + self.commit_url = False + self.first_line_message = False + + def docker_hook_parser(self): + """parse data from docker""" + + docker_hook_details = { + "release_tag": self.docker_hook["push_data"]["tag"], + "repo_url": self.docker_hook["repository"]["repo_url"], + "repo_name": self.docker_hook["repository"]["repo_name"] + } + + return docker_hook_details + + def get_latest_commit(self): + """get latest commit url from master""" + response = requests.get(f"{self.COMMITS_URL}/master").json() + self.commit_url = response["html_url"] + self.first_line_message = response["commit"]["message"].split("\n")[0] + + def forward_message(self): + """forward message to discrod""" + data = self.build_message() + response = requests.post(self.HOOK_URL, json=data) + if not response.ok: + print(response.json()) + return {"success": False} + + return {"success": True} + + def build_message(self): + """build message for discord hook""" + release_tag = self.docker_hook_details["release_tag"] + repo_url = self.docker_hook_details["repo_url"] + message = ( + f"There is a new **{release_tag}** build " + + f"published to [docker]({repo_url}). Built from:\n" + + self.commit_url) + + data = { + "content": message + } + + return data diff --git a/tubearchivist/web/src/webhook_github.py b/tubearchivist/web/src/webhook_github.py new file mode 100644 index 0000000..79656cf --- /dev/null +++ b/tubearchivist/web/src/webhook_github.py @@ -0,0 +1,160 @@ +"""handle release functionality""" + +from datetime import datetime +from os import environ +import requests + +from src.db import DatabaseConnect + + + +class GithubBackup: + """backup release and notes""" + + URL = "https://api.github.com/repos/bbilly1/tubearchivist/releases/tags/" + TABLE = "ta_release" + + def __init__(self, tag): + self.tag = tag + self.ingest_line = False + self.query = False + + def save_tag(self): + """save release tag in db""" + self.ingest_build_line() + self.reset_latest() + _ = self.db_execute() + self._build_ingest_query() + _ = self.db_execute() + + def get_tag(self): + """get tag dict""" + self.build_get_query() + rows = self.db_execute() + result = dict(rows[0]) + return result + + def ingest_build_line(self): + """ingest latest release into postgres""" + response = requests.get(self.URL + self.tag) + if not response.ok: + print(response.text) + raise ValueError + + response_json = response.json() + + if isinstance(response_json, list): + last_release = response.json()[0] + elif isinstance(response_json, dict): + last_release = response.json() + + published_at = last_release["published_at"] + published = datetime.strptime(published_at, "%Y-%m-%dT%H:%M:%SZ") + release_notes = last_release["body"] + head = release_notes.split("\r\n")[0].lower() + breaking_changes = "manual changes" in head or "breaking changes" in head + + ingest_line = { + "time_stamp": int(published.strftime("%s")), + "time_stamp_human": published.strftime("%Y-%m-%d"), + "release_version": last_release["tag_name"], + "release_is_latest": True, + "breaking_changes": breaking_changes, + "release_notes": release_notes, + } + self.ingest_line = ingest_line + + def _build_ingest_query(self): + """build ingest query for postgres""" + keys = self.ingest_line.keys() + values = tuple(self.ingest_line.values()) + keys_str = ", ".join(keys) + valid = ", ".join(["%s" for i in keys]) + query = ( + f"INSERT INTO {self.TABLE} ({keys_str}) VALUES ({valid});", values + ) + self.query = query + + def reset_latest(self): + """unset latest tag of now old version""" + self.query = ( + f"UPDATE {self.TABLE} SET release_is_latest = %s;", (False,) + ) + + def db_execute(self): + """add line to postgres""" + handler = DatabaseConnect() + rows = handler.db_execute(self.query) + handler.db_close() + return rows + + def build_get_query(self): + """get release dict from db""" + if self.tag == "latest": + query = ( + f"SELECT * FROM {self.TABLE} " + + "WHERE release_is_latest = True " + + "LIMIT 1;" + ) + else: + query = ( + f"SELECT * FROM {self.TABLE} " + + f"WHERE release_version = '{self.tag}' " + + "LIMIT 1;" + ) + self.query = query + + +class RoadmapHook: + """update roadmap""" + + README = "https://raw.githubusercontent.com/bbilly1/tubearchivist/master/README.md" + HOOK_URL = environ.get("ROADMAP_HOOK_URL") + + def __init__(self): + self.roadmap_raw = False + self.implemented = False + self.pending = False + + def update(self): + """update message""" + self.get_roadmap() + self.parse_roadmap() + self.send_message() + + def get_roadmap(self): + """get current roadmap""" + response = requests.get(self.README) + paragraphs = [i.strip() for i in response.text.split("##")] + for paragraph in paragraphs: + if paragraph.startswith("Roadmap"): + roadmap_raw = paragraph + break + else: + roadmap_raw = False + + self.roadmap_raw = roadmap_raw + + def parse_roadmap(self): + """extract relevant information""" + _, pending, implemented = self.roadmap_raw.split("\n\n") + implemented = implemented.lstrip("Implemented:\n") + self.implemented = implemented.replace("[X] ", "") + self.pending = pending.replace("[ ]", "") + + def send_message(self): + """build message dict""" + data = { + "embeds": [{ + "title": "Upcoming:", + "description": self.pending, + "color": 2331524 + }, { + "title": "Implemented:", + "description": self.implemented, + "color": 10555 + }] + } + response = requests.post(self.HOOK_URL, json=data) + print(response) + print(response.text) diff --git a/tubearchivist/web/start.sh b/tubearchivist/web/start.sh new file mode 100644 index 0000000..199ee23 --- /dev/null +++ b/tubearchivist/web/start.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +uwsgi --ini uwsgi.ini diff --git a/tubearchivist/web/static/favicon.ico b/tubearchivist/web/static/favicon.ico new file mode 100644 index 0000000..10a9c4c Binary files /dev/null and b/tubearchivist/web/static/favicon.ico differ diff --git a/tubearchivist/web/static/font/Sen-Bold.ttf.woff b/tubearchivist/web/static/font/Sen-Bold.ttf.woff new file mode 100644 index 0000000..aea6c13 Binary files /dev/null and b/tubearchivist/web/static/font/Sen-Bold.ttf.woff differ diff --git a/tubearchivist/web/static/font/Sen-Regular.ttf.woff b/tubearchivist/web/static/font/Sen-Regular.ttf.woff new file mode 100644 index 0000000..5edaa34 Binary files /dev/null and b/tubearchivist/web/static/font/Sen-Regular.ttf.woff differ diff --git a/tubearchivist/web/static/img/O8H8Z01c0Ys.jpg b/tubearchivist/web/static/img/O8H8Z01c0Ys.jpg new file mode 100644 index 0000000..c7ee94f Binary files /dev/null and b/tubearchivist/web/static/img/O8H8Z01c0Ys.jpg differ diff --git a/tubearchivist/web/static/img/banner-tube-archivist-dark.png b/tubearchivist/web/static/img/banner-tube-archivist-dark.png new file mode 100644 index 0000000..ad2cd5e Binary files /dev/null and b/tubearchivist/web/static/img/banner-tube-archivist-dark.png differ diff --git a/tubearchivist/web/static/img/icon-play.svg b/tubearchivist/web/static/img/icon-play.svg new file mode 100644 index 0000000..210adec --- /dev/null +++ b/tubearchivist/web/static/img/icon-play.svg @@ -0,0 +1,75 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + diff --git a/tubearchivist/web/static/img/logo-discord.png b/tubearchivist/web/static/img/logo-discord.png new file mode 100644 index 0000000..e62ca74 Binary files /dev/null and b/tubearchivist/web/static/img/logo-discord.png differ diff --git a/tubearchivist/web/static/img/logo-docker.png b/tubearchivist/web/static/img/logo-docker.png new file mode 100644 index 0000000..3c150b9 Binary files /dev/null and b/tubearchivist/web/static/img/logo-docker.png differ diff --git a/tubearchivist/web/static/img/logo-git.png b/tubearchivist/web/static/img/logo-git.png new file mode 100644 index 0000000..eaf2b06 Binary files /dev/null and b/tubearchivist/web/static/img/logo-git.png differ diff --git a/tubearchivist/web/static/img/logo-github.png b/tubearchivist/web/static/img/logo-github.png new file mode 100644 index 0000000..c74ee23 Binary files /dev/null and b/tubearchivist/web/static/img/logo-github.png differ diff --git a/tubearchivist/web/static/img/logo-reddit.png b/tubearchivist/web/static/img/logo-reddit.png new file mode 100644 index 0000000..b239d8e Binary files /dev/null and b/tubearchivist/web/static/img/logo-reddit.png differ diff --git a/tubearchivist/web/static/script.js b/tubearchivist/web/static/script.js new file mode 100644 index 0000000..b7c341a --- /dev/null +++ b/tubearchivist/web/static/script.js @@ -0,0 +1,27 @@ +document.addEventListener("DOMContentLoaded", ready); + +function ready() { + loadIframes(); +}; + +// iframes +function loadIframes() { + var youtube = document.querySelectorAll( ".youtube" ); + // youtube + for (var i = 0; i < youtube.length; i++) { + var source = "/static/img/"+ youtube[i].dataset.embed +".jpg"; + var image = new Image(); + image.src = source; + image.addEventListener( "load", function() { + youtube[ i ].appendChild( image ); + }( i ) ); + youtube[i].addEventListener( "click", function() { + var iframe = document.createElement( "iframe" ); + iframe.setAttribute( "frameborder", "0" ); + iframe.setAttribute( "allowfullscreen", "" ); + iframe.setAttribute( "src", "https://www.youtube.com/embed/"+ this.dataset.embed +"?rel=0&showinfo=0&autoplay=1" ); + this.innerHTML = ""; + this.appendChild( iframe ); + } ); + } +} diff --git a/tubearchivist/web/static/style.css b/tubearchivist/web/static/style.css new file mode 100644 index 0000000..83d090b --- /dev/null +++ b/tubearchivist/web/static/style.css @@ -0,0 +1,183 @@ +@font-face { + font-family: 'Sen-Bold'; + src: url('../static/font/Sen-Bold.ttf.woff'); + font-family: 'Sen-Bold'; +} + +@font-face { + font-family: 'Sen-Regular'; + src: url('../static/font/Sen-Regular.ttf.woff'); + font-family: 'Sen-Regular'; +} +* { + margin: 0; + padding: 0; +} +html { + height: 100%; +} +body { + background-color: #00202f; + min-height: 100%; + display: grid; + grid-template-rows: 1fr auto; +} +h1 { + font-family: Sen-Bold, sans-serif; + font-size: 2.3em; + color: #97d4c8; + margin-bottom: 20px; +} +h2 { + font-family: Sen-Regular, sans-serif; + font-size: 2.0em; + color: #259485; +} +p { + font-family: Sen-Regular, sans-serif; + font-size: 1.1em; + color: #eeeeee; + margin-bottom: 15px; +} +a, li { + font-family: Sen-Regular, sans-serif; + text-decoration: none; + color: #eeeeee; +} +span { + font-family: Sen-Regular, sans-serif; + color: #eeeeee; +} +.alert { + background-color: #990202; + text-align: center; + padding: 20px 0; + margin: 10px 0; +} +.content { + margin: auto; + max-width: 1000px; +} +.banner { + text-align: center; +} +.banner img { + width: 80%; + margin-bottom: 20px; +} +.tag-line { + text-align: center; +} +.social-links { + width: 100%; + display: flex; + justify-content: center; +} +.social-item > a { + padding: 10px; + display: block; + text-align: center; +} +.social-item > a:hover { + background-color: #00293b; +} +.social-item img { + padding: 5px 20px; + width: 60px; +} +.block-2 { + display: grid; + grid-template-columns: 1fr 1fr; + gap: 1rem; +} +.release-notes { + padding: 30px; + background: #00293b; + margin-bottom: 20px; +} +.footer-colors { + grid-row-start: 2; + grid-row-end: 3; + display: flex; +} +.footer-colors div { + padding: 20px 0; + width: 33.33%; +} +.col-1 { + background-color: #00293b; +} +.col-2 { + background-color: #259485; +} +.col-3 { + background-color: #97d4c8; +} + +.youtube { + background-color: #000; + margin: 2rem 0; + position: relative; + padding-top: 56.25%; + overflow: hidden; + cursor: pointer +} + +.youtube img { + position: absolute; + width: 100%; + left: 0; + top: 0 +} + +.youtube iframe { + position: absolute; + height: 100%; + width: 100%; + top: 0; + left: 0 +} + +.play-button img { + z-index: 3; + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + width: 80px; + background-color: rgba(255, 255, 255, 0.5); + padding: 15px; + border-radius: 50%; + transition: all 0.5s ease-in-out +} + +.play-button img:hover { + background-color: rgba(255, 255, 255, 0.9); + padding: 25px +} + +/* tablet */ +@media screen and (max-width: 1000px) { + .content { + width: 90%; + } +} + +/* phone */ +@media screen and (max-width: 600px) { + * { + word-wrap: anywhere; + } + .banner img { + width: 100%; + } + .block-2 { + grid-template-columns: 1fr; + } + .social-links { + flex-wrap: wrap; + } + .social-item > a { + padding: 2px; + } +} \ No newline at end of file diff --git a/tubearchivist/web/templates/home.html b/tubearchivist/web/templates/home.html new file mode 100644 index 0000000..5719c4e --- /dev/null +++ b/tubearchivist/web/templates/home.html @@ -0,0 +1,92 @@ + + + + + + + Tube Archivist + + + + + + + + +
+ +
+

Your self hosted YouTube media server

+
+ +
+
+ play +
+
+
+
+

Core functionality

+
    +
  • Subscribe to your favorite YouTube channels
    • +
  • Download Videos
    • +
  • Index and make videos searchable
    • +
  • Play videos
    • +
  • Keep track of viewed and unviewed videos
    • +
+
+
+

Problem Description

+

Once your YouTube video collection grows, it becomes hard to search and find a specific video. That's where Tube Archivist comes in: By indexing your video collection with metadata from YouTube, you can organize, search and enjoy your archived YouTube videos without hassle offline through a convenient web interface. +

+
+
+
+

Latest Release:

+ {% if latest.breaking_changes %} +
+ Requires your attention! +
+ {% endif %} +

Release tag: {{ latest.release_version }}

+

Release date: {{ latest.time_stamp_human }}

+
+ {{ latest_notes|safe }} +
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/tubearchivist/web/uwsgi.ini b/tubearchivist/web/uwsgi.ini new file mode 100644 index 0000000..24eadfd --- /dev/null +++ b/tubearchivist/web/uwsgi.ini @@ -0,0 +1,10 @@ +[uwsgi] +wsgi-file = views.py +callable = app +socket = :8080 +processes = 4 +threads = 2 +master = true +chmod-socket = 660 +vacuum = true +die-on-term = true \ No newline at end of file diff --git a/tubearchivist/web/views.py b/tubearchivist/web/views.py new file mode 100644 index 0000000..efc07b7 --- /dev/null +++ b/tubearchivist/web/views.py @@ -0,0 +1,54 @@ +"""holds all views and api endpoints""" + +from flask import Flask, render_template, jsonify, request +from src.webhook_docker import DockerHook +from src.webhook_github import GithubBackup +import markdown + +app = Flask(__name__) + + +@app.route("/") +def home(): + """home page""" + latest = GithubBackup("latest").get_tag() + latest_notes = markdown.markdown(latest["release_notes"]) + return render_template( + 'home.html', latest=latest, latest_notes=latest_notes + ) + + +@app.route("/api/release//") +def release(release_id): + """api release""" + result = GithubBackup(release_id).get_tag() + return jsonify(result) + + +@app.route("/api/webhook/docker/", methods=['POST']) +def webhook_docker(): + """parse docker webhook data""" + print(request.json) + hook = DockerHook(request.json) + if hook.docker_hook_details.get("release_tag") != "unstable": + message = {"success": False} + print(message, "not unstable build") + return jsonify(message) + + hook.get_latest_commit() + if not hook.first_line_message.endswith("#build"): + message = {"success": False} + print(message, "not build message in commit") + return jsonify(message) + + message = hook.forward_message() + print(message, "hook sent to discord") + return jsonify(message) + + +@app.route("/api/webhook/github/", methods=['POST']) +def webhook_github(): + """prase webhooks from github""" + print(request.json) + message = {"success": False} + return jsonify(message) diff --git a/version_check.py b/version_check.py new file mode 100755 index 0000000..1671873 --- /dev/null +++ b/version_check.py @@ -0,0 +1,115 @@ +#!/usr/bin/env python +""" check requirements.txt for outdated packages """ + +import pathlib + +import requests + + +class Requirements: + """handle requirements.txt""" + + FILE_PATH = "tubearchivist/web/requirements.txt" + LOCK = "/tmp/tubearchivist-web-requirements.lock" + + def __init__(self): + self.exists = self.checked_today() + self.all_requirements = False + self.all_updates = False + + def checked_today(self): + """skip requirements check when lock file exists""" + exists = pathlib.Path(self.LOCK).exists() + return exists + + def look_for_updates(self): + """look through requirements and check for updates""" + self.all_requirements = self.get_dependencies() + self.all_updates = self.check_packages() + + def get_dependencies(self): + """read out requirements.txt""" + + all_requirements = [] + with open(self.FILE_PATH, "r", encoding="utf-8") as f: + dependencies = f.readlines() + + for dependency in dependencies: + package, version = dependency.split("==") + all_requirements.append((package, version.strip())) + + all_requirements.sort(key=lambda x: x[0].lower()) + + return all_requirements + + def check_packages(self): + """compare installed with remote version""" + + total = len(self.all_requirements) + print(f"checking versions for {total} packages...") + + all_updates = {} + + for dependency in self.all_requirements: + package, version_installed = dependency + url = f"https://pypi.org/pypi/{package}/json" + response = requests.get(url).json() + version_remote = response["info"]["version"] + homepage = response["info"]["home_page"] + if version_remote != version_installed: + to_update = { + package: {"from": version_installed, "to": version_remote} + } + all_updates.update(to_update) + message = ( + f"update {package} {version_installed}" + + f"==> {version_remote}\n {homepage}" + ) + print(message) + + if not all_updates: + print("no updates found") + + # remember that + pathlib.Path(self.LOCK).touch() + + return all_updates + + def apply_updates(self): + """update requirements.txt file with new versions""" + + to_write = [] + + for requirement in self.all_requirements: + package, old_version = requirement + + if package in self.all_updates.keys(): + package_version = self.all_updates[package]["to"] + else: + package_version = old_version + + to_write.append(f"{package}=={package_version}\n") + + with open(self.FILE_PATH, "w", encoding="utf-8") as f: + f.writelines(to_write) + + print("requirements.txt updates") + + +def main(): + """main to check for updates""" + handler = Requirements() + if handler.exists: + return + + handler.look_for_updates() + if handler.all_updates: + input_response = input("\nupdate requirements.txt? [y/n] ") + if input_response == "y": + handler.apply_updates() + else: + print("skip update...") + + +if __name__ == "__main__": + main()