├── LICENSE ├── README.md ├── img ├── license.svg └── squid-dl.no-outline.web.svg ├── requirements.txt ├── scripts ├── squid-dl └── squidson ├── setup.py ├── squid_dl ├── __init__.py ├── downloader.py ├── linode.py ├── proxy.py ├── socks.py └── util.py └── tests └── linode-test.py /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | squid-dl logo 3 |

squid-dl

4 |

5 | 6 |

7 | 8 | Code style: black 9 | 10 | 11 | License: AGPL v3 12 | 13 |

14 | 15 | `squid-dl` is a massively parallel 16 | [yt-dlp](https://github.com/yt-dlp/yt-dlp)-based YouTube downloader useful for 17 | downloading large video playlists. The faster your internet connection, the 18 | more fun you can have! 19 | 20 | ## Installation 21 | Run the `setup.py`, which will install `squid-dl` and its two dependencies: 22 | `linode-cli` and `yt-dlp`. 23 | ``` 24 | $ python3 setup.py install 25 | ``` 26 | 27 | If that fails, you may have to install `setuptools`. You can get it by 28 | invoking: 29 | ``` 30 | $ python3 -m pip install setuptools 31 | ``` 32 | 33 | ### Linode Proxy Setup 34 | If you want to use the Linode SOCKS proxy feature, be sure to configure the 35 | `linode-cli` first: 36 | ``` 37 | $ linode-cli configure --token 38 | ``` 39 | 40 | Follow the onscreen instructions and be sure to set sensible defaults. The 41 | default region for new Linodes that you pick here is where your proxies will 42 | live. For more information, see 43 | [this page](https://www.linode.com/docs/guides/linode-cli/) on Linode's website. 44 | 45 | ## Usage 46 | To download a playlist, first fetch its metadata with `squidson`: 47 | ``` 48 | (.venv) $ squidson 'https://www.youtube.com/playlist?list=PLhI42_YpLVHvYqvjniSp7lhAM55K4fllO' 49 | [youtube:tab] PLhI42_YpLVHvYqvjniSp7lhAM55K4fllO: Downloading webpage 50 | [youtube:tab] PLhI42_YpLVHvYqvjniSp7lhAM55K4fllO: Downloading API JSON with unavailable videos 51 | [download] Downloading playlist: Programming 52 | [youtube:tab] playlist Programming: Downloading 12 videos 53 | [download] Downloading video 1 of 12 54 | [youtube] Wp9XD5FKZ2c: Downloading webpage 55 | [youtube] Wp9XD5FKZ2c: Downloading android player API JSON 56 | ... 57 | [download] Downloading video 12 of 12 58 | [youtube] CIpfoMKqPAg: Downloading webpage 59 | [youtube] CIpfoMKqPAg: Downloading android player API JSON 60 | [youtube] CIpfoMKqPAg: Downloading MPD manifest 61 | [youtube] CIpfoMKqPAg: Downloading MPD manifest 62 | [download] Finished downloading playlist: Programming 63 | [INFO]: Writing JSON-ified playlist info_dict to "Programming.json" 64 | ``` 65 | 66 | Now that you have the playlist `.json` file, you can download it with 67 | `squid-dl`. Use the `-n` flag to tell `squid-dl` how many workers you'd like to 68 | spawn downloading videos at once (the default is 8 workers). In this 12-video 69 | playlist example, we'll spawn 12 workers: 70 | ``` 71 | (.venv) $ squid-dl -n 12 Programming.json 72 | 73 | [INFO]: Starting squid-dl... 74 | [INFO]: saving videos to "Programming" directory 75 | 76 | ... 77 | [download] Download completed 78 | [download] Download completed 79 | [download] Download completed 80 | [INFO]: Worker 80214 done... 81 | [INFO]: Worker 80319 done... 82 | [download] Download completed 83 | [INFO]: Worker 80150 done... 84 | [INFO]: Worker 80248 done... 85 | [download] Download completed 86 | [INFO]: Worker 80219 done... 87 | [INFO]: Worker 80109 done... 88 | [INFO]: Worker 80341 done... 89 | [download] Download completed 90 | [INFO]: Worker 80193 done... 91 | [download] Download completed 92 | [INFO]: Worker 80117 done... 93 | [INFO]: All done! 94 | ``` 95 | 96 | For more information see the built-in help by running `squid-dl -h`. 97 | 98 | ### SOCKS Proxying 99 | For those with access to a dedicated SOCKS proxy already, you can use 100 | `squid-dl`'s `-S` and a fully-qualified SOCKS4, SOCKS4A, or SOCKS5 proxy URL 101 | to download your playlists through a proxy! Here's an example using NordVPN's 102 | SOCKS5 proxy: 103 | ``` 104 | (.venv) $ squid-dl -S socks5://us.socks.nordhold.net:1080 -n 12 Mems.json 105 | 106 | [INFO]: Starting squid-dl... 107 | [INFO]: saving videos to "Mems" directory 108 | SOCKS username: 0asFVrZt0bw1ucPvQRKiUe87 109 | SOCKS password: 110 | 111 | ... 112 | [download] Download completed 113 | [INFO]: Worker 1667326 done... 114 | [INFO]: Worker 1667396 done... 115 | [INFO]: Worker 1667484 done... 116 | [download] Download completed 117 | [download] Download completed 118 | [INFO]: Worker 1667352 done... 119 | [INFO]: Worker 1667421 done... 120 | [INFO]: All done! 121 | ``` 122 | 123 | You can also add a username and password to SOCKS5 and SOCKS4A proxy URLs in a 124 | format like this: 125 | ``` 126 | socks5://username:password@hostname:port 127 | ``` 128 | 129 | **SECURITY NOTE:** typing in usernames and passwords this way is considered 130 | insecure, as they will likely end up in your shell's history file completely 131 | unprotected and in the clear (☹). It is generally recommended to input the 132 | username and password interactively unless you are scripting `squid-dl`. 133 | 134 | ### Linode Proxying 135 | With the `-L` option, you can run each worker through its own Linode-powered 136 | SSH-tunneled SOCKSv5 proxy! `squid-dl` will make an temporary SSH key in 137 | the current working directory and then get to work spinning up Linodes and 138 | downloading your videos: 139 | ``` 140 | (.venv) anon@fire-crotch:~/butter/youtube/btr$ squid-dl -L Mem.json 141 | 142 | [INFO]: Creating SSH key for Linode proxying... 143 | Generating public/private rsa key pair. 144 | Your identification has been saved in /home/anon/fuse/butter-anon/youtube/btr/proxy 145 | _key 146 | Your public key has been saved in /home/anon/fuse/butter-anon/youtube/btr/proxy_key 147 | .pub 148 | The key fingerprint is: 149 | SHA256:cSns+aK0l7xS+fRSXRdqmc5DXkT5pIQsDV8/Ql526vg anon@fire-crotch 150 | The key's randomart image is: 151 | +---[RSA 3072]----+ 152 | | .+ oo+o| 153 | | . .o*.+*o| 154 | | + o..+*++| 155 | | . = Oo.=| 156 | | S. B.o..| 157 | | o.. .*. | 158 | | .o.+.o E | 159 | | ..o+.o . | 160 | | oo.. . | 161 | +----[SHA256]-----+ 162 | 163 | [INFO]: Starting squid-dl... 164 | [INFO]: saving videos to "Mems" directory 165 | [INFO]: Created Linode 30970792. 166 | [INFO]: Waiting for Linodes to come online........................... 167 | 168 | [INFO]: Starting proxy on port 1337 with Linode 30970792 169 | Warning: Permanently added '45.79.47.110' (ED25519) to the list of known hosts. 170 | [INFO]: SOCKS validation succeeded on port 1337 from ID 30970792 171 | [youtube] fIdfGtG7Isg: Downloading android player API JSON 172 | [youtube] fIdfGtG7Isg: Downloading iframe API JS 173 | [youtube] fIdfGtG7Isg: Downloading player 03869671 174 | [youtube] fIdfGtG7Isg: Downloading web player API JSON 175 | [youtube] fIdfGtG7Isg: Downloading MPD manifest 176 | [youtube] fIdfGtG7Isg: Downloading MPD manifest 177 | [youtube] fIdfGtG7Isg: Downloading initial data API JSON 178 | [info] fIdfGtG7Isg: Downloading 1 format(s): 22 179 | [info] Downloading video thumbnail ... 180 | [info] Writing video thumbnail to: Plankton goes to an anime convention [fIdfGtG7Is 181 | g].webp 182 | [download] Destination: Plankton goes to an anime convention [fIdfGtG7Isg].mp4 183 | [download] Download completed 184 | [INFO]: Cleaning up worker 83832's exclusive proxy 185 | [CLEANUP]: Deleted Linode 30970792. 186 | [INFO]: Worker 83832 done... 187 | [INFO]: All done! 188 | [CLEANUP]: Deleting Linode proxies... 189 | ``` 190 | 191 | ## Bugs 192 | If you encounter any issues running `squid-dl`, please create an issue 193 | [on GitHub](https://github.com/targetdisk/squid-dl/issues/new/choose). 194 | 195 | This software has only tested on Linux so far (patches welcome). 196 | 197 | ## Contributing 198 | Submit your patches as GitHub 199 | [pull requests](https://github.com/targetdisk/squid-dl/pulls). 200 | 201 | ### Contact 202 | Feel free to holler at me on `#squid-dl` on 203 | [Libera.chat](https://libera.chat/). 204 | 205 | ### Style notes 206 | I am an 80 column stickler. I run all Python code in this repository through 207 | `black -l 80`. 208 | -------------------------------------------------------------------------------- /img/license.svg: -------------------------------------------------------------------------------- 1 | license: AGPLv3+TRANS RIGHTSlicenseAGPLv3+TRANS RIGHTS 2 | -------------------------------------------------------------------------------- /img/squid-dl.no-outline.web.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 13 | 15 | 18 | 22 | 26 | 30 | 34 | 38 | 42 | 46 | 50 | 54 | 58 | 62 | 66 | 70 | 74 | 78 | 82 | 86 | 90 | 94 | 95 | 98 | 107 | 114 | 118 | 119 | 120 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | linode-cli 2 | yt-dlp 3 | -------------------------------------------------------------------------------- /scripts/squid-dl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | from squid_dl import main 3 | from sys import argv as ARGV 4 | 5 | if __name__ == "__main__": 6 | name = ARGV.pop(0) 7 | welcome = ( 8 | "" 9 | + " ⣠⣾⢿⣿⣷⣦\n" 10 | + " ⣀⣼⢟⡱⣆⡹⠹⣿⣇ ⢠⣶⣿⠿⣦⡀\n" 11 | + " ⠈⠛⠛⠊⠉⠁ ⠹⣿⣧⡀ ⢠⣿⠏⠁⠝⢪⣻⡦\n" 12 | + " ⠙⢻⣿⡄ ⣴⣿⠏\n" 13 | + " ⣿⣷ ⢸⣿⠁\n" 14 | + " ⢀⣽⣿⣿⣿⣿⣿⣶⣦⣼⠟\n" 15 | + " ⣀⡀ ⢀⣴⣿⣿⣿⢿⣿⣿⣿⣿⣿⣿⣷⡀\n" 16 | + "⢀⣴⣿⡿⢿⣷⡄ ⣼⣿⣿⣿⣿ ⠈⠙⠻⣿⣿⣿⣿⣷\n" 17 | + "⣾⣿⠱⠉⠛⣿⣿⣄ ⣀⣿⣿⣿⣿⣿ ⣀⣽⣿⣿⣿ ⣠⣶⣿⣷⣦⡀\n" 18 | + "⠈⠁ ⠙⠿⠿⠛⠛⢻⣿⣿⣿⣿ ⣀⣴⣾⣿⣿⣿⣿⣿⣤⣾⣿⡿⠖⡯⢿⣷\n" 19 | + " ⠈⠻⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠉⠛⠛⠉ ⠹⠟\n" 20 | + " ⢀⣴⡾⠟⠿⣿⣿⣿⣿⠿⢿⡍\n" 21 | + " ⣀⣾⡟ ⠈⣿⣶⣤⣤⣄⡀\n" 22 | + " ⣰⣾⣿⣿⣿⣿⠏ ⠈⠛⠛⢿⣿⣿⣦\n" 23 | + " ⠛⠉⠉⠉⠉ _ _ ⠈⠻⣿⣿⣇_ _\n" 24 | + " ___ __ _ _ _(_)__| |___ __| | |\n" 25 | + "(_- int: 7 | return real_main(args=args, name=name) 8 | -------------------------------------------------------------------------------- /squid_dl/downloader.py: -------------------------------------------------------------------------------- 1 | """ 2 | Fancy parallel downloader for a pre- 3 | retrieved YoutubeDL() info_dict JSON. 4 | ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⣀⣀⣠⣤⣤⣄⣀⣀⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ 5 | ⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⠤⠖⠊⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⠙⠲⢤⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ 6 | ⠀⠀⠀⠀⠀⠀⠀⡤⠊⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⢦⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀ 7 | ⠀⠀⠀⠀⠀⠀⡜⠀⠀⠀⠀⠀⠀⢀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢢⠀⠀⠀⠀⠀⢳⠀⠀⠀⠀⠀⠀⠀⠀⠀ 8 | ⠀⠀⠀⠀⠀⣸⠁⠀⠀⠀⠀⠀⠀⠀⠱⡀⠀⠀⠀⠀⠀⠀⠀⡀⠈⠀⡀⠀⠀⠀⠈⡇⠀⠀⠀⠀⠀⠀⠀⠀ 9 | ⠀⠀⠀⠀⠀⡏⠀⠀⠀⠀⠀⠀⠀⠀⡰⠁⠀⠀⠀⠀⠀⠀⠀⠘⡆⡜⠁⠀⠀⠀⠀⢧⡀⠀⠀⠀⠀⠀⠀⠀ 10 | ⠀⠀⠀⠀⠀⡇⠀⠀⠀⠀⠀⠀⠀⠸⡀⠀⠀⠀⠀⠀⣀⣤⡂⠀⠇⠱⠀⡀⠀⠀⠀⠀⡇⠀⠀⠀⠀⠀⠀⠀ 11 | ⠀⠀⠀⠀⠀⢇⠀⠀⠀⠀⠀⠀⠀⠀⠈⢄⡀⢠⣟⢭⣥⣤⠽⡆⠀⡶⣊⣉⣲⣤⢀⡞⠀⠀⠀⠀⠀⠀⠀⠀ 12 | ⠀⠀⠀⠀⠀⠘⣆⠀⠀⠀⠀⠀⠀⡀⠀⠐⠂⠘⠄⣈⣙⡡⡴⠀⠀⠙⣄⠙⣛⠜⠘⣆⠀⠀⠀⠀⠀⠀⠀⠀ 13 | ⠀⠀⠀⠀⠀⠀⠈⢦⡀⠀⠀⠀⢸⠁⠀⠀⠀⠀⠀⠀⠄⠊⠀⠀⠀⠀⡸⠛⠀⠀⠀⢸⠆⠀⠀⠀⠀⠀⠀⠀ 14 | ⠀⠀⠀⠀⠀⠀⠀⠀⠈⠓⠦⢄⣘⣄⠀⠀⠀⠀⠀⠀⠀⡠⠀⠀⠀⠀⣇⡀⠀⠀⣠⠎⠀⠀⠀⠀⠀⠀⠀⠀ 15 | ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣸⠁⠈⡟⠒⠲⣄⠀⠀⡰⠇⠖⢄⠀⠀⡹⡇⢀⠎⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀ 16 | ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡇⠀⠀⡇⠀⠀⠹⠀⡞⠀⠀⢀⠤⣍⠭⡀⢱⢸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ 17 | ⠀⠀⠀⠀⠀⠀⢀⣀⣀⣠⠞⠀⠀⢠⡇⠀⠀⠀⠀⠁⠀⢴⠥⠤⠦⠦⡼⠀⢸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ 18 | ⣀⣤⣴⣶⣿⣿⡟⠁⠀⠋⠀⠀⠀⢸⠁⠀⠀⠀⠀⠀⠀⠀⠑⣠⢤⠐⠁⠀⢸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ 19 | ⣿⣿⣿⣿⣿⡟⠀⠀⠀⠀⠀⠀⠀⢸⡀⠀⠀⠀⠀⠀⠀⠀⠀⠬⠥⣄⠀⠀⠈⠲⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀ 20 | ⣿⣿⣿⣿⣿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠙⠦⣄⠀⠀⠀⠀⠀⠀⠀⠀⠈⢳⠀⠀⢀⣿⡀⠀⠀⠀⠀⠀⠀⠀⠀ 21 | ⣿⣿⣿⣿⣿⣧⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠙⠒⠦⠤⢤⣄⣀⣠⠤⢿⣶⣶⣿⣿⣿⣶⣤⡀⠀⠀⠀⠀⠀ 22 | ⣿⣿⣿⣿⣿⣿⣷⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡼⠁⠀⠀⣠⣾⣿⣿⣿⣿⣿⣿⣿⣿⣄⠀⠀⠀⠀ 23 | ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣶⣦⣤⣤⣀⣀⣀⣀⣀⣀⣀⣤⣤⣤⣶⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀ 24 | 25 | NOTE: Not my fault if your IP gets rate- 26 | limited or throttled by YouTube. With 27 | great power comes great responsibility! 28 | 29 | ALSO NOTE: Have yet to test on other 30 | video sites besides YouTube... 31 | """ 32 | import argparse 33 | import json as j 34 | from multiprocessing import cpu_count, Process, Queue 35 | from multiprocessing.queues import Empty, Full 36 | import os 37 | from random import randint 38 | from time import sleep 39 | import typing 40 | from yt_dlp import YoutubeDL 41 | from yt_dlp.utils import encodeFilename, sanitize_filename 42 | from yt_dlp.extractor.common import InfoExtractor as IE 43 | 44 | from .linode import LinodeProxy 45 | from .proxy import Proxy 46 | from .socks import SocksProxy 47 | from .util import die, eprint, runcmd 48 | 49 | 50 | def do_download( 51 | entry_q: Queue, 52 | opts: argparse.Namespace, 53 | sub_langs: [str], 54 | proxy: Proxy = None, 55 | ): 56 | 57 | sub_opts = { 58 | "writesubtitles": True, 59 | "writeautomaticsub": True, 60 | } 61 | if sub_langs[0] == "all": 62 | sub_opts["allsubtitles"] = True 63 | else: 64 | sub_opts["subtitleslangs"] = sub_langs 65 | 66 | yt_opts = { 67 | "noprogress": True, 68 | "http_chunk_size": 10485760, 69 | "writethumbnail": True, 70 | "ignoreerrors": True, 71 | "format_sort": IE.FormatSort.ytdl_default, 72 | "extractor_args": { 73 | "youtube": {"player_skip": ["webpage"]}, 74 | "youtubetab": {"skip": ["webpage"]}, 75 | }, 76 | } 77 | if proxy is not None: 78 | yt_opts["proxy"] = proxy.proxy_url 79 | if opts.all_thumbnails: 80 | yt_opts["write_all_thumbnails"] = True 81 | 82 | y = YoutubeDL({**yt_opts, **sub_opts}) 83 | y_nosubs = YoutubeDL(yt_opts) 84 | 85 | while True: 86 | try: 87 | try: 88 | entry = entry_q.get(block=True, timeout=0.5) 89 | except Empty: 90 | break 91 | 92 | try: 93 | id_dir = entry["id"] 94 | except TypeError: 95 | continue 96 | 97 | try: 98 | os.mkdir(id_dir) 99 | except FileExistsError: 100 | pass 101 | 102 | try: 103 | os.chdir(id_dir) 104 | except OSError as oserr: 105 | eprint("[WARN]: Skipping {} due to {}".format(id_dir, oserr)) 106 | continue 107 | 108 | nfo_path = "playlist_entry.json" 109 | if not (os.path.exists(nfo_path) and os.path.isfile(nfo_path)): 110 | nfo_file = open(nfo_path, mode="w") 111 | nfo_file.write(j.dumps(entry, sort_keys=True, indent=2)) 112 | nfo_file.close() 113 | 114 | desc_path = "description" 115 | if not (os.path.exists(desc_path) and os.path.isfile(desc_path)): 116 | desc_file = open(desc_path, mode="w") 117 | desc_file.write(entry["description"]) 118 | desc_file.close() 119 | 120 | dl_url = "https://www.youtube.com/watch?v=" + entry["id"] 121 | try: 122 | if entry["tux_get_subs"] is True: 123 | y.download([dl_url]) 124 | else: 125 | y_nosubs.download([dl_url]) 126 | except KeyError: 127 | y.download([dl_url]) 128 | 129 | os.chdir("..") 130 | sleep(2) 131 | except KeyboardInterrupt: 132 | break 133 | 134 | if proxy is not None: 135 | if proxy.exclusive: 136 | print( 137 | "[INFO]: Cleaning up worker {}'s exclusive proxy".format( 138 | os.getpid() 139 | ) 140 | ) 141 | proxy.cleanup() 142 | 143 | print("[INFO]: Worker {} done...".format(os.getpid())) 144 | 145 | 146 | def get_entries(entries: dict, entry_q: Queue): 147 | try: 148 | for entry in entries: 149 | while True: 150 | try: 151 | entry_q.put(entry, block=True, timeout=0.2) 152 | break 153 | except Full: 154 | pass 155 | 156 | except KeyboardInterrupt: 157 | pass 158 | 159 | entry_q.close() 160 | 161 | 162 | def check_subs_done(entry: dict, basename: str, langs: [str] = None) -> bool: 163 | if langs is None: 164 | langs = entry["automatic_captions"].keys() 165 | 166 | for lang in langs: 167 | subbase = basename + "." + lang 168 | 169 | lang_sub_exists = False 170 | for subentry in entry["automatic_captions"][lang]: 171 | sfname = subbase + "." + subentry["ext"] 172 | if os.path.exists(sfname) and os.path.isfile(sfname): 173 | lang_sub_exists = True 174 | break 175 | if not lang_sub_exists: 176 | return False 177 | 178 | return True 179 | 180 | 181 | def check_video_done(entry: dict, basename: str) -> bool: 182 | for ext in (".mp4", ".webm", ".mkv"): 183 | vfname = basename + ext 184 | 185 | if os.path.exists(vfname) and os.path.isfile(vfname): 186 | return True 187 | 188 | return False 189 | 190 | 191 | def check_dl(in_q: Queue, out_q: Queue): 192 | while True: 193 | try: 194 | try: 195 | entry = in_q.get(block=True, timeout=0.5) 196 | except Empty: 197 | break 198 | 199 | try: 200 | id_dir = entry["id"] 201 | except TypeError: 202 | continue 203 | 204 | if os.path.isdir(id_dir): 205 | try: 206 | os.chdir(id_dir) 207 | except OSError as oserr: 208 | eprint( 209 | "[WARN]: Skipping {} due to {}".format(id_dir, oserr) 210 | ) 211 | continue 212 | elif os.path.exists(id_dir): 213 | eprint( 214 | "[WARN]: Not downloading https://youtube.com/watch?v={} " 215 | + "because {} exists and is not a directory!" 216 | ) 217 | continue 218 | else: 219 | out_q.put(entry) 220 | continue 221 | 222 | nfo_path = "playlist_entry.json" 223 | if not (os.path.exists(nfo_path) and os.path.isfile(nfo_path)): 224 | os.chdir("..") 225 | out_q.put(entry) 226 | continue 227 | 228 | desc_path = "description" 229 | if not (os.path.exists(desc_path) and os.path.isfile(desc_path)): 230 | desc_file = open(desc_path, mode="w") 231 | desc_file.write(entry["description"]) 232 | desc_file.close() 233 | 234 | y = YoutubeDL({"ignoreerrors": True}) 235 | basename = os.path.splitext( 236 | sanitize_filename(encodeFilename(y.prepare_filename(entry))) 237 | )[0] 238 | try: 239 | if check_subs_done(entry, basename): 240 | entry["tux_get_subs"] = False 241 | else: 242 | entry["tux_get_subs"] = True 243 | except KeyError: 244 | eprint( 245 | "[WARN]: Couldn't find auto subs for {} in info".format( 246 | entry["id"] 247 | ) 248 | ) 249 | entry["tux_get_subs"] = False 250 | 251 | if not (check_video_done(entry, basename)): 252 | out_q.put(entry) 253 | os.chdir("..") 254 | continue 255 | 256 | os.chdir("..") 257 | except KeyboardInterrupt: 258 | break 259 | 260 | 261 | def testworker(in_q: Queue): 262 | i = 0 263 | while not in_q.empty(): 264 | try: 265 | entry = in_q.get(block=True, timeout=0.5) 266 | except Empty: 267 | break 268 | try: 269 | i += 1 270 | print("{}: ".format(i), end="") 271 | print(entry["id"]) 272 | acs = entry["automatic_captions"] 273 | except KeyError: 274 | eprint("couldn't get caps on vid {}".format(entry["id"])) 275 | 276 | 277 | def workers_alive(workers: [Process]): 278 | for worker in workers: 279 | if worker.is_alive(): 280 | return True 281 | 282 | return False 283 | 284 | 285 | def resume_cleanup(workers: [Process], q_worker: Process): 286 | print("\n[CLEANUP]: Cleaning up...") 287 | 288 | for worker in workers: 289 | if worker.is_alive(): 290 | print("[CLEANUP]: Terminating resume worker {}".format(worker.pid)) 291 | worker.terminate() 292 | 293 | print("[CLEANUP]: Terminating queue worker {}".format(worker.pid)) 294 | q_worker.terminate() 295 | 296 | 297 | def resume_preprocess(entries: [dict]) -> list: 298 | ncpus = cpu_count() 299 | n_workers = ncpus if len(entries) >= ncpus else len(entries) 300 | 301 | in_q = Queue(n_workers) 302 | out_q = Queue(len(entries)) 303 | iq_builder = Process(target=get_entries, args=(entries, in_q)) 304 | workers = [] 305 | 306 | try: 307 | iq_builder.start() 308 | 309 | for n in range(n_workers): 310 | workers.append(Process(target=check_dl, args=(in_q, out_q))) 311 | 312 | while not in_q.full(): 313 | sleep(0.2) 314 | 315 | for w in workers: 316 | w.start() 317 | 318 | unfinished_entries = [] 319 | while workers_alive(workers): 320 | try: 321 | unfinished_entries.append(out_q.get(block=True, timeout=2)) 322 | except Empty: 323 | continue 324 | except KeyboardInterrupt: 325 | resume_cleanup(workers, iq_builder) 326 | return [] 327 | 328 | if iq_builder.is_alive(): 329 | iq_builder.terminate() 330 | die("[BUG]: Workers didn't verify whole list! Exiting...") 331 | 332 | return unfinished_entries 333 | 334 | 335 | def validate_linode_proxy(proxy: LinodeProxy) -> LinodeProxy: 336 | if not proxy.start(): 337 | eprint( 338 | "[WARN]: " 339 | + "Proxy, validation failed, deleting and rebuilding Linode..." 340 | ) 341 | port = proxy.proxy_port 342 | proxy.cleanup() 343 | proxy = LinodeProxy(proxy_port=port) 344 | return validate_linode_proxy(proxy) 345 | else: 346 | print( 347 | "[INFO]: SOCKS validation succeeded on port {} from ID {}".format( 348 | proxy.proxy_port, proxy.info["id"] 349 | ) 350 | ) 351 | return proxy 352 | 353 | 354 | def cleanup(workers: [Process], linode_proxies: [LinodeProxy]) -> None: 355 | if len(workers) > 0: 356 | for worker in workers: 357 | if worker.is_alive(): 358 | print( 359 | "[CLEANUP]: Terminating download worker {}".format( 360 | worker.pid 361 | ) 362 | ) 363 | worker.terminate() 364 | 365 | if len(linode_proxies) > 0: 366 | print("[CLEANUP]: Deleting Linode proxies...") 367 | for proxy in linode_proxies: 368 | proxy.cleanup() 369 | 370 | 371 | def parse_args(args: list, name: str): 372 | parser = argparse.ArgumentParser(prog=name) 373 | 374 | group = parser.add_mutually_exclusive_group(required=False) 375 | group.add_argument( 376 | "-L", 377 | "--linode-proxy", 378 | action="store_true", 379 | help="Give each worker a Linode SOCKS proxy. Assumes you have already " 380 | + "setup the linode-cli with an API key and default settings. See " 381 | + "https://www.linode.com/docs/guides/linode-cli/ " 382 | + "for more information.", 383 | ) 384 | group.add_argument( 385 | "-S", 386 | "--socks-proxy", 387 | type=str, 388 | default=None, 389 | help="Run workers through a SOCKS proxy. Requires a fully-qualified " 390 | + 'proxy URL (e.g. "socks5://user:pass@hostname:port" or ' 391 | + '"socks5://hostname:port").\n' 392 | + "Be mindful of your shell's history file when entering passwords on " 393 | + "the command line. If this script encounters a proxy that requires " 394 | + "authentication, it will prompt the user for a password " 395 | + "interactively, as well.", 396 | ) 397 | parser.add_argument( 398 | "-p", 399 | "--proxy-base-port", 400 | type=int, 401 | default=1337, 402 | help="Port number that local Linode-powered proxy ports are derived " 403 | + "from, does nothing without " 404 | + "enabling --linode-proxy (aka. -L).", 405 | ) 406 | parser.add_argument( 407 | "--resume-dump", 408 | action="store_true", 409 | help="Dump resume info_dict to JSON (for debugging).", 410 | ) 411 | parser.add_argument( 412 | "-n", 413 | "--n-workers", 414 | type=int, 415 | default=8, 416 | help="Number of parallel download workers", 417 | ) 418 | parser.add_argument( 419 | "-l", 420 | "--subtitle-langs", 421 | type=str, 422 | default="en", 423 | help="Comma-delimited list of subtitle languages to download; " 424 | + 'pass "all" to download all auto captions. ' 425 | + 'Downloads "en" subtitles by default.', 426 | ) 427 | parser.add_argument( 428 | "-T", 429 | "--all-thumbnails", 430 | action="store_true", 431 | help="Download all thumbnails instead of just the best one.", 432 | ) 433 | parser.add_argument( 434 | "playlist_json", 435 | type=argparse.FileType("r"), 436 | help="JSON-ified playlist file to download", 437 | ) 438 | 439 | return parser.parse_args(args=args) 440 | 441 | def check_keys(): 442 | key_path = os.path.abspath("./proxy_key") 443 | pubkey_path = os.path.abspath(key_path + ".pub") 444 | if not ( 445 | os.path.isfile(pubkey_path) 446 | or os.path.isfile(os.path.splitext(pubkey_path)[0]) 447 | ): 448 | print("[INFO]: Creating SSH key for Linode proxying...") 449 | print(runcmd('ssh-keygen -f "{}" -N ""'.format(key_path)).decode()) 450 | 451 | def main(args: [str], name: str) -> int: 452 | opts = parse_args(args=args, name=name) 453 | sub_langs = opts.subtitle_langs.split(",") 454 | n_workers = opts.n_workers 455 | 456 | info_dict = j.loads(opts.playlist_json.read()) 457 | opts.playlist_json.close() 458 | 459 | print("[INFO]: Starting squid-dl...") 460 | 461 | dirname = sanitize_filename(info_dict["title"]) 462 | print('[INFO]: saving videos to "{}" directory'.format(dirname)) 463 | if not (os.path.exists(dirname) and os.path.isdir(dirname)): 464 | os.mkdir(dirname) 465 | else: 466 | playlist_size = len(info_dict["entries"]) 467 | 468 | info_dict["entries"] = resume_preprocess(info_dict["entries"]) 469 | if len(info_dict["entries"]) == 0: 470 | print("[WARN]: Nothing left to download, exiting...") 471 | return 1 472 | 473 | print( 474 | "Resuming download of {}/{} videos...".format( 475 | len(info_dict["entries"]), playlist_size 476 | ) 477 | ) 478 | if opts.resume_dump: 479 | rdump = open(info_dict["title"] + ".resume.json", mode="w") 480 | rdump.write(j.dumps(info_dict, sort_keys=True, indent=2)) 481 | rdump.close() 482 | 483 | n_entries = len(info_dict["entries"]) 484 | n_workers = n_workers if n_workers < n_entries else n_entries 485 | entry_q = Queue(n_workers) 486 | entry_getter = Process( 487 | target=get_entries, args=(info_dict["entries"], entry_q) 488 | ) 489 | entry_getter.start() 490 | 491 | base_port = 1337 492 | workers = [] 493 | linode_proxies = [] 494 | if opts.socks_proxy is not None: 495 | socks_proxy = SocksProxy(url=opts.socks_proxy) 496 | try: 497 | for n in range(n_workers): 498 | port = base_port + n 499 | 500 | if opts.linode_proxy: 501 | check_keys() 502 | linode_proxies.append( 503 | LinodeProxy(proxy_port=port, pubkey_path=pubkey_path) 504 | ) 505 | worker_args = (entry_q, opts, sub_langs, linode_proxies[n]) 506 | elif opts.socks_proxy is not None: 507 | worker_args = (entry_q, opts, sub_langs, socks_proxy) 508 | else: 509 | worker_args = (entry_q, opts, sub_langs) 510 | 511 | workers.append( 512 | Process( 513 | target=do_download, 514 | args=worker_args, 515 | ) 516 | ) 517 | 518 | if len(linode_proxies) > 0: 519 | if not ( 520 | os.path.isfile(pubkey_path) 521 | or os.path.isfile(os.path.splitext(pubkey_path)[0]) 522 | ): 523 | die( 524 | '[ERROR]: SSH key file "{}" does not exist!'.format( 525 | pubkey_path 526 | ) 527 | ) 528 | print("[INFO]: Waiting for Linodes to come online", end="") 529 | nodes_to_ping = list(range(n_workers)) 530 | while len(nodes_to_ping) > 0: 531 | print(".", end="") 532 | temp_list = [] 533 | for proxy_idx in nodes_to_ping: 534 | if linode_proxies[proxy_idx].get_status() != "running": 535 | temp_list.append(proxy_idx) 536 | sleep(0.2) 537 | nodes_to_ping = temp_list 538 | print() 539 | 540 | while not entry_q.full(): 541 | sleep(0.2) 542 | 543 | os.chdir(dirname) 544 | 545 | for i in range(n_workers): 546 | if len(linode_proxies) > 0: 547 | linode_proxies[i] = validate_linode_proxy(linode_proxies[i]) 548 | seconds = randint(0, 1) 549 | else: 550 | seconds = randint(1, 6) 551 | workers[i].start() 552 | sleep(seconds) 553 | 554 | while workers_alive(workers): 555 | sleep(0.2) 556 | 557 | except KeyboardInterrupt: 558 | eprint("\n[CLEANUP]: Interrupted, cleaning up...") 559 | cleanup(workers, linode_proxies) 560 | if entry_getter.is_alive(): 561 | print( 562 | "[CLEANUP]: Terminating queue worker {}".format( 563 | entry_getter.pid 564 | ) 565 | ) 566 | entry_getter.terminate() 567 | return 1 568 | 569 | print("[INFO]: All done!") 570 | cleanup(workers, linode_proxies) 571 | 572 | return 0 573 | -------------------------------------------------------------------------------- /squid_dl/linode.py: -------------------------------------------------------------------------------- 1 | """ 2 | You ever wanted to spawn n proxies? 3 | ⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⡀⠠⠤⠀⣀⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀ 4 | ⠀⠀⠀⠀⣀⢤⡒⠉⠁⠀⠒⢂⡀⠀⠀⠀⠈⠉⣒⠤⣀⠀⠀⠀⠀ 5 | ⠀⠀⣠⠾⠅⠈⠀⠙⠀⠀⠀⠈⠀⠀⢀⣀⣓⡀⠉⠀⠬⠕⢄⠀⠀ 6 | ⠀⣰⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡤⠶⢦⡀⠑⠀⠀⠀⠀⠈⢧⠀ 7 | ⠀⡇⠀⠀⠀⠀⠀⢤⣀⣀⣀⣀⡀⢀⣀⣀⠙⠀⠀⠀⠀⠀⠀⢸⡄ 8 | ⠀⢹⡀⠀⠀⠀⠀⡜⠁⠀⠀⠙⡴⠁⠀⠀⠱⡄⠀⠀⠀⠀⠀⣸⠀ 9 | ⠀⠀⠱⢄⡀⠀⢰⣁⣒⣒⣂⣰⣃⣀⣒⣒⣂⢣⠀⠀⠀⢀⡴⠁⠀ 10 | ⠀⠀⠀⠀⠙⠲⢼⡀⠀⠙⠀⢠⡇⠀⠛⠀⠀⣌⣀⡤⠖⠉⠀⠀⠀ 11 | ⠀⠀⠀⠀⠀⠀⢸⡗⢄⣀⡠⠊⠈⢦⣀⣀⠔⡏⠀⠀⠀⠀⠀⠀⠀ 12 | ⠀⠀⠀⠀⠀⠀⠈⡇⠀⢰⠁⠀⠀⠀⢣⠀⠀⣷⠀⠀⠀⠀⠀⠀⠀ 13 | ⠀⠀⠀⠀⣠⠔⠊⠉⠁⡏⠀⠀⠀⠀⠘⡆⠤⠿⣄⣀⠀⠀⠀⠀⠀ 14 | ⠀⠀⠀⠀⣧⠸⠒⣚⡩⡇⠀⠀⠀⠀⠀⣏⣙⠒⢴⠈⡇⠀⠀⠀⠀ 15 | ⠀⠀⠀⠀⠈⠋⠉⠀⠀⢳⡀⠀⠀⠀⣸⠁⠈⠉⠓⠚⠁⠀⠀⠀⠀ 16 | ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠓⠛⠛ 17 | Well, here you go. 18 | """ 19 | 20 | import json as j 21 | from os.path import splitext 22 | import socket 23 | import struct 24 | import subprocess 25 | from time import sleep 26 | import typing 27 | 28 | from .proxy import Proxy 29 | from .util import eprint, runcmd 30 | 31 | 32 | class LinodeProxy(Proxy): 33 | user_made = False 34 | 35 | def __init__( 36 | self, 37 | pubkey_path: str = "proxy_key.pub", 38 | proxy_port: int = 1337, 39 | proxy_user: str = "boing", 40 | debug: bool = False, 41 | exclusive: bool = True, 42 | ): 43 | try: 44 | self.proxy_port = proxy_port 45 | self.proxy_user = proxy_user 46 | self.pubkey_path = pubkey_path 47 | self.debug = debug 48 | self.exclusive = exclusive 49 | 50 | self.proxy_url = "socks5://127.0.0.1:" + str(self.proxy_port) 51 | 52 | self.ssh_prefix = ( 53 | 'ssh -o "UserKnownHostsFile=/dev/null" ' 54 | + '-o "StrictHostKeyChecking=no" -i ' 55 | + splitext(self.pubkey_path)[0] 56 | + " " 57 | ) 58 | pubfile = open(self.pubkey_path, mode="r") 59 | self.pubkey = pubfile.readline().rstrip() 60 | pubfile.close() 61 | 62 | self.passwd = runcmd( 63 | "echo $(cat /dev/random | strings | head -c 512 | " 64 | + "grep -oE '[a-zA-Z0-9#%!]') | sed 's/\s//g' | head -c 32;" 65 | ).decode() 66 | 67 | create_cmd = ( 68 | "linode-cli --json linodes create " 69 | + "--image linode/arch " 70 | + "--authorized_keys " 71 | + '"' 72 | + self.pubkey 73 | + '"' 74 | + ' --root_pass "' 75 | + self.passwd 76 | + '"' 77 | ) 78 | self.info = j.loads(runcmd(create_cmd).decode())[0] 79 | print("[INFO]: Created Linode {}.".format(self.info["id"])) 80 | except KeyboardInterrupt: 81 | self.cleanup() 82 | 83 | def find_linode(self) -> bool: 84 | linodes = j.loads(runcmd("linode-cli --json linodes list").decode()) 85 | 86 | for linode in linodes: 87 | if linode["id"] == self.info["id"]: 88 | return True 89 | return False 90 | 91 | def cleanup(self) -> None: 92 | if hasattr(self, "proxy_proc"): 93 | self.proxy_proc.terminate() 94 | 95 | if hasattr(self, "info"): 96 | if self.find_linode(): 97 | print( 98 | runcmd( 99 | "linode-cli --json linodes delete " 100 | + str(self.info["id"]) 101 | ).decode(), 102 | end="", 103 | ) 104 | print("[CLEANUP]: Deleted Linode {}.".format(self.info["id"])) 105 | delattr(self, "info") 106 | 107 | def get_info(self) -> None: 108 | self.info = j.loads( 109 | runcmd( 110 | "linode-cli --json linodes view " + str(self.info["id"]) 111 | ).decode() 112 | )[0] 113 | 114 | def get_status(self) -> str: 115 | self.get_info() 116 | return self.info["status"] 117 | 118 | def setup_user(self) -> None: 119 | """ 120 | This will probably break on other distros that assign new accounts to 121 | the `users` primary group instead of one derived from their user name. 122 | (Patches welcome!) 123 | """ 124 | user_cmd = ( 125 | "useradd -m " 126 | + self.proxy_user 127 | + "; " 128 | + "mkdir /home/" 129 | + self.proxy_user 130 | + "/.ssh; " 131 | + "touch /home/" 132 | + self.proxy_user 133 | + "/.ssh/authorized_keys; " 134 | + "chown -R " 135 | + self.proxy_user 136 | + ":" 137 | + self.proxy_user # change to "users" if using Red Hat/Fedora 138 | + " /home/" 139 | + self.proxy_user 140 | + "/.ssh; " 141 | + "chmod 700 /home/" 142 | + self.proxy_user 143 | + "/.ssh; " 144 | + "chmod 600 /home/" 145 | + self.proxy_user 146 | + "/.ssh/authorized_keys; " 147 | + "cat ~/.ssh/authorized_keys >> /home/" 148 | + self.proxy_user 149 | + "/.ssh/authorized_keys" 150 | ) 151 | full_cmd = ( 152 | self.ssh_prefix 153 | + "root@" 154 | + self.info["ipv4"][0] 155 | + " '" 156 | + user_cmd 157 | + "'" 158 | ) 159 | if self.debug: 160 | print(full_cmd) 161 | 162 | print(runcmd(full_cmd).decode()) 163 | self.user_made = True 164 | 165 | def test_proxy(self) -> bool: 166 | sen = struct.pack("BBB", 0x05, 0x01, 0x00) 167 | s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 168 | s.settimeout(2) 169 | 170 | try: 171 | s.connect(("127.0.0.1", self.proxy_port)) 172 | except ConnectionRefusedError as e: 173 | eprint( 174 | "[WARN]: Linode {} SOCKS proxy on {} got {}".format( 175 | self.info["id"], self.proxy_port, e 176 | ) 177 | ) 178 | return False 179 | 180 | for n in range(3): 181 | s.sendall(sen) 182 | try: 183 | data = s.recv(2) 184 | break 185 | except socket.timeout: 186 | if n == 2: 187 | eprint( 188 | "[ERROR]: Linode SOCKS timed out after three attempts!", 189 | ) 190 | return False 191 | 192 | version, auth = struct.unpack("BB", data) 193 | if version == 5 and auth == 0: 194 | return True 195 | else: 196 | eprint("[WARN]: SOCKSv5 proxy anomaly!") 197 | return False 198 | 199 | def start(self, headless: bool = True) -> bool: 200 | if not self.user_made: 201 | self.setup_user() 202 | 203 | verbose_ssh = "" 204 | if self.debug: 205 | verbose_ssh = "-v " 206 | 207 | proxy_cmd = ( 208 | self.ssh_prefix 209 | + "-D " 210 | + str(self.proxy_port) 211 | + " -NT " 212 | + verbose_ssh 213 | + self.proxy_user 214 | + "@" 215 | + self.info["ipv4"][0] 216 | ) 217 | if self.debug: 218 | print(proxy_cmd) 219 | 220 | print( 221 | "[INFO]: Starting proxy on port {} with Linode {}".format( 222 | self.proxy_port, self.info["id"] 223 | ) 224 | ) 225 | if headless is True: 226 | self.proxy_proc = subprocess.Popen(proxy_cmd, shell=True) 227 | else: 228 | self.proxy_proc = subprocess.Popen( 229 | proxy_cmd, 230 | shell=True, 231 | stdout=subprocess.PIPE, 232 | stderr=subprocess.PIPE, 233 | ) 234 | sleep(2) 235 | 236 | return self.test_proxy() 237 | -------------------------------------------------------------------------------- /squid_dl/proxy.py: -------------------------------------------------------------------------------- 1 | """ 2 | squid_dl Proxy base class (for typing) 3 | 4 | ⣀⣠⣴⣷⣾⣿⣿⣿⣶⣦⣠ 5 | ⣴⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡖ 6 | ⣰⣿⣿⠟⠉⣀⠄⠻⣿⣿⣿⣿⣿⣿⡟ 7 | ⣠⣿⣿⡯ ⠜⠁ ⢰⣿⣿⣿⣿⣿⡿⠋ 8 | ⢀⣠⣼⣿⣿⣿⣿⣯⡄⡀⣠⣤⡿⡿⢿⣿⠿⠋ 9 | ⣀⣶⣿⣿⣿⡿⠿⠿⠿⢿⢿⣿⣿⣿⣿⣿⣿⣶ 10 | ⣠⣿⣿⣿⣿⡿⠗⠁ ⠙⣿⣿⣿⣿⣿⣿⣷⡆ 11 | ⢀⣴⣿⣿⣿⣿⣿ ⢻⣿⣿⣿⣿⣿⣿⣿⣥⠄ 12 | ⣴⣿⣿⣿⣿⣿⡃ ⢨⣿⣿⣿⣿⣿⣿⣿⣿⡅ 13 | ⠼⣿⣿⣿⣿⠋ ⠈⣿⣿⣿⣿⣿⣿⣿⣿⣗⠄ 14 | ⠹⠛⠏⠃ ⠸⣿⣿⣿⣿⣿⣿⣿⣿⣿⡁ 15 | ⣨⣟⣿⣿⣿⣿⣿⡏⣿⣿⣗ 16 | ⢠⣾⢷⣿⣿⣿⣿⣿⣯⢿⣿⣿⡂ 17 | ⣠⣾⣟⣾⣿⣿⣿⣿⣿⣿⣸⣿⣿⣧⠄ 18 | ⢀⣴⣿⣿⣽⣿⣿⣿⣿⣿⣿⣿⣧⢿⣿⣿⣷⣵⣀ 19 | ⢾⣿⣻⣾⣿⣿⣿⣿⣿⣿⣿⣿⡟⠘⢿⣿⣿⣿⣷⠄ 20 | ⢀⣤⣷⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡗ ⠈⠘⠉⠋⠁ 21 | ⢀⣴⣿⣿⡟⠋⠉⠁⠁⠁⠉⠹⣻⣿⣿⣧⡀ 22 | ⣰⣿⣿⡟⠉ ⢻⣿⣿⡄ 23 | ⢠⣾⣿⣿⠯ ⣻⣿⣷⣆ 24 | ⢠⣿⣿⣿⠩ ⠙⣿⣿⣿⣦⡀ 25 | ⢠⣿⣿⣟⡷⡕ ⠈⢻⣿⣿⣿⣷⡀ 26 | ⢰⣿⣿⡳⡩⣇ ⢙⣿⣿⣿⣿⣞⡄ 27 | ⢸⣿⣿⢧⡲⣧ ⢺⣿⣿⣿⣿⡽⡆ 28 | ⠻⣿⣯⠛ ⠘⠟⠿⠿⡙ 29 | 30 | """ 31 | 32 | 33 | class Proxy: 34 | proxy_url = None 35 | exclusive = False 36 | 37 | def cleanup(self) -> None: 38 | pass 39 | -------------------------------------------------------------------------------- /squid_dl/socks.py: -------------------------------------------------------------------------------- 1 | """ 2 | Generic SOCKS proxy support. 3 | ⢀⣀⣤⣴⣶⣶⣾⣿⣷⣶⣶⣦⣄⡀⠀⠀⠀ 4 | ⠀⢠⣴⣿⣿⣿⣿⣿⣭⣭⣭⣭⣭⣿⣿⣿⣿⣧⣀⠀ 5 | ⢰⣿⣿⣿⣿⣿⣯⣿⡶⠶⠶⠶⠶⣶⣭⣽⣿⣿⣷⣆ 6 | ⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿ 7 | ⠈⢿⣿⣿⡿⠋⠉⠁⠈⠉⠛⠉⠀⠀⠀⠈⠻⣿⡿⠃ 8 | ⠀⠀⠀⠉⠁⠀⢴⣐⢦⠀⠀⠀⣴⡖⣦⠀⠀⠈⠀⠀ 9 | ⠀⠀⠀⠀⠀⠀⠈⠛⠋⠀⠀⠀⠈⠛⠁⠀⠀⠀⠀⠀ 10 | ⠀⠀⠀⠀⠀⣀⡀⠀⠀⠀⣀⠀⠀⠀⢀⡀⠀⠀⠀⠀ 11 | ⠀⠀⢀⡔⣻⣭⡇⠀⣼⣿⣿⣿⡇⠦⣬⣟⢓⡄⠀⠀ 12 | ⠀⠀⠀⠉⠁⠀⠀⠀⣿⣿⣿⣿⡇⠀⠀⠉⠉⠀⠀⠀ 13 | ⠀⠀⠀⠀⠀⠀⠀⠀⠻⠿⠿⠟⠁⠀⠀ 14 | """ 15 | 16 | from getpass import getpass 17 | import json as j 18 | import typing 19 | import os 20 | import socket 21 | import struct 22 | from urllib.parse import unquote_plus, urlparse 23 | from yt_dlp.socks import ProxyType, Socks4Error, Socks5Error, sockssocket 24 | 25 | from .proxy import Proxy 26 | from .util import die, eprint 27 | 28 | 29 | class SocksUnknownSchemeError(Exception): 30 | pass 31 | 32 | 33 | def test_proxy(host: str, port: int): 34 | sen = struct.pack("BBB", 0x05, 0x01, 0x00) 35 | s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 36 | s.settimeout(2) 37 | 38 | try: 39 | s.connect((host, port)) 40 | except ConnectionRefusedError as e: 41 | die( 42 | '[ERROR]: Got "{}" when connecting to {} on port {}'.format( 43 | e, host, port 44 | ) 45 | ) 46 | 47 | for n in range(3): 48 | s.sendall(sen) 49 | try: 50 | data = s.recv(2) 51 | break 52 | except socket.timeout: 53 | if n == 2: 54 | eprint("[ERROR]: SOCKS proxy timed out after three attempts!") 55 | exit(1) 56 | 57 | s.close() 58 | return struct.unpack("BB", data) # (version, auth) 59 | 60 | 61 | class SocksProxy(Proxy): 62 | """ 63 | The ``params`` dict can either contain the single element ``url`` or: 64 | * ``host`` (string) 65 | * ``port`` (string) 66 | * ``scheme`` (string, optional) 67 | * ``user`` (string, optional) 68 | * ``password`` (string, optional) 69 | """ 70 | 71 | def __init__( 72 | self, url: str = None, params: dict = None, debug: bool = False 73 | ): 74 | self.debug = debug 75 | 76 | if url is not None: 77 | self.init_from_url(url) 78 | else: 79 | self.init_from_params(params) 80 | 81 | self.setup() 82 | 83 | def get_socks_proxytype(self): 84 | if self.scheme.lower() == "socks5": 85 | return ProxyType.SOCKS5 86 | elif self.scheme.lower() in ("socks", "socks4"): 87 | return ProxyType.SOCKS4 88 | elif self.scheme.lower() == "socks4a": 89 | return ProxyType.SOCKS4A 90 | else: 91 | eprint("[ERROR]: Unknown scheme in proxy URL!") 92 | raise SocksUnknownSchemeError 93 | 94 | def init_from_url(self, url: str): 95 | self.proxy_url = url 96 | url_pieces = urlparse(url) 97 | 98 | self.scheme = url_pieces.scheme 99 | self.host = url_pieces.hostname 100 | self.port = url_pieces.port or 1080 101 | self.user = url_pieces.username 102 | self.password = url_pieces.password 103 | 104 | def init_from_params(self, params: dict): 105 | self.host = params["host"] 106 | self.port = params["port"] if "port" in params else 1080 107 | if "user" in params and "password" in params: 108 | self.user = params["user"] 109 | self.password = params["password"] 110 | authstr = self.user + ":" + self.password + "@" 111 | else: 112 | self.user = None 113 | self.password = None 114 | authstr = "" 115 | self.scheme = ( 116 | params["scheme"].lower() if "scheme" in params else "socks5" 117 | ) 118 | self.proxy_url = ( 119 | self.scheme + "://" + authstr + self.host + ":" + str(self.port) 120 | ) 121 | 122 | def get_creds(self): 123 | self.username = input("SOCKS username: ") 124 | self.password = getpass(prompt="SOCKS password: ") 125 | self.proxy_url = ( 126 | self.scheme 127 | + "://" 128 | + self.username 129 | + ":" 130 | + self.password 131 | + "@" 132 | + self.host 133 | + ":" 134 | + str(self.port) 135 | ) 136 | 137 | def setup(self): 138 | version, auth = test_proxy(host=self.host, port=self.port) 139 | if auth != 0 and (self.user is None or self.password is None): 140 | self.get_creds() 141 | 142 | def unquote_if_non_empty(s): 143 | if not s: 144 | return s 145 | return unquote_plus(s) 146 | 147 | proxy_args = ( 148 | self.get_socks_proxytype(), 149 | self.host, 150 | self.port or 1080, 151 | True, # Remote DNS 152 | unquote_if_non_empty(self.username), 153 | unquote_if_non_empty(self.password), 154 | ) 155 | 156 | testsock = sockssocket() 157 | testsock.setproxy(*proxy_args) 158 | try: 159 | testsock.connect((self.host, self.port)) 160 | testsock.close() 161 | except (Socks4Error, Socks5Error) as e: 162 | die("[ERROR]: {}: {}".format(type(e).__name__, e)) 163 | -------------------------------------------------------------------------------- /squid_dl/util.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import subprocess 3 | from sys import stderr as STDERR 4 | import typing 5 | 6 | 7 | def eprint(errmsg): 8 | print(errmsg, file=STDERR) 9 | 10 | 11 | def die(errmsg, stat: int = 1): 12 | """Prints message and exits Python with a status of stat.""" 13 | eprint(errmsg) 14 | exit(stat) 15 | 16 | 17 | def runcmd(args): 18 | """ 19 | Run a given program/shell command and return its output. 20 | 21 | Error Handling 22 | ============== 23 | If the spawned proccess returns a nonzero exit status, it will print the 24 | program's ``STDERR`` to the running Python iterpreter's ``STDERR``. 25 | """ 26 | proc = subprocess.Popen( 27 | args, 28 | shell=True, 29 | stdout=subprocess.PIPE, 30 | stderr=subprocess.PIPE, 31 | ) 32 | 33 | try: 34 | if proc.wait() == 1: 35 | print(proc.stdout.read().decode()) 36 | eprint(proc.stderr.read().decode()) 37 | 38 | return proc.stdout.read() 39 | except KeyboardInterrupt: 40 | proc.terminate() 41 | return b"" 42 | -------------------------------------------------------------------------------- /tests/linode-test.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | from squid_dl.linode import LinodeProxy 3 | from squid_dl.util import die, eprint 4 | from time import sleep 5 | 6 | 7 | def main(): 8 | """ 9 | A simple LinodeProxy class example. This should work once you have setup 10 | linode-cli. Only tested with Linode CLI settings that select Arch Linux 11 | image by default. YMMV with other distro images. 12 | """ 13 | proxy = LinodeProxy(debug=True) 14 | while proxy.get_status() != "running": 15 | sleep(1) 16 | 17 | if not proxy.start(headless=False): 18 | proxy.cleanup() 19 | print(proxy.proxy_proc.stdout.read().decode()) 20 | eprint(proxy.proxy_proc.stderr.read().decode()) 21 | die("BAD PROXY!") 22 | 23 | sleep(10) 24 | # proxy.cleanup() 25 | proxy.proxy_proc.terminate() 26 | print(proxy.proxy_proc.stdout.read().decode()) 27 | eprint(proxy.proxy_proc.stderr.read().decode()) 28 | 29 | 30 | if __name__ == "__main__": 31 | main() 32 | --------------------------------------------------------------------------------