├── .gitignore ├── LICENSE ├── docker-compose.yml ├── dockerfile ├── entrypoint.sh ├── hooks.py ├── launch.sh ├── main.py ├── params.py ├── process_utils.py ├── readme.md ├── readme.old.md ├── requirements.txt ├── result.jpg ├── tests.py ├── userscript.js ├── ydl_api.service └── ydl_utils.py /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | .idea 3 | *.iml 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.1" 2 | services: 3 | ydl_api: 4 | container_name: ydl_api 5 | image: totonyus/ydl_api 6 | ports: 7 | - 5011:80 8 | volumes: 9 | - ./downloads:/app/downloads 10 | - ./params:/app/params 11 | -------------------------------------------------------------------------------- /dockerfile: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM python:3.9-slim-buster 4 | WORKDIR /app 5 | 6 | COPY main.py process_utils.py ydl_utils.py entrypoint.sh userscript.js requirements.txt ./ 7 | COPY hooks.py params.py userscript.js ./setup/ 8 | 9 | RUN pip3 install -r requirements.txt 10 | RUN apt update && apt install ffmpeg -y && apt-get autoremove && apt-get -y clean && rm -rf /var/lib/apt/lists/* 11 | 12 | EXPOSE 80 13 | VOLUME ["/app/downloads", "/app/params"] 14 | 15 | CMD ["sh", "/app/entrypoint.sh"] 16 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | pip3 install yt-dlp --upgrade 4 | 5 | if [ ! -f /app/params/params.py ]; then 6 | cp /app/setup/params.py /app/params/params.py 7 | fi 8 | 9 | if [ ! -f /app/params/hooks.py ]; then 10 | cp /app/setup/hooks.py /app/params/hooks.py 11 | fi 12 | 13 | if [ ! -f /app/params/userscript.js ]; then 14 | cp /app/setup/userscript.js /app/params/userscript.js 15 | fi 16 | 17 | ln -s /app/params/params.py /app/params.py 18 | ln -s /app/params/hooks.py /app/hooks.py 19 | 20 | uvicorn main:app --port 80 --host 0.0.0.0 21 | -------------------------------------------------------------------------------- /hooks.py: -------------------------------------------------------------------------------- 1 | import logging 2 | 3 | """ 4 | You can customize this method as you want 5 | ydl_api_opts = { 6 | 'hostname' : urlparse(url).hostname, 7 | 'user_name' : definitive_params.get('user_name'), 8 | 'user_token' : definitive_params.get('user_token'), 9 | 'location_identifier' : definitive_params.get('location'), 10 | 'filename_identifier' : definitive_params.get('filename'), 11 | 'url' : url, 12 | 'is_playlist' : url_properties.get('playlist'), 13 | 'is_video' : url_properties.get('video') 14 | } 15 | 16 | download is the standard youtube-dl object 17 | """ 18 | def handler(ydl_opts, download): 19 | if download.get('status') == 'finished': 20 | logging.info(f'{download.get("filename")} download finished ({download.get("_total_bytes_str")})') 21 | if download.get('status') == 'error': 22 | logging.error(f'Download failed') 23 | -------------------------------------------------------------------------------- /launch.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | uvicorn main:app --port 5011 --host 0.0.0.0 4 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import logging, ydl_utils, params, process_utils 2 | from urllib.parse import urlparse, unquote 3 | from fastapi import BackgroundTasks, FastAPI, Response 4 | import yt_dlp as youtube_dl 5 | 6 | app = FastAPI() 7 | 8 | @app.get(params.api_route) 9 | async def download_request(response : Response, background_tasks : BackgroundTasks, url, token = None, 10 | format = None, subtitles = None, location = None, filename = None, presets = None): 11 | 12 | decoded_url = unquote(url) 13 | decoded_presets = [] # from string to list 14 | selected_presets_objects = [] # store presets objects required by the presets field 15 | 16 | if presets is not None: 17 | decoded_presets = presets.split(',') 18 | selected_presets_objects = ydl_utils.existing_presets(decoded_presets) # transform string in object 19 | 20 | user = None 21 | if params.enable_users_management and token is not None: 22 | user = ydl_utils.find_associated_user(unquote(token)) 23 | 24 | if params.enable_users_management and user is None: 25 | logging.warning(f'An unauthorized user tried to download {decoded_url}') 26 | response.status_code = 401 # unauthorized 27 | return {'status_code' : response.status_code} 28 | 29 | query_parameters = { # parameters object build form url query parameters 30 | 'format' : unquote(format) if format is not None else None, 31 | 'subtitles' : unquote(subtitles) if subtitles is not None else None, 32 | 'location' : unquote(location) if location is not None else None, 33 | 'filename' : unquote(filename) if filename is not None else None, 34 | 'presets' : unquote(presets) if presets is not None else None 35 | } 36 | 37 | # override location setting of the preset for the current user 38 | if params.enable_users_management and user.get('force_location') is not None : 39 | query_parameters['location'] = user.get('force_location') 40 | 41 | # generate all options sets for all download 42 | downloads_options_sets = ydl_utils.generate_ydl_options_sets(decoded_url, selected_presets_objects, query_parameters, user) 43 | 44 | # count the number of check downloads and the number of errors 45 | validity_check = ydl_utils.recap_all_downloads_validity(downloads_options_sets) 46 | 47 | # if all downloads were checked and without errors, we can ensure the file will be correctly downloaded 48 | if validity_check.get('checked') == validity_check.get('total') and validity_check.get('errors') == 0: 49 | background_tasks.add_task(ydl_utils.launch_downloads, decoded_url, downloads_options_sets) 50 | response.status_code = 200 # request ok 51 | # if not all downloads were checked, we can't ensure all files will be correctly downloaded 52 | elif validity_check.get('checked') != validity_check.get('total'): 53 | background_tasks.add_task(ydl_utils.launch_downloads, decoded_url, downloads_options_sets) 54 | response.status_code = 202 # request ok but result not granted 55 | # if all downloads are in error, we can ensure no file will be downloaded 56 | else: 57 | logging.error(f'Impossible to download \'{decoded_url}\'') 58 | response.status_code = 400 # bad request 59 | 60 | return { 61 | 'status_code' : response.status_code, 62 | 'url' : decoded_url, 63 | 'presets_errors' : (len(decoded_presets) - len(selected_presets_objects)), 64 | 'list' : downloads_options_sets, 65 | 'youtube-dl_version' : youtube_dl.version.__version__ 66 | } 67 | 68 | @app.get(params.api_route_info) 69 | async def info_request(): 70 | return { 71 | 'state' : 'started', 72 | 'ydl_version' : youtube_dl.version.__version__ 73 | } 74 | 75 | @app.get(params.api_route_active_downloads) 76 | async def active_downloads_request(response : Response, token = None): 77 | user = None 78 | if params.enable_users_management and token is not None: 79 | user = ydl_utils.find_associated_user(unquote(token)) 80 | 81 | if params.enable_users_management and user is None: 82 | response.status_code = 401 # unauthorized 83 | return {'status_code' : response.status_code} 84 | 85 | return process_utils.get_active_downloads_list() 86 | 87 | @app.get(f'{params.api_route_active_downloads}/terminate') 88 | async def terminate_all_active_downloads(response : Response, token = None): 89 | user = None 90 | if params.enable_users_management and token is not None: 91 | user = ydl_utils.find_associated_user(unquote(token)) 92 | 93 | if params.enable_users_management and user is None: 94 | response.status_code = 401 # unauthorized 95 | return {'status_code' : response.status_code} 96 | 97 | return process_utils.terminate_all_active_downloads() 98 | 99 | @app.get(f'{params.api_route_active_downloads}/terminate/{"{pid}"}') 100 | async def terminate_active_download(response : Response, pid, token = None): 101 | user = None 102 | if params.enable_users_management and token is not None: 103 | user = ydl_utils.find_associated_user(unquote(token)) 104 | 105 | if params.enable_users_management and user is None: 106 | response.status_code = 401 # unauthorized 107 | return {'status_code' : response.status_code} 108 | 109 | return process_utils.terminate_active_download(unquote(pid)) 110 | -------------------------------------------------------------------------------- /params.py: -------------------------------------------------------------------------------- 1 | # /!\ Do not modify this if ydl_api runs in docker /!\ 2 | root_download_directory = './downloads' 3 | # /!\ Do not modify this if ydl_api runs in docker /!\ 4 | 5 | api_route = '/download' 6 | api_route_info = '/info' 7 | api_route_active_downloads = '/active_downloads' 8 | 9 | default_download_format= 'bestvideo+bestaudio/best' #https://github.com/ytdl-org/youtube-dl/tree/3e4cedf9e8cd3157df2457df7274d0c842421945#format-selection 10 | 11 | default_subtitles_languages = None #example : 'en,fr' 12 | default_subtitles_format = 'srt' 13 | 14 | keep_modification_time = False #True = modified date of the file will be the upload date, False = current date 15 | 16 | no_playlist = True #prevent downloading all the playlist when a video url contains playlist id 17 | playlist_detection = [ #used to detect if the url is a video, a playlist or a video in a playlist 18 | {'hosts' : ['www.youtube.com', 'youtu.be'], 'video_indicators': ['/watch?'] , 'playlist_indicators' : ['?list=', '&list=', '/user/', '/playlists']} 19 | ] 20 | 21 | # https://github.com/ytdl-org/youtube-dl/tree/3e4cedf9e8cd3157df2457df7274d0c842421945#output-template 22 | # you can use those tags : %hostname%, %location_identifier%, %filename_identifier%, %user_name% 23 | # /!\ Docker note : you can only set path included in the downloads volume, you can use symlinks /!\ 24 | download_directory_templates={ # you must keep a 'default' preset 25 | 'default' : f'{root_download_directory}/', 26 | #'dad' : '/home/dad/' # utility example 27 | } 28 | 29 | # https://github.com/ytdl-org/youtube-dl/tree/3e4cedf9e8cd3157df2457df7274d0c842421945#output-template 30 | # you can use those tags : %hostname%, %location_identifier%, %filename_identifier%, %user_name% 31 | file_name_templates = { # you must keep a 'default' preset 32 | 'default' : 'videos/%hostname%/%(title)s_(%(height)s).%(ext)s', 33 | 'playlist' : 'videos/%hostname%/playlists/%(playlist)s/%(title)s_(%(height)s).%(ext)s', 34 | 'audio' : 'audio/%(title)s.%(ext)s', 35 | } 36 | 37 | presets_templates={ # you must keep a 'default' preset 38 | 'default' : {'format' : default_download_format, 'subtitles' : default_subtitles_languages, 'location' : 'default', 'filename' : 'default'}, 39 | 'audio': {'format' : 'bestaudio', 'filename' : 'audio'}, # you can skip parameters you want to remain default 40 | 'best' : {'format' : 'bestvideo+bestaudio/best'}, 41 | 'fullhd' : {'format' : 'best[height=1080]/bestvideo[height=1080]+bestaudio/best'}, 42 | 'hd' : {'format' : 'best[height=720]/bestvideo[height=720]+bestaudio/best'}, 43 | 'sd' : {'format' : 'best[height=360]/bestvideo[height=360]+bestaudio/best'}, 44 | 'archiving' : {'filename' : 'playlist'}, 45 | } 46 | 47 | # enable security in case yu want to open the api to the web 48 | enable_users_management = False 49 | 50 | authorized_users_list = [ # ---%--- REPLACE ---%--- your token here 51 | { 'name' : 'default', 'token' : 'ydl_api_very_secret_token', 'force_location' : None }, 52 | #{ 'name' : 'dad', 'token' : 'dad_super_password', 'force_location' : 'dad' } #for example 53 | ] 54 | -------------------------------------------------------------------------------- /process_utils.py: -------------------------------------------------------------------------------- 1 | import psutil 2 | import re, os 3 | import pathlib 4 | import logging 5 | 6 | 7 | def get_active_downloads_list(): 8 | children_process = psutil.Process().children(recursive=True) 9 | 10 | active_downloads_list = [] 11 | for child in children_process: 12 | active_download = { 13 | 'command_line': f'{child.cmdline()}', 14 | 'filename': get_current_download_file_destination(child.cmdline()), 15 | 'pid': child.pid, 16 | 'create_time' : child.create_time() 17 | } 18 | 19 | active_downloads_list.append(active_download) 20 | 21 | return active_downloads_list 22 | 23 | 24 | def get_current_download_file_destination(cmdline): 25 | regex = r'\'file:(.*\/)(.*)\'' 26 | 27 | match = re.search(regex, f'{cmdline}') 28 | 29 | part_filename = f'{match.group(1)}{match.group(2)}' 30 | filename = part_filename.rstrip('.part') 31 | 32 | path = match.group(1) 33 | filename_stem = pathlib.Path(filename).stem 34 | extension = pathlib.Path(filename).suffix 35 | 36 | return { 37 | 'part_filename': part_filename, 38 | 'filename': filename, 39 | 'path': path, 40 | 'filename_stem': filename_stem, 41 | 'extension': extension, 42 | } 43 | 44 | 45 | def is_a_child_process(pid): 46 | children_process = psutil.Process().children(recursive=True) 47 | 48 | is_child = False 49 | 50 | for child in children_process: 51 | if child.pid == pid: 52 | is_child = True 53 | 54 | return is_child 55 | 56 | 57 | def get_child_object(pid): 58 | children_process = psutil.Process().children(recursive=True) 59 | 60 | for child in children_process: 61 | if child.pid == pid: 62 | return child 63 | 64 | return None 65 | 66 | 67 | def terminate_active_download(pid): 68 | logging.info(f'Active download {pid} is being terminated') 69 | 70 | child = get_child_object(int(pid)) 71 | 72 | if child is not None: 73 | child.terminate() 74 | filename_info = get_current_download_file_destination(child.cmdline()) 75 | 76 | new_name = f'{filename_info.get("path")}{filename_info.get("filename_stem")}_terminated{filename_info.get("extension")}' 77 | 78 | os.rename(filename_info.get('part_filename'), new_name) # renaming file to remove the .part 79 | return pid 80 | 81 | return None 82 | 83 | 84 | def terminate_all_active_downloads(): 85 | logging.info('All active downloads are being terminated') 86 | 87 | pids = [] 88 | for download in get_active_downloads_list(): 89 | pid = download.get('pid') 90 | pids.append(terminate_active_download(pid)) 91 | 92 | return pids 93 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # Important notice 2 | This project is deprecated. Find the new version here : [ydl_api_ng](https://github.com/Totonyus/ydl_api_ng) 3 | 4 | To find documentation of the repo, refer to the `readme.old.md` file -------------------------------------------------------------------------------- /readme.old.md: -------------------------------------------------------------------------------- 1 | # Important update 2 | youtube-dlp is now used instead of youtube-dl 3 | 4 | # Simple youtube-dl rest API (ydl_api) 5 | 6 | ### Exhaustive list of the ydl_api features 7 | - Launch youtube-dl download directly on your server 8 | - Chose your video format 9 | - Download subtitles 10 | 11 | ### Disclaimer 12 | This is my very first python program. I did my best. If you are an experienced python developer, you may not want to look at the source code. (I'm kidding, you're going to have to configure some things anyway). 13 | 14 | ### Files 15 | * `readme.md` 16 | * `main.py` the main program 17 | * `ydl_utils.py` utils to make downloading easier 18 | * `process_utils.py` utils to manage download process 19 | * `params.py` all the default parameters of the application, everything is set up to offer you a working application out of the box 20 | * `hooks.py` youtube-dl hooks handler method. Customize this as you want ! 21 | * `launch.sh` a simple sh file to launch the server 22 | * `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 23 | * `ydl_api.service` a systemd service file to launch this application as a daemon 24 | * An iOS shortcut you can find [here](https://www.icloud.com/shortcuts/a4656b84fb614f3ebce46d8d8c9d0a38) 25 | * API documentation at the url `http://localhost:5011/docs` 26 | 27 | ### Dependencies 28 | * Installation with distribution package manager (`apt`, `yum`, ...) : `python3`, `python3-pip`, `ffmpeg` 29 | * Installation with pip3 : `fastapi`, `uvicorn`, `yt-dlp` 30 | 31 | ``` 32 | pip3 install fastapi yt-dlp uvicorn --upgrade 33 | ``` 34 | 35 | * Make sure you have the last youtube-dl version installed : `yt-dlp --version` (currently `2022.03.08.2`). You could have problems with some videos if you use an older version. 36 | 37 | ### Installation 38 | #### Download this repo 39 | Download the latest release : 40 | ``` 41 | wget https://github.com/Totonyus/ydl_api/archive/master.zip 42 | ``` 43 | 44 | 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 ) 45 | ``` 46 | unzip master.zip; mv ydl_api-master ydl_api 47 | ``` 48 | 49 | #### Configuration 50 | The application is setup to work out of th box but you should probably change some settings : 51 | 52 | Placeholders looks like this : `---%--- REPLACE ---%---` 53 | * (Optional) `params.py` : you can change destination folder, file name template and a few others options 54 | * (Optional) `userscript.js` : you must set your api route (default : `http://localhost:5011/download`, you can also add format options as you want 55 | * (Optional) `launch.sh` : the default port is set arbitrarily to `5011`. Change it as you want. 56 | * (Optional) `ydl_api.service` : you must set the working directory to the directory you downloaded this application. If you don't want change default user and group, you can delete those lines : 57 | 58 | ``` 59 | # (Optional, default='root') Enter here the user and group you want 60 | User=---%--- REPLACE ---%--- 61 | Group=---%--- REPLACE ---%--- 62 | ``` 63 | 64 | #### Install as daemon 65 | Just move `ydl_api.service` in `/usr/lib/systemd/system/` for `systemd` linux. 66 | 67 | ``` 68 | mv ydl_api.service /usr/lib/systemd/system/ 69 | ``` 70 | 71 | You can change the name of the service by changing the name of the file. 72 | 73 | then (you must run this command every time you change the service file) 74 | 75 | ``` 76 | systemctl daemon-reload 77 | ``` 78 | 79 | To start the daemon : 80 | ``` 81 | systemctl start ydl_api 82 | ``` 83 | 84 | To stop the daemon : 85 | ``` 86 | systemctl stop ydl_api 87 | ``` 88 | 89 | To start the daemon on boot : 90 | ``` 91 | systemctl enable ydl_api 92 | ``` 93 | 94 | To NOT start the daemon on boot : 95 | ``` 96 | systemctl disable ydl_api 97 | ``` 98 | 99 | #### Install the userscript 100 | 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. 101 | 102 | You now should have access to download options on every site. 103 | 104 | ![result.jpg](result.jpg) 105 | 106 | ##### Userscript setup 107 | You probably should change the default host set in the script. 108 | 109 | You can modify the `preset_list` as you want. Note : the key parameter of a preset is not mandatory. It's just a shortcut. 110 | 111 | ### API usage 112 | #### Templates 113 | You can create three types of templates : 114 | 115 | * download destinations in `params.download_directory_templates` 116 | * file names in `params.file_name_templates` 117 | * server-side presets in `params.presets_templates` 118 | 119 | In all cases, always keep a template named `default` (you still can modify them). 120 | 121 | ##### Download destinations and file name templates 122 | In those templates, you can use tags delimited by `%` (example : `%hostname%`). 123 | 124 | Provided tags are `hostname`, `location_identifier`, `filename_identifier` and `user_name` 125 | 126 | ##### Presets 127 | If more than one preset is provided (`&presets=audio,best`), the url will be downloaded one time with each format. For example, you can download both music and clip of a song video. 128 | 129 | Some rules : 130 | * If not all provided presets are correct, only the correct presets will be downloaded 131 | * If no correct preset is provided, the default preset is used 132 | 133 | #### Authentication 134 | The authentication is disabled by default. It could be a great idea to activate it if : 135 | - you open your ydl_api installation on the web 136 | - multiple users uses your ydl_api installation 137 | 138 | ##### Define users 139 | The users list can be set in `params.authorized_users_list` with those parameters : 140 | - name : just a common name, only used within logs 141 | - token : the token of the user. The token must be provided in any request 142 | - force_location : the destination folder can be forced according to the user, if `None`, the default behavior is used 143 | 144 | #### Query parameters 145 | Parameters : 146 | * `url` : the page to download 147 | * (optional) `format` : the format of the video you want, if not provided, default value = `params.default_format` 148 | * (optional) `subtitles` : the list of subtitles you want to download. Can not download generated subtitles. If not provided, default value = `params.default_subtitles_languages` 149 | * (optional) `location` : the identifier of the location you want to use. Set in `download_directory_templates`. If not provided, default value = `default` 150 | * (optional) `filename` : the identifier of the filename you want to use. Set in `params.file_name_templates`. If not provided, default value = `default` 151 | * (optional) `presets` : the identifier of the presets you want to use. Multiple preset are separated by coma `&presets=audio,best`. The presets are defines in `params.presets_templates` 152 | * (Optional if `params.enable_users_management` is False) `token`: the user authentication token 153 | 154 | #### Priority 155 | The priority order of parameters is : User forced location > Query paramaters > Preset parameters > Default parameters. 156 | 157 | This means : 158 | * you can override a preset parameter in your query 159 | * if a parameter is not present in you preset, the parameter of the default preset will be used (unless the parameter is present il query) 160 | * If the location is forced for a user, there is no way to change it in the query 161 | 162 | #### Manage process 163 | You can stop active downloads. 164 | 165 | Stop all active downloads : 166 | ``` 167 | GET http://localhost:5011/active_downloads/terminate 168 | ``` 169 | 170 | Stop the active download with it PID. It uses se system PID : 171 | ``` 172 | GET http://localhost:5011/active_downloads/terminate/{pid} 173 | ``` 174 | 175 | You can get a current download PID by using this route : 176 | ``` 177 | GET http://localhost:5011/active_downloads 178 | ``` 179 | 180 | This feature is safe : you cannot stop a process wich is not a children of the main process 181 | 182 | #### API usage examples 183 | Only the url is required to use the api. 184 | 185 | The simplest request is : (will use the default preset) 186 | 187 | ``` 188 | GET http://localhost:5011/download?url=https://www.youtube.com/watch?v=9Lgc3TxqgHA 189 | ``` 190 | 191 | However, most of the requests defined in the userscript will look like hits 192 | 193 | ``` 194 | GET http://localhost:5011/download?url=https://www.youtube.com/watch?v=Kf1XttuuIiQ&presets=audio 195 | ``` 196 | 197 | You can override presets parameters 198 | ``` 199 | GET http://localhost:5011/download?url=https://www.youtube.com/watch?v=wV4wepiucf4&presets=audio&location=default 200 | ``` 201 | 202 | #### API response 203 | Responses status : 204 | * 200 : Everything should be downloaded correctly 205 | * 202 : When downloading playlist : not all downloads were checked, some file may not be downloaded by youtube-dl 206 | * 202 : When using multiple presets : one or more presets is invalid, not all files will be downloaded 207 | * 400 : No video can be downloaded 208 | 209 | ### Docker 210 | 211 | The parameters files are generated in the params volume on the first launch of the container. 212 | 213 | Container on Docker Hub [here](https://hub.docker.com/r/totonyus/ydl_api) 214 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | fastapi 2 | yt-dlp 3 | uvicorn 4 | psutil 5 | -------------------------------------------------------------------------------- /result.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Totonyus/ydl_api/9c29bef025bc05b89b0e7ee1010b9015ac911588/result.jpg -------------------------------------------------------------------------------- /tests.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import ydl_utils 3 | import yt_dlp as youtube_dl 4 | 5 | class Tests(unittest.TestCase): 6 | def test_ydl_version(self): 7 | print(f'youtube-dl installed version : {youtube_dl.version.__version__}') 8 | 9 | #Tests with no_playlist = True 10 | def test_must_be_checked_no_playlist(self): 11 | self.assertTrue(ydl_utils.can_be_checked('https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj', True) is False) #playlist only 12 | self.assertTrue(ydl_utils.can_be_checked('https://www.youtube.com/watch?v=Ax4uSTdkp04', True) is True) #video only 13 | self.assertTrue(ydl_utils.can_be_checked('https://www.youtube.com/watch?v=Ax4uSTdkp04&list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj&index=10&t=0s', True) is True) #video in playlist 14 | self.assertTrue(ydl_utils.can_be_checked('https://twitter.com/Totonyus/status/1198152820232314885', True) is True) #not youtube 15 | 16 | #Tests with no_playlist = False 17 | def test_must_be_checked_with_playlist(self): 18 | self.assertTrue(ydl_utils.can_be_checked('https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj', False) is False) #playlist only 19 | self.assertTrue(ydl_utils.can_be_checked('https://www.youtube.com/watch?v=Ax4uSTdkp04', False) is True) #video only 20 | self.assertTrue(ydl_utils.can_be_checked('https://www.youtube.com/watch?v=Ax4uSTdkp04&list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj&index=10&t=0s', False) is False) #video in playlist 21 | self.assertTrue(ydl_utils.can_be_checked('https://twitter.com/Totonyus/status/1198152820232314885', False) is True) #not youtube 22 | 23 | def test_check_download(self): 24 | self.assertTrue(ydl_utils.check_download_validity('https://www.youtube.com/watch?v=Ax4uSTdkp04', 'best')['errors'] is False) 25 | self.assertTrue(ydl_utils.check_download_validity('https://www.youtube.com/watch?v=Ax4uSTdkp04', 'b3st')['errors'] is True) 26 | self.assertTrue(ydl_utils.check_download_validity('https://www.youtube.com/playlist?list=PL8Zccvo5Xlj53ESRIn2Q4lg2DvKIB92sj', 'b3st')['checked'] is False) 27 | 28 | def test_preset(self): 29 | self.assertEqual(len(ydl_utils.existing_presets(['best', 'audio'])), 2) 30 | self.assertEqual(len(ydl_utils.existing_presets(['b3st', 'audio'])), 1) 31 | self.assertEqual(len(ydl_utils.existing_presets(['b3st', 'aud1o'])), 1) 32 | self.assertEqual(len(ydl_utils.existing_presets(['b3st'])), 1) 33 | 34 | def test_find_associated_user(self): 35 | self.assertTrue(ydl_utils.find_associated_user('ydl_api_very_secret_token') is not None) 36 | self.assertTrue(ydl_utils.find_associated_user('ydl_api_wrong_very_secret_token') is None) 37 | 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /userscript.js: -------------------------------------------------------------------------------- 1 | // ==UserScript== 2 | // @name ydl_api 3 | // @include * 4 | // @grant GM_registerMenuCommand 5 | // @grant GM_xmlhttpRequest 6 | // @grant GM_notification 7 | // ==/UserScript== 8 | 9 | (function() { 10 | 'use strict'; 11 | 12 | // ---%--- REPLACE ---%--- your host and token here 13 | const default_host = 'http://127.0.0.1:5011/download'; 14 | const userToken = null; 15 | const notificationTimeout = 5000; 16 | 17 | // possible parameters : 'format', 'subtitles', 'location', 'filename', 'presets' 18 | const preset_list = [ 19 | {name: 'Download (default)', key : '1', host : default_host, params : {}}, 20 | {name: 'Download (best)', key : '2', host : default_host, params : { presets: 'best'}}, 21 | {name: 'Download (720p)', key : '3', host : default_host, params : { presets: 'hd'}}, 22 | {name: 'Download (audio)', key : '4', host : default_host, params : { presets: 'audio'}}, 23 | {name: 'Download (audio + video)', key : '5', host : default_host, params : { presets: 'best,audio'}}, 24 | {name: 'Download (best, subtitles)', key : '6', host : default_host, params : { presets: 'best', subtitles: 'en'}}, // multiple subtitles example : 'fr,en' 25 | {name: 'Archiving', key : '7', host : default_host, params : { presets: 'archiving'}}, 26 | ]; 27 | 28 | const buildURL = function (preset) { 29 | const url = new URL(preset.host); 30 | 31 | url.searchParams.append('url', window.location.href); 32 | 33 | if(userToken !== null){ 34 | url.searchParams.append('token', userToken); 35 | } 36 | 37 | Object.entries(preset.params).forEach(([key, value]) => { 38 | url.searchParams.append(key, value); 39 | }); 40 | 41 | return url.href; 42 | }; 43 | 44 | const launchRequest = function (preset) { 45 | const notificationOptions = {}; 46 | 47 | GM_xmlhttpRequest({ 48 | method: 'GET', 49 | url: buildURL(preset), 50 | onerror: function () { 51 | notificationOptions.title = `Download failed`; notificationOptions.text = `Host seams unreachable, is the server up ?`; 52 | GM_notification(notificationOptions); 53 | }, 54 | onload: function (response) { 55 | if (response.status === 200) { 56 | notificationOptions.title = `Download launched`; notificationOptions.text = `Downloading`; notificationOptions.timeout = notificationTimeout; 57 | } else if(response.status === 202){ 58 | notificationOptions.title = `Download launched`; notificationOptions.text = `The download have not been checked. Some files may be not downloaded`; notificationOptions.timeout = notificationTimeout; 59 | } else if(response.status === 401){ 60 | notificationOptions.title = `Authentication failed`; notificationOptions.text = `The server require a user token or the provided token is wrong`; 61 | } else { 62 | notificationOptions.title = `Download failed`; notificationOptions.text = `The format may be wrong or not available or there is no video to download`; 63 | } 64 | 65 | GM_notification(notificationOptions); 66 | } 67 | }); 68 | }; 69 | 70 | preset_list.forEach((preset)=>{ 71 | GM_registerMenuCommand(preset.name, ()=>{launchRequest(preset)}, preset.key); 72 | }) 73 | })(); 74 | -------------------------------------------------------------------------------- /ydl_api.service: -------------------------------------------------------------------------------- 1 | #This file must be placed in /usr/lib/systemd/system/ 2 | 3 | [Unit] 4 | Description=Simple Rest api for youtube-dl 5 | After=network.target 6 | 7 | [Service] 8 | type=simple 9 | RemainAfterExit=yes 10 | 11 | # (Optional, default='root') uncomment and enter here the user and group you want 12 | #User=---%--- REPLACE ---%--- 13 | #Group=---%--- REPLACE ---%--- 14 | 15 | # The directory where you downloaded this program 16 | WorkingDirectory=---%--- REPLACE ---%--- 17 | ExecStart=sh launch.sh 18 | 19 | [Install] 20 | WantedBy=multi-user.target 21 | -------------------------------------------------------------------------------- /ydl_utils.py: -------------------------------------------------------------------------------- 1 | import logging, params, re 2 | from urllib.parse import urlparse, unquote 3 | import hooks, functools 4 | import yt_dlp as youtube_dl 5 | 6 | """ 7 | Check if all requested presets are available 8 | if no preset is available, use the 'default' preset (only once) 9 | """ 10 | def existing_presets(preset_identifiers): 11 | correct_presets = [] 12 | for preset_identifier in preset_identifiers: 13 | preset_object = params.presets_templates.get(preset_identifier) 14 | if preset_object is not None: 15 | correct_presets.append(preset_object) 16 | 17 | if len(correct_presets) == 0: # charge default preset if no preset was found 18 | correct_presets.append(params.presets_templates.get('default')) 19 | 20 | return correct_presets 21 | 22 | """ 23 | Verify if the url can be checked (playlists shouldn't be checked) 24 | no_playlist param is for unit testing purpose 25 | """ 26 | def can_be_checked(url, no_playlist = params.no_playlist): 27 | url_properties = define_url_properties(url) 28 | is_a_playlist = url_properties['playlist'] 29 | is_a_video = url_properties['video'] 30 | 31 | if is_a_playlist and ((not is_a_video) or (is_a_video and not no_playlist)): 32 | return False 33 | else: #In other cases : checking 34 | return True 35 | 36 | """ 37 | Used to define if the url is a video, un playlist or a video in a playlist 38 | """ 39 | def define_url_properties(url): 40 | properties = {'playlist' : False, 'video' : False} # set at the beginning in case params.playlist_detection is empty 41 | 42 | for entry in params.playlist_detection: 43 | if entry['hosts'] is not None and urlparse(url).hostname in entry['hosts']: 44 | for indicator in entry['video_indicators']: 45 | if url.find(indicator) != -1 : properties['video'] = True 46 | 47 | for indicator in entry['playlist_indicators']: 48 | if url.find(indicator) != -1 : properties['playlist'] = True 49 | 50 | return properties 51 | 52 | return properties 53 | 54 | """ 55 | Get definitive parameters to use 56 | Priority : query_params > preset_params > default_params 57 | """ 58 | def get_definitive_params(query_params, user, preset_params=None): 59 | default_params = params.presets_templates.get('default') 60 | 61 | if preset_params is None: preset_params = default_params 62 | 63 | definitive_params = {} 64 | definitive_params['user_name'] = user.get('name') if user is not None else None 65 | definitive_params['user_token'] = user.get('token') if user is not None else None 66 | 67 | for param in ['format', 'subtitles', 'location', 'filename']: 68 | definitive_params[param] = query_params.get(param) if query_params.get(param) is not None else preset_params.get(param) if preset_params.get(param) is not None else default_params.get(param) 69 | return definitive_params 70 | 71 | """ 72 | Check if all downloads successfully passed the checking process 73 | """ 74 | def recap_all_downloads_validity(download_list): 75 | checked_downloads_number = 0 76 | download_errors_number = 0 77 | 78 | for download in download_list: 79 | if download.get('check_result').get('checked') : checked_downloads_number += 1 80 | if download.get('check_result').get('errors') : download_errors_number += 1 81 | return {'checked' : checked_downloads_number, 'errors' : download_errors_number, 'total' : len(download_list)} 82 | 83 | """ 84 | Generate download options set 85 | """ 86 | def set_ydl_opts(url, definitive_params): 87 | url_properties = define_url_properties(url) 88 | 89 | ydl_api_opts = { #used to resolve tags in templates 90 | 'hostname' : urlparse(url).hostname, 91 | 'user_name' : definitive_params.get('user_name'), 92 | 'user_token' : definitive_params.get('user_token'), 93 | 'location_identifier' : definitive_params.get('location'), 94 | 'filename_identifier' : definitive_params.get('filename'), 95 | 'url' : url, 96 | 'is_playlist' : url_properties.get('playlist'), 97 | 'is_video' : url_properties.get('video') 98 | } 99 | 100 | download_directory_template = params.download_directory_templates.get(ydl_api_opts.get('location_identifier')) 101 | if download_directory_template is None : download_directory_template = params.download_directory_templates.get('default') 102 | file_name_template = params.file_name_templates.get(ydl_api_opts.get('filename_identifier')) 103 | if file_name_template is None: file_name_template = params.file_name_templates.get('default') 104 | 105 | ydl_opts = { 106 | 'quiet': True, 107 | 'ignoreerrors' : True, 108 | 'subtitlesformat': params.default_subtitles_format, 109 | 'noplaylist': params.no_playlist, 110 | 'format': definitive_params.get('format'), 111 | 'subtitleslangs' : definitive_params.get('subtitles').split(',') if definitive_params.get('subtitles') is not None else None, 112 | 'writesubtitles' : definitive_params.get('subtitles') is not None, 113 | 'outtmpl' : resolve_templates_tags(download_directory_template + file_name_template, ydl_api_opts), 114 | 'updatetime' : params.keep_modification_time, 115 | 'progress_hooks' : [functools.partial(hooks.handler, ydl_api_opts)] 116 | } 117 | 118 | return ydl_opts 119 | 120 | """ 121 | Verify if youtube-dl can find video and the format is right 122 | """ 123 | def check_download_validity(url, download_format): 124 | ydl_opts = { # the option ignoreerrors breaks the function but it can be a problem while downloading playlists with unavailable videos inside 125 | 'quiet': True, 126 | 'simulate': True, 127 | 'format': download_format, 128 | 'noplaylist': params.no_playlist 129 | } 130 | 131 | with youtube_dl.YoutubeDL(ydl_opts) as ydl: 132 | try: 133 | if can_be_checked(url): 134 | ydl.download([url]) 135 | return {'checked' : True, 'errors' : False} 136 | else: 137 | logging.warning('Unable to check download') 138 | return {'checked' : False, 'errors' : False} # can't be wrong if not tested right ? 139 | except: 140 | return {'checked' : True, 'errors' : True} 141 | 142 | """ 143 | Launch the download instruction 144 | """ 145 | def launch_downloads(url, download_options_sets): 146 | for option_set in download_options_sets: 147 | ydl_opts = option_set.get('ydl_opts') 148 | logging.info(f'Downloading \'{url}\' with quality \'{ydl_opts["format"]}\' in \'{ydl_opts["outtmpl"]}\'') 149 | 150 | with youtube_dl.YoutubeDL(ydl_opts) as ydl: 151 | ydl.download([url]) 152 | 153 | """ 154 | Resolve tags in templates 155 | """ 156 | def resolve_templates_tags(template_with_tags, ydl_api_opts): 157 | regex = r'%(\w*)%' 158 | 159 | matches = re.finditer(regex, template_with_tags) 160 | 161 | resolved_path = template_with_tags 162 | for match in matches: 163 | tag_value = ydl_api_opts.get(match.group(1)) 164 | if tag_value is not None : 165 | resolved_path = resolved_path.replace(match.group(0), ydl_api_opts.get(match.group(1))) 166 | else: 167 | resolved_path = resolved_path.replace(match.group(0), 'NA') 168 | return resolved_path 169 | 170 | """ 171 | Generate ydl_opts for all downloads 172 | """ 173 | def generate_ydl_options_sets(url, preset_objects, query_params, user): 174 | checked_downloads_list = [] 175 | if len(preset_objects) == 0: 176 | definitive_params = get_definitive_params(query_params, user, None) 177 | ydl_opts = set_ydl_opts(url, definitive_params) 178 | checked_downloads_list.append({'check_result' : check_download_validity(url, definitive_params.get('format')), 'ydl_opts' : ydl_opts}) 179 | else: 180 | for selected_preset in preset_objects: 181 | definitive_params = get_definitive_params(query_params, user, selected_preset) 182 | ydl_opts = set_ydl_opts(url, definitive_params) 183 | checked_downloads_list.append({'check_result' : check_download_validity(url, definitive_params.get('format')), 'ydl_opts' : ydl_opts}) 184 | return checked_downloads_list 185 | 186 | """ 187 | Find the user associated to the given token 188 | """ 189 | def find_associated_user(token): 190 | if token is None: 191 | return None 192 | 193 | for user in params.authorized_users_list: 194 | if user.get('token') == token: 195 | return user 196 | return None 197 | 198 | --------------------------------------------------------------------------------