diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e15770e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,3 @@ +- [ ] I agree to license my contribution under AGPL-3.0-only with my contribution automatically being licensed under LGPL-3.0 additionally after 6 months + +*** \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ced69af..77d24bc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,6 +15,8 @@ jobs: # Initialization - uses: actions/checkout@v3 - uses: actions/setup-node@v3 + with: + node-version: 18 - run: npm install - name: Run Tests timeout-minutes: 5 diff --git a/.github/workflows/eslint.yml b/.github/workflows/eslint.yml index a4b57b8..02902c1 100644 --- a/.github/workflows/eslint.yml +++ b/.github/workflows/eslint.yml @@ -15,6 +15,8 @@ jobs: # Initialization - uses: actions/checkout@v3 - uses: actions/setup-node@v3 + with: + node-version: 18 - run: npm install - name: Run Tests timeout-minutes: 5 diff --git a/.github/workflows/generate-sqlite-base.yml b/.github/workflows/generate-sqlite-base.yml index 2714dc7..f4bcf06 100644 --- a/.github/workflows/generate-sqlite-base.yml +++ b/.github/workflows/generate-sqlite-base.yml @@ -16,6 +16,8 @@ jobs: steps: - uses: actions/checkout@v3 - uses: actions/setup-node@v3 + with: + node-version: 18 - run: npm install - name: Set config run: | diff --git a/.github/workflows/postgres-redis-ci.yml b/.github/workflows/postgres-redis-ci.yml index 31ec50c..6963ab5 100644 --- a/.github/workflows/postgres-redis-ci.yml +++ b/.github/workflows/postgres-redis-ci.yml @@ -21,6 +21,8 @@ jobs: - name: Check running containers run: docker ps - uses: actions/setup-node@v3 + with: + node-version: 18 - run: npm install - name: Run Tests env: diff --git a/LICENSE b/LICENSE index 16c4d7f..be3f7b2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,661 @@ -MIT License + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 -Copyright (c) 2019 Ajay Ramachandran + 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. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + Preamble -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/LICENSE.old b/LICENSE.old new file mode 100644 index 0000000..6498262 --- /dev/null +++ b/LICENSE.old @@ -0,0 +1,27 @@ +License for code prior to commit d738e89f203e9cea21b7df4acb9f4b3505f0acdd + +You must follow LICENSE instead if you want to use any newer version. + +---- + +MIT License + +Copyright (c) 2019 Ajay Ramachandran + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.MD b/README.MD index 4be6058..c2f9564 100644 --- a/README.MD +++ b/README.MD @@ -35,3 +35,7 @@ If you want to make changes, run `npm run dev` to automatically reload the serve # API Docs Available [here](https://wiki.sponsor.ajay.app/index.php/API_Docs) + +# License + +This is licensed under AGPL-3.0-only. \ No newline at end of file diff --git a/ci.json b/ci.json index 5a3ee2f..1637b41 100644 --- a/ci.json +++ b/ci.json @@ -76,5 +76,6 @@ "clientSecret": "testClientSecret", "redirectUri": "http://127.0.0.1/fake/callback" }, - "minReputationToSubmitFiller": -1 + "minReputationToSubmitFiller": -1, + "minUserIDLength": 0 } diff --git a/config.json.example b/config.json.example index 2445ba9..7adefc2 100644 --- a/config.json.example +++ b/config.json.example @@ -66,5 +66,6 @@ { "name": "vipUsers" }] - } + }, + "minUserIDLength": 30 // minimum length of UserID to be accepted } diff --git a/package-lock.json b/package-lock.json index 2ed2143..8ab460a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,7 +7,7 @@ "": { "name": "sponsor_block_server", "version": "0.1.0", - "license": "MIT", + "license": "AGPL-3.0-only", "dependencies": { "axios": "^1.1.3", "better-sqlite3": "^8.0.1", @@ -3434,9 +3434,9 @@ "dev": true }, "node_modules/json5": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.1.tgz", - "integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==", + "version": "2.2.2", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.2.tgz", + "integrity": "sha512-46Tk9JiOL2z7ytNQWFLpj99RZkVgeHf87yGQKsIkaPz1qSH9UczKH1rO7K3wgRselo0tYMUNfecYpm/p1vC7tQ==", "dev": true, "bin": { "json5": "lib/cli.js" @@ -3518,9 +3518,9 @@ } }, "node_modules/luxon": { - "version": "1.28.0", - "resolved": "https://registry.npmjs.org/luxon/-/luxon-1.28.0.tgz", - "integrity": "sha512-TfTiyvZhwBYM/7QdAVDh+7dBTBA29v4ik0Ce9zda3Mnf8on1S5KJI8P2jKFZ8+5C0jhmr0KwJEO/Wdpm0VeWJQ==", + "version": "1.28.1", + "resolved": "https://registry.npmjs.org/luxon/-/luxon-1.28.1.tgz", + "integrity": "sha512-gYHAa180mKrNIUJCbwpmD0aTu9kV0dREDrwNnuyFAsO1Wt0EVYSZelPnJlbj9HplzXX/YWXHFTL45kvZ53M0pw==", "engines": { "node": "*" } @@ -8335,9 +8335,9 @@ "dev": true }, "json5": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.1.tgz", - "integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==", + "version": "2.2.2", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.2.tgz", + "integrity": "sha512-46Tk9JiOL2z7ytNQWFLpj99RZkVgeHf87yGQKsIkaPz1qSH9UczKH1rO7K3wgRselo0tYMUNfecYpm/p1vC7tQ==", "dev": true }, "just-extend": { @@ -8398,9 +8398,9 @@ } }, "luxon": { - "version": "1.28.0", - "resolved": "https://registry.npmjs.org/luxon/-/luxon-1.28.0.tgz", - "integrity": "sha512-TfTiyvZhwBYM/7QdAVDh+7dBTBA29v4ik0Ce9zda3Mnf8on1S5KJI8P2jKFZ8+5C0jhmr0KwJEO/Wdpm0VeWJQ==" + "version": "1.28.1", + "resolved": "https://registry.npmjs.org/luxon/-/luxon-1.28.1.tgz", + "integrity": "sha512-gYHAa180mKrNIUJCbwpmD0aTu9kV0dREDrwNnuyFAsO1Wt0EVYSZelPnJlbj9HplzXX/YWXHFTL45kvZ53M0pw==" }, "make-dir": { "version": "3.1.0", diff --git a/package.json b/package.json index d455689..c47f349 100644 --- a/package.json +++ b/package.json @@ -9,15 +9,15 @@ "cover:report": "nyc report", "dev": "nodemon", "dev:bash": "nodemon -x 'npm test ; npm start'", - "postgres:docker": "docker run --rm -p 5432:5432 -e POSTGRES_USER=ci_db_user -e POSTGRES_PASSWORD=ci_db_pass postgres:alpine", - "redis:docker": "docker run --rm -p 6379:6379 redis:alpine", + "postgres:docker": "docker run --rm -p 5432:5432 -e POSTGRES_USER=ci_db_user -e POSTGRES_PASSWORD=ci_db_pass postgres:14-alpine", + "redis:docker": "docker run --rm -p 6379:6379 redis:7-alpine --save '' --appendonly no", "start": "ts-node src/index.ts", "tsc": "tsc -p tsconfig.json", "lint": "eslint src test", "lint:fix": "eslint src test --fix" }, "author": "Ajay Ramachandran", - "license": "MIT", + "license": "AGPL-3.0-only", "dependencies": { "axios": "^1.1.3", "better-sqlite3": "^8.0.1", diff --git a/src/app.ts b/src/app.ts index 3827713..b58d326 100644 --- a/src/app.ts +++ b/src/app.ts @@ -1,7 +1,6 @@ import express, { Request, RequestHandler, Response, Router } from "express"; import { config } from "./config"; import { oldSubmitSponsorTimes } from "./routes/oldSubmitSponsorTimes"; -import { oldGetVideoSponsorTimes } from "./routes/oldGetVideoSponsorTimes"; import { postSegmentShift } from "./routes/postSegmentShift"; import { postWarning } from "./routes/postWarning"; import { getIsUserVIP } from "./routes/getIsUserVIP"; @@ -21,13 +20,13 @@ import { viewedVideoSponsorTime } from "./routes/viewedVideoSponsorTime"; import { voteOnSponsorTime, getUserID as voteGetUserID } from "./routes/voteOnSponsorTime"; import { getSkipSegmentsByHash } from "./routes/getSkipSegmentsByHash"; import { postSkipSegments } from "./routes/postSkipSegments"; -import { endpoint as getSkipSegments } from "./routes/getSkipSegments"; +import { getSkipSegments, oldGetVideoSponsorTimes } from "./routes/getSkipSegments"; import { userCounter } from "./middleware/userCounter"; import { loggerMiddleware } from "./middleware/logger"; import { corsMiddleware } from "./middleware/cors"; import { apiCspMiddleware } from "./middleware/apiCsp"; import { rateLimitMiddleware } from "./middleware/requestRateLimit"; -import dumpDatabase, { appExportPath, downloadFile } from "./routes/dumpDatabase"; +import dumpDatabase from "./routes/dumpDatabase"; import { endpoint as getSegmentInfo } from "./routes/getSegmentInfo"; import { postClearCache } from "./routes/postClearCache"; import { addUnlistedVideo } from "./routes/addUnlistedVideo"; @@ -52,6 +51,7 @@ import { generateTokenRequest } from "./routes/generateToken"; import { verifyTokenRequest } from "./routes/verifyToken"; import { getBranding, getBrandingByHashEndpoint } from "./routes/getBranding"; import { postBranding } from "./routes/postBranding"; +import { cacheMiddlware } from "./middleware/etag"; export function createServer(callback: () => void): Server { // Create a service (the app object is just a callback). @@ -59,11 +59,13 @@ export function createServer(callback: () => void): Server { const router = ExpressPromiseRouter(); app.use(router); + app.set("etag", false); // disable built in etag //setup CORS correctly router.use(corsMiddleware); router.use(loggerMiddleware); router.use("/api/", apiCspMiddleware); + router.use(cacheMiddlware); router.use(express.json()); if (config.userCounterURL) router.use(userCounter); diff --git a/src/config.ts b/src/config.ts index e8ae606..53e86f6 100644 --- a/src/config.ts +++ b/src/config.ts @@ -166,7 +166,8 @@ addDefaults(config, { }, gumroad: { productPermalinks: ["sponsorblock"] - } + }, + minUserIDLength: 30 }); loadFromEnv(config); migrate(config); diff --git a/src/middleware/cors.ts b/src/middleware/cors.ts index e3b71ab..6e5f2c2 100644 --- a/src/middleware/cors.ts +++ b/src/middleware/cors.ts @@ -3,6 +3,6 @@ import { NextFunction, Request, Response } from "express"; export function corsMiddleware(req: Request, res: Response, next: NextFunction): void { res.header("Access-Control-Allow-Origin", "*"); res.header("Access-Control-Allow-Methods", "GET, POST, OPTIONS, DELETE"); - res.header("Access-Control-Allow-Headers", "Content-Type"); + res.header("Access-Control-Allow-Headers", "Content-Type, If-None-Match"); next(); } diff --git a/src/middleware/etag.ts b/src/middleware/etag.ts new file mode 100644 index 0000000..826c305 --- /dev/null +++ b/src/middleware/etag.ts @@ -0,0 +1,49 @@ +import { NextFunction, Request, Response } from "express"; +import { VideoID, VideoIDHash, Service } from "../types/segments.model"; +import { QueryCacher } from "../utils/queryCacher"; +import { skipSegmentsHashKey, skipSegmentsKey, videoLabelsHashKey, videoLabelsKey } from "../utils/redisKeys"; + +type hashType = "skipSegments" | "skipSegmentsHash" | "videoLabel" | "videoLabelHash"; +type ETag = `${hashType};${VideoIDHash};${Service};${number}`; +type hashKey = string | VideoID | VideoIDHash; + +export function cacheMiddlware(req: Request, res: Response, next: NextFunction): void { + const reqEtag = req.get("If-None-Match") as string; + // if weak etag, do not handle + if (!reqEtag || reqEtag.startsWith("W/")) return next(); + // split into components + const [hashType, hashKey, service, lastModified] = reqEtag.split(";"); + // fetch last-modified + getLastModified(hashType as hashType, hashKey as VideoIDHash, service as Service) + .then(redisLastModified => { + if (redisLastModified <= new Date(Number(lastModified) + 1000)) { + // match cache, generate etag + const etag = `${hashType};${hashKey};${service};${redisLastModified.getTime()}` as ETag; + res.status(304).set("etag", etag).send(); + } + else next(); + }) + .catch(next); +} + +function getLastModified(hashType: hashType, hashKey: hashKey, service: Service): Promise { + let redisKey: string | null; + if (hashType === "skipSegments") redisKey = skipSegmentsKey(hashKey as VideoID, service); + else if (hashType === "skipSegmentsHash") redisKey = skipSegmentsHashKey(hashKey as VideoIDHash, service); + else if (hashType === "videoLabel") redisKey = videoLabelsKey(hashKey as VideoID, service); + else if (hashType === "videoLabelHash") redisKey = videoLabelsHashKey(hashKey as VideoIDHash, service); + else return Promise.reject(); + return QueryCacher.getKeyLastModified(redisKey); +} + +export async function getEtag(hashType: hashType, hashKey: hashKey, service: Service): Promise { + const lastModified = await getLastModified(hashType, hashKey, service); + return `${hashType};${hashKey};${service};${lastModified.getTime()}` as ETag; +} + +/* example usage +import { getEtag } from "../middleware/etag"; +await getEtag(hashType, hashPrefix, service) + .then(etag => res.set("ETag", etag)) + .catch(() => null); +*/ \ No newline at end of file diff --git a/src/routes/getSkipSegments.ts b/src/routes/getSkipSegments.ts index 4dfe589..2a72dca 100644 --- a/src/routes/getSkipSegments.ts +++ b/src/routes/getSkipSegments.ts @@ -12,7 +12,8 @@ import { QueryCacher } from "../utils/queryCacher"; import { getReputation } from "../utils/reputation"; import { getService } from "../utils/getService"; import { promiseOrTimeout } from "../utils/promise"; - +import { parseSkipSegments } from "../utils/parseSkipSegments"; +import { getEtag } from "../middleware/etag"; async function prepareCategorySegments(req: Request, videoID: VideoID, service: Service, segments: DBSegment[], cache: SegmentCache = { shadowHiddenSegmentIPs: {} }, useCache: boolean): Promise { const shouldFilter: boolean[] = await Promise.all(segments.map(async (segment) => { @@ -86,9 +87,6 @@ async function getSegmentsByVideoID(req: Request, videoID: VideoID, categories: } try { - categories = categories.filter((category) => !/[^a-z|_|-]/.test(category)); - if (categories.length === 0) return null; - const segments: DBSegment[] = (await getSegmentsFromDBByVideoID(videoID, service)) .map((segment: DBSegment) => { if (filterRequiredSegments(segment.UUID, requiredSegments)) segment.required = true; @@ -97,7 +95,17 @@ async function getSegmentsByVideoID(req: Request, videoID: VideoID, categories: const canUseCache = requiredSegments.length === 0; let processedSegments: Segment[] = (await prepareCategorySegments(req, videoID, service, segments, cache, canUseCache)) - .filter((segment: Segment) => categories.includes(segment?.category) && (actionTypes.includes(segment?.actionType))); + .filter((segment: Segment) => categories.includes(segment?.category) && (actionTypes.includes(segment?.actionType))) + .map((segment: Segment) => ({ + category: segment.category, + actionType: segment.actionType, + segment: segment.segment, + UUID: segment.UUID, + videoDuration: segment.videoDuration, + locked: segment.locked, + votes: segment.votes, + description: segment.description + })); if (forcePoiAsSkip) { processedSegments = processedSegments.map((segment) => ({ @@ -127,15 +135,11 @@ async function getSegmentsByHash(req: Request, hashedVideoIDPrefix: VideoIDHash, } try { - type SegmentWithHashPerVideoID = SBRecord; + type SegmentPerVideoID = SBRecord; - categories = categories.filter((category) => !(/[^a-z|_|-]/.test(category))); - if (categories.length === 0) return null; - - const segmentPerVideoID: SegmentWithHashPerVideoID = (await getSegmentsFromDBByHash(hashedVideoIDPrefix, service)) - .reduce((acc: SegmentWithHashPerVideoID, segment: DBSegment) => { + const segmentPerVideoID: SegmentPerVideoID = (await getSegmentsFromDBByHash(hashedVideoIDPrefix, service)) + .reduce((acc: SegmentPerVideoID, segment: DBSegment) => { acc[segment.videoID] = acc[segment.videoID] || { - hash: segment.hashedVideoID, segments: [] }; if (filterRequiredSegments(segment.UUID, requiredSegments)) segment.required = true; @@ -148,13 +152,22 @@ async function getSegmentsByHash(req: Request, hashedVideoIDPrefix: VideoIDHash, await Promise.all(Object.entries(segmentPerVideoID).map(async ([videoID, videoData]) => { const data: VideoData = { - hash: videoData.hash, segments: [], }; const canUseCache = requiredSegments.length === 0; data.segments = (await prepareCategorySegments(req, videoID as VideoID, service, videoData.segments, cache, canUseCache)) - .filter((segment: Segment) => categories.includes(segment?.category) && actionTypes.includes(segment?.actionType)); + .filter((segment: Segment) => categories.includes(segment?.category) && actionTypes.includes(segment?.actionType)) + .map((segment) => ({ + category: segment.category, + actionType: segment.actionType, + segment: segment.segment, + UUID: segment.UUID, + videoDuration: segment.videoDuration, + locked: segment.locked, + votes: segment.votes, + description: segment.description + })); if (forcePoiAsSkip) { data.segments = data.segments.map((segment) => ({ @@ -378,75 +391,59 @@ function splitPercentOverlap(groups: OverlappingSegmentGroup[]): OverlappingSegm }); } -/** - * - * Returns what would be sent to the client. - * Will respond with errors if required. Returns false if it errors. - * - * @param req - * @param res - * - * @returns - */ -async function handleGetSegments(req: Request, res: Response): Promise { +async function getSkipSegments(req: Request, res: Response): Promise { const videoID = req.query.videoID as VideoID; if (!videoID) { - res.status(400).send("videoID not specified"); - return false; - } - // Default to sponsor - // If using params instead of JSON, only one category can be pulled - const categories: Category[] = req.query.categories - ? JSON.parse(req.query.categories as string) - : req.query.category - ? Array.isArray(req.query.category) - ? req.query.category - : [req.query.category] - : ["sponsor"]; - if (!Array.isArray(categories)) { - res.status(400).send("Categories parameter does not match format requirements."); - return false; + return res.status(400).send("videoID not specified"); } - const actionTypes: ActionType[] = req.query.actionTypes - ? JSON.parse(req.query.actionTypes as string) - : req.query.actionType - ? Array.isArray(req.query.actionType) - ? req.query.actionType - : [req.query.actionType] - : [ActionType.Skip]; - if (!Array.isArray(actionTypes)) { - res.status(400).send("actionTypes parameter does not match format requirements."); - return false; + const parseResult = parseSkipSegments(req); + if (parseResult.errors.length > 0) { + return res.status(400).send(parseResult.errors); } - const requiredSegments: SegmentUUID[] = req.query.requiredSegments - ? JSON.parse(req.query.requiredSegments as string) - : req.query.requiredSegment - ? Array.isArray(req.query.requiredSegment) - ? req.query.requiredSegment - : [req.query.requiredSegment] - : []; - if (!Array.isArray(requiredSegments)) { - res.status(400).send("requiredSegments parameter does not match format requirements."); - return false; - } - - const service = getService(req.query.service, req.body.service); - + const { categories, actionTypes, requiredSegments, service } = parseResult; const segments = await getSegmentsByVideoID(req, videoID, categories, actionTypes, requiredSegments, service); if (segments === null || segments === undefined) { - res.sendStatus(500); - return false; + return res.sendStatus(500); + } else if (segments.length === 0) { + return res.sendStatus(404); } - if (segments.length === 0) { - res.sendStatus(404); - return false; + await getEtag("skipSegments", (videoID as string), service) + .then(etag => res.set("ETag", etag)) + .catch(() => null); + return res.send(segments); +} + +async function oldGetVideoSponsorTimes(req: Request, res: Response): Promise { + const videoID = req.query.videoID as VideoID; + if (!videoID) { + return res.status(400).send("videoID not specified"); } - return segments; + const segments = await getSegmentsByVideoID(req, videoID, ["sponsor"] as Category[], [ActionType.Skip], [], Service.YouTube); + + if (segments === null || segments === undefined) { + return res.sendStatus(500); + } else if (segments.length === 0) { + return res.sendStatus(404); + } + + // Convert to old outputs + const sponsorTimes = []; + const UUIDs = []; + + for (const segment of segments) { + sponsorTimes.push(segment.segment); + UUIDs.push(segment.UUID); + } + + return res.send({ + sponsorTimes, + UUIDs, + }); } const filterRequiredSegments = (UUID: SegmentUUID, requiredSegments: SegmentUUID[]): boolean => { @@ -456,25 +453,9 @@ const filterRequiredSegments = (UUID: SegmentUUID, requiredSegments: SegmentUUID return false; }; -async function endpoint(req: Request, res: Response): Promise { - try { - const segments = await handleGetSegments(req, res); - - // If false, res.send has already been called - if (segments) { - //send result - return res.send(segments); - } - } catch (err) /* istanbul ignore next */ { - if (err instanceof SyntaxError) { - return res.status(400).send("Categories parameter does not match format requirements."); - } else return res.sendStatus(500); - } -} - export { getSegmentsByVideoID, getSegmentsByHash, - endpoint, - handleGetSegments + getSkipSegments, + oldGetVideoSponsorTimes }; diff --git a/src/routes/getSkipSegmentsByHash.ts b/src/routes/getSkipSegmentsByHash.ts index d6ea9de..eaf7f97 100644 --- a/src/routes/getSkipSegmentsByHash.ts +++ b/src/routes/getSkipSegmentsByHash.ts @@ -1,9 +1,10 @@ import { hashPrefixTester } from "../utils/hashPrefixTester"; import { getSegmentsByHash } from "./getSkipSegments"; import { Request, Response } from "express"; -import { ActionType, Category, SegmentUUID, VideoIDHash, Service } from "../types/segments.model"; -import { getService } from "../utils/getService"; +import { VideoIDHash } from "../types/segments.model"; import { Logger } from "../utils/logger"; +import { parseSkipSegments } from "../utils/parseSkipSegments"; +import { getEtag } from "../middleware/etag"; export async function getSkipSegmentsByHash(req: Request, res: Response): Promise { let hashPrefix = req.params.prefix as VideoIDHash; @@ -12,66 +13,21 @@ export async function getSkipSegmentsByHash(req: Request, res: Response): Promis } hashPrefix = hashPrefix.toLowerCase() as VideoIDHash; - let categories: Category[] = []; - try { - categories = req.query.categories - ? JSON.parse(req.query.categories as string) - : req.query.category - ? Array.isArray(req.query.category) - ? req.query.category - : [req.query.category] - : ["sponsor"]; - if (!Array.isArray(categories)) { - return res.status(400).send("Categories parameter does not match format requirements."); - } - } catch(error) { - return res.status(400).send("Bad parameter: categories (invalid JSON)"); + const parseResult = parseSkipSegments(req); + if (parseResult.errors.length > 0) { + return res.status(400).send(parseResult.errors); } - - let actionTypes: ActionType[] = []; - try { - actionTypes = req.query.actionTypes - ? JSON.parse(req.query.actionTypes as string) - : req.query.actionType - ? Array.isArray(req.query.actionType) - ? req.query.actionType - : [req.query.actionType] - : [ActionType.Skip]; - if (!Array.isArray(actionTypes)) { - return res.status(400).send("actionTypes parameter does not match format requirements."); - } - } catch(error) { - return res.status(400).send("Bad parameter: actionTypes (invalid JSON)"); - } - - let requiredSegments: SegmentUUID[] = []; - try { - requiredSegments = req.query.requiredSegments - ? JSON.parse(req.query.requiredSegments as string) - : req.query.requiredSegment - ? Array.isArray(req.query.requiredSegment) - ? req.query.requiredSegment - : [req.query.requiredSegment] - : []; - if (!Array.isArray(requiredSegments)) { - return res.status(400).send("requiredSegments parameter does not match format requirements."); - } - } catch(error) { - return res.status(400).send("Bad parameter: requiredSegments (invalid JSON)"); - } - - const service: Service = getService(req.query.service, req.body.service); - - // filter out none string elements, only flat array with strings is valid - categories = categories.filter((item: any) => typeof item === "string"); + const { categories, actionTypes, requiredSegments, service } = parseResult; // Get all video id's that match hash prefix const segments = await getSegmentsByHash(req, hashPrefix, categories, actionTypes, requiredSegments, service); try { + await getEtag("skipSegmentsHash", hashPrefix, service) + .then(etag => res.set("ETag", etag)) + .catch(() => null); const output = Object.entries(segments).map(([videoID, data]) => ({ videoID, - hash: data.hash, segments: data.segments, })); return res.status(output.length === 0 ? 404 : 200).json(output); diff --git a/src/routes/getVideoLabel.ts b/src/routes/getVideoLabel.ts index 02ba7c5..ccd17f5 100644 --- a/src/routes/getVideoLabel.ts +++ b/src/routes/getVideoLabel.ts @@ -54,7 +54,6 @@ async function getLabelsByHash(hashedVideoIDPrefix: VideoIDHash, service: Servic for (const [videoID, videoData] of Object.entries(segmentPerVideoID)) { const data: VideoData = { - hash: videoData.hash, segments: chooseSegment(videoData.segments), }; diff --git a/src/routes/getVideoLabelByHash.ts b/src/routes/getVideoLabelByHash.ts index e3a3615..23ba053 100644 --- a/src/routes/getVideoLabelByHash.ts +++ b/src/routes/getVideoLabelByHash.ts @@ -20,7 +20,6 @@ export async function getVideoLabelsByHash(req: Request, res: Response): Promise const output = Object.entries(segments).map(([videoID, data]) => ({ videoID, - hash: data.hash, segments: data.segments, })); return res.status(output.length === 0 ? 404 : 200).json(output); diff --git a/src/routes/oldGetVideoSponsorTimes.ts b/src/routes/oldGetVideoSponsorTimes.ts deleted file mode 100644 index 90a58ae..0000000 --- a/src/routes/oldGetVideoSponsorTimes.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { handleGetSegments } from "./getSkipSegments"; -import { Request, Response } from "express"; - -export async function oldGetVideoSponsorTimes(req: Request, res: Response): Promise { - const segments = await handleGetSegments(req, res); - - if (segments) { - // Convert to old outputs - const sponsorTimes = []; - const UUIDs = []; - - for (const segment of segments) { - sponsorTimes.push(segment.segment); - UUIDs.push(segment.UUID); - } - - return res.send({ - sponsorTimes, - UUIDs, - }); - } - - // Error has already been handled in the other method -} diff --git a/src/routes/postSkipSegments.ts b/src/routes/postSkipSegments.ts index aaf8eda..069aa5a 100644 --- a/src/routes/postSkipSegments.ts +++ b/src/routes/postSkipSegments.ts @@ -22,6 +22,7 @@ import axios from "axios"; import { vote } from "./voteOnSponsorTime"; import { canSubmit } from "../utils/permissions"; import { getVideoDetails, videoDetails } from "../utils/getVideoDetails"; +import * as youtubeID from "../utils/youtubeID"; type CheckResult = { pass: boolean, @@ -185,15 +186,23 @@ async function checkUserActiveWarning(userID: string): Promise { } async function checkInvalidFields(videoID: VideoID, userID: UserID, hashedUserID: HashedUserID - , segments: IncomingSegment[], videoDurationParam: number, userAgent: string): Promise { + , segments: IncomingSegment[], videoDurationParam: number, userAgent: string, service: Service): Promise { const invalidFields = []; const errors = []; if (typeof videoID !== "string" || videoID?.length == 0) { invalidFields.push("videoID"); } - if (typeof userID !== "string" || userID?.length < 30) { + if (service === Service.YouTube && config.mode !== "test") { + const sanitizedVideoID = youtubeID.validate(videoID) ? videoID : youtubeID.sanitize(videoID); + if (!youtubeID.validate(sanitizedVideoID)) { + invalidFields.push("videoID"); + errors.push("YouTube videoID could not be extracted"); + } + } + const minLength = config.minUserIDLength; + if (typeof userID !== "string" || userID?.length < minLength) { invalidFields.push("userID"); - if (userID?.length < 30) errors.push(`userID must be at least 30 characters long`); + if (userID?.length < minLength) errors.push(`userID must be at least ${minLength} characters long`); } if (!Array.isArray(segments) || segments.length == 0) { invalidFields.push("segments"); @@ -335,7 +344,7 @@ async function checkByAutoModerator(videoID: any, userID: any, segments: Array { + const userIDHash = await getHashCache(userID); + const userNameHash = await getHashCache(username); + if (userIDHash == userNameHash) return false; + const sponsorTimeRow = await db.prepare("get", `SELECT "userID" FROM "sponsorTimes" WHERE "userID" = ? LIMIT 1`, [userNameHash]); + const userNameRow = await db.prepare("get", `SELECT "userID" FROM "userNames" WHERE "userID" = ? LIMIT 1`, [userNameHash]); + if ((sponsorTimeRow || userNameRow)?.userID) return false; + return true; +} \ No newline at end of file diff --git a/src/routes/viewedVideoSponsorTime.ts b/src/routes/viewedVideoSponsorTime.ts index f111cab..168a92d 100644 --- a/src/routes/viewedVideoSponsorTime.ts +++ b/src/routes/viewedVideoSponsorTime.ts @@ -2,9 +2,9 @@ import { db } from "../databases/databases"; import { Request, Response } from "express"; export async function viewedVideoSponsorTime(req: Request, res: Response): Promise { - const UUID = req.query.UUID; + const UUID = req.query?.UUID; - if (UUID == undefined) { + if (!UUID) { //invalid request return res.sendStatus(400); } diff --git a/src/routes/voteOnSponsorTime.ts b/src/routes/voteOnSponsorTime.ts index bbda1e2..186c8f9 100644 --- a/src/routes/voteOnSponsorTime.ts +++ b/src/routes/voteOnSponsorTime.ts @@ -325,7 +325,7 @@ export async function vote(ip: IPAddress, UUID: SegmentUUID, paramUserID: UserID return { status: 400 }; } // Ignore this vote, invalid - if (paramUserID.length < 30 && config.mode !== "test") { + if (paramUserID.length < config.minUserIDLength) { return { status: 200 }; } diff --git a/src/types/config.model.ts b/src/types/config.model.ts index 3f7e1ae..058048e 100644 --- a/src/types/config.model.ts +++ b/src/types/config.model.ts @@ -94,7 +94,8 @@ export interface SBSConfig { } gumroad: { productPermalinks: string[], - } + }, + minUserIDLength: number } export interface WebhookConfig { diff --git a/src/types/segments.model.ts b/src/types/segments.model.ts index 47be636..8e7a785 100644 --- a/src/types/segments.model.ts +++ b/src/types/segments.model.ts @@ -45,6 +45,9 @@ export interface Segment { segment: number[]; UUID: SegmentUUID; videoDuration: VideoDuration; + locked: boolean; + votes: number; + description: string; } export enum Visibility { @@ -94,7 +97,6 @@ export interface VotableObjectWithWeight extends VotableObject { } export interface VideoData { - hash: VideoIDHash; segments: Segment[]; } diff --git a/src/utils/getSubmissionUUID.ts b/src/utils/getSubmissionUUID.ts index 89a525c..aafec80 100644 --- a/src/utils/getSubmissionUUID.ts +++ b/src/utils/getSubmissionUUID.ts @@ -7,10 +7,11 @@ export function getSubmissionUUID( videoID: VideoID, category: Category, actionType: ActionType, + description: string, userID: UserID, startTime: number, endTime: number, service: Service ) : HashedValue { - return `${getHash(`${videoID}${startTime}${endTime}${userID}${category}${actionType}${service}`, 1)}6` as HashedValue; + return `${getHash(`${videoID}${startTime}${endTime}${userID}${description}${category}${actionType}${service}`, 1)}7` as HashedValue; } diff --git a/src/utils/innerTubeAPI.ts b/src/utils/innerTubeAPI.ts index 9361a8d..dbdd728 100644 --- a/src/utils/innerTubeAPI.ts +++ b/src/utils/innerTubeAPI.ts @@ -34,7 +34,7 @@ async function getFromITube (videoID: string): Promise { context: { client: { clientName: "WEB", - clientVersion: "2.20211129.09.00" + clientVersion: "2.20221215.04.01" } }, videoId: videoID diff --git a/src/utils/parseSkipSegments.ts b/src/utils/parseSkipSegments.ts new file mode 100644 index 0000000..f9e5b96 --- /dev/null +++ b/src/utils/parseSkipSegments.ts @@ -0,0 +1,75 @@ +import { Request } from "express"; +import { ActionType, SegmentUUID, Category, Service } from "../types/segments.model"; +import { getService } from "./getService"; + +type fn = (req: Request) => any[]; + +const syntaxErrorWrapper = (fn: fn, req: Request) => { + try { return fn(req); } + catch (e) { return undefined; } +}; + +// Default to sponsor +const getCategories = (req: Request): Category[] => + req.query.categories + ? JSON.parse(req.query.categories as string) + : req.query.category + ? Array.isArray(req.query.category) + ? req.query.category + : [req.query.category] + : ["sponsor"]; + +// Default to skip +const getActionTypes = (req: Request): ActionType[] => + req.query.actionTypes + ? JSON.parse(req.query.actionTypes as string) + : req.query.actionType + ? Array.isArray(req.query.actionType) + ? req.query.actionType + : [req.query.actionType] + : [ActionType.Skip]; + +// Default to empty array +const getRequiredSegments = (req: Request): SegmentUUID[] => + req.query.requiredSegments + ? JSON.parse(req.query.requiredSegments as string) + : req.query.requiredSegment + ? Array.isArray(req.query.requiredSegment) + ? req.query.requiredSegment + : [req.query.requiredSegment] + : []; + +const errorMessage = (parameter: string) => `${parameter} parameter does not match format requirements.`; + +export function parseSkipSegments(req: Request): { + categories: Category[]; + actionTypes: ActionType[]; + requiredSegments: SegmentUUID[]; + service: Service; + errors: string[]; +} { + let categories: Category[] = syntaxErrorWrapper(getCategories, req); + const actionTypes: ActionType[] = syntaxErrorWrapper(getActionTypes, req); + const requiredSegments: SegmentUUID[] = syntaxErrorWrapper(getRequiredSegments, req); + const service: Service = getService(req.query.service, req.body.services); + const errors: string[] = []; + if (!Array.isArray(categories)) errors.push(errorMessage("categories")); + else { + // check category names for invalid characters + // and none string elements + categories = categories + .filter((item: any) => typeof item === "string") + .filter((category) => !(/[^a-z|_|-]/.test(category))); + if (categories.length === 0) errors.push("No valid categories provided."); + } + if (!Array.isArray(actionTypes)) errors.push(errorMessage("actionTypes")); + if (!Array.isArray(requiredSegments)) errors.push(errorMessage("requiredSegments")); + // finished parsing + return { + categories, + actionTypes, + requiredSegments, + service, + errors + }; +} \ No newline at end of file diff --git a/src/utils/queryCacher.ts b/src/utils/queryCacher.ts index 1b3f6a1..6b02268 100644 --- a/src/utils/queryCacher.ts +++ b/src/utils/queryCacher.ts @@ -87,6 +87,17 @@ function clearSegmentCache(videoInfo: { videoID: VideoID; hashedVideoID: VideoID } } +async function getKeyLastModified(key: string): Promise { + if (!config.redis?.enabled) return Promise.reject("ETag - Redis not enabled"); + return await redis.ttl(key) + .then(ttl => { + const sinceLive = config.redis?.expiryTime - ttl; + const now = Math.floor(Date.now() / 1000); + return new Date((now-sinceLive) * 1000); + }) + .catch(() => Promise.reject("ETag - Redis error")); +} + function clearRatingCache(videoInfo: { hashedVideoID: VideoIDHash; service: Service;}): void { if (videoInfo) { redis.del(ratingHashKey(videoInfo.hashedVideoID, videoInfo.service)).catch((err) => Logger.error(err)); @@ -101,6 +112,7 @@ export const QueryCacher = { get, getAndSplit, clearSegmentCache, + getKeyLastModified, clearRatingCache, - clearFeatureCache + clearFeatureCache, }; \ No newline at end of file diff --git a/src/utils/redis.ts b/src/utils/redis.ts index 01761ae..ef55906 100644 --- a/src/utils/redis.ts +++ b/src/utils/redis.ts @@ -19,6 +19,7 @@ interface RedisSB { del(...keys: [RedisCommandArgument]): Promise; increment?(key: RedisCommandArgument): Promise; sendCommand(args: RedisCommandArguments, options?: RedisClientOptions): Promise; + ttl(key: RedisCommandArgument): Promise; quit(): Promise; } @@ -30,6 +31,7 @@ let exportClient: RedisSB = { increment: () => new Promise((resolve) => resolve(null)), sendCommand: () => new Promise((resolve) => resolve(null)), quit: () => new Promise((resolve) => resolve(null)), + ttl: () => new Promise((resolve) => resolve(null)), }; let lastClientFail = 0; diff --git a/src/utils/youtubeID.ts b/src/utils/youtubeID.ts new file mode 100644 index 0000000..d825d70 --- /dev/null +++ b/src/utils/youtubeID.ts @@ -0,0 +1,26 @@ +import { VideoID } from "../types/segments.model"; + +const idRegex = new RegExp(/([0-9A-Za-z_-]{11})/); // group to always be index 1 +const exclusiveIdegex = new RegExp(`^${idRegex.source}$`); +// match /c/, /channel/, /@channel, full UUIDs +const negativeRegex = new RegExp(/(\/(channel|c)\/.+)|(\/@.+)|([a-f0-9]{64,65})|(youtube\.com\/clip\/)/); +const urlRegex = new RegExp(`(?:v=|/|youtu.be/)${idRegex.source}(?:|/|[?&]t=\\d+s?)>?(?:\\s|$)`); +const negateIdRegex = new RegExp(/(?:[^0-9A-Za-z_-]*?)/); +const looseEndsRegex = new RegExp(`${negateIdRegex.source}${idRegex.source}${negateIdRegex.source}`); + +export const validate = (id: string): boolean => exclusiveIdegex.test(id); + +export const sanitize = (id: string): VideoID | null => { + // first decode URI + id = decodeURIComponent(id); + // strict matching + const strictMatch = id.match(exclusiveIdegex)?.[1]; + const urlMatch = id.match(urlRegex)?.[1]; + // return match, if not negative, return looseMatch + const looseMatch = id.match(looseEndsRegex)?.[1]; + return strictMatch ? (strictMatch as VideoID) + : negativeRegex.test(id) ? null + : urlMatch ? (urlMatch as VideoID) + : looseMatch ? (looseMatch as VideoID) + : null; +}; \ No newline at end of file diff --git a/test.json b/test.json index 16ace5c..fef8052 100644 --- a/test.json +++ b/test.json @@ -64,5 +64,6 @@ "clientSecret": "testClientSecret", "redirectUri": "http://127.0.0.1/fake/callback" }, - "minReputationToSubmitFiller": -1 + "minReputationToSubmitFiller": -1, + "minUserIDLength": 0 } diff --git a/test/cases/environment.ts b/test/cases/environment.ts new file mode 100644 index 0000000..a0a6d88 --- /dev/null +++ b/test/cases/environment.ts @@ -0,0 +1,12 @@ +import assert from "assert"; +import { config } from "../../src/config"; + +describe("environment", () => { + it("minUserIDLength should be < 10", () => { + assert(config.minUserIDLength < 10); + }); + it("nodeJS major version should be >= 16", () => { + const [major] = process.versions.node.split(".").map(i => parseInt(i)); + assert(major >= 16); + }); +}); diff --git a/test/cases/getSkipSegments.ts b/test/cases/getSkipSegments.ts index b252f11..f89b778 100644 --- a/test/cases/getSkipSegments.ts +++ b/test/cases/getSkipSegments.ts @@ -46,7 +46,6 @@ describe("getSkipSegments", () => { assert.strictEqual(data[0].votes, 1); assert.strictEqual(data[0].locked, 0); assert.strictEqual(data[0].videoDuration, 100); - assert.strictEqual(data[0].userID, "testman"); done(); }) .catch(err => done(err)); diff --git a/test/cases/getSubmissionUUID.ts b/test/cases/getSubmissionUUID.ts index e15044f..93d6ae3 100644 --- a/test/cases/getSubmissionUUID.ts +++ b/test/cases/getSubmissionUUID.ts @@ -6,7 +6,7 @@ import { UserID } from "../../src/types/user.model"; describe("getSubmissionUUID", () => { it("Should return the hashed value", () => { assert.strictEqual( - getSubmissionUUID("video001" as VideoID, "sponsor" as Category, "skip" as ActionType, "testuser001" as UserID, 13.33337, 42.000001, Service.YouTube), - "2a473bca993dd84d8c2f6a4785989b20948dfe0c12c00f6f143bbda9ed561dca6"); + getSubmissionUUID("video001" as VideoID, "sponsor" as Category, "skip" as ActionType, "", "testuser001" as UserID, 13.33337, 42.000001, Service.YouTube), + "2a473bca993dd84d8c2f6a4785989b20948dfe0c12c00f6f143bbda9ed561dca7"); }); }); diff --git a/test/cases/setUsername.ts b/test/cases/setUsername.ts index 39a518b..a3da56c 100644 --- a/test/cases/setUsername.ts +++ b/test/cases/setUsername.ts @@ -22,12 +22,22 @@ const user07PrivateUserID = "setUsername_07"; const username07 = "Username 07"; const user08PrivateUserID = "setUsername_08"; +// private = public cases +// user09 - username === privateID +const user09PrivateUserID = "setUsername_09"; +// user 10/11 - user 11 username === user 10 privateID +const user10PrivateUserID = "setUsername_10_collision"; +const username10 = "setUsername_10"; +const user11PrivateUserID = "setUsername_11"; +const user12PrivateUserID = "setUsername_12"; +const username12 = "Username 12"; + async function addUsername(userID: string, userName: string, locked = 0) { await db.prepare("run", 'INSERT INTO "userNames" ("userID", "userName", "locked") VALUES(?, ?, ?)', [userID, userName, locked]); await addLogUserNameChange(userID, userName); } -async function getUsernameInfo(userID: string): Promise<{ userName: string, locked: string }> { +async function getUsernameInfo(userID: string): Promise<{ userName: string, locked: string}> { const row = await db.prepare("get", 'SELECT "userName", "locked" FROM "userNames" WHERE "userID" = ?', [userID]); if (!row) { return null; @@ -88,6 +98,9 @@ describe("setUsername", () => { await addUsername(getHash(user05PrivateUserID), username05, 0); await addUsername(getHash(user06PrivateUserID), username06, 0); await addUsername(getHash(user07PrivateUserID), username07, 1); + await addUsername(getHash(user10PrivateUserID), username10, 0); + // user11 skipped + await addUsername(getHash(user12PrivateUserID), username12, 0); }); it("Should be able to set username that has never been set", (done) => { @@ -240,6 +253,44 @@ describe("setUsername", () => { const usernameInfo = await getUsernameInfo(getHash(user08PrivateUserID)); assert.strictEqual(usernameInfo, null); done(); - }); + }) + .catch((err) => done(err)); + }); + + it("Should return error if trying to set username to privateID", (done) => { + const privateID = user09PrivateUserID; + postSetUserName(privateID, privateID) + .then(async (res) => { + assert.strictEqual(res.status, 400); + const usernameInfo = await getUsernameInfo(getHash(privateID)); + assert.strictEqual(usernameInfo, null); + done(); + }) + .catch((err) => done(err)); + }); + + it("Should return error if trying to set username to someone else's privateID", (done) => { + const privateID = user11PrivateUserID; + postSetUserName(privateID, user10PrivateUserID) + .then(async (res) => { + assert.strictEqual(res.status, 400); + const usernameInfo = await getUsernameInfo(getHash(privateID)); // user 10's privateID + assert.strictEqual(usernameInfo, null); + done(); + }) + .catch((err) => done(err)); + }); + + it("Should not return error if trying to set username to someone else's publicID", (done) => { + const privateID = user12PrivateUserID; + const user10PublicID = getHash(user10PrivateUserID); + postSetUserName(privateID, user10PublicID) + .then(async (res) => { + assert.strictEqual(res.status, 200); + const usernameInfo = await getUsernameInfo(getHash(privateID)); // user 10's publicID + assert.strictEqual(usernameInfo.userName, user10PublicID); + done(); + }) + .catch((err) => done(err)); }); }); diff --git a/test/cases/validateVideoIDs.ts b/test/cases/validateVideoIDs.ts new file mode 100644 index 0000000..dc1c62d --- /dev/null +++ b/test/cases/validateVideoIDs.ts @@ -0,0 +1,125 @@ +import assert from "assert"; +import { client } from "../utils/httpClient"; +import { config } from "../../src/config"; +import sinon from "sinon"; +import { sanitize } from "../../src/utils/youtubeID"; + +// videoID array +const badVideoIDs = [ + ["null", "< 11"], + ["dQw4w9WgXc?", "invalid characters"], + ["https://www.youtube.com/clip/UgkxeLPGsmKnMdm46DGml_0aa0aaAAAAA00a", "clip URL"], + ["https://youtube.com/channel/UCaAa00aaaAA0a0a0AaaAAAA", "channel ID (UC)"], + ["https://www.youtube.com/@LinusTechTips", "channel @username"], + ["https://www.youtube.com/@GamersNexus", "channel @username"], + ["https://www.youtube.com/c/LinusTechTips", "custom channel /c/"], + ["https://www.youtube.com/c/GamersNexus", "custom channel /c/"], + ["https://www.youtube.com/", "home/ page URL"], + ["03224876b002487796379942f199bc22ffac46157ad2488119bccc7b03c55430","UUID"], + ["https://www.youtube.com/watch?v=dQw4w9WgXcQ&t=16s#requiredSegment=03224876b002487796379942f199bc22ffac46157ad2488119bccc7b03c55430", "full #requiredSegments uuid"], + ["","empty videoID"] + +]; +const goodVideoIDs = [ + ["dQw4w9WgXcQ", "standalone videoID"], + ["https://www.youtube.com/watch?v=dQw4w9WgXcQ", "?watch link"], + ["http://www.youtube.com/watch?v=dQw4w9WgXcQ", "http link"], + ["www.youtube.com/watch?v=dQw4w9WgXcQ", "no protocol link"], + ["https://www.youtube.com/watch?v=dQw4w9WgXcQ?t=2", "trailing &t parameter"], + ["https://youtu.be/dQw4w9WgXcQ","youtu.be"], + ["youtu.be/dQw4w9WgXcQ","no protocol youtu.be"], + ["https://www.youtube.com/watch?v=dQw4w9WgXcQ&t=16s#requiredSegment=00000000000","#requiredsegment link"], + ["https://www.youtube.com/embed/dQw4w9WgXcQ?wmode=transparent&rel=0&autohide=1&showinfo=1&fs=1&enablejsapi=0&theme=light", "long embedded link"], + ["http://m.youtube.com/watch?v=dQw4w9WgXcQ&app=m&persist_app=1", "force persist desktop"], + ["http://m.youtube.com/watch?v=dQw4w9WgXcQ", "mobile"], + ["https://www.youtube.com/watch?v=dQw4w9WgXcQ&list=PL8mG-AaA0aAa0AAa0A0A-aAaaA00aaAa0","/watch&list"], + ["https://www.youtube.com/embed/dQw4w9WgXcQ?list=PL8mG-AaA0aAa0AAa0A0A-aAaaA00aaAa0","/embed/video"], + ["dQw4w9WgXcQ\n", "escaped newline"], + ["dQw4w9WgXcQ\t", "escaped tab"], + ["%20dQw4w9WgXcQ%20%20%20", "urlencoded"], + ["https://sb.ltn.fi/video/dQw4w9WgXcQ/","sbltnfi link"], + ["https://www.youtube.com/watch?v=dQw4w9WgXcQ#t=0m10s", "anchor as t parameter"], +]; +const edgeVideoIDs = [ + ["https://www.youtube.com/embed/videoseries?list=PL8mG-Aaa0aAa1AAa0A0A-a0aaA00aaAa0", "/videoseries"], + ["https://www.youtube.com/embed/playlist?list=PL8mG-Aaa0aAa1AAa0A0A-a0aaA00aaAa0", "/playlist"], + ["PL8mG-Aaa0aAa1AAa0A0A-a0aaA00aaAa0", "playlist ID"], + ["UgkxeLPGsmKnMdm46DGml_0aa0aaAAAAA00a","clip ID"], + ["https://www.youtube.com/GamersNexus", "channel custom URL"], + ["https://www.youtube.com/LinusTechTips", "channel custom URL"], +]; +const targetVideoID = "dQw4w9WgXcQ"; + +// tests +describe("YouTube VideoID validation - failing tests", () => { + for (const testCase of badVideoIDs) { + it(`Should error on invalid videoID - ${testCase[1]}`, () => { + assert.equal(sanitize(testCase[0]), null); + }); + } +}); +describe("YouTube VideoID validation - passing tests", () => { + for (const testCase of goodVideoIDs) { + it(`Should be able to sanitize good videoID - ${testCase[1]}`, () => { + assert.equal(sanitize(testCase[0]), targetVideoID); + }); + } +}); +describe("YouTube VideoID validation - edge cases tests", () => { + for (const testCase of edgeVideoIDs) { + it(`edge cases produce bad results - ${testCase[1]}`, () => { + assert.ok(sanitize(testCase[0])); + }); + } +}); + +// stubs +const mode = "production"; +let stub: sinon.SinonStub; + +// constants +const endpoint = "/api/skipSegments"; +const userID = "postVideoID_user1"; +const expectedError = `No valid videoID. YouTube videoID could not be extracted`; + + +// helper functions +const postSkipSegments = (videoID: string) => client({ + method: "POST", + url: endpoint, + params: { + videoID, + startTime: Math.random(), + endTime: 10, + userID, + service: "YouTube", + category: "sponsor" + } +}); + +describe("VideoID Validation - postSkipSegments", () => { + before(() => stub = sinon.stub(config, "mode").value(mode)); + after(() => stub.restore()); + + it("Should return production mode if stub worked", (done) => { + assert.strictEqual(config.mode, mode); + done(); + }); + + it(`Should return 400 for invalid videoID`, (done) => { + postSkipSegments("123456").then(res => { + assert.strictEqual(res.status, 400); + assert.strictEqual(res.data, expectedError); + done(); + }) + .catch(err => done(err)); + }); + + it(`Should return 200 for valid videoID`, (done) => { + postSkipSegments("dQw4w9WgXcQ").then(res => { + assert.strictEqual(res.status, 200); + done(); + }) + .catch(err => done(err)); + }); +}); \ No newline at end of file