initial commit
This commit is contained in:
commit
0007acad90
13 changed files with 1893 additions and 0 deletions
661
LICENSE
Normal file
661
LICENSE
Normal file
|
|
@ -0,0 +1,661 @@
|
|||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
151
README.md
Normal file
151
README.md
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<center>
|
||||

|
||||
<h1 align="center">squid-dl</h1>
|
||||
</center>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/psf/black">
|
||||
<img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
|
||||
</a>
|
||||
<a href="https://github.com/targetdisk/squid-dl/blob/main/LICENSE">
|
||||
<img alt="License: AGPL v3" src="./img/license.svg">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
`squid-dl` is a massively parallel
|
||||
[yt-dlp](https://github.com/yt-dlp/yt-dlp)-based YouTube downloader.
|
||||
|
||||
## Installation
|
||||
Run the `setup.py`, which will install `squid-dl` and its two dependencies:
|
||||
`linode-cli` and `yt-dlp`.
|
||||
```
|
||||
$ python3 setup.py install
|
||||
```
|
||||
|
||||
### Linode Setup
|
||||
If you want to use the Linode SOCKS proxy feature, be sure to configure the
|
||||
`linode-cli` first:
|
||||
```
|
||||
$ linode-cli configure --token
|
||||
```
|
||||
|
||||
Follow the onscreen instructions and be sure to set sensible defaults. The
|
||||
default region for new Linodes that you pick here is where your proxies will
|
||||
live. For more information, see
|
||||
[this page](https://www.linode.com/docs/guides/linode-cli/) on Linode's website.
|
||||
|
||||
## Usage
|
||||
To download a playlist, first fetch its metadata with `squidson`:
|
||||
```
|
||||
(.venv) $ squidson 'https://www.youtube.com/playlist?list=PLhI42_YpLVHvYqvjniSp7lhAM55K4fllO'
|
||||
[youtube:tab] PLhI42_YpLVHvYqvjniSp7lhAM55K4fllO: Downloading webpage
|
||||
[youtube:tab] PLhI42_YpLVHvYqvjniSp7lhAM55K4fllO: Downloading API JSON with unavailable videos
|
||||
[download] Downloading playlist: Programming
|
||||
[youtube:tab] playlist Programming: Downloading 12 videos
|
||||
[download] Downloading video 1 of 12
|
||||
[youtube] Wp9XD5FKZ2c: Downloading webpage
|
||||
[youtube] Wp9XD5FKZ2c: Downloading android player API JSON
|
||||
...
|
||||
[download] Downloading video 12 of 12
|
||||
[youtube] CIpfoMKqPAg: Downloading webpage
|
||||
[youtube] CIpfoMKqPAg: Downloading android player API JSON
|
||||
[youtube] CIpfoMKqPAg: Downloading MPD manifest
|
||||
[youtube] CIpfoMKqPAg: Downloading MPD manifest
|
||||
[download] Finished downloading playlist: Programming
|
||||
[INFO]: Writing JSON-ified playlist info_dict to "Programming.json"
|
||||
```
|
||||
|
||||
Now that you have the playlist `.json` file, you can download it with
|
||||
`squid-dl`. Use the `-n` flag to tell `squid-dl` how many workers you'd like to
|
||||
spawn downloading videos at once (the default is 8 workers). In this 12-video
|
||||
playlist example, we'll spawn 12 workers:
|
||||
```
|
||||
(.venv) $ squid-dl -n 12 Programming.json
|
||||
|
||||
[INFO]: Starting squid-dl...
|
||||
[INFO]: saving videos to "Programming" directory
|
||||
|
||||
...
|
||||
[download] Download completed
|
||||
[download] Download completed
|
||||
[download] Download completed
|
||||
[INFO]: Worker 80214 done...
|
||||
[INFO]: Worker 80319 done...
|
||||
[download] Download completed
|
||||
[INFO]: Worker 80150 done...
|
||||
[INFO]: Worker 80248 done...
|
||||
[download] Download completed
|
||||
[INFO]: Worker 80219 done...
|
||||
[INFO]: Worker 80109 done...
|
||||
[INFO]: Worker 80341 done...
|
||||
[download] Download completed
|
||||
[INFO]: Worker 80193 done...
|
||||
[download] Download completed
|
||||
[INFO]: Worker 80117 done...
|
||||
[INFO]: All done!
|
||||
```
|
||||
|
||||
For more information see the built-in help by running `squid-dl -h`.
|
||||
|
||||
## Linode Proxying
|
||||
With the `-L` option, you can run each worker through its own Linode-powered
|
||||
SSH-tunneled SOCKSv5 proxy! `squid-dl` will make an temporary SSH key in
|
||||
the current working directory and then get to work spinning up Linodes and
|
||||
downloading your videos:
|
||||
```
|
||||
(.venv) anon@fire-crotch:~/butter/youtube/btr$ squid-dl -L Mem.json
|
||||
|
||||
[INFO]: Creating SSH key for Linode proxying...
|
||||
Generating public/private rsa key pair.
|
||||
Your identification has been saved in /home/anon/fuse/butter-anon/youtube/btr/proxy
|
||||
_key
|
||||
Your public key has been saved in /home/anon/fuse/butter-anon/youtube/btr/proxy_key
|
||||
.pub
|
||||
The key fingerprint is:
|
||||
SHA256:cSns+aK0l7xS+fRSXRdqmc5DXkT5pIQsDV8/Ql526vg anon@fire-crotch
|
||||
The key's randomart image is:
|
||||
+---[RSA 3072]----+
|
||||
| .+ oo+o|
|
||||
| . .o*.+*o|
|
||||
| + o..+*++|
|
||||
| . = Oo.=|
|
||||
| S. B.o..|
|
||||
| o.. .*. |
|
||||
| .o.+.o E |
|
||||
| ..o+.o . |
|
||||
| oo.. . |
|
||||
+----[SHA256]-----+
|
||||
|
||||
[INFO]: Starting squid-dl...
|
||||
[INFO]: saving videos to "Mems" directory
|
||||
[INFO]: Created Linode 30970792.
|
||||
[INFO]: Waiting for Linodes to come online...........................
|
||||
|
||||
[INFO]: Starting proxy on port 1337 with Linode 30970792
|
||||
Warning: Permanently added '45.79.47.110' (ED25519) to the list of known hosts.
|
||||
[INFO]: SOCKS validation succeeded on port 1337 from ID 30970792
|
||||
[youtube] fIdfGtG7Isg: Downloading android player API JSON
|
||||
[youtube] fIdfGtG7Isg: Downloading iframe API JS
|
||||
[youtube] fIdfGtG7Isg: Downloading player 03869671
|
||||
[youtube] fIdfGtG7Isg: Downloading web player API JSON
|
||||
[youtube] fIdfGtG7Isg: Downloading MPD manifest
|
||||
[youtube] fIdfGtG7Isg: Downloading MPD manifest
|
||||
[youtube] fIdfGtG7Isg: Downloading initial data API JSON
|
||||
[info] fIdfGtG7Isg: Downloading 1 format(s): 22
|
||||
[info] Downloading video thumbnail ...
|
||||
[info] Writing video thumbnail to: Plankton goes to an anime convention [fIdfGtG7Is
|
||||
g].webp
|
||||
[download] Destination: Plankton goes to an anime convention [fIdfGtG7Isg].mp4
|
||||
[download] Download completed
|
||||
[INFO]: Cleaning up worker 83832's exclusive proxy
|
||||
[CLEANUP]: Deleted Linode 30970792.
|
||||
[INFO]: Worker 83832 done...
|
||||
[INFO]: All done!
|
||||
[CLEANUP]: Deleting Linode proxies...
|
||||
```
|
||||
|
||||
## Bugs
|
||||
If you encounter any issues running `squid-dl`, please create an issue
|
||||
[on GitHub](https://github.com/targetdisk/squid-dl/issues/new/choose).
|
||||
|
||||
This software has only tested on Linux so far (patches welcome).
|
||||
1
img/license.svg
Normal file
1
img/license.svg
Normal file
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="194" height="20" role="img" aria-label="license: AGPLv3+TRANS RIGHTS"><title>license: AGPLv3+TRANS RIGHTS</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="194" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="47" height="20" fill="#55CDFC"/><rect x="47" width="147" height="20" fill="#F7A8B8"/><rect width="194" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="245" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">license</text><text x="245" y="140" transform="scale(.1)" fill="#fff" textLength="370">license</text><text aria-hidden="true" x="1195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="1370">AGPLv3+TRANS RIGHTS</text><text x="1195" y="140" transform="scale(.1)" fill="#fff" textLength="1370">AGPLv3+TRANS RIGHTS</text></g></svg>
|
||||
|
After Width: | Height: | Size: 1.2 KiB |
119
img/squid-dl.no-outline.web.svg
Normal file
119
img/squid-dl.no-outline.web.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 63 KiB |
2
requirements.txt
Normal file
2
requirements.txt
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
linode-cli
|
||||
yt-dlp
|
||||
31
scripts/squid-dl
Executable file
31
scripts/squid-dl
Executable file
|
|
@ -0,0 +1,31 @@
|
|||
#!/usr/bin/env python3
|
||||
from squid_dl import main
|
||||
from sys import argv as ARGV
|
||||
|
||||
if __name__ == "__main__":
|
||||
name = ARGV.pop(0)
|
||||
welcome = (
|
||||
""
|
||||
+ " ⣠⣾⢿⣿⣷⣦ \n"
|
||||
+ " ⣀⣼⢟⡱⣆⡹⠹⣿⣇ ⢠⣶⣿⠿⣦⡀ \n"
|
||||
+ " ⠈⠛⠛⠊⠉⠁ ⠹⣿⣧⡀ ⢠⣿⠏⠁⠝⢪⣻⡦ \n"
|
||||
+ " ⠙⢻⣿⡄ ⣴⣿⠏ \n"
|
||||
+ " ⣿⣷ ⢸⣿⠁ \n"
|
||||
+ " ⢀⣽⣿⣿⣿⣿⣿⣶⣦⣼⠟ \n"
|
||||
+ " ⣀⡀ ⢀⣴⣿⣿⣿⢿⣿⣿⣿⣿⣿⣿⣷⡀ \n"
|
||||
+ "⢀⣴⣿⡿⢿⣷⡄ ⣼⣿⣿⣿⣿ ⠈⠙⠻⣿⣿⣿⣿⣷ \n"
|
||||
+ "⣾⣿⠱⠉⠛⣿⣿⣄ ⣀⣿⣿⣿⣿⣿ ⣀⣽⣿⣿⣿ ⣠⣶⣿⣷⣦⡀\n"
|
||||
+ "⠈⠁ ⠙⠿⠿⠛⠛⢻⣿⣿⣿⣿ ⣀⣴⣾⣿⣿⣿⣿⣿⣤⣾⣿⡿⠖⡯⢿⣷\n"
|
||||
+ " ⠈⠻⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠉⠛⠛⠉ ⠹⠟\n"
|
||||
+ " ⢀⣴⡾⠟⠿⣿⣿⣿⣿⠿⢿⡍ \n"
|
||||
+ " ⣀⣾⡟ ⠈⣿⣶⣤⣤⣄⡀ \n"
|
||||
+ " ⣰⣾⣿⣿⣿⣿⠏ ⠈⠛⠛⢿⣿⣿⣦ \n"
|
||||
+ " ⠛⠉⠉⠉⠉ _ _ ⠈⠻⣿⣿⣇_ _\n"
|
||||
+ " ___ __ _ _ _(_)__| |___ __| | |\n"
|
||||
+ "(_-</ _` | || | / _` |___/ _` | |\n"
|
||||
+ "/__/\__, |\_,_|_\__,_| \__,_|_|\n"
|
||||
+ " |_|\n\n"
|
||||
)
|
||||
print(welcome)
|
||||
|
||||
exit(main(args=ARGV, name=name))
|
||||
54
scripts/squidson
Executable file
54
scripts/squidson
Executable file
|
|
@ -0,0 +1,54 @@
|
|||
#!/usr/bin/env python3
|
||||
import argparse
|
||||
import json as j
|
||||
from yt_dlp import YoutubeDL
|
||||
from yt_dlp.utils import encodeFilename, sanitize_path
|
||||
|
||||
"""
|
||||
Dump yt_dlp's entire info_dict for a whole playlist in JSON format.
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡀⠤⠲⠦⠉⠉⠉⠏⠉⠒⢄⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡠⠲⠃⢀⣤⠀⠀⠀⠲⠂⠀⠠⠆⠀⠙⢄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⢀⡔⠁⣤⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⡆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⢀⠊⠁⠀⢁⡴⠚⠉⣉⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⣀⠠⠤⠔⠒⡄⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⡆⢰⠆⠀⠋⣠⠔⠉⠁⣀⡠⠄⠒⠂⠀⠀⠀⠀⠀⠀⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠔⠊⠁⠀⠀⠀⠀⠀⣠⡴⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⢠⡆⠀⠀⠀⡜⠁⣠⠔⠋⢁⡔⠒⠒⠤⡀⠀⠀⠀⠀⡐⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⠎⠀⠀⠀⢀⣀⣤⣶⡾⠋⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⡆⡶⠀⠀⢀⡜⠁⢀⣀⢸⠀⠀⠀⠀⠈⢆⠀⠀⡜⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⠤⠊⠁⠀⢀⡀⣴⡿⠿⠛⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠰⡀⠀⠀⠘⠀⡞⠁⠀⠉⢇⠀⣿⣄⠀⠈⡆⠀⠕⠒⠉⣉⡒⡄⠀⠀⠀⠀⢀⠤⠊⠁⢀⡠⠔⠊⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠑⢄⡀⠀⠀⢇⠀⣤⡄⠈⢢⡈⠻⡖⢀⡞⣀⠔⠊⠁⠀⠀⠉⠐⠒⠠⢎⢁⡠⠔⠂⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⠉⠉⢂⠘⢿⣦⡇⠉⠓⢶⡫⠞⠁⣀⣤⣤⣤⣤⣤⣤⣤⠴⠛⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢡⠦⠭⡇⠀⡠⠊⠀⣠⣮⣬⣿⣿⣿⣿⣿⣯⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢰⠁⢀⠔⡧⠊⠀⢀⡜⠁⠙⣿⣿⣿⡿⠟⠋⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠸⣀⣡⠎⠀⠀⢠⠊⠀⠀⠀⣸⣿⣿⣷⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⠃⠀⠀⣰⣧⣀⣀⡠⣴⣿⣿⣿⣿⣿⣆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢧⣤⣤⣾⡿⠿⠋⠁⠀⢹⣿⣿⣿⣿⣿⣿⡆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠁⠀⠀⠀⠀⠀⠀⢸⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣼⣿⣿⣿⣿⣿⣿⣿⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⠿⠛⠛⠛⠛⠻⢿⠇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡸⠀⠀⠀⠀⠀⠀⠀⡸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢰⠁⡰⢤⣀⣀⡄⢠⠞⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
"""
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument(
|
||||
"playlist_url",
|
||||
type=str,
|
||||
help="URL of playlist to download as JSON",
|
||||
)
|
||||
opts = parser.parse_args()
|
||||
|
||||
y = YoutubeDL({"ignoreerrors": True})
|
||||
info_dict = y.sanitize_info(
|
||||
y.extract_info(opts.playlist_url, download=False)
|
||||
)
|
||||
|
||||
dump_path = encodeFilename(sanitize_path(info_dict["title"] + ".json"))
|
||||
print(
|
||||
'[INFO]: Writing JSON-ified playlist info_dict to "{}"'.format(
|
||||
dump_path
|
||||
)
|
||||
)
|
||||
dumpfile = open(dump_path, mode="w")
|
||||
dumpfile.write(j.dumps(info_dict, sort_keys=True, indent=2))
|
||||
dumpfile.close()
|
||||
24
setup.py
Normal file
24
setup.py
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
from setuptools import setup
|
||||
|
||||
try:
|
||||
from pip import main as pipmain
|
||||
except ImportError:
|
||||
from pip._internal import main as pipmain
|
||||
|
||||
# install_requires sucks, I don't know why and I really
|
||||
# don't care, so I do this:
|
||||
pipmain(["install", "-r", "requirements.txt"])
|
||||
|
||||
scripts = ["scripts/squid-dl", "scripts/squidson"]
|
||||
|
||||
setup(
|
||||
name="squid-dl",
|
||||
version="0.9",
|
||||
author="Andrea Rogers (@targetdisk)",
|
||||
description="Massively parallel YouTube downloader using yt-dlp",
|
||||
author_email="targetdisk one three nine four at g mail dot com",
|
||||
url="https://github.com/targetdisk/squid-dl",
|
||||
packages=["squid_dl"],
|
||||
include_package_data=True,
|
||||
scripts=scripts,
|
||||
)
|
||||
6
squid_dl/__init__.py
Normal file
6
squid_dl/__init__.py
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
import typing
|
||||
|
||||
from .downloader import main as real_main
|
||||
|
||||
def main(args: [str], name: str) -> int:
|
||||
return real_main(args=args, name=name)
|
||||
551
squid_dl/downloader.py
Normal file
551
squid_dl/downloader.py
Normal file
|
|
@ -0,0 +1,551 @@
|
|||
"""
|
||||
Fancy parallel downloader for a pre-
|
||||
retrieved YoutubeDL() info_dict JSON.
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⣀⣀⣠⣤⣤⣄⣀⣀⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⠤⠖⠊⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⠙⠲⢤⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⡤⠊⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⢦⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⡜⠀⠀⠀⠀⠀⠀⢀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢢⠀⠀⠀⠀⠀⢳⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⣸⠁⠀⠀⠀⠀⠀⠀⠀⠱⡀⠀⠀⠀⠀⠀⠀⠀⡀⠈⠀⡀⠀⠀⠀⠈⡇⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⡏⠀⠀⠀⠀⠀⠀⠀⠀⡰⠁⠀⠀⠀⠀⠀⠀⠀⠘⡆⡜⠁⠀⠀⠀⠀⢧⡀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⡇⠀⠀⠀⠀⠀⠀⠀⠸⡀⠀⠀⠀⠀⠀⣀⣤⡂⠀⠇⠱⠀⡀⠀⠀⠀⠀⡇⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⢇⠀⠀⠀⠀⠀⠀⠀⠀⠈⢄⡀⢠⣟⢭⣥⣤⠽⡆⠀⡶⣊⣉⣲⣤⢀⡞⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠘⣆⠀⠀⠀⠀⠀⠀⡀⠀⠐⠂⠘⠄⣈⣙⡡⡴⠀⠀⠙⣄⠙⣛⠜⠘⣆⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠈⢦⡀⠀⠀⠀⢸⠁⠀⠀⠀⠀⠀⠀⠄⠊⠀⠀⠀⠀⡸⠛⠀⠀⠀⢸⠆⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠈⠓⠦⢄⣘⣄⠀⠀⠀⠀⠀⠀⠀⡠⠀⠀⠀⠀⣇⡀⠀⠀⣠⠎⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣸⠁⠈⡟⠒⠲⣄⠀⠀⡰⠇⠖⢄⠀⠀⡹⡇⢀⠎⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡇⠀⠀⡇⠀⠀⠹⠀⡞⠀⠀⢀⠤⣍⠭⡀⢱⢸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⢀⣀⣀⣠⠞⠀⠀⢠⡇⠀⠀⠀⠀⠁⠀⢴⠥⠤⠦⠦⡼⠀⢸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⣀⣤⣴⣶⣿⣿⡟⠁⠀⠋⠀⠀⠀⢸⠁⠀⠀⠀⠀⠀⠀⠀⠑⣠⢤⠐⠁⠀⢸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⣿⣿⣿⣿⣿⡟⠀⠀⠀⠀⠀⠀⠀⢸⡀⠀⠀⠀⠀⠀⠀⠀⠀⠬⠥⣄⠀⠀⠈⠲⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⣿⣿⣿⣿⣿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠙⠦⣄⠀⠀⠀⠀⠀⠀⠀⠀⠈⢳⠀⠀⢀⣿⡀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⣿⣿⣿⣿⣿⣧⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠙⠒⠦⠤⢤⣄⣀⣠⠤⢿⣶⣶⣿⣿⣿⣶⣤⡀⠀⠀⠀⠀⠀
|
||||
⣿⣿⣿⣿⣿⣿⣷⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡼⠁⠀⠀⣠⣾⣿⣿⣿⣿⣿⣿⣿⣿⣄⠀⠀⠀⠀
|
||||
⣿⣿⣿⣿⣿⣿⣿⣿⣿⣶⣦⣤⣤⣀⣀⣀⣀⣀⣀⣀⣤⣤⣤⣶⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀
|
||||
|
||||
NOTE: Not my fault if your IP gets rate-
|
||||
limited or throttled by YouTube. With
|
||||
great power comes great responsibility!
|
||||
|
||||
ALSO NOTE: Have yet to test on other
|
||||
video sites besides YouTube...
|
||||
"""
|
||||
import argparse
|
||||
import json as j
|
||||
from multiprocessing import cpu_count, Process, Queue
|
||||
from multiprocessing.queues import Empty, Full
|
||||
import os
|
||||
from random import randint
|
||||
from time import sleep
|
||||
import typing
|
||||
from yt_dlp import YoutubeDL
|
||||
from yt_dlp.utils import encodeFilename, sanitize_path
|
||||
from yt_dlp.extractor.common import InfoExtractor as IE
|
||||
|
||||
from .linode import LinodeProxy
|
||||
from .util import die, eprint, runcmd
|
||||
|
||||
|
||||
def do_download(
|
||||
entry_q: Queue,
|
||||
opts: argparse.Namespace,
|
||||
sub_langs: [str],
|
||||
proxy: LinodeProxy = None,
|
||||
):
|
||||
|
||||
sub_opts = {
|
||||
"writesubtitles": True,
|
||||
"writeautomaticsub": True,
|
||||
}
|
||||
if sub_langs[0] == "all":
|
||||
sub_opts["allsubtitles"] = True
|
||||
else:
|
||||
sub_opts["subtitleslangs"] = sub_langs
|
||||
|
||||
yt_opts = {
|
||||
"noprogress": True,
|
||||
"http_chunk_size": 10485760,
|
||||
"writethumbnail": True,
|
||||
"ignoreerrors": True,
|
||||
"format_sort": IE.FormatSort.ytdl_default,
|
||||
"extractor_args": {
|
||||
"youtube": {"player_skip": ["webpage"]},
|
||||
"youtubetab": {"skip": ["webpage"]},
|
||||
},
|
||||
}
|
||||
if proxy is not None:
|
||||
yt_opts["proxy"] = proxy.proxy_url
|
||||
if opts.all_thumbnails:
|
||||
yt_opts["write_all_thumbnails"] = True
|
||||
|
||||
y = YoutubeDL({**yt_opts, **sub_opts})
|
||||
y_nosubs = YoutubeDL(yt_opts)
|
||||
|
||||
while True:
|
||||
try:
|
||||
try:
|
||||
entry = entry_q.get(block=True, timeout=0.5)
|
||||
except Empty:
|
||||
break
|
||||
|
||||
if entry["id"] is None:
|
||||
continue
|
||||
else:
|
||||
id_dir = entry["id"]
|
||||
|
||||
try:
|
||||
os.mkdir(id_dir)
|
||||
except FileExistsError:
|
||||
pass
|
||||
|
||||
try:
|
||||
os.chdir(id_dir)
|
||||
except OSError as oserr:
|
||||
eprint("[WARN]: Skipping {} due to {}".format(id_dir, oserr))
|
||||
continue
|
||||
|
||||
nfo_path = "playlist_entry.json"
|
||||
if not (os.path.exists(nfo_path) and os.path.isfile(nfo_path)):
|
||||
nfo_file = open(nfo_path, mode="w")
|
||||
nfo_file.write(j.dumps(entry, sort_keys=True, indent=2))
|
||||
nfo_file.close()
|
||||
|
||||
desc_path = "description"
|
||||
if not (os.path.exists(desc_path) and os.path.isfile(desc_path)):
|
||||
desc_file = open(desc_path, mode="w")
|
||||
desc_file.write(entry["description"])
|
||||
desc_file.close()
|
||||
|
||||
dl_url = "https://www.youtube.com/watch?v=" + entry["id"]
|
||||
try:
|
||||
if entry["tux_get_subs"] is True:
|
||||
y.download([dl_url])
|
||||
else:
|
||||
y_nosubs.download([dl_url])
|
||||
except KeyError:
|
||||
y.download([dl_url])
|
||||
|
||||
os.chdir("..")
|
||||
sleep(2)
|
||||
except KeyboardInterrupt:
|
||||
break
|
||||
|
||||
if proxy is not None:
|
||||
if proxy.exclusive:
|
||||
print(
|
||||
"[INFO]: Cleaning up worker {}'s exclusive proxy".format(
|
||||
os.getpid()
|
||||
)
|
||||
)
|
||||
proxy.cleanup()
|
||||
|
||||
print("[INFO]: Worker {} done...".format(os.getpid()))
|
||||
|
||||
|
||||
def get_entries(entries: dict, entry_q: Queue):
|
||||
try:
|
||||
for entry in entries:
|
||||
while True:
|
||||
try:
|
||||
entry_q.put(entry, block=True, timeout=0.2)
|
||||
break
|
||||
except Full:
|
||||
pass
|
||||
|
||||
except KeyboardInterrupt:
|
||||
pass
|
||||
|
||||
entry_q.close()
|
||||
|
||||
|
||||
def check_subs_done(entry: dict, basename: str, langs: [str] = None) -> bool:
|
||||
if langs is None:
|
||||
langs = entry["automatic_captions"].keys()
|
||||
|
||||
for lang in langs:
|
||||
subbase = basename + "." + lang
|
||||
|
||||
lang_sub_exists = False
|
||||
for subentry in entry["automatic_captions"][lang]:
|
||||
sfname = subbase + "." + subentry["ext"]
|
||||
if os.path.exists(sfname) and os.path.isfile(sfname):
|
||||
lang_sub_exists = True
|
||||
break
|
||||
if not lang_sub_exists:
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def check_video_done(entry: dict, basename: str) -> bool:
|
||||
for ext in (".mp4", ".webm", ".mkv"):
|
||||
vfname = basename + ext
|
||||
|
||||
if os.path.exists(vfname) and os.path.isfile(vfname):
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def check_dl(in_q: Queue, out_q: Queue):
|
||||
while True:
|
||||
try:
|
||||
try:
|
||||
entry = in_q.get(block=True, timeout=0.5)
|
||||
except Empty:
|
||||
break
|
||||
|
||||
if entry["id"] is None:
|
||||
continue
|
||||
else:
|
||||
id_dir = entry["id"]
|
||||
|
||||
if os.path.isdir(id_dir):
|
||||
try:
|
||||
os.chdir(id_dir)
|
||||
except OSError as oserr:
|
||||
eprint(
|
||||
"[WARN]: Skipping {} due to {}".format(id_dir, oserr)
|
||||
)
|
||||
continue
|
||||
elif os.path.exists(id_dir):
|
||||
eprint(
|
||||
"[WARN]: Not downloading https://youtube.com/watch?v={} "
|
||||
+ "because {} exists and is not a directory!"
|
||||
)
|
||||
continue
|
||||
else:
|
||||
out_q.put(entry)
|
||||
continue
|
||||
|
||||
nfo_path = "playlist_entry.json"
|
||||
if not (os.path.exists(nfo_path) and os.path.isfile(nfo_path)):
|
||||
os.chdir("..")
|
||||
out_q.put(entry)
|
||||
continue
|
||||
|
||||
desc_path = "description"
|
||||
if not (os.path.exists(desc_path) and os.path.isfile(desc_path)):
|
||||
desc_file = open(desc_path, mode="w")
|
||||
desc_file.write(entry["description"])
|
||||
desc_file.close()
|
||||
|
||||
y = YoutubeDL({"ignoreerrors": True})
|
||||
basename = os.path.splitext(
|
||||
sanitize_path(encodeFilename(y.prepare_filename(entry)))
|
||||
)[0]
|
||||
try:
|
||||
if check_subs_done(entry, basename):
|
||||
entry["tux_get_subs"] = False
|
||||
else:
|
||||
entry["tux_get_subs"] = True
|
||||
except KeyError:
|
||||
eprint(
|
||||
"[WARN]: Couldn't find auto subs for {} in info".format(
|
||||
entry["id"]
|
||||
)
|
||||
)
|
||||
entry["tux_get_subs"] = False
|
||||
|
||||
if not (check_video_done(entry, basename)):
|
||||
out_q.put(entry)
|
||||
os.chdir("..")
|
||||
continue
|
||||
|
||||
os.chdir("..")
|
||||
except KeyboardInterrupt:
|
||||
break
|
||||
|
||||
|
||||
def testworker(in_q: Queue):
|
||||
i = 0
|
||||
while not in_q.empty():
|
||||
try:
|
||||
entry = in_q.get(block=True, timeout=0.5)
|
||||
except Empty:
|
||||
break
|
||||
try:
|
||||
i += 1
|
||||
print("{}: ".format(i), end="")
|
||||
print(entry["id"])
|
||||
acs = entry["automatic_captions"]
|
||||
except KeyError:
|
||||
eprint("couldn't get caps on vid {}".format(entry["id"]))
|
||||
|
||||
|
||||
def workers_alive(workers: [Process]):
|
||||
for worker in workers:
|
||||
if worker.is_alive():
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def resume_cleanup(workers: [Process], q_worker: Process):
|
||||
print("\n[CLEANUP]: Cleaning up...")
|
||||
|
||||
for worker in workers:
|
||||
if worker.is_alive():
|
||||
print("[CLEANUP]: Terminating resume worker {}".format(worker.pid))
|
||||
worker.terminate()
|
||||
|
||||
print("[CLEANUP]: Terminating queue worker {}".format(worker.pid))
|
||||
q_worker.terminate()
|
||||
|
||||
|
||||
def resume_preprocess(entries: [dict]) -> list:
|
||||
ncpus = cpu_count()
|
||||
n_workers = ncpus if len(entries) >= ncpus else len(entries)
|
||||
|
||||
in_q = Queue(n_workers)
|
||||
out_q = Queue(len(entries))
|
||||
iq_builder = Process(target=get_entries, args=(entries, in_q))
|
||||
workers = []
|
||||
|
||||
try:
|
||||
iq_builder.start()
|
||||
|
||||
for n in range(n_workers):
|
||||
workers.append(Process(target=check_dl, args=(in_q, out_q)))
|
||||
|
||||
while not in_q.full():
|
||||
sleep(0.2)
|
||||
|
||||
for w in workers:
|
||||
w.start()
|
||||
|
||||
unfinished_entries = []
|
||||
while workers_alive(workers):
|
||||
try:
|
||||
unfinished_entries.append(out_q.get(block=True, timeout=2))
|
||||
except Empty:
|
||||
continue
|
||||
except KeyboardInterrupt:
|
||||
resume_cleanup(workers, iq_builder)
|
||||
return []
|
||||
|
||||
if iq_builder.is_alive():
|
||||
iq_builder.terminate()
|
||||
die("[BUG]: Workers didn't verify whole list! Exiting...")
|
||||
|
||||
return unfinished_entries
|
||||
|
||||
|
||||
def validate_proxy(proxy: LinodeProxy) -> LinodeProxy:
|
||||
if not proxy.start():
|
||||
eprint(
|
||||
"[WARN]: "
|
||||
+ "Proxy, validation failed, deleting and rebuilding Linode..."
|
||||
)
|
||||
port = proxy.proxy_port
|
||||
proxy.cleanup()
|
||||
proxy = LinodeProxy(proxy_port=port)
|
||||
return validate_proxy(proxy)
|
||||
else:
|
||||
print(
|
||||
"[INFO]: SOCKS validation succeeded on port {} from ID {}".format(
|
||||
proxy.proxy_port, proxy.info["id"]
|
||||
)
|
||||
)
|
||||
return proxy
|
||||
|
||||
|
||||
def cleanup(workers: [Process], proxies: [LinodeProxy]) -> None:
|
||||
if len(workers) > 0:
|
||||
for worker in workers:
|
||||
if worker.is_alive():
|
||||
print(
|
||||
"[CLEANUP]: Terminating download worker {}".format(
|
||||
worker.pid
|
||||
)
|
||||
)
|
||||
worker.terminate()
|
||||
|
||||
if len(proxies) > 0:
|
||||
print("[CLEANUP]: Deleting Linode proxies...")
|
||||
for proxy in proxies:
|
||||
proxy.cleanup()
|
||||
|
||||
|
||||
def parse_args(args: list, name: str):
|
||||
parser = argparse.ArgumentParser(prog=name)
|
||||
|
||||
group = parser.add_argument_group("Proxy settings")
|
||||
group.add_argument(
|
||||
"-L",
|
||||
"--linode-proxy",
|
||||
action="store_true",
|
||||
help="Give each worker a Linode SOCKS proxy. Assumes you have already "
|
||||
+ "setup the linode-cli with an API key and default settings. See "
|
||||
+ "https://www.linode.com/docs/guides/linode-cli/ "
|
||||
+ "for more information.",
|
||||
)
|
||||
group.add_argument(
|
||||
"-p",
|
||||
"--proxy-base-port",
|
||||
type=int,
|
||||
default=1337,
|
||||
help="Port number proxy ports are derived from, does nothing without "
|
||||
"enabling a type of proxy (like --linode-proxy).",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--resume-dump",
|
||||
action="store_true",
|
||||
help="Dump resume info_dict to JSON (for debugging).",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-n",
|
||||
"--n-workers",
|
||||
type=int,
|
||||
default=8,
|
||||
help="Number of parallel download workers",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-l",
|
||||
"--subtitle-langs",
|
||||
type=str,
|
||||
default="en",
|
||||
help="Comma-delimited list of subtitle languages to download; "
|
||||
+ 'pass "all" to download all auto captions. '
|
||||
+ 'Downloads "en" subtitles by default.',
|
||||
)
|
||||
parser.add_argument(
|
||||
"-T",
|
||||
"--all-thumbnails",
|
||||
action="store_true",
|
||||
help="Download all thumbnails instead of just the best one.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"playlist_json",
|
||||
type=argparse.FileType("r"),
|
||||
help="JSON-ified playlist file to download",
|
||||
)
|
||||
|
||||
return parser.parse_args(args=args)
|
||||
|
||||
|
||||
def main(args: [str], name: str) -> int:
|
||||
opts = parse_args(args=args, name=name)
|
||||
sub_langs = opts.subtitle_langs.split(",")
|
||||
n_workers = opts.n_workers
|
||||
|
||||
key_path = os.path.abspath("./proxy_key")
|
||||
pubkey_path = os.path.abspath(key_path + ".pub")
|
||||
if not (
|
||||
os.path.isfile(pubkey_path)
|
||||
or os.path.isfile(os.path.splitext(pubkey_path)[0])
|
||||
):
|
||||
print("[INFO]: Creating SSH key for Linode proxying...")
|
||||
print(runcmd('ssh-keygen -f "{}" -N ""'.format(key_path)).decode())
|
||||
|
||||
info_dict = j.loads(opts.playlist_json.read())
|
||||
opts.playlist_json.close()
|
||||
|
||||
print("[INFO]: Starting squid-dl...")
|
||||
|
||||
dirname = info_dict["title"]
|
||||
print('[INFO]: saving videos to "{}" directory'.format(dirname))
|
||||
if not (os.path.exists(dirname) and os.path.isdir(dirname)):
|
||||
os.mkdir(dirname)
|
||||
os.chdir(dirname)
|
||||
else:
|
||||
os.chdir(dirname)
|
||||
playlist_size = len(info_dict["entries"])
|
||||
|
||||
info_dict["entries"] = resume_preprocess(info_dict["entries"])
|
||||
if len(info_dict["entries"]) == 0:
|
||||
print("[WARN]: Nothing left to download, exiting...")
|
||||
return 1
|
||||
|
||||
print(
|
||||
"Resuming download of {}/{} videos...".format(
|
||||
len(info_dict["entries"]), playlist_size
|
||||
)
|
||||
)
|
||||
if opts.resume_dump:
|
||||
rdump = open("resume.json", mode="w")
|
||||
rdump.write(j.dumps(info_dict, sort_keys=True, indent=2))
|
||||
rdump.close()
|
||||
|
||||
n_entries = len(info_dict["entries"])
|
||||
n_workers = n_workers if n_workers < n_entries else n_entries
|
||||
entry_q = Queue(n_workers)
|
||||
entry_getter = Process(
|
||||
target=get_entries, args=(info_dict["entries"], entry_q)
|
||||
)
|
||||
entry_getter.start()
|
||||
|
||||
base_port = 1337
|
||||
workers = []
|
||||
proxies = []
|
||||
try:
|
||||
for n in range(n_workers):
|
||||
port = base_port + n
|
||||
|
||||
if opts.linode_proxy:
|
||||
proxies.append(
|
||||
LinodeProxy(proxy_port=port, pubkey_path=pubkey_path)
|
||||
)
|
||||
worker_args = (entry_q, opts, sub_langs, proxies[n])
|
||||
else:
|
||||
worker_args = (entry_q, opts, sub_langs)
|
||||
|
||||
workers.append(
|
||||
Process(
|
||||
target=do_download,
|
||||
args=worker_args,
|
||||
)
|
||||
)
|
||||
|
||||
if len(proxies) > 0:
|
||||
if not (
|
||||
os.path.isfile(pubkey_path)
|
||||
or os.path.isfile(os.path.splitext(pubkey_path)[0])
|
||||
):
|
||||
die(
|
||||
'[ERROR]: SSH key file "{}" does not exist!'.format(
|
||||
pubkey_path
|
||||
)
|
||||
)
|
||||
print("[INFO]: Waiting for Linodes to come online", end="")
|
||||
nodes_to_ping = list(range(n_workers))
|
||||
while len(nodes_to_ping) > 0:
|
||||
print(".", end="")
|
||||
temp_list = []
|
||||
for proxy_idx in nodes_to_ping:
|
||||
if proxies[proxy_idx].get_status() != "running":
|
||||
temp_list.append(proxy_idx)
|
||||
sleep(0.2)
|
||||
nodes_to_ping = temp_list
|
||||
print()
|
||||
|
||||
while not entry_q.full():
|
||||
sleep(0.2)
|
||||
|
||||
for i in range(n_workers):
|
||||
if len(proxies) > 0:
|
||||
proxies[i] = validate_proxy(proxies[i])
|
||||
seconds = randint(0, 1)
|
||||
else:
|
||||
seconds = randint(1, 6)
|
||||
workers[i].start()
|
||||
sleep(seconds)
|
||||
|
||||
while workers_alive(workers):
|
||||
sleep(0.2)
|
||||
|
||||
except KeyboardInterrupt:
|
||||
eprint("\n[CLEANUP]: Interrupted, cleaning up...")
|
||||
cleanup(workers, proxies)
|
||||
if entry_getter.is_alive():
|
||||
print(
|
||||
"[CLEANUP]: Terminating queue worker {}".format(
|
||||
entry_getter.pid
|
||||
)
|
||||
)
|
||||
entry_getter.terminate()
|
||||
return 1
|
||||
|
||||
print("[INFO]: All done!")
|
||||
cleanup(workers, proxies)
|
||||
|
||||
return 0
|
||||
220
squid_dl/linode.py
Normal file
220
squid_dl/linode.py
Normal file
|
|
@ -0,0 +1,220 @@
|
|||
"""
|
||||
You ever wanted to spawn n proxies?
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⡀⠠⠤⠀⣀⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⣀⢤⡒⠉⠁⠀⠒⢂⡀⠀⠀⠀⠈⠉⣒⠤⣀⠀⠀⠀⠀
|
||||
⠀⠀⣠⠾⠅⠈⠀⠙⠀⠀⠀⠈⠀⠀⢀⣀⣓⡀⠉⠀⠬⠕⢄⠀⠀
|
||||
⠀⣰⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡤⠶⢦⡀⠑⠀⠀⠀⠀⠈⢧⠀
|
||||
⠀⡇⠀⠀⠀⠀⠀⢤⣀⣀⣀⣀⡀⢀⣀⣀⠙⠀⠀⠀⠀⠀⠀⢸⡄
|
||||
⠀⢹⡀⠀⠀⠀⠀⡜⠁⠀⠀⠙⡴⠁⠀⠀⠱⡄⠀⠀⠀⠀⠀⣸⠀
|
||||
⠀⠀⠱⢄⡀⠀⢰⣁⣒⣒⣂⣰⣃⣀⣒⣒⣂⢣⠀⠀⠀⢀⡴⠁⠀
|
||||
⠀⠀⠀⠀⠙⠲⢼⡀⠀⠙⠀⢠⡇⠀⠛⠀⠀⣌⣀⡤⠖⠉⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⢸⡗⢄⣀⡠⠊⠈⢦⣀⣀⠔⡏⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠈⡇⠀⢰⠁⠀⠀⠀⢣⠀⠀⣷⠀⠀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⣠⠔⠊⠉⠁⡏⠀⠀⠀⠀⠘⡆⠤⠿⣄⣀⠀⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⣧⠸⠒⣚⡩⡇⠀⠀⠀⠀⠀⣏⣙⠒⢴⠈⡇⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠈⠋⠉⠀⠀⢳⡀⠀⠀⠀⣸⠁⠈⠉⠓⠚⠁⠀⠀⠀⠀
|
||||
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠓⠛⠛
|
||||
Well, here you go.
|
||||
"""
|
||||
|
||||
import json as j
|
||||
from os.path import splitext
|
||||
import socket
|
||||
import struct
|
||||
import subprocess
|
||||
from time import sleep
|
||||
import typing
|
||||
|
||||
from .util import eprint, runcmd
|
||||
|
||||
|
||||
class LinodeProxy:
|
||||
user_made = False
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
pubkey_path: str = "proxy_key.pub",
|
||||
proxy_port: int = 1337,
|
||||
proxy_user: str = "boing",
|
||||
debug: bool = False,
|
||||
exclusive: bool = True,
|
||||
):
|
||||
self.proxy_port = proxy_port
|
||||
self.proxy_user = proxy_user
|
||||
self.pubkey_path = pubkey_path
|
||||
self.debug = debug
|
||||
self.exclusive = exclusive
|
||||
|
||||
self.proxy_url = "socks5://127.0.0.1:" + str(self.proxy_port)
|
||||
|
||||
self.ssh_prefix = (
|
||||
'ssh -o "UserKnownHostsFile=/dev/null" '
|
||||
+ '-o "StrictHostKeyChecking=no" -i '
|
||||
+ splitext(self.pubkey_path)[0]
|
||||
+ " "
|
||||
)
|
||||
pubfile = open(self.pubkey_path, mode="r")
|
||||
self.pubkey = pubfile.readline().rstrip()
|
||||
pubfile.close()
|
||||
|
||||
self.passwd = runcmd(
|
||||
"echo $(cat /dev/random | strings | head -c 512 | "
|
||||
+ "grep -oE '[a-zA-Z0-9#%!]') | sed 's/\s//g' | head -c 32;"
|
||||
).decode()
|
||||
|
||||
create_cmd = (
|
||||
"linode-cli --json linodes create "
|
||||
+ "--image linode/arch "
|
||||
+ '--authorized_keys '
|
||||
+ '"'
|
||||
+ self.pubkey
|
||||
+ '"'
|
||||
+ ' --root_pass "'
|
||||
+ self.passwd
|
||||
+ '"'
|
||||
)
|
||||
self.info = j.loads(runcmd(create_cmd).decode())[0]
|
||||
print("[INFO]: Created Linode {}.".format(self.info["id"]))
|
||||
|
||||
def find_linode(self) -> bool:
|
||||
linodes = j.loads(runcmd("linode-cli --json linodes list").decode())
|
||||
|
||||
for linode in linodes:
|
||||
if linode["id"] == self.info["id"]:
|
||||
return True
|
||||
return False
|
||||
|
||||
def cleanup(self) -> None:
|
||||
if hasattr(self, "proxy_proc"):
|
||||
self.proxy_proc.terminate()
|
||||
|
||||
if hasattr(self, "info"):
|
||||
if self.find_linode():
|
||||
print(
|
||||
runcmd(
|
||||
"linode-cli --json linodes delete "
|
||||
+ str(self.info["id"])
|
||||
).decode(),
|
||||
end="",
|
||||
)
|
||||
print("[CLEANUP]: Deleted Linode {}.".format(self.info["id"]))
|
||||
delattr(self, "info")
|
||||
|
||||
def get_info(self) -> None:
|
||||
self.info = j.loads(
|
||||
runcmd(
|
||||
"linode-cli --json linodes view " + str(self.info["id"])
|
||||
).decode()
|
||||
)[0]
|
||||
|
||||
def get_status(self) -> str:
|
||||
self.get_info()
|
||||
return self.info["status"]
|
||||
|
||||
def setup_user(self) -> None:
|
||||
"""
|
||||
This will probably break on other distros that assign new accounts to
|
||||
the `users` primary group instead of one derived from their user name.
|
||||
(Patches welcome!)
|
||||
"""
|
||||
user_cmd = (
|
||||
"useradd -m "
|
||||
+ self.proxy_user
|
||||
+ "; "
|
||||
+ "mkdir /home/"
|
||||
+ self.proxy_user
|
||||
+ "/.ssh; "
|
||||
+ "touch /home/"
|
||||
+ self.proxy_user
|
||||
+ "/.ssh/authorized_keys; "
|
||||
+ "chown -R "
|
||||
+ self.proxy_user
|
||||
+ ":"
|
||||
+ self.proxy_user # change to "users" if using Red Hat/Fedora
|
||||
+ " /home/"
|
||||
+ self.proxy_user
|
||||
+ "/.ssh; "
|
||||
+ "chmod 700 /home/"
|
||||
+ self.proxy_user
|
||||
+ "/.ssh; "
|
||||
+ "chmod 600 /home/"
|
||||
+ self.proxy_user
|
||||
+ "/.ssh/authorized_keys; "
|
||||
+ "cat ~/.ssh/authorized_keys >> /home/"
|
||||
+ self.proxy_user
|
||||
+ "/.ssh/authorized_keys"
|
||||
)
|
||||
full_cmd = (
|
||||
self.ssh_prefix
|
||||
+ "root@"
|
||||
+ self.info["ipv4"][0]
|
||||
+ " '"
|
||||
+ user_cmd
|
||||
+ "'"
|
||||
)
|
||||
if self.debug:
|
||||
print(full_cmd)
|
||||
|
||||
print(runcmd(full_cmd).decode())
|
||||
self.user_made = True
|
||||
|
||||
def test_proxy(self) -> bool:
|
||||
sen = struct.pack("BBB", 0x05, 0x01, 0x00)
|
||||
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||
try:
|
||||
s.connect(("127.0.0.1", self.proxy_port))
|
||||
except ConnectionRefusedError as e:
|
||||
eprint(
|
||||
"[WARN]: Linode {} SOCKS proxy on {} got {}".format(
|
||||
self.info["id"], self.proxy_port, e
|
||||
)
|
||||
)
|
||||
return False
|
||||
s.sendall(sen)
|
||||
data = s.recv(2)
|
||||
|
||||
version, auth = struct.unpack("BB", data)
|
||||
if version == 5 and auth == 0:
|
||||
return True
|
||||
else:
|
||||
eprint("[WARN]: SOCKSv5 proxy anomaly!")
|
||||
return False
|
||||
|
||||
def start(self, headless: bool = True) -> bool:
|
||||
if not self.user_made:
|
||||
self.setup_user()
|
||||
|
||||
verbose_ssh = ""
|
||||
if self.debug:
|
||||
verbose_ssh = "-v "
|
||||
|
||||
proxy_cmd = (
|
||||
self.ssh_prefix
|
||||
+ "-D "
|
||||
+ str(self.proxy_port)
|
||||
+ " -NT "
|
||||
+ verbose_ssh
|
||||
+ self.proxy_user
|
||||
+ "@"
|
||||
+ self.info["ipv4"][0]
|
||||
)
|
||||
if self.debug:
|
||||
print(proxy_cmd)
|
||||
|
||||
print(
|
||||
"[INFO]: Starting proxy on port {} with Linode {}".format(
|
||||
self.proxy_port, self.info["id"]
|
||||
)
|
||||
)
|
||||
if headless is True:
|
||||
self.proxy_proc = subprocess.Popen(proxy_cmd, shell=True)
|
||||
else:
|
||||
self.proxy_proc = subprocess.Popen(
|
||||
proxy_cmd,
|
||||
shell=True,
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.PIPE,
|
||||
)
|
||||
sleep(2)
|
||||
|
||||
return self.test_proxy()
|
||||
42
squid_dl/util.py
Normal file
42
squid_dl/util.py
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
#!/usr/bin/env python3
|
||||
import subprocess
|
||||
from sys import stderr as STDERR
|
||||
import typing
|
||||
|
||||
|
||||
def eprint(errmsg):
|
||||
print(errmsg, file=STDERR)
|
||||
|
||||
|
||||
def die(errmsg, stat: int = 1):
|
||||
"""Prints message and exits Python with a status of stat."""
|
||||
eprint(errmsg)
|
||||
exit(stat)
|
||||
|
||||
|
||||
def runcmd(args):
|
||||
"""
|
||||
Run a given program/shell command and return its output.
|
||||
|
||||
Error Handling
|
||||
==============
|
||||
If the spawned proccess returns a nonzero exit status, it will print the
|
||||
program's ``STDERR`` to the running Python iterpreter's ``STDERR``.
|
||||
"""
|
||||
proc = subprocess.Popen(
|
||||
args,
|
||||
shell=True,
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.PIPE,
|
||||
)
|
||||
|
||||
try:
|
||||
if proc.wait() == 1:
|
||||
print(proc.stdout.read().decode())
|
||||
eprint(proc.stderr.read().decode())
|
||||
|
||||
return proc.stdout.read()
|
||||
except KeyboardInterrupt:
|
||||
proc.terminate()
|
||||
return b""
|
||||
|
||||
31
tests/linode-test.py
Normal file
31
tests/linode-test.py
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
#!/usr/bin/env python3
|
||||
from squid_dl.linode import LinodeProxy
|
||||
from squid_dl.util import die, eprint
|
||||
from time import sleep
|
||||
|
||||
|
||||
def main():
|
||||
"""
|
||||
A simple LinodeProxy class example. This should work once you have setup
|
||||
linode-cli. Only tested with Linode CLI settings that select Arch Linux
|
||||
image by default. YMMV with other distro images.
|
||||
"""
|
||||
proxy = LinodeProxy(debug=True)
|
||||
while proxy.get_status() != "running":
|
||||
sleep(1)
|
||||
|
||||
if not proxy.start(headless=False):
|
||||
proxy.cleanup()
|
||||
print(proxy.proxy_proc.stdout.read().decode())
|
||||
eprint(proxy.proxy_proc.stderr.read().decode())
|
||||
die("BAD PROXY!")
|
||||
|
||||
sleep(10)
|
||||
# proxy.cleanup()
|
||||
proxy.proxy_proc.terminate()
|
||||
print(proxy.proxy_proc.stdout.read().decode())
|
||||
eprint(proxy.proxy_proc.stderr.read().decode())
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue