commit 9b899f6fc0325f4e008724c37065e251946c86f1 Author: Roland Date: Mon Nov 1 16:42:52 2021 -0600 A new start Signed-off-by: Roland diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..69cd3f57 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,3 @@ +app/node_modules +test +venv \ No newline at end of file diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 00000000..3c7aae57 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,54 @@ +name: "CodeQL" + +on: + push: + branches: [master, ] + pull_request: + # The branches below must be a subset of the branches above + branches: [master] + schedule: + - cron: '0 15 * * 4' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + with: + # We must fetch at least the immediate parents so that if this is + # a pull request then we can checkout the head. + fetch-depth: 2 + + # If this run was triggered by a pull request event, then checkout + # the head of the pull request instead of the merge commit. + - run: git checkout HEAD^2 + if: ${{ github.event_name == 'pull_request' }} + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + # Override language selection by uncommenting this and choosing your languages + # with: + # languages: go, javascript, csharp, python, cpp, java + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # ℹ️ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..fb9b5fb5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,126 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ + +# intellij +.idea/ + +# example videos +test/videos +test/archive + +# local configs +config/local.yaml +config/local.yaml.bak +config/inventories.yaml + +app/package-lock.json +modules/node_modules/ +docker/archive/node_modules/ +docker/archive/package-lock.json + +# open street map files +*.pbf + +# docker override +docker-compose.override.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..34c0f17b --- /dev/null +++ b/.travis.yml @@ -0,0 +1,15 @@ +os: linux +services: + - docker +language: python +python: + - "3.7" + - "3.8" + - "3.9" +before_install: + - docker-compose -p wrolpi -f docker-compose.dev.yml up -d db + - docker-compose -p wrolpi -f docker-compose.dev.yml run api db upgrade + - docker-compose -p wrolpi -f docker-compose.dev.yml up -d api + - docker-compose -p wrolpi -f docker-compose.dev.yml ps +script: + - docker-compose -p wrolpi -f docker-compose.dev.yml exec api pytest ./api diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..f288702d --- /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 00000000..470a9334 --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ +# WROLPi + +[![Build Status](https://img.shields.io/travis/lrnselfreliance/wrolpi?style=flat-square)](https://travis-ci.com/lrnselfreliance/wrolpi) +[![License: GPL v3](https://img.shields.io/github/license/lrnselfreliance/wrolpi?style=flat-square)](https://github.com/lrnselfreliance/wrolpi/blob/master/LICENSE) + +**Take your internet, off-grid.** + +

+ WROLPi Logo +

+ +WROLPi is a self-contained collection of software (on a Raspberry Pi) to help you survive the world Without Rule of Law. + +WROLPi is intended to be run on a Raspberry Pi with an optional external drive attached. It serves up it's own wifi +network so that any person with a laptop/tablet/phone can connect and use the data previously collected by the user. + +# WARNING WROLPi is under active development! + +- WROLPi is in early Alpha! +- Expect things to change! + +# Features + +- [x] Video player & downloader +- [x] One-Time pad generator, encrypter/decrypter +- [x] Web archiver +- [x] Inventory management +- [ ] Wi-Fi Hotspot +- [ ] Universal search +- [ ] Map viewer & downloader +- [ ] eBook viewer +- [ ] Wiki viewer & downloader +- [ ] Synchronizer and/or duplicator +- [ ] Food storage calculator +- [ ] Podcast player & downloader + +# Try WROLPi! + +You can try out WROLPi by running the docker containers. + +1. [Install docker-ce](https://docs.docker.com/install/linux/docker-ce/debian/) and + [docker-compose](https://docs.docker.com/compose/install/) +2. Copy the latest WROLPi code + * `git clone git@github.com:lrnselfreliance/wrolpi.git` +3. Change directory into the code base + * `cd wrolpi` +4. Start the database. + * `docker-compose up -d db` +5. Initialize the database + * `docker-compose run api db upgrade` +6. Start the docker containers + * `docker-compose up` +7. Navigate to WROLPi + * http://0.0.0.0:8080 + +# RaspberryPi Install + +Install WROLPi onto a fresh Raspberry Pi. + +**Warning: this will clobber anything else on the Raspberry Pi! Do not run this installation script elsewhere!** + +1. Install [Ubuntu Server 20.04](https://ubuntu.com/download/raspberry-pi) onto a RaspberryPi. +2. Login to the new RaspberryPi. +3. Get the WROLPi installation script + * `wget https://raw.githubusercontent.com/lrnselfreliance/wrolpi/master/install.sh -O /tmp/install.sh` +4. Run the installation script + * `sudo /bin/bash /tmp/install.sh` + +# Charter + +## Physical properties + +1. A WROLPi instance should be capable of running with a minimal of hardware: + * Raspberry Pi + * SD card + * External USB hard drive + * Power supply and cables + * WiFi USER device such as a phone, tablet, or laptop. +1. A WROLPi instance should consume a minimal amount of electricity during WROL event. It is expected power will be + scarce when WROLPi is needed most. + +## User expectations + +1. A WROLPi instance should be run and maintained by a person (MAINTAINER) with a moderate amount of Linux and Raspberry + Pi experience. It is expected that they should be able to do this using only the documentation on their WROLPi. + +## Software properties and capabilities + +1. A WROLPi instance should be able to "factory-reset" itself without any outside services. +1. WROLPi should function completely without any internet services. +1. A user should have easy access to their data if WROLPi fails: + * For example, a user can watch their videos by navigating a short and intuitive directory structure and opening the + video in their preferred video player. +1. WROLPi should be self-documented. The UI should contain a tutorial for USERS as well as the MAINTAINER. + * If the UI isn't functional, the code should be documented such that a user can restore functionality. +1. WROLPi should favor pre-processing, rather than processing during a WROL event. Such as re-encoding a video, or + processing captions. This is to ensure that when a user adds content during non-WROL time, the processing for optimum + performance is already done for a WROL event. + +# Join! + +

+ Discord QR Code +

+ +[Join our Discord](https://discord.gg/HrwFk7nqA2) diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 00000000..c9d850c4 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,89 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. +prepend_sys_path = . + +# timezone to use when rendering the date +# within the migration file as well as the filename. +# string value is passed to dateutil.tz.gettz() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the +# "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; this defaults +# to alembic/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat alembic/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = postgresql://postgres:wrolpi@localhost:5432/wrolpi + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/alembic/README b/alembic/README new file mode 100644 index 00000000..98e4f9c4 --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 00000000..751d50af --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,81 @@ +import os +from logging.config import fileConfig + +from alembic import context +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +target_metadata = None + + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + if not os.environ.get('DOCKER', '').lower().startswith('t'): + # Set role when not in a docker container + connection.execute("SET ROLE 'wrolpi'") + context.configure( + connection=connection, target_metadata=target_metadata + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 00000000..e13d8b06 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,33 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +import os +from alembic import op +from sqlalchemy.orm import Session +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + +DOCKERIZED = True if os.environ.get('DOCKER', '').lower().startswith('t') else False + + +def upgrade(): + bind = op.get_bind() + session = Session(bind=bind) + + ${upgrades if upgrades else "pass"} + + if not DOCKERIZED: + session.execute('ALTER TABLE public.TABLE_NAME OWNER TO wrolpi') + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/053f17f07c4e_init_inventory_tables.py b/alembic/versions/053f17f07c4e_init_inventory_tables.py new file mode 100644 index 00000000..e31c7efa --- /dev/null +++ b/alembic/versions/053f17f07c4e_init_inventory_tables.py @@ -0,0 +1,70 @@ +"""Init inventory tables. + +Revision ID: 053f17f07c4e +Revises: f0d0086a73d1 +Create Date: 2021-09-20 16:21:00.322598 + +""" +import os + +from alembic import op +from sqlalchemy.orm import Session + +revision = '053f17f07c4e' +down_revision = 'f0d0086a73d1' +branch_labels = None +depends_on = None + +DOCKERIZED = True if os.environ.get('DOCKER', '').lower().startswith('t') else False + + +def upgrade(): + bind = op.get_bind() + session = Session(bind=bind) + + session.execute(''' + CREATE TABLE inventories_version ( + version SERIAL PRIMARY KEY NOT NULL + ) + ''') + + session.execute(''' + CREATE TABLE public.inventory ( + id SERIAL PRIMARY KEY, + name TEXT NOT NULL UNIQUE, + viewed_at TIMESTAMP WITHOUT TIME ZONE, + created_at TIMESTAMP WITHOUT TIME ZONE DEFAULT CURRENT_TIMESTAMP, + deleted_at TIMESTAMP WITHOUT TIME ZONE + )''') + + session.execute(''' + CREATE TABLE public.item ( + id SERIAL PRIMARY KEY, + inventory_id INTEGER REFERENCES inventory(id) ON DELETE CASCADE, + brand TEXT, + name TEXT, + count DECIMAL, + item_size DECIMAL, + unit TEXT, + serving INTEGER, + category TEXT, + subcategory TEXT, + expiration_date DATE, + purchase_date DATE, + created_at TIMESTAMP WITHOUT TIME ZONE DEFAULT CURRENT_TIMESTAMP, + deleted_at TIMESTAMP WITHOUT TIME ZONE + )''') + + if not DOCKERIZED: + session.execute('ALTER TABLE public.inventories_version OWNER TO wrolpi') + session.execute('ALTER TABLE public.inventory OWNER TO wrolpi') + session.execute('ALTER TABLE public.item OWNER TO wrolpi') + + +def downgrade(): + bind = op.get_bind() + session = Session(bind=bind) + + session.execute('DROP TABLE IF EXISTS public.inventories_version''') + session.execute('DROP TABLE IF EXISTS public.item''') + session.execute('DROP TABLE IF EXISTS public.inventory''') diff --git a/alembic/versions/1870bec7c81e_initialize_archive_tables.py b/alembic/versions/1870bec7c81e_initialize_archive_tables.py new file mode 100644 index 00000000..2d1d4e41 --- /dev/null +++ b/alembic/versions/1870bec7c81e_initialize_archive_tables.py @@ -0,0 +1,70 @@ +"""Initialize archive tables. + +Revision ID: 1870bec7c81e +Revises: 053f17f07c4e +Create Date: 2021-09-22 18:31:15.056697 + +""" +import os + +from alembic import op +from sqlalchemy.orm import Session + +# revision identifiers, used by Alembic. +revision = '1870bec7c81e' +down_revision = '053f17f07c4e' +branch_labels = None +depends_on = None + +DOCKERIZED = True if os.environ.get('DOCKER', '').lower().startswith('t') else False + + +def upgrade(): + bind = op.get_bind() + session = Session(bind=bind) + + session.execute(''' + CREATE TABLE domains ( + id SERIAL PRIMARY KEY, + domain TEXT NOT NULL UNIQUE, + directory TEXT NOT NULL UNIQUE + )''') + + session.execute(''' + CREATE TABLE url ( + id SERIAL PRIMARY KEY, + domain_id INTEGER REFERENCES domains(id) NOT NULL, + url TEXT NOT NULL UNIQUE, + latest_datetime TIMESTAMPTZ + )''') + + session.execute(''' + CREATE TABLE archive ( + id SERIAL PRIMARY KEY, + url_id INTEGER REFERENCES url(id) ON DELETE CASCADE NOT NULL, + domain_id INTEGER REFERENCES domains(id) ON DELETE CASCADE NOT NULL, + singlefile_path TEXT, + readability_path TEXT, + readability_txt_path TEXT, + readability_json_path TEXT, + screenshot_path TEXT, + title TEXT, + archive_datetime TIMESTAMPTZ, + status TEXT + )''') + + session.execute('ALTER TABLE url ADD COLUMN latest_id INTEGER REFERENCES archive(id) ON DELETE CASCADE') + + if not DOCKERIZED: + session.execute('ALTER TABLE public.domains OWNER TO wrolpi') + session.execute('ALTER TABLE public.url OWNER TO wrolpi') + session.execute('ALTER TABLE public.archive OWNER TO wrolpi') + + +def downgrade(): + bind = op.get_bind() + session = Session(bind=bind) + + session.execute('DROP TABLE IF EXISTS domains CASCADE') + session.execute('DROP TABLE IF EXISTS url CASCADE') + session.execute('DROP TABLE IF EXISTS archive CASCADE') diff --git a/alembic/versions/f0d0086a73d1_init_videos_tables.py b/alembic/versions/f0d0086a73d1_init_videos_tables.py new file mode 100644 index 00000000..8afc75a1 --- /dev/null +++ b/alembic/versions/f0d0086a73d1_init_videos_tables.py @@ -0,0 +1,79 @@ +"""Init videos tables. + +Revision ID: f0d0086a73d1 +Revises: +Create Date: 2021-09-20 16:19:36.576217 + +""" +import os + +from alembic import op +from sqlalchemy.orm import Session + +revision = 'f0d0086a73d1' +down_revision = None +branch_labels = None +depends_on = None + +DOCKERIZED = True if os.environ.get('DOCKER', '').lower().startswith('t') else False + + +def upgrade(): + bind = op.get_bind() + session = Session(bind=bind) + + session.execute('''CREATE TABLE public.channel +( + id BIGSERIAL PRIMARY KEY, + name TEXT, + link TEXT UNIQUE, + idempotency TEXT, + url TEXT, + match_regex TEXT, + directory TEXT, + info_json JSON, + info_date DATE, + skip_download_videos text[], + generate_posters BOOLEAN DEFAULT true, + calculate_duration BOOLEAN DEFAULT true, + download_frequency INTEGER, + next_download DATE +)''') + + session.execute('''CREATE TABLE public.video +( + id BIGSERIAL PRIMARY KEY, + title TEXT, + ext TEXT, + source_id TEXT, + description_path TEXT, + poster_path TEXT, + video_path TEXT, + caption_path TEXT, + info_json_path TEXT, + idempotency TEXT, + channel_id INTEGER REFERENCES channel(id) ON DELETE CASCADE, + caption TEXT, + textsearch tsvector GENERATED ALWAYS AS (to_tsvector('english'::regconfig, + ((COALESCE(title, ''::text) || ' '::text) || + COALESCE(caption, ''::text)))) STORED, + upload_date TIMESTAMP WITHOUT TIME ZONE, + duration INTEGER, + favorite TIMESTAMP WITHOUT TIME ZONE, + size BIGINT, + viewed TIMESTAMP WITHOUT TIME ZONE, + validated_poster BOOLEAN DEFAULT false, + view_count INTEGER +)''') + + if not DOCKERIZED: + session.execute('ALTER TABLE public.channel OWNER TO wrolpi') + session.execute('ALTER TABLE public.video OWNER TO wrolpi') + + +def downgrade(): + bind = op.get_bind() + session = Session(bind=bind) + + session.execute('DROP TABLE IF EXISTS channel CASCADE') + session.execute('DROP TABLE IF EXISTS video CASCADE') diff --git a/app/.gitignore b/app/.gitignore new file mode 100644 index 00000000..4d29575d --- /dev/null +++ b/app/.gitignore @@ -0,0 +1,23 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# production +/build + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/app/README.md b/app/README.md new file mode 100644 index 00000000..89b278ae --- /dev/null +++ b/app/README.md @@ -0,0 +1,68 @@ +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). + +## Available Scripts + +In the project directory, you can run: + +### `yarn start` + +Runs the app in the development mode.
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser. + +The page will reload if you make edits.
+You will also see any lint errors in the console. + +### `yarn test` + +Launches the test runner in the interactive watch mode.
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. + +### `yarn build` + +Builds the app for production to the `build` folder.
+It correctly bundles React in production mode and optimizes the build for the best performance. + +The build is minified and the filenames include the hashes.
+Your app is ready to be deployed! + +See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. + +### `yarn eject` + +**Note: this is a one-way operation. Once you `eject`, you can’t go back!** + +If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. + +Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. + +You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. + +## Learn More + +You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). + +To learn React, check out the [React documentation](https://reactjs.org/). + +### Code Splitting + +This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting + +### Analyzing the Bundle Size + +This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size + +### Making a Progressive Web App + +This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app + +### Advanced Configuration + +This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration + +### Deployment + +This section has moved here: https://facebook.github.io/create-react-app/docs/deployment + +### `yarn build` fails to minify + +This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify diff --git a/app/package.json b/app/package.json new file mode 100644 index 00000000..17996a61 --- /dev/null +++ b/app/package.json @@ -0,0 +1,41 @@ +{ + "name": "app", + "version": "0.1.0", + "private": true, + "dependencies": { + "dot-prop": "^5.1.1", + "lodash": "^4.17.19", + "npm": "^6.14.7", + "query-string": "^6.13.0", + "react": "^16.13.1", + "react-dom": "^16.13.1", + "react-router-dom": "^5.2.0", + "react-scripts": "^3.4.1", + "react-semantic-toasts": "^0.6.5", + "react-timezone-select": "^1.0.5", + "semantic-ui-offline": "^2.4.1-1", + "semantic-ui-react": "^0.88.2", + "yargs-parser": "^18.1.2" + }, + "scripts": { + "start": "react-scripts start", + "build": "react-scripts build", + "test": "react-scripts test", + "eject": "react-scripts eject" + }, + "eslintConfig": { + "extends": "react-app" + }, + "browserslist": { + "production": [ + ">0.2%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] + } +} diff --git a/app/public/favicon.ico b/app/public/favicon.ico new file mode 100644 index 00000000..c2c86b85 Binary files /dev/null and b/app/public/favicon.ico differ diff --git a/app/public/index.html b/app/public/index.html new file mode 100644 index 00000000..189545fa --- /dev/null +++ b/app/public/index.html @@ -0,0 +1,43 @@ + + + + + + + + + + + + + WROLPi - Bring your personal internet, off-grid + + + +
+ + + diff --git a/app/public/logo192.png b/app/public/logo192.png new file mode 100644 index 00000000..fa313abf Binary files /dev/null and b/app/public/logo192.png differ diff --git a/app/public/logo512.png b/app/public/logo512.png new file mode 100644 index 00000000..bd5d4b5e Binary files /dev/null and b/app/public/logo512.png differ diff --git a/app/public/manifest.json b/app/public/manifest.json new file mode 100644 index 00000000..080d6c77 --- /dev/null +++ b/app/public/manifest.json @@ -0,0 +1,25 @@ +{ + "short_name": "React App", + "name": "Create React App Sample", + "icons": [ + { + "src": "favicon.ico", + "sizes": "64x64 32x32 24x24 16x16", + "type": "image/x-icon" + }, + { + "src": "logo192.png", + "type": "image/png", + "sizes": "192x192" + }, + { + "src": "logo512.png", + "type": "image/png", + "sizes": "512x512" + } + ], + "start_url": ".", + "display": "standalone", + "theme_color": "#000000", + "background_color": "#ffffff" +} diff --git a/app/public/one-time-pad-cheat-sheet.pdf b/app/public/one-time-pad-cheat-sheet.pdf new file mode 100644 index 00000000..4b3c0821 Binary files /dev/null and b/app/public/one-time-pad-cheat-sheet.pdf differ diff --git a/app/public/robots.txt b/app/public/robots.txt new file mode 100644 index 00000000..01b0f9a1 --- /dev/null +++ b/app/public/robots.txt @@ -0,0 +1,2 @@ +# https://www.robotstxt.org/robotstxt.html +User-agent: * diff --git a/app/src/App.css b/app/src/App.css new file mode 100644 index 00000000..8e71b651 --- /dev/null +++ b/app/src/App.css @@ -0,0 +1,48 @@ +.channel-edit { + border-radius: 3px; + padding: 0.75em; +} + +.channel-edit:hover { + background-color: #7abaff; + cursor: pointer; +} + +::-ms-clear { + display: none; +} + +.form-control-clear { + z-index: 10; + pointer-events: auto; + cursor: pointer; +} + +pre.wrap-text { + white-space: pre-wrap; /* Since CSS 2.1 */ + white-space: -moz-pre-wrap; /* Mozilla, since 1999 */ + word-wrap: break-word; /* Internet Explorer 5.5+ */ +} + +.duration-overlay { + position: absolute; + top: 4px; + right: 4px; + color: black; + background: #eee; + opacity: 0.8; + padding: 0px 4px; + border-radius: 3px; +} + +.no-link-underscore { + text-decoration: none !important; +} + +.video-card-link { + color: black; +} + +.center-me { + margin: 0 auto; +} diff --git a/app/src/App.js b/app/src/App.js new file mode 100644 index 00000000..e4a37c78 --- /dev/null +++ b/app/src/App.js @@ -0,0 +1,60 @@ +import React from 'react'; +import './App.css'; +import {NavBar} from "./components/Nav"; +import {Route, Switch} from "react-router-dom"; +import {FavoriteVideosPreview, VideosRoute, VideoWrapper, ViewedVideosPreview} from "./components/Videos"; +import Admin from "./components/Admin"; +import {Container, Header, Segment} from "semantic-ui-react"; +import 'semantic-ui-offline/semantic.min.css'; +import {SemanticToastContainer} from 'react-semantic-toasts'; +import 'react-semantic-toasts/styles/react-semantic-alert.css'; +import {AppsRoute} from "./components/Apps"; +import {InventoryRoute} from "./components/Inventory"; +import {ArchiveRoute} from "./components/Archive"; + +function Welcome() { + return ( + +
Welcome to WROLPi!
+

+ Take your internet, off-grid. +

+ + + + + + + + ) +} + +function PageNotFound() { + return ( + +

Page Not Found!

+

The page you requested cannot be found

+ + ) +} + +export default function App() { + return ( + <> +
+ +
+ + + + + + + + + + + + + ); +} diff --git a/app/src/App.test.js b/app/src/App.test.js new file mode 100644 index 00000000..ebda12e2 --- /dev/null +++ b/app/src/App.test.js @@ -0,0 +1,9 @@ +import React from 'react'; +import ReactDOM from 'react-dom'; +import App from './App'; + +it('renders without crashing', () => { + const div = document.createElement('div'); + ReactDOM.render(, div); + ReactDOM.unmountComponentAtNode(div); +}); diff --git a/app/src/api.js b/app/src/api.js new file mode 100644 index 00000000..2205ff48 --- /dev/null +++ b/app/src/api.js @@ -0,0 +1,330 @@ +import {API_URI, ARCHIVES_API, DEFAULT_LIMIT, OTP_API, VIDEOS_API} from "./components/Common"; +import {toast} from 'react-semantic-toasts'; + +function timeoutPromise(ms, promise) { + // Create a timeout wrapper around a promise. If the timeout is reached, throw an error. Otherwise, return + // the results of the promise. + return new Promise((resolve, reject) => { + const timeoutId = setTimeout(() => { + reject(new Error("promise timeout")) + }, ms); + promise.then( + (res) => { + clearTimeout(timeoutId); + resolve(res); + }, + (err) => { + clearTimeout(timeoutId); + reject(err); + } + ); + }) +} + +async function apiCall(url, method, body, ms = 10000) { + let init = {method}; + if (body !== undefined) { + init.body = JSON.stringify(body); + } + + // Create a fetch promise, this will be awaited by the timeout. + let promise = fetch(url, init); + + try { + // await the response or error. + return await timeoutPromise(ms, promise); + } catch (e) { + // Timeout, or some other exception. + if (e.message === 'promise timeout') { + toast({ + type: 'error', + title: 'Server failed to respond!', + description: 'Timeout while waiting for server response. See server logs.', + time: 5000, + }); + } else { + toast({ + type: 'error', + title: 'Error!', + description: 'See client logs', + time: 5000, + }); + } + throw e; + } +} + +// Convenience functions for API calls. +let apiGet = async (url) => { + return await apiCall(url, 'GET') +}; +let apiDelete = async (url) => { + return await apiCall(url, 'DELETE') +}; +let apiPost = async (url, body) => { + return await apiCall(url, 'POST', body) +}; +let apiPut = async (url, body) => { + return await apiCall(url, 'PUT', body) +}; +let apiPatch = async (url, body) => { + return await apiCall(url, 'PATCH', body) +}; + + +export async function updateChannel(link, channel) { + return await apiPut(`${VIDEOS_API}/channels/${link}`, channel); +} + +export async function createChannel(channel) { + return await apiPost(`${VIDEOS_API}/channels`, channel); +} + +export async function deleteChannel(channel_link) { + return apiDelete(`${VIDEOS_API}/channels/${channel_link}`); +} + +export async function getChannels() { + let response = await apiGet(`${VIDEOS_API}/channels`); + return (await response.json())['channels']; +} + +export async function getChannel(link) { + let response = await apiGet(`${VIDEOS_API}/channels/${link}`); + return (await response.json())['channel']; +} + +export async function searchVideos(offset, limit, channel_link, searchStr, favorites, order_by) { + // Build a search query to retrieve a list of videos from the API + offset = offset || 0; + limit = limit || DEFAULT_LIMIT; + let body = {offset, limit, favorites: favorites}; + + if (searchStr) { + body.search_str = searchStr; + } + if (channel_link) { + body.channel_link = channel_link; + } + body.order_by = order_by ? order_by : 'rank' + + let response = await apiPost(`${VIDEOS_API}/search`, body); + if (response.status === 200) { + let data = await response.json(); + return [data['videos'], data['totals']['videos']]; + } else { + throw Error(`Unable to search videos`); + } +} + +export async function getVideo(video_id) { + let response = await apiGet(`${VIDEOS_API}/video/${video_id}`); + let data = await response.json(); + return [data['video'], data['prev'], data['next']]; +} + +export async function deleteVideo(video_id) { + let response = await apiDelete(`${VIDEOS_API}/video/${video_id}`); + let data = await response.json(); + if (data.code === 17) { + toast({ + type: 'warning', + title: 'WROL Mode Enabled', + description: 'This cannot be done while WROL Mode is enabled.', + time: 5000, + }); + throw Error('WROL Mode enabled'); + } + if (response.status !== 204) { + toast({ + type: 'error', + title: 'Unexpected server response', + description: 'Failed to delete video. See server logs.', + time: 5000, + }); + throw Error('Failed to delete video'); + } +} + +export async function getDirectories(search_str) { + let form_data = {'search_str': search_str || null}; + let response = await apiPost(`${VIDEOS_API}/directories`, form_data); + if (response.status === 200) { + return (await response.json())['directories']; + } + return []; +} + +export async function getConfig() { + let response = await apiGet(`${API_URI}/settings`); + let data = await response.json(); + return data['config']; +} + +export async function saveConfig(config) { + return await apiPatch(`${API_URI}/settings`, config); +} + +export async function validateRegex(regex) { + let response = await apiPost(`${API_URI}/valid_regex`, {regex}); + return (await response.json())['valid']; +} + +export async function favoriteVideo(video_id, favorite) { + let body = {favorite: favorite, video_id}; + let response = await apiPost(`${VIDEOS_API}:favorite`, body); + return (await response.json())['favorite']; +} + +export async function getStatistics() { + let response = await apiGet(`${VIDEOS_API}/statistics`); + return (await response.json())['statistics']; +} + +export async function refresh() { + let response = await apiPost(`${VIDEOS_API}:refresh`); + return await response.json(); +} + +export async function download() { + let response = await apiPost(`${VIDEOS_API}:download`); + return await response.json(); +} + +export async function downloadChannel(link) { + let url = `${VIDEOS_API}:download/${link}`; + await fetch(url, {method: 'POST'}); +} + +export async function downloadHistory() { + let url = `${VIDEOS_API}/download_history`; + let resp = await apiGet(url); + return await resp.json(); +} + +export async function refreshChannel(link) { + let url = `${VIDEOS_API}:refresh/${link}`; + await fetch(url, {method: 'POST'}); +} + +export async function encryptOTP(otp, plaintext) { + let body = {otp, plaintext}; + let response = await apiPost(`${OTP_API}:encrypt_otp`, body); + if (response.status !== 200) { + toast({ + type: 'error', + title: 'Error!', + description: 'Failed to encrypt OTP', + time: 5000, + }); + return; + } + return await response.json(); +} + +export async function decryptOTP(otp, ciphertext) { + let body = {otp, ciphertext}; + let response = await apiPost(`${OTP_API}:decrypt_otp`, body); + if (response.status !== 200) { + toast({ + type: 'error', + title: 'Error!', + description: 'Failed to decrypt OTP', + time: 5000, + }); + return; + } + return await response.json(); +} + +export async function getCategories() { + let response = await apiGet(`${API_URI}/inventory/categories`); + return (await response.json())['categories']; +} + +export async function getBrands() { + let response = await apiGet(`${API_URI}/inventory/brands`); + return (await response.json())['brands']; +} + +export async function getInventories() { + let response = await apiGet(`${API_URI}/inventory`); + return (await response.json())['inventories']; +} + +export async function getInventory(inventoryId) { + let response = await apiGet(`${API_URI}/inventory/${inventoryId}`); + return await response.json(); +} + +export async function saveInventory(inventory) { + return await apiPost(`${API_URI}/inventory`, inventory); +} + +export async function updateInventory(inventoryId, inventory) { + delete inventory['id']; + return await apiPut(`${API_URI}/inventory/${inventoryId}`, inventory); +} + +export async function deleteInventory(inventoryId) { + return await apiDelete(`${API_URI}/inventory/${inventoryId}`); +} + +export async function getItems(inventoryId) { + let response = await apiGet(`${API_URI}/inventory/${inventoryId}/item`); + return await response.json(); +} + +export async function saveItem(inventoryId, item) { + return await apiPost(`${API_URI}/inventory/${inventoryId}/item`, item); +} + +export async function updateItem(itemId, item) { + return await apiPut(`${API_URI}/inventory/item/${itemId}`, item); +} + +export async function deleteItems(itemIds) { + let i = itemIds.join(','); + await apiDelete(`${API_URI}/inventory/item/${i}`); +} + +export async function postArchive(url) { + let i = {url: url}; + return await apiPost(`${API_URI}/archive`, i); +} + +export async function deleteArchive(url_id) { + return await apiDelete(`${API_URI}/archive/${url_id}`); +} + +export async function searchURLs(offset, limit, domain = null) { + // Build a search query to retrieve a list of videos from the API + offset = offset || 0; + limit = limit || DEFAULT_LIMIT; + let body = {offset, limit}; + if (domain) { + body['domain'] = domain; + } + + let response = await apiPost(`${ARCHIVES_API}/search`, body); + if (response.status === 200) { + let data = await response.json(); + return [data['urls'], data['totals']['urls']]; + } else { + throw Error(`Unable to search archives`); + } +} + +export async function refreshArchives() { + return await apiPost(`${ARCHIVES_API}:refresh`); +} + +export async function fetchDomains() { + let response = await apiGet(`${ARCHIVES_API}/domains`); + if (response.status === 200) { + let data = await response.json(); + return [data['domains'], data['totals']['domains']]; + } else { + throw Error(`Unable to fetch domains`); + } +} diff --git a/app/src/components/Admin.js b/app/src/components/Admin.js new file mode 100644 index 00000000..6e535e68 --- /dev/null +++ b/app/src/components/Admin.js @@ -0,0 +1,173 @@ +import React from 'react'; +import {Button, Checkbox, Container, Divider, Form, Header, Loader, Tab} from "semantic-ui-react"; +import {getConfig, saveConfig} from "../api"; +import TimezoneSelect from 'react-timezone-select'; + +class Settings extends React.Component { + + constructor(props) { + super(props); + this.state = { + disabled: false, + ready: false, + validTimezone: true, + timezone: '', + } + this.mediaDirectory = React.createRef(); + + this.handleSubmit = this.handleSubmit.bind(this); + } + + async componentDidMount() { + let config = await getConfig(); + this.setState({ + ready: true, + disabled: config.wrol_mode, + timezone: config.timezone || '', + }); + this.mediaDirectory.current.value = config.media_directory; + } + + async handleSubmit(e) { + e.preventDefault(); + let config = { + media_directory: this.mediaDirectory.current.value, + timezone: this.state.timezone.value, + }; + this.setState({validTimezone: true}); + let response = await saveConfig(config); + if (response.status !== 200) { + let json = await response.json(); + if (json.api_error === 'Invalid timezone') { + this.setState({validTimezone: false}); + } + } + } + + handleTimezoneChange = async (timezone) => { + this.setState({timezone}); + } + + render() { + if (this.state.ready === false) { + return + } + + return ( + +

+ The global settings for your server. +

+

+ When saved, these will be written to your local.yaml file. Storing these settings in your + local configuration file (rather than the database) allows your WROLPi to be rebuilt and save your + settings. +

+ +
+ + + + + + +

+ This directory must already exist. + The directory in which your media will be stored. Typically, this will be some external + drive like /media/wrolpi. +

+ + + + + + + + + + + +
+ ) + } +} + +class WROLMode extends React.Component { + + constructor(props) { + super(props); + this.state = { + WROLMode: false, + } + } + + async componentDidMount() { + let config = await getConfig(); + this.setState({ready: true, WROLMode: config.wrol_mode}); + } + + toggleWROLMode = async () => { + // Handle WROL Mode toggling by itself so that other settings are not modified. + let config = { + wrol_mode: !this.state.WROLMode, + } + await saveConfig(config); + this.setState({disabled: !this.state.WROLMode, WROLMode: !this.state.WROLMode}); + } + + render() { + if (this.state.ready === false) { + return + } + + return ( + + +
WROL Mode
+

+ Enable read-only mode. No content can be deleted or modified. Enable this when the SHTF and you + want to prevent any potential loss of data. +

+

+ Note: User settings and favorites can still be modified. +

+ + + + ) + } +} + +class Admin extends React.Component { + + render() { + + const panes = [ + {menuItem: 'Settings', render: () => }, + {menuItem: 'WROL Mode', render: () => }, + ]; + + return ( + + + + ) + } + +} + +export default Admin; diff --git a/app/src/components/Apps.js b/app/src/components/Apps.js new file mode 100644 index 00000000..ef318d50 --- /dev/null +++ b/app/src/components/Apps.js @@ -0,0 +1,156 @@ +import React from 'react'; +import {Button, Divider, Segment, TextArea} from "semantic-ui-react"; +import Container from "semantic-ui-react/dist/commonjs/elements/Container"; +import {Route} from "react-router-dom"; +import "../static/wrolpi.css"; +import {decryptOTP, encryptOTP} from "../api"; + +class Encrypt extends React.Component { + constructor(props) { + super(props); + this.state = { + otp: '', + plaintext: '', + ciphertext: '', + } + } + + handleSubmit = async (e) => { + e.preventDefault(); + let {otp, plaintext, ciphertext} = await encryptOTP(this.state.otp, this.state.plaintext); + this.setState({otp, plaintext, ciphertext}); + } + + handleInputChange = async (event, {name, value}) => { + this.setState({[name]: value}); + } + + render() { + return ( + <> +

Encrypt

+ + +

Key

+