From a0d08e7adf455824d12d7ae39f9ec2943f9880b6 Mon Sep 17 00:00:00 2001 From: Totonyus Date: Sun, 17 Apr 2022 21:38:46 +0200 Subject: [PATCH] Initial commit --- .gitignore | 5 + LICENSE | 674 ++++++++++++++++++++++++++++++++++ config_manager.py | 277 ++++++++++++++ docker-compose.yml | 16 + dockerfile | 14 + download_manager.py | 231 ++++++++++++ entrypoint.sh | 14 + main.py | 165 +++++++++ params/hooks_requirements | 0 params/params.ini | 63 ++++ params/params.sample.ini | 178 +++++++++ params/params_metadata.ini | 17 + params/postprocessor_hooks.py | 17 + params/progress_hooks.py | 20 + params/userscript.js | 83 +++++ params/ydl_api_hooks.py | 53 +++ pip_requirements | 5 + process_utils.py | 96 +++++ readme.md | 271 ++++++++++++++ unit_tests.py | 294 +++++++++++++++ ydl_api_ng.service | 20 + 21 files changed, 2513 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 config_manager.py create mode 100644 docker-compose.yml create mode 100644 dockerfile create mode 100644 download_manager.py create mode 100644 entrypoint.sh create mode 100644 main.py create mode 100644 params/hooks_requirements create mode 100644 params/params.ini create mode 100644 params/params.sample.ini create mode 100644 params/params_metadata.ini create mode 100644 params/postprocessor_hooks.py create mode 100644 params/progress_hooks.py create mode 100644 params/userscript.js create mode 100644 params/ydl_api_hooks.py create mode 100644 pip_requirements create mode 100644 process_utils.py create mode 100644 readme.md create mode 100644 unit_tests.py create mode 100644 ydl_api_ng.service diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..840a479 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +api_tests.http +ydl_api_ng.iml +.idea +logs/ +downloads/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /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/config_manager.py b/config_manager.py new file mode 100644 index 0000000..099100e --- /dev/null +++ b/config_manager.py @@ -0,0 +1,277 @@ +import configparser +import copy +import json +import logging +import logging.handlers as handlers + + +class SectionConfig: + def append(self, key, item): + self.__dict__[key] = item + + def get(self, key): + try: + return self.__dict__[key] + except KeyError: + return None + + def delete(self, key): + try: + self.__delattr__(key) + except AttributeError: + pass + + def get_all(self): + return self.__dict__ + + +class GlobalConfig: + def add_section(self, group): + self.__dict__[group] = SectionConfig() + self.__dict__[group].append('_name', group) + + def get(self, key): + try: + return self.__dict__[key.upper()] + except KeyError: + return None + + def add_item(self, group, key, item): + self.__dict__[group].append(key, item) + + def search_section_by_value(self, key, value): + for item in self.__dict__: + return_value = self.__dict__[item].get(key) + if isinstance(return_value, list): + if value in return_value: + return self.__dict__[item] + elif return_value == value: + return self.__dict__[item] + return None + + def get_all(self): + return self.__dict__ + + +class ConfigManager: + __config = None + __app_config = None + __presets_config = None + __site_config = None + __user_config = None + __auth_config = None + __keys_metadata = {} + __presets_config_object = GlobalConfig() + __site_config_object = GlobalConfig() + __user_config_object = GlobalConfig() + __app_config_object = GlobalConfig() + __auth_config_object = GlobalConfig() + + def __init__(self, params_file=None): + self.__config = configparser.ConfigParser(interpolation=None) + self.__presets_config = configparser.ConfigParser(interpolation=None) + self.__site_config = configparser.ConfigParser(interpolation=None) + self.__user_config = configparser.ConfigParser(interpolation=None) + self.__app_config = configparser.ConfigParser(interpolation=None) + self.__auth_config = configparser.ConfigParser(interpolation=None) + + self.__config.read(params_file if params_file is not None else 'params/params.ini') + + self.__init_logger(self.__config['app'].getint('_log_level'), self.__config['app'].getint('_log_backups')) + + self.__dispatch_configs() + self.__load_metadata() + self.__set_config_objects() + + @staticmethod + def __init_logger(level=30, backup_count=7): + logging.basicConfig(level=level, format='[%(asctime)s][%(name)s][%(levelname)s] %(message)s', datefmt='%d-%m-%y %H:%M:%S') + + time_handler = handlers.TimedRotatingFileHandler('logs/ydl_api_ng', when='midnight', interval=1, backupCount=backup_count) + time_handler.setLevel(level) + time_handler.setFormatter(logging.Formatter('[%(asctime)s][%(name)s][%(levelname)s] %(message)s', datefmt='%d-%m-%y %H:%M:%S')) + logging.getLogger().addHandler(time_handler) + + logging.getLogger('config_manager').info('Logger initialized') + + # Send configs to the right objects + def __dispatch_configs(self): + for section in self.__config.sections(): + if section.startswith('preset:'): + self.__presets_config[section] = self.__expand_config(section) + elif section.startswith('user:'): + self.__user_config[section] = self.__expand_config(section) + elif section.startswith('site:'): + self.__site_config[section] = self.__expand_config(section) + elif section.startswith('auth:'): + self.__auth_config[section] = self.__expand_config(section) + elif section == 'app': + self.__app_config[section] = self.__config[section] + + # Resolve config expansions + def __expand_config(self, section_name): + temp_config = configparser.ConfigParser(interpolation=None) + temp_config['__current_params'] = copy.deepcopy(self.__config[section_name]) + + current_params = temp_config['__current_params'] + + self.__expand_section(current_params, temp_config) + + # Merge with default to fill remaining parameters + if self.__config.has_section(f'{section_name.split(":")[0]}:DEFAULT'): + self.__merge_configs(self.__config[f'{section_name.split(":")[0]}:DEFAULT'], current_params, temp_config) + self.__expand_section(current_params, temp_config) + + logging.getLogger('config_manager').debug(f'Expandig section {section_name}') + return current_params + + def __expand_section(self, section, config_set): + merged = False + expendable_fields = ['_preset', '_template', '_location', '_auth', '_site', '_user'] + + for key, value in section.items(): + if key in expendable_fields: + merged = True + config_set.remove_option(section.name, key) + self.__merge_configs(self.__config[f'{key.lstrip("_")}:{value}'], section, config_set) + + if merged: + self.__expand_section(section, config_set) + + # Merge expanded config into current config + @staticmethod + def __merge_configs(src, dest, config_set): + for key, value in src.items(): + if not config_set.has_option(dest.name, key): + dest[key] = value + + # Done on premise directly with objects, override values + @staticmethod + def merge_configs_object(user_object, preset_object): + changed_preset = copy.deepcopy(preset_object) + + if user_object is not None: + logging.getLogger('config_manager').debug(f'Merging preset {preset_object.get("_name")} in user {user_object.get("_name")}') + + for option in user_object.get_all(): + if option != '_name': + changed_preset.append(option, user_object.get(option)) + + return changed_preset + + # Get parameters type from meta section of the parameters file + def __load_metadata(self): + logging.getLogger('config_manager').debug(f'Loading parameters metadata') + + params_meta_parser = configparser.ConfigParser(interpolation=None) + params_meta_parser.read('params/params_metadata.ini') + + for key, value in params_meta_parser['meta'].items(): + if value != "": + splitted = value.split(',') + else: + splitted = [] + self.__keys_metadata[key] = splitted + + def __set_config_objects(self): + self.__populate_config_object(self.__app_config, self.__app_config_object) + self.__populate_config_object(self.__presets_config, self.__presets_config_object) + self.__populate_config_object(self.__user_config, self.__user_config_object) + self.__populate_config_object(self.__site_config, self.__site_config_object) + self.__populate_config_object(self.__auth_config, self.__auth_config_object) + + # Set python objects with the right type of object + def __populate_config_object(self, config_set, config_set_object): + logging.getLogger('config_manager').debug(f'Populate config objects with rights ') + + for section in config_set.sections(): + splitted_key = section.split(':')[-1].upper() + + config_set_object.add_section(splitted_key) + for key, value in config_set[section].items(): + parsed_item = self.__get_parsed_parameter_value(key, value) + logging.getLogger('config_manager').debug(f'Parameter parsing : {key} => {type(parsed_item).__name__}') + + config_set_object.add_item(splitted_key, key, parsed_item) + + def __get_parsed_parameter_value(self, key, value): + if key in self.__keys_metadata.get('_int'): + return int(value) + if key in self.__keys_metadata.get('_float'): + return float(value) + if key in self.__keys_metadata.get('_bool'): + return value == "true" + if key in self.__keys_metadata.get('_array'): + if value != '': + return value.split(',') + return None + if key in self.__keys_metadata.get('_object'): + return json.loads(value) + + # It's a string by default + return value + + def is_user_permitted_by_token(self, user_token): + manage_user = self.get_app_params().get('_enable_users_management') + user = self.get_user_param_by_token(user_token) + + if manage_user: + if user is None: + logging.getLogger('auth').warning(f'Unauthorized user {user_token}') + return False + else: + logging.getLogger('auth').info(f'Authorized user {user.get("_name")}') + return user + else: + return None + + def get_all_users_params(self): + return self.__user_config_object + + def get_user_param_by_token(self, token): + return self.__user_config_object.search_section_by_value('_token', token) + + def get_all_preset_params(self): + return self.__presets_config_object + + def get_preset_params(self, preset_name): + return self.__presets_config_object.get(preset_name) + + def get_all_sites_params(self): + return self.__site_config_object + + def get_site_params(self, site_name): + return self.__site_config_object.search_section_by_value('_hosts', site_name) + + def get_all_auth_params(self): + return self.__auth_config_object + + def get_auth_params(self, preset_name): + return self.__auth_config_object.get(preset_name) + + def get_keys_meta(self): + return self.__keys_metadata + + def get_app_params(self): + return self.__app_config_object.get('APP') + + def get_app_params_object(self): + return self.__app_config_object + + # Remove hiddens fields to return on api + def sanitize_config_object(self, config_object): + clone_object = copy.deepcopy(config_object) + + for item in clone_object.get_all(): + self.sanitize_config_object_section(clone_object.get(item), True) + + return clone_object + + # Remove hiddens fields to return on api + def sanitize_config_object_section(self, config_section_object, mutate=False): + clone_object = config_section_object if mutate else copy.deepcopy(config_section_object) + + for hidden_field in self.__keys_metadata.get('_hidden'): + clone_object.delete(hidden_field) + + return clone_object diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..f154d41 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,16 @@ +version: "3.1" +services: + ydl_api_ng: + container_name: ydl_api_ng + image: totonyus/ydl_api_ng + restart: unless-stopped + ports: + - 5011:80 + volumes: + - ./downloads:/app/downloads + - ./params:/app/params + - ./logs:/app/logs + #- ./params/hooks_utils:/app/params/hooks_utils + environment: + - UID=1000 + - GID=1000 \ No newline at end of file diff --git a/dockerfile b/dockerfile new file mode 100644 index 0000000..45a43f6 --- /dev/null +++ b/dockerfile @@ -0,0 +1,14 @@ +# syntax=docker/dockerfile:1 + +FROM python:3.9-slim-buster +WORKDIR /app + +ENV UID=1000 GID=1000 + +COPY config_manager.py download_manager.py main.py process_utils.py entrypoint.sh pip_requirements ./ +COPY params/ydl_api_hooks.py params/postprocessor_hooks.py params/progress_hooks.py params/params.ini params/params_metadata.ini params/params.sample.ini params/userscript.js params/hooks_requirements ./setup/ + +RUN pip3 install -r pip_requirements +RUN apt update && apt install ffmpeg -y && apt-get autoremove && apt-get -y clean && rm -rf /var/lib/apt/lists/* + +CMD ["bash", "/app/entrypoint.sh"] diff --git a/download_manager.py b/download_manager.py new file mode 100644 index 0000000..ff4977c --- /dev/null +++ b/download_manager.py @@ -0,0 +1,231 @@ +import copy +import functools +import logging +from urllib.parse import urlparse + +import yt_dlp as ydl + +from params import progress_hooks, postprocessor_hooks, ydl_api_hooks + + +class DownloadManager: + __cm = None + + def __init__(self, config_manager, url, presets, user_token): + logging.getLogger('download_manager').info(f'Init download - user_token: {user_token} - presets: {presets} - url :{url} ' ) + + self.presets = [] + self.presets_display = [] + + self.all_downloads_checked = True + self.no_preset_found = False + + self.presets_not_found = 0 + self.presets_found = 0 + + self.downloads_cannot_be_checked = 0 + self.downloads_can_be_checked = 0 + + self.failed_checks = 0 + self.passed_checks = 0 + + self.downloaded_files = [] + + self.__cm = config_manager + self.url = url + self.site = self.__cm.get_site_params(urlparse(url).hostname) + self.user = self.__cm.get_user_param_by_token(user_token) + self.get_presets_objects(presets) + self.simulate_all_downloads() + + def simulate_all_downloads(self): + for preset in self.presets: + check_result = self.simulate_download(preset) + if check_result is False: + self.failed_checks = self.failed_checks + 1 + logging.getLogger('download_manager').error(f'Checking url with preset {preset.get("_name")} => check failed') + else: + self.passed_checks = self.passed_checks + 1 + logging.getLogger('download_manager').info(f'Checking url with preset {preset.get("_name")} => check passed') + + preset.append('__is_video', self.is_video()) + preset.append('__is_playlist', self.is_from_playlist()) + + # Retrieve parameters objects from api string presets + def get_presets_objects(self, presets): + default_preset = self.get_preset_for_user(self.__cm.get_preset_params('DEFAULT')) + default_preset.append('_default', True) + + if presets is None: + self.presets.append(default_preset) + self.presets_display.append(self.__cm.sanitize_config_object_section(default_preset)) + return self.presets + + for preset in presets: + found_preset = self.__cm.get_preset_params(preset) + + if found_preset is not None: + found_preset.append('_default', False) + self.presets.append(self.get_preset_for_user(found_preset)) + self.presets_display.append(self.__cm.sanitize_config_object_section(found_preset)) + + self.presets_found = self.presets_found + 1 + else: + self.presets_not_found = self.presets_not_found + 1 + + # Add default preset if not valid preset found + if len(self.presets) == 0: + self.presets.append(self.get_preset_for_user(default_preset)) + self.presets_display.append(self.__cm.sanitize_config_object_section(default_preset)) + self.no_preset_found = True + + return self.presets + + def is_from_playlist(self): + if self.site is None or self.site.get('_playlist_indicators') is None: + return None + + for playlist_indicator in self.site.get('_playlist_indicators'): + if self.url.find(playlist_indicator) != -1: + return True + + return False + + def is_video(self): + if self.site is None or self.site.get('_video_indicators') is None: + return None + + for video_indicator in self.site.get('_video_indicators'): + if self.url.find(video_indicator) != -1: + return True + + return False + + + def get_site_param_object(self): + return self.site + + # A playlist should not be cheched + # A video in a playlist should checked only if noplaylist = True + def can_url_be_checked(self, preset): + noplaylist_param = preset.get('noplaylist') + + if noplaylist_param is None: + noplaylist_param = False + + is_from_playlist = self.is_from_playlist() + is_video = self.is_video() + + return_value = True + if is_from_playlist is None and is_video is None: + return_value = True + + if not noplaylist_param and is_from_playlist: + return_value = False + + if noplaylist_param and is_from_playlist and not is_video: + return_value = False + + return return_value + + def is_user_permitted(self, users_management=None): + manage_user = self.__cm.get_app_params().get('_enable_users_management') if users_management is None else users_management + + if manage_user: + if self.user is None: + return False + else: + return self.user + else: + return None + + # Extends preset with user informations + def get_preset_for_user(self, preset): + new_preset = self.__cm.merge_configs_object(self.user, preset) + new_preset.delete('_token') + self.__cm.merge_configs_object(self.site, new_preset) + + return new_preset + + def simulate_download(self, preset): + if not self.can_url_be_checked(preset): + self.downloads_cannot_be_checked = self.downloads_cannot_be_checked + 1 + self.all_downloads_checked = False + + preset.append('__can_be_checked', False) + preset.append('__check_result', None) + + return None + + self.downloads_can_be_checked = self.downloads_can_be_checked + 1 + + ydl_opts = copy.deepcopy(preset) + ydl_opts.append('simulate', True) + ydl_opts.append('logger', logging.getLogger('youtube-dlp')) + + ydl_opts = ydl_opts.get_all() + + with ydl.YoutubeDL(ydl_opts) as dl: + simulation_result = dl.download([self.url]) == 0 + + preset.append('__can_be_checked', True) + preset.append('__check_result', simulation_result) + + return simulation_result + + def progress_hooks_proxy(self, download): + if download.get('status') == 'finished': + self.downloaded_files.append(download) + + def process_download(self, preset): + if self.__cm.get_app_params().get('_dev_mode'): + logging.getLogger('download_manager').critical("server in DEV mode, set the _dev_mode at false in the [app] parameters") + return + + ydl_opts = copy.deepcopy(preset) + + ydl_opts.append('progress_hooks', [functools.partial(progress_hooks.handler, ydl_opts, self, self.__cm), functools.partial(self.progress_hooks_proxy)]) + ydl_opts.append('postprocessor_hooks', [functools.partial(postprocessor_hooks.handler, ydl_opts, self, self.__cm)]) + ydl_opts.append('logger', logging.getLogger('youtube-dlp')) + + ydl_api_hooks.pre_download_handler(ydl_opts, self, self.__cm) + + with ydl.YoutubeDL(ydl_opts.get_all()) as dl: + download_result = dl.download([self.url]) == 0 + + ydl_api_hooks.post_download_handler(ydl_opts, self, self.__cm, self.downloaded_files) + + return download_result + + def process_downloads(self): + for preset in self.presets: + self.process_download(preset) + + def flush_presets(self): + self.url = None + self.presets = [] + self.user = None + self.site = None + + self.all_downloads_checked = True + self.no_preset_found = False + + self.presets_not_found = 0 + self.presets_found = 0 + + self.downloads_cannot_be_checked = 0 + self.downloads_can_be_checked = 0 + + self.failed_checks = 0 + self.passed_checks = 0 + + @staticmethod + def extract_info(url): + ydl_opts = { + 'ignoreerrors': True + } + + with ydl.YoutubeDL(ydl_opts) as dl: + informations = dl.extract_info(url, download=False) + + return informations diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100644 index 0000000..e26c422 --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +cp -n /app/setup/* /app/params/ + +addgroup --gid $GID ydl_api_ng && useradd --uid $UID --gid ydl_api_ng ydl_api_ng + +pip3 install yt-dlp --upgrade +pip3 install -r /app/params/hooks_requirements + +mkdir -p /app/logs /app/downloads +chown $UID:$GID /app/logs /app/downloads +chown $UID:$GID /app/downloads + +su ydl_api_ng -c "python3 main.py" diff --git a/main.py b/main.py new file mode 100644 index 0000000..69d6f8b --- /dev/null +++ b/main.py @@ -0,0 +1,165 @@ +import logging +from urllib.parse import unquote + +import uvicorn +import yt_dlp.version +from fastapi import BackgroundTasks, FastAPI, Response + +import config_manager +import download_manager +import process_utils + +__cm = config_manager.ConfigManager() + +app = FastAPI() + + + + + +### +# Application +### + +@app.get(__cm.get_app_params().get('_api_route_info')) +async def info_request(response: Response, token=None): + param_token = unquote(token) if token is not None else None + user = is_user_permitted_by_token(param_token) + + if user is False: + response.status_code = 401 + return + + return { + 'ydl_version': yt_dlp.version.__version__, + 'ydl_git_head': yt_dlp.version.RELEASE_GIT_HEAD, + 'processed_config': { + 'meta_keys': __cm.get_keys_meta(), + 'app_config': __cm.sanitize_config_object(__cm.get_app_params_object()), + 'user_config': __cm.sanitize_config_object(__cm.get_all_users_params()), + 'preset_config': __cm.sanitize_config_object(__cm.get_all_preset_params()), + 'site_config': __cm.sanitize_config_object(__cm.get_all_sites_params()), + 'auth_config': __cm.sanitize_config_object(__cm.get_all_auth_params()), + } + } + + +### +# Download +### + +@app.get(__cm.get_app_params().get('_api_route_download')) +async def download_request(response: Response, background_tasks: BackgroundTasks, url, token=None, presets=None): + param_url = unquote(url) + param_token = unquote(token) if token is not None else None + param_presets = unquote(presets).split(',') if presets is not None else None + + dm = download_manager.DownloadManager(__cm, param_url, param_presets, param_token) + + user = __cm.is_user_permitted_by_token(param_token) + + if user is False: + response.status_code = 401 + return + + if param_url == '': + response.status_code = 400 + logging.getLogger('api').error('Url paramater is empty') + return + + # Some presets were not found + if dm.presets_not_found > 0: + response.status_code = 206 + + # Some downloads can't be checked (playlists) + if dm.downloads_cannot_be_checked > 0: + response.status_code = 202 + + # Some presets can't be downloaded + if dm.failed_checks > 0 and dm.passed_checks > 0: + response.status_code = 206 + + # No video can be downloaded + if dm.failed_checks == dm.downloads_can_be_checked and dm.downloads_cannot_be_checked == 0: + logging.getLogger('api').error(f'Not downloadable with presets : {param_presets} : {param_url}') + response.status_code = 400 + else: + background_tasks.add_task(dm.process_downloads) + + return { + 'url': param_url, + 'no_preset_found': dm.no_preset_found, + 'presets_found': dm.presets_found, + 'presets_not_found': dm.presets_not_found, + 'all_downloads_checked': dm.all_downloads_checked, + 'passed_checks': dm.passed_checks, + 'failed_checks': dm.failed_checks, + 'downloads_can_be_checked': dm.downloads_can_be_checked, + 'downloads_cannot_be_checked': dm.downloads_cannot_be_checked, + 'downloads': dm.presets_display, + } + + +### +# Video +### + +@app.get(__cm.get_app_params().get('_api_route_extract_info')) +async def extract_info_request(response: Response, url, token=None): + param_url = unquote(url) + param_token = unquote(token) if token is not None else None + user = __cm.is_user_permitted_by_token(param_token) + + if user is False: + response.status_code = 401 + return + + return download_manager.DownloadManager.extract_info(param_url) + + +### +# Process +### +@app.get(__cm.get_app_params().get('_api_route_active_downloads')) +async def active_downloads_request(response: Response, token=None): + param_token = unquote(token) if token is not None else None + user = __cm.is_user_permitted_by_token(param_token) + + if user is False: + response.status_code = 401 + return + + return process_utils.get_active_downloads_list() + + +@app.get(f"{__cm.get_app_params().get('_api_route_active_downloads')}/terminate/{'{pid}'}") +async def terminate_active_download_request(response: Response, pid, token=None): + param_token = unquote(token) if token is not None else None + user = __cm.is_user_permitted_by_token(param_token) + + if user is False: + response.status_code = 401 + return + + return_status = process_utils.terminate_active_download(unquote(pid)) + + if return_status is None: + response.status_code = 400 + return + + return return_status + + +@app.get(f"{__cm.get_app_params().get('_api_route_active_downloads')}/terminate") +async def terminate_all_active_downloads_request(response: Response, token=None): + param_token = unquote(token) if token is not None else None + user = __cm.is_user_permitted_by_token(param_token) + + if user is False: + response.status_code = 401 + return + + return process_utils.terminate_all_active_downloads() + + +uvicorn.run(app, host="0.0.0.0", port=__cm.get_app_params().get('_listen_port'), log_config=None) diff --git a/params/hooks_requirements b/params/hooks_requirements new file mode 100644 index 0000000..e69de29 diff --git a/params/params.ini b/params/params.ini new file mode 100644 index 0000000..554371f --- /dev/null +++ b/params/params.ini @@ -0,0 +1,63 @@ +[app] +_api_route_download = /download +_api_route_extract_info = /extract_info +_api_route_info = /info +_api_route_active_downloads = /active_downloads +_enable_users_management = false +_log_level = 20 +_log_backups = 7 +_listen_port = 5011 + +;;; +;;; Locations +;;; +[location:DEFAULT] +paths = {"home" : "./downloads/"} + +;;; +;;; Templates +;;; +[template:DEFAULT] +outtmpl = {"default" : "videos/%(webpage_url_domain)s/%(title)s_(%(height)s).%(ext)s"} + +[template:AUDIO] +outtmpl = {"default" : "audio/%(title)s.%(ext)s", "chapter" : "audio/%(title)s/%(section_number)s-%(section_title)s.%(ext)s"} + +;;; +;;; Presets +;;; +[preset:DEFAULT] +_location = DEFAULT +_template = DEFAULT +quiet = true +ignoreerrors = true +noplaylist = true +updatetime = false +format = bestvideo+bestaudio/best +restrictfilenames : true +windowsfilenames : true + +[preset:AUDIO] +_template : AUDIO +format = bestaudio +postprocessors = [{"key": "FFmpegSplitChapters", "force_keyframes": false}] + +[preset:BEST] +format = bestvideo+bestaudio/best + +[preset:FULLHD] +format = best[height=1080]/bestvideo[height=1080]+bestaudio/best + +[preset:HD] +format = best[height=720]/bestvideo[height=720]+bestaudio/best + +[preset:SD] +format = best[height=360]/bestvideo[height=360]+bestaudio/best + +;;; +;;; Sites +;;; +[site:YOUTUBE] +_hosts = www.youtube.com,youtu.be +_video_indicators = /watch? +_playlist_indicators = ?list=,&list=,/user/,/playlists diff --git a/params/params.sample.ini b/params/params.sample.ini new file mode 100644 index 0000000..4ca7751 --- /dev/null +++ b/params/params.sample.ini @@ -0,0 +1,178 @@ +;;;;; +;;; - All parameters starting with an underscore (_) are technical parameters for this application +;;; - All others parameters are youtube-dl python parameters : https://github.com/yt-dlp/yt-dlp/blob/cda1bc51973c89b72b916dcc40dbe3d7f457097d/yt_dlp/YoutubeDL.py#L183 +;;; - Sections type : +;;; - [location:] +;;; - [template:] +;;; - [USER:] +;;; - [SITE:] +;;; - [AUTH:] +;;; - [PRESET:] +;;; - Expansion tags : +;;; - _location +;;; - _template +;;; - _user +;;; - _site +;;; - _auth +;;; - _preset +;;; - Expand a section permit to merge the target section in the current section +;;; - If a parameter exists in current section, it will not be overriden +;;; +;;; - Precedence from lower to higher : +;;; - preset +;;; - user +;;; - site +;;; +;;; - Every parameter can have different type, check params_metadata.ini to add or change parameters type +;;; +;;;;; + +[app] +_api_route_download = /download +_api_route_extract_info = /extract_info +_api_route_info = /info +_api_route_active_downloads = /active_downloads +_enable_users_management = false +;; 0 : NOTSET, 10 : DEBUG, 20 : INFO; 30 : WARNING; 40 : ERROR; 50 : CRITICAL +_log_level = 20 +;; number of log files to keep +_log_backups = 7 +_listen_port = 80 + +;;; just for unit tests purpose, please don't mind +_int_test = 42 +_float_test = 42.0 +_bool_test = true +_string_test = test +_array_test = 4,2 +_object_test = {"nb": "42"} + +;;; +;;; Locations +;;; Only contains the path +;;; Must keep a DEFAULT location +;;; Docker note : you must keep the _path in /app/ directory +;;; If you are not using docker, you can use whatever you want +;;; +[location:DEFAULT] +paths= {"home" : "./downloads/"} + +[location:DAD] +paths= {"home" : "./downloads/symlink_to_dad_home/"} + +[location:SHARE] +paths= {"home" : "./downloads/symlink_to_some_shared_folder/or_a_nas/or_something/ya_know/"} + +;;; +;;; Templates +;;; Contains the output template of the filename +;;; Must keep a DEFAULT template +;;; +[template:DEFAULT] +outtmpl = {"default" : "videos/%(webpage_url_domain)s/%(title)s_(%(height)s).%(ext)s"} + +[template:AUDIO] +outtmpl = {"default" : "audio/%(title)s.%(ext)s", "chapter" : "audio/%(title)s/%(section_number)s-%(section_title)s.%(ext)s"} + +[template:PLAYLIST] +outtmpl = {"default" : "videos/%(webpage_url_domain)s/playlists/%(playlist)s/%(title)s_(%(height)s).%(ext)s"} + +;;; +;;; Presets +;;; Must keep a DEFAULT preset +;;; Every other preset will automatically be extended with the DEFAULT preset +;;; +[preset:DEFAULT] +; Will use the DEFAULT location item +_location = DEFAULT +; Will use the DEFAULT template item +_template = DEFAULT + +; youtube-dlp parameters : +quiet = true +ignoreerrors = true +noplaylist = true +updatetime = false +subtitleslangs = en +subtitlesformat = srt +format = bestvideo+bestaudio/best +restrictfilenames : true +windowsfilenames : true + +;;; Only need to override parameters that changed from preset +[preset:AUDIO] +; will use AUDIO template to have a different naming convention +_template : AUDIO +format = bestaudio +; allow to split each track when the video contains chapters +postprocessors = [{"key": "FFmpegSplitChapters", "force_keyframes": false}] + +[preset:BEST] +format = bestvideo+bestaudio/best + +[preset:FULLHD] +format = best[height=1080]/bestvideo[height=1080]+bestaudio/best + +[preset:HD] +format = best[height=720]/bestvideo[height=720]+bestaudio/best + +[preset:SD] +format = best[height=360]/bestvideo[height=360]+bestaudio/best + +[preset:SHARE] +_location = SHARE +; you can extend another preset +_preset = HD + +[preset:PLAYLIST] +_template = PLAYLIST +_preset = HD +noplaylist = false + +;;; +;;; Users +;;; +[user:DAD] +_location = DAD +; The token is mandatory to find the right user +; Not two users can have the same token +_token = dad_super_password + +[user:MOM] +; Files will be downloaded in Dad location +_location = DAD +_token = mom_super_password +; Mom like to have her subtitles +writesubtitles = true + +[user:TOTONYUS] +_token = totonyus_super_password +subtitleslangs = fr,en +writesubtitles = true + +;;; +;;; Sites +;;; Used to dertermine a few special tricks for websites +;;; If exanding an auth section, auth section will not override site parameters +;;; Any parameter in this section will always override existing parameters +;;; +[site:YOUTUBE] +_hosts = www.youtube.com,youtu.be +_video_indicators = /watch? +; download check will not be performed on playlists (youtube-dl checks every video of the playlist) +_playlist_indicators = ?list=,&list=,/user/,/playlists +; You can add parameters for site only, here, I want to get thumbnails only on youtube videos +; writethumbnail = true + +[site:DAILYMOTION] +_host = www.dailymotion.com,dailymotion.com +_auth = DAILYMOTION + +;;; +;;; Auth +;;; Every parameter in auth section will override existing parameters +;;; Meant to the authentication layer +;;; +[auth:DAILYMOTION] +username = Totonyus +password = is_this_site_still_running_fr_? diff --git a/params/params_metadata.ini b/params/params_metadata.ini new file mode 100644 index 0000000..1a97f7e --- /dev/null +++ b/params/params_metadata.ini @@ -0,0 +1,17 @@ +;;; +;;; Describe how each field must be interpreted by the program +;;; If a field is not in this file, it will be considered as string +;;; +[meta] +_int = _listen_port,_log_backups,_log_level,_int_test,age_limit,min_views,max_views,socket_timeout,buffersize,ratelimit,throttledratelimit,min_filesize,max_filesize,retries,http_chunk_size,xattr_set_filesize,extractor_retries,sleep_interval_requests,sleep_interval,max_sleep_interval,sleep_interval_subtitles,trim_file_name +_float = _float_test +_bool = _bool_test,_enable_users_management,_dev_mode,quiet,usenetrc,verbose,quiet,no_warnings,forceurl,forcetitle,forceid,forcethumbnail,forcedescription,forcefilename,forceduration,allow_unplayable_formats,allow_multiple_video_streams,allow_multiple_audio_streams,restrictfilenames,skip_playlist_after_errors,allow_playlist_files,legacyserverconnect,call_home,playlistreverse,playlistrandom,mark_watched,youtube_include_dash_manifest,youtube_include_hls_manifest,windowsfilenames,ignoreerrors,force_generic_extractor,overwrites,simulate,force_write_download_archive,ignore_no_formats_error,format_sort_force,prefer_free_formats,writedescription,writeinfojson,clean_infojson,getcomments,writeannotations,writethumbnail,write_all_thumbnails,writelink,writeurllink,writewebloclink,writedesktoplink,writesubtitles,writeautomaticsub,allsubtitles,download_archive,break_on_existing,break_on_reject,break_per_url,noplaylist,keepvideo,nocheckcertificate,prefer_insecure,skip_download,listsubtitles,check_formats,hls_prefer_native,dynamic_mpd,prefer_ffmpeg,hls_split_discontinuity,nopart,noresizebuffer,file_access_retries,fragment_retries,continuedl,noprogress,hls_use_mpegts,concurrent_fragment_downloads,geo_bypass,no_color,listformats,list_thumbnails,fixup,merge_output_format,wait_for_video,extract_flat,include_ads,bidi_workaround,debug_printtraffic,updatetime + +;;; Each value of the array must be separated by a comma (,) +_array = _array_test,_video_indicators,_playlist_indicators,_hosts,format_sort,subtitleslangs + +;;; Complex fields, supply a json string and it will be loaded as python object +_object = _object_test,forceprint,print_to_file,forcejson,dump_single_json,paths,outtmpl,http_headers,postprocessors,progress_hooks,postprocessor_hooks,match_filter,external_downloader,progress_template,postprocessor_args,extractor_args,compat_opts,external_downloader_args + +;;; The fiels that shouldn't be returned by the api +_hidden = username,password,_token,progress_hooks,postprocessor_hooks diff --git a/params/postprocessor_hooks.py b/params/postprocessor_hooks.py new file mode 100644 index 0000000..9e36134 --- /dev/null +++ b/params/postprocessor_hooks.py @@ -0,0 +1,17 @@ +import sys + +sys.path.insert(1, 'params/hooks_utils/') + + +### +# ydl_opts contains all the informations of the selected preset +# download_manager contains all the processed informations about the download +# config_manager contains all the parameters of the application +# download contains the standart youtube-dlp object for postprocessor hooks +### + +def handler(ydl_opts, download_manager, config_manager, download): + if download.get('status') == 'finished': + return + if download.get('status') == 'error': + return diff --git a/params/progress_hooks.py b/params/progress_hooks.py new file mode 100644 index 0000000..f765a9d --- /dev/null +++ b/params/progress_hooks.py @@ -0,0 +1,20 @@ +import logging +import sys + +import humanize + +sys.path.insert(1, 'params/hooks_utils/') + + +### +# ydl_opts contains all the informations of the selected preset +# download_manager contains all the processed informations about the download +# config_manager contains all the parameters of the application +# download contains the standart youtube-dlp object for progress hooks +### + +def handler(ydl_opts, download_manager, config_manager, download): + if download.get('status') == 'finished': + logging.getLogger('progress_hooks').debug(f'[SUCCESS][preset:{ydl_opts.get("_name")}] - {download_manager.url} -> {download.get("filename")} ({humanize.naturalsize(download.get("total_bytes"), binary=True)})') + if download.get('status') == 'error': + logging.getLogger('progress_hooks').error(f'[FAILED][preset:{ydl_opts.get("_name")}] - {download_manager.url}') diff --git a/params/userscript.js b/params/userscript.js new file mode 100644 index 0000000..781890e --- /dev/null +++ b/params/userscript.js @@ -0,0 +1,83 @@ +// ==UserScript== +// @name ydl_api +// @match http*://*/* +// @grant GM_registerMenuCommand +// @grant GM_xmlhttpRequest +// @grant GM_notification +// ==/UserScript== + +(function () { + 'use strict'; + + // ---%--- REPLACE ---%--- your host and token here + const default_host = 'http://localhost:5011/download'; + const userToken = null; + const notificationTimeout = 5000; + + const preset_list = [ + {name: 'Default', key: '1', host: default_host, params: {}}, + {name: 'Best', key: '2', host: default_host, params: {presets: 'BEST'}}, + {name: '720p', key: '3', host: default_host, params: {presets: 'HD'}}, + {name: 'Audio', key: '4', host: default_host, params: {presets: 'AUDIO'}}, + {name: 'Best + Audio', key: '5', host: default_host, params: {presets: 'BEST,AUDIO'}}, + ]; + + const buildURL = function (preset) { + const url = new URL(preset.host); + + url.searchParams.append('url', window.location.href); + + if (userToken !== null) { + url.searchParams.append('token', userToken); + } + + Object.entries(preset.params).forEach(([key, value]) => { + url.searchParams.append(key, value); + }); + + return url.href; + }; + + const launchRequest = function (preset) { + const notificationOptions = {}; + + GM_xmlhttpRequest({ + method: 'GET', + url: buildURL(preset), + onerror: function () { + notificationOptions.title = `Download failed`; + notificationOptions.text = `Host seams unreachable, is the server up ?`; + GM_notification(notificationOptions); + }, + onload: function (response) { + if (response.status === 200) { + notificationOptions.title = `Download launched`; + notificationOptions.text = `Downloading`; + notificationOptions.timeout = notificationTimeout; + } else if (response.status === 202) { + notificationOptions.title = `Download launched`; + notificationOptions.text = `The download have not been checked. Some files may be not downloaded`; + notificationOptions.timeout = notificationTimeout; + } else if (response.status === 206) { + notificationOptions.title = `Download launched`; + notificationOptions.text = `Some presets failed download test`; + notificationOptions.timeout = notificationTimeout; + } else if (response.status === 401) { + notificationOptions.title = `Authentication failed`; + notificationOptions.text = `The server require a user token or the provided token is wrong`; + } else { + notificationOptions.title = `Download failed`; + notificationOptions.text = `The format may be wrong or not available or there is no video to download`; + } + + GM_notification(notificationOptions); + } + }); + }; + + preset_list.forEach((preset) => { + GM_registerMenuCommand(preset.name, () => { + launchRequest(preset) + }, preset.key); + }) +})(); diff --git a/params/ydl_api_hooks.py b/params/ydl_api_hooks.py new file mode 100644 index 0000000..82f52b9 --- /dev/null +++ b/params/ydl_api_hooks.py @@ -0,0 +1,53 @@ +import logging +import sys + +import humanize + +sys.path.insert(1, 'params/hooks_utils/') + + +### +# ydl_opts contains all the informations of the selected preset +# download_manager contains all the processed informations about the download +# config_manager contains all the parameters of the application +# downloads is a list of youtube-dlp stadart ojbects for progress_hooks +### + +# Called just before preset effective download +def pre_download_handler(ydl_opts, download_manager, config_manager): + logging.getLogger('pre_download_hooks').info(f'Downloading {download_manager.url} with preset {ydl_opts.get("_name")} in {ydl_opts.get("outtmpl")}') + pass + + +# Called after all files of the preset are downloaded +def post_download_handler(ydl_opts, download_manager, config_manager, downloads): + downloads_state = {} + + for download in downloads: + video_id = download.get('info_dict').get('id') + + if downloads_state.get(video_id) is None: + downloads_state[video_id] = { + 'finished_downloads': 0, + 'error_downloads': 0, + 'file_size': 0, + 'downloads': [] + } + + if download.get('status') == 'finished': + downloads_state.get(video_id)['finished_downloads'] = downloads_state.get(video_id).get('finished_downloads') + 1 + downloads_state.get(video_id)['file_size'] = downloads_state.get(video_id).get('file_size') + download.get('total_bytes') + elif download.get('status') == 'error': + downloads_state.get(video_id)['error_downloads'] = downloads_state.get(video_id).get('error_downloads') + 1 + + downloads_state.get(video_id).get('downloads').append(download) + + for video_id in downloads_state: + download_object = downloads_state.get(video_id) + + if download_object.get('finished_downloads') != 0 and download_object.get('error_downloads') != 0: + logging.getLogger('post_download_hooks').error(f'[FAILED][preset:{ydl_opts.get("_name")}] - {download_manager.url} : Not all files were downloaded') + elif download_object.get('error_downloads') != 0 and download_object.get('finished_downloads') == 0: + logging.getLogger('post_download_hooks').error(f'[FAILED][preset:{ydl_opts.get("_name")}] - {download_manager.url} : No file downloaded') + elif download_object.get('finished_downloads') != 0 and download_object.get('error_downloads') == 0: + logging.getLogger('post_download_hooks').info(f'[SUCCESS][preset:{ydl_opts.get("_name")}] - {download_manager.url} -> {download_object.get("downloads")[0].get("info_dict").get("_filename")} ({humanize.naturalsize(download_object.get("file_size"), binary=True)})') diff --git a/pip_requirements b/pip_requirements new file mode 100644 index 0000000..c5b74c2 --- /dev/null +++ b/pip_requirements @@ -0,0 +1,5 @@ +fastapi +yt-dlp +uvicorn +psutil +humanize \ No newline at end of file diff --git a/process_utils.py b/process_utils.py new file mode 100644 index 0000000..50525a4 --- /dev/null +++ b/process_utils.py @@ -0,0 +1,96 @@ +import logging +import os +import pathlib +import re + +import psutil + + +def get_active_downloads_list(): + children_process = psutil.Process().children(recursive=True) + + active_downloads_list = [] + for child in children_process: + active_download = { + 'command_line': f'{child.cmdline()}', + 'filename': get_current_download_file_destination(child.cmdline()), + 'pid': child.pid, + 'create_time': child.create_time() + } + + active_downloads_list.append(active_download) + + return active_downloads_list + + +def get_current_download_file_destination(cmdline): + regex = r'\'file:(.*\/)(.*)\'' + + match = re.search(regex, f'{cmdline}') + + part_filename = f'{match.group(1)}{match.group(2)}' + filename = part_filename.rstrip('.part') + + path = match.group(1) + filename_stem = pathlib.Path(filename).stem + extension = pathlib.Path(filename).suffix + + return { + 'part_filename': part_filename, + 'filename': filename, + 'path': path, + 'filename_stem': filename_stem, + 'extension': extension, + } + + +def is_a_child_process(pid): + children_process = psutil.Process().children(recursive=True) + + is_child = False + + for child in children_process: + if child.pid == pid: + is_child = True + + return is_child + + +def get_child_object(pid): + children_process = psutil.Process().children(recursive=True) + + for child in children_process: + if child.pid == pid: + return child + + return None + + +def terminate_active_download(pid): + child = get_child_object(int(pid)) + + if child is not None: + logging.getLogger('process_utils').info(f'PID {pid} will be terminated') + + child.terminate() + filename_info = get_current_download_file_destination(child.cmdline()) + + new_name = f'{filename_info.get("path")}{filename_info.get("filename_stem")}_terminated{filename_info.get("extension")}' + + os.rename(filename_info.get('part_filename'), new_name) # renaming file to remove the .part + return pid + else: + logging.getLogger('process_utils').error(f'PID {pid} does not exist or does not belong to the application') + + return None + + +def terminate_all_active_downloads(): + logging.getLogger('process_utils').info('All active downloads are being terminated') + + pids = [] + for download in get_active_downloads_list(): + pid = download.get('pid') + pids.append(terminate_active_download(pid)) + + return pids diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..effc0ba --- /dev/null +++ b/readme.md @@ -0,0 +1,271 @@ +# ydl_api_ng + +ydl_api_ng is the new version of [ydl_api](https://github.com/Totonyus/ydl_api) + +## But why ? + +ydl_api was built to fulfill my needs, and it works really well for me. However, it has a few drawbacks : + +- limited to a few parameters +- complexity to add new parameters in the api +- Not suitable for advanced youtube-dl users + +## Differences with ydl_api ? + +- A huge portion of the codebase has been rewritten +- A new system of parameter file +- More powerful : you can now add any youtube-dlp option to ehance your downloads +- Better maintenability : no need new devs on this application if youtube-dlp adds new options +- Suitable for advanced youtube-dlp users +- Not complicated for basic users +- New features are planned + +# Installation + +## With docker + +Container on Docker Hub [here](https://hub.docker.com/r/totonyus/ydl_api_ng) + +The parameters files are generated in the params volume on the first launch of the container. + +### Volumes mapping + +Volumes you could want to map : + +- `/app/downloads/` : where files will be downloaded +- `/app/params/` : where the parameters files will be stored +- `/app/params/hooks_utils/` : if you need to import your own python scripts for the hooks handlers +- `/app/logs` + +### Ports + +The internal port of the api is `80` + +### Docker-compose + +Just copy the `docker-compose.yml` file where you want and launch this command : + +```shell +docker-compose pull # pull the latest image +docker-compose up # to start the container +docker-compose down # to stop the container +``` + +### By command line + +```shell +docker run -p 5011:80 totonyus/ydl_api # don't forget to map the folders +``` + +### UID and GID + +The default user used in the container is `1000:1000`. You can edit thoses by changing the environment vars `UID` +and `GID` in the `docker-compose.yml` or in the `docker run` command. + +The user must be root (`UID=0` ans `GID=0`) or match the owner of the download repository. + +To know your `UID` and `GID`, simple run this command with the right user or check your `/etc/passwd` file. + +```shell +echo $UID $GIG +``` + +## Without Docker + +## Requirements + +* Installation with distribution package manager (`apt`, `yum`, ...) : `python3`, `python3-pip`, `ffmpeg` + +```shell +pip3 install -r pip_requirements +``` + +### Download this repo + +Download the latest release : + +```shell +wget https://github.com/Totonyus/ydl_api_ng/archive/master.zip +``` + +Then unzip the file and rename the unziped folder : (note you can use `unzip -d %your_path%` to specify where you want +to unzip the file ) + +```shell +unzip master.zip; mv ydl_api_ng-master ydl_api_ng +``` + +### Modify listening port + +The api listen by default on the port `80`. It's perfect for docker use but not really a good idea for a bare metal +user. Set the port you want in the `params.ini` file. + +### Install as daemon + +Just fill the `ydl_api_ng.service` file and move it in `/usr/lib/systemd/system/` for `systemd` linux. + +```shell +mv ydl_api.service /usr/lib/systemd/system/ +``` + +You can change the name of the service by changing the name of the file. + +then (you must run this command every time you change the service file) + +```shell +systemctl daemon-reload +``` + +Commands : + +```shell +systemctl start ydl_api_ng +systemctl stop ydl_api_ng +systemctl enable ydl_api_ng # start at boot +systemctl disable ydl_api_ng # don't start at boot +``` + +### Install the userscript + +Install [Greasemonkey (firefox)](https://addons.mozilla.org/fr/firefox/addon/greasemonkey/) +or [Tampermonkey (chrome)](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo?hl=fr) +and add a new userscript. Then copy the content of `userscript.js` in the interface and save. + +Then change the default host set in the script. You can also customize all the presets to match the configuration file +of your server. + +You now should have access to download options on every site. You can also modify the match options to limit the usages. + +## Files you'll probably want to consult or customize + +These files are generated in `params/` +* `params.ini` all the default parameters of the application, everything is set up to offer you a working application + out of the box +* `params_metadata.ini` describe how each parameter in `params.ini` should be interpreted +* `userscript.js` a javascript file you can import + in [Greasemonkey (firefox)](https://addons.mozilla.org/fr/firefox/addon/greasemonkey/) + or [Tampermonkey (chrome)](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo?hl=fr) + to access the api from yout browser +* `progress_hooks.py` youtube-dl progress hooks handler method +* `postprocessor_hooks.py` youtube-dl postprocessor hooks handler method +* `ydl_api_hooks.py` api hooks handler methods, only called at few moments +* `hooks_requirements` the extra requirements you need to fully use the hooks + +There files are in the base folder : +* `docker-compose.yml` to configure easily the container +* `ydl_api_ng.service` a systemd service file to launch this application as a daemon + +## Updating youtube-dlp + +### Docker + +Simply reload the container, an updated is performed at launch + +### Without docker + +```shell +pip3 install yt_dlp --upgrade +``` + +## Configuration details + +### parameters_metadata.ini + +Each parameter in the `params.ini` file is a string. The `parameters_metadata.ini` file is used to describe how each +parameter must be cast. + +As I don't know any option of `youtuble-dlp`, I tried my best to arrange the fields correctly but some are probably +wrong. + +Please don't hesitate to make a merge request or to open a ticket on this repo to ask the correction. + +You can also add your own parameters fields if you need it. + +### params.sample.ini + +This file is a complete working configation file who is fully documented to help you to understand how it works. + +## User management + +If the user management is activated (disabled by default), each request must have the `&token` query parameter. You can +override some parameters for a specific user. + +## Site management + +You can define parameters for given websites. It's usefull to avoid long-running playlist download simulation. + +```ini +# Every host matching this site +_hosts = www.youtube.com,youtu.be +# How to define the url is a video +_video_indicators = /watch? +# How to define the url is a playlist +_playlist_indicators = ?list=,&list=,/user/,/playlists +``` + +You can also add parameters tied to the site like login informations + +# API + +## Application informations + +Return the application complete parameters + +```shell +GET http://localhost:5011/info +``` + +### Responses status + +* `401` : User is not permitted + +## Downloads + +Only the url is required to use the api. + +```shell +# Simplest case, uses the DEFAULT preset +GET http://localhost:5011/download?url=https://www.youtube.com/watch?v=9Lgc3TxqgHA + +# You can download multiple presets at once, if no preset is valid, will download with DEFAULT preset, if at least one preset is valid, will download only valid presets +GET http://localhost:5011/download?url=https://www.youtube.com/watch?v=Kf1XttuuIiQ&presets=audio,hd + +# If the user management is enabled +GET http://localhost:5011/download?url=https://www.youtube.com/watch?v=wV4wepiucf4&token=dad_super_password +``` + +## Video informations + +Returns the standart youtube-dlp extract info object. + +```shell +GET http://localhost:5011/extract_info?url=https://www.youtube.com/watch?v=9Lgc3TxqgHA +``` + +### Responses status + +* `401` : User is not permitted + +## Process management + +The process management system only works you livestreams + +```shell +# Get all active downloads (with PID) +GET http://localhost:5011/active_downloads + +# Stop all active downloads +GET http://localhost:5011/active_downloads/terminate + +# Stop the active download with it PID. It uses se system PID, this feature is safe, a non-child process cannot be killed +GET http://localhost:5011/active_downloads/terminate/{pid} +``` + +## Responses status + +* `401` : User is not permitted + +# Contributing + +- Found a bug ? Need an imprivment ? Need help ? Open a ticket ! +- \ No newline at end of file diff --git a/unit_tests.py b/unit_tests.py new file mode 100644 index 0000000..2147a02 --- /dev/null +++ b/unit_tests.py @@ -0,0 +1,294 @@ +import unittest + +import requests + +import config_manager +import download_manager + + +class TestConfig(unittest.TestCase): + config_manager = config_manager.ConfigManager('params/params.sample.ini') + + def test_meta(self): + self.assertIsInstance(self.config_manager.get_app_params().get('_int_test'), int) + self.assertIsInstance(self.config_manager.get_app_params().get('_float_test'), float) + self.assertIsInstance(self.config_manager.get_app_params().get('_bool_test'), bool) + self.assertIsInstance(self.config_manager.get_app_params().get('_string_test'), str) + self.assertIsInstance(self.config_manager.get_app_params().get('_array_test'), list) + self.assertIsInstance(self.config_manager.get_app_params().get('_object_test'), dict) + + def test_sites(self): + self.assertIsNotNone(self.config_manager.get_site_params('www.youtube.com')) + self.assertIsNone(self.config_manager.get_site_params('youteu.be')) + self.assertIsNotNone(self.config_manager.get_site_params('www.youtube.com').get('_hosts')) + + def test_presets(self): + self.assertIsNotNone(self.config_manager.get_preset_params('HD')) + self.assertIsNone(self.config_manager.get_preset_params('4K')) + self.assertIsNotNone(self.config_manager.get_preset_params('HD')) + self.assertIsNotNone(self.config_manager.get_preset_params('audio')) + self.assertEqual('bestaudio', self.config_manager.get_preset_params('audio').get('format')) + + def test_expand(self): + self.assertEqual('videos/%(webpage_url_domain)s/%(title)s_(%(height)s).%(ext)s', self.config_manager.get_preset_params('DEFAULT').get('outtmpl').get('default')) + self.assertEqual('videos/%(webpage_url_domain)s/%(title)s_(%(height)s).%(ext)s', self.config_manager.get_preset_params('SHARE').get('outtmpl').get('default')) + self.assertNotEqual('/home/videos/%(webpage_url_domain)s/%(title)s_(%(height)s).%(ext)s', self.config_manager.get_preset_params('DEFAULT').get('outtmpl').get('default')) + self.assertFalse(self.config_manager.get_preset_params('playlist').get('noplaylist')) + self.assertTrue(self.config_manager.get_preset_params('DEFAULT').get('noplaylist')) + + def test_app(self): + self.assertEqual('/download', self.config_manager.get_app_params().get('_api_route_download')) + self.assertIsNotNone(self.config_manager.get_app_params().get('_enable_users_management')) + + def test_user(self): + self.assertIsNotNone(self.config_manager.get_user_param_by_token('dad_super_password')) + self.assertIsNone(self.config_manager.get_user_param_by_token('doggo_super_password')) + self.assertIsNone(self.config_manager.get_user_param_by_token('dad_super_password').get('doesnotexists')) + self.assertEqual('./downloads/symlink_to_dad_home/', self.config_manager.get_user_param_by_token('dad_super_password').get('paths').get('home')) + + def test_auth(self): + self.assertEqual('Totonyus', self.config_manager.get_auth_params('DAILYMOTION').get('username')) + self.assertEqual('is_this_site_still_running_fr_?', self.config_manager.get_auth_params('DAILYMOTION').get('password')) + + +class TestUtils(unittest.TestCase): + config_manager = config_manager.ConfigManager('params/params.sample.ini') + + def test_get_presets(self): + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=OWCK3413Wuk', None, None) + + dm.flush_presets() + self.assertIsNotNone(dm.get_presets_objects(['AUDIO'])) + + dm.flush_presets() + self.assertEqual(2, len(dm.get_presets_objects(['HD', 'FULLHD']))) + + dm.flush_presets() + self.assertEqual(1, len(dm.get_presets_objects(['8K', '4K']))) + + dm.flush_presets() + self.assertEqual(1, len(dm.get_presets_objects([]))) + + dm.flush_presets() + self.assertEqual(1, len(dm.get_presets_objects(None))) + + dm.flush_presets() + self.assertEqual('DEFAULT', dm.get_presets_objects([])[0].get('_name')) + + dm.flush_presets() + self.assertEqual(1, len(dm.get_presets_objects(['HD', '4K']))) + + dm.flush_presets() + dm.get_presets_objects(['HD', '4K']) + self.assertEqual(1, dm.presets_not_found) + + dm.flush_presets() + dm.get_presets_objects(['HD', '4K', '8K']) + self.assertEqual(2, dm.presets_not_found) + + dm.flush_presets() + dm.get_presets_objects(['HD', 'AUDIO']) + self.assertEqual(2, dm.presets_found) + + dm.flush_presets() + dm.get_presets_objects(['HD', '4K', '8K']) + self.assertEqual(1, dm.presets_found) + + dm.flush_presets() + dm.get_presets_objects(['HD', '4K', '8K', 'AUDIO']) + self.assertEqual(2, dm.presets_found) + + dm.flush_presets() + dm.get_presets_objects(['8K', '4K']) + self.assertTrue(dm.no_preset_found) + + dm.flush_presets() + dm.get_presets_objects(['8K', '4K', 'AUDIO']) + self.assertFalse(dm.no_preset_found) + + def test_is_from_playlist(self): + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj', None, None) + self.assertTrue(dm.is_from_playlist()) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y&list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj&index=2', None, None) + self.assertTrue(dm.is_from_playlist()) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, None) + self.assertFalse(dm.is_from_playlist()) + + dm = download_manager.DownloadManager(self.config_manager, 'https://twitter.com/Totonyus/status/1471896525617909760', None, None) + self.assertIsNone(dm.is_from_playlist()) + + def test_is_video(self): + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj', None, None) + self.assertFalse(dm.is_video()) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y&list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj&index=2', None, None) + self.assertTrue(dm.is_video()) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, None) + self.assertTrue(dm.is_video()) + + dm = download_manager.DownloadManager(self.config_manager, 'https://twitter.com/Totonyus/status/1471896525617909760', None, None) + self.assertIsNone(dm.is_video()) + + def test_can_be_checked(self): + default_preset = self.config_manager.get_preset_params('DEFAULT') + playlist_preset = self.config_manager.get_preset_params('PLAYLIST') + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj', None, None) + self.assertFalse(dm.can_url_be_checked(default_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y&list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj&index=2', None, None) + self.assertTrue(dm.can_url_be_checked(default_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, None) + self.assertTrue(dm.can_url_be_checked(default_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://twitter.com/Totonyus/status/1471896525617909760', None, None) + self.assertTrue(dm.can_url_be_checked(default_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj', None, None) + self.assertFalse(dm.can_url_be_checked(playlist_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y&list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj&index=2', None, None) + self.assertFalse(dm.can_url_be_checked(playlist_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, None) + self.assertTrue(dm.can_url_be_checked(playlist_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://twitter.com/Totonyus/status/1471896525617909760', None, None) + self.assertTrue(dm.can_url_be_checked(playlist_preset)) + + def test_get_permission(self): + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'dad_super_password') + self.assertIsInstance(dm.is_user_permitted(True), config_manager.SectionConfig) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'doggo_super_password') + self.assertFalse(dm.is_user_permitted(True)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, None) + self.assertFalse(dm.is_user_permitted(True)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'dad_super_password') + self.assertIsNone(dm.is_user_permitted(False)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'doggo_super_password') + self.assertIsNone(dm.is_user_permitted(False)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, None) + self.assertIsNone(dm.is_user_permitted(False)) + + def test_get_preset_for_user(self): + default_preset = self.config_manager.get_preset_params('DEFAULT') + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'totonyus_super_password') + self.assertEqual(['fr', 'en'], dm.get_preset_for_user(default_preset).get('subtitleslangs')) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'totonyus_super_password') + self.assertEqual('./downloads/', dm.get_preset_for_user(default_preset).get('paths').get('home')) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'totonyus_super_password') + self.assertEqual('DEFAULT', dm.get_preset_for_user(default_preset).get('_name')) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'dad_super_password') + self.assertEqual(['en'], dm.get_preset_for_user(default_preset).get('subtitleslangs')) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, 'dad_super_password') + self.assertEqual('./downloads/symlink_to_dad_home/', dm.get_preset_for_user(default_preset).get('paths').get('home')) + + def test_simulate(self): + default_preset = self.config_manager.get_preset_params('DEFAULT') + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', None, None) + self.assertTrue(dm.simulate_download(default_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UfErWGjj95', None, None) + self.assertFalse(dm.simulate_download(default_preset)) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj', None, None) + self.assertIsNone(dm.simulate_download(default_preset)) + + @unittest.skip + def test_process_download(self): + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', ['DEFAULT'], None) + self.assertTrue(dm.process_download(dm.presets[0])) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', ['AUDIO'], None) + self.assertTrue(dm.process_download(dm.presets[0])) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5dUErWGjj95', ['AUDIO'], None) + self.assertFalse(dm.process_download(dm.presets[0])) + + dm = download_manager.DownloadManager(self.config_manager, 'https://www.youtube.com/watch?v=5UErWGjj95Y', ['AUDIO'], 'dad_super_password') + self.assertTrue(dm.process_download(dm.presets[0])) + + def test_sanitize(self): + self.config_manager.get_user_param_by_token('dad_super_password'), + self.assertEqual('dad_super_password', self.config_manager.get_user_param_by_token('dad_super_password').get('_token')) + + self.assertIsNone(self.config_manager.sanitize_config_object(self.config_manager.get_all_users_params()).get('DAD').get('_token')) + + +@unittest.skip +class TestAPI(unittest.TestCase): + base_url = "http://localhost:5011/download" + + def test_download(self): + self.assertEqual(401, requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk').status_code) + self.assertEqual(202, requests.get(f'{self.base_url}?url=https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj&token=dad_super_password').status_code) + self.assertEqual(200, requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=dad_super_password').status_code) + self.assertEqual(401, requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=mom_super_password').status_code) + self.assertEqual(400, requests.get(f'{self.base_url}?url=&token=dad_super_password').status_code) + self.assertEqual(422, requests.get(f'{self.base_url}?token=dad_super_password').status_code) + self.assertEqual(200, requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=dad_super_password&presets=hd').status_code) + self.assertEqual(200, requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=totonyus_super_password&presets=hd').status_code) + self.assertEqual(200, requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=dad_super_password&presets=hd,audio').status_code) + self.assertEqual(200, requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=dad_super_password&presets=HD,AUDIO').status_code) + self.assertEqual(206, requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=dad_super_password&presets=hd,audio,4k').status_code) + + def test_download_info(self): + request_json = requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=dad_super_password&presets=hd,audio,4k').json() + + self.assertTrue(request_json.get('all_downloads_checked')) + self.assertFalse(request_json.get('no_preset_found')) + self.assertEqual(2, request_json.get('presets_found')) + self.assertEqual(1, request_json.get('presets_not_found')) + self.assertEqual(0, request_json.get('failed_checks')) + self.assertEqual(2, request_json.get('passed_checks')) + self.assertEqual('HD', request_json.get('downloads')[0].get('_name')) + self.assertEqual('AUDIO', request_json.get('downloads')[1].get('_name')) + + request_json = requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=fdsOWCK3413Wuk&token=dad_super_password&presets=4K,8K').json() + + self.assertTrue(request_json.get('all_downloads_checked')) + self.assertTrue(request_json.get('no_preset_found')) + self.assertEqual(0, request_json.get('presets_found')) + self.assertEqual(2, request_json.get('presets_not_found')) + self.assertEqual(1, request_json.get('failed_checks')) + self.assertEqual(0, request_json.get('passed_checks')) + self.assertEqual('DEFAULT', request_json.get('downloads')[0].get('_name')) + + request_json = requests.get(f'{self.base_url}?url=https://www.youtube.com/watch?v=OWCK3413Wuk&token=dad_super_password').json() + + self.assertTrue(request_json.get('all_downloads_checked')) + self.assertFalse(request_json.get('no_preset_found')) + self.assertEqual(0, request_json.get('presets_found')) + self.assertEqual(0, request_json.get('presets_not_found')) + self.assertEqual(0, request_json.get('failed_checks')) + self.assertEqual(1, request_json.get('passed_checks')) + self.assertEqual('DEFAULT', request_json.get('downloads')[0].get('_name')) + + request_json = requests.get(f'{self.base_url}?url=https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj&token=dad_super_password').json() + + self.assertFalse(request_json.get('all_downloads_checked')) + self.assertFalse(request_json.get('no_preset_found')) + self.assertEqual(0, request_json.get('presets_found')) + self.assertEqual(0, request_json.get('presets_not_found')) + self.assertEqual(0, request_json.get('failed_checks')) + self.assertEqual(1, request_json.get('passed_checks')) + self.assertEqual('DEFAULT', request_json.get('downloads')[0].get('_name')) + + +if __name__ == '__main__': + unittest.main() diff --git a/ydl_api_ng.service b/ydl_api_ng.service new file mode 100644 index 0000000..4804358 --- /dev/null +++ b/ydl_api_ng.service @@ -0,0 +1,20 @@ +# This file must be placed in /usr/lib/systemd/system/ + +[Unit] +Description=Simple Rest api for youtube-dl +After=network.target + +[Service] +type=simple +RemainAfterExit=yes + +# (Optional, default='root') uncomment and enter here the user and group you want +#User=---%--- REPLACE ---%--- +#Group=---%--- REPLACE ---%--- + +# The directory where you downloaded this program +WorkingDirectory=---%--- REPLACE ---%--- +ExecStart=python3 main.py + +[Install] +WantedBy=multi-user.target