Initial commit
This commit is contained in:
commit
7e7af01370
4
.gitignore
vendored
Normal file
4
.gitignore
vendored
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
__pycache__/
|
||||||
|
src/__pycache__/
|
||||||
|
logs/
|
||||||
|
*.json
|
674
LICENSE
Normal file
674
LICENSE
Normal file
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 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 General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<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 General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
171
README.md
Normal file
171
README.md
Normal file
|
@ -0,0 +1,171 @@
|
||||||
|
# Bulk Downloader for Reddit
|
||||||
|
This program downloads imgur, gfycat and direct image and video links of saved posts from a reddit account. It is written in Python 3.
|
||||||
|
|
||||||
|
**PLEASE** post any issue you had with the script to [Issues](https://github.com/aliparlakci/bulk-downloader-for-reddit/issues) tab. Since I don't have any testers or contributers I need your feedback.
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Requirements](#requirements)
|
||||||
|
- [Configuring the APIs](#configuring-the-apis)
|
||||||
|
- [Creating an imgur app](#creating-an-imgur-app)
|
||||||
|
- [Program Modes](#program-modes)
|
||||||
|
- [saved mode](#saved-mode)
|
||||||
|
- [submitted mode](#submitted-mode)
|
||||||
|
- [upvoted mode](#upvoted-mode)
|
||||||
|
- [subreddit mode](#subreddit-mode)
|
||||||
|
- [multireddit mode](#multireddit-mode)
|
||||||
|
- [link mode](#link-mode)
|
||||||
|
- [log read mode](#log-read-mode)
|
||||||
|
- [Running the script](#running-the-script)
|
||||||
|
- [Using the command line arguments](#using-the-command-line-arguments)
|
||||||
|
- [Examples](#examples)
|
||||||
|
- [FAQ](#faq)
|
||||||
|
- [Changelog](#changelog)
|
||||||
|
- [release-1.0.0](#release-100)
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
- Python 3.x*
|
||||||
|
|
||||||
|
You can install Python 3 here: [https://www.python.org/downloads/](https://www.python.org/downloads/)
|
||||||
|
|
||||||
|
You have to check "**Add Python 3 to PATH**" option when installing in order it to run correctly.
|
||||||
|
|
||||||
|
*\*Although the latest version of python is suggested, you can use 3.6.5 since it runs perfectly on that version*
|
||||||
|
|
||||||
|
## Configuring the APIs
|
||||||
|
Because this is not a commercial app, you need to create an imgur developer app in order API to work.
|
||||||
|
|
||||||
|
### Creating an imgur app
|
||||||
|
* Go to https://api.imgur.com/oauth2/addclient
|
||||||
|
* Enter a name into the **Application Name** field.
|
||||||
|
* Pick **Anonymous usage without user authorization** as an **Authorization type**\*
|
||||||
|
* Enter your email into the Email field.
|
||||||
|
* Correct CHAPTCHA
|
||||||
|
* Click **submit** button
|
||||||
|
|
||||||
|
It should redirect to a page which shows your **imgur_client_id** and **imgur_client_secret**
|
||||||
|
|
||||||
|
\*Select **OAuth 2 authorization without a callback URL** first then select **Anonymous usage without user authorization** if it says *Authorization callback URL: required*
|
||||||
|
|
||||||
|
## Program Modes
|
||||||
|
All the program modes are activated with command-line arguments as shown [here](#using-the-command-line-arguments)
|
||||||
|
### saved mode
|
||||||
|
In saved mode, the program gets posts from given user's saved posts.
|
||||||
|
### submitted mode
|
||||||
|
In submitted mode, the program gets posts from given user's submitted posts.
|
||||||
|
### upvoted mode
|
||||||
|
In submitted mode, the program gets posts from given user's upvoted posts.
|
||||||
|
### subreddit mode
|
||||||
|
In subreddit mode, the program gets posts from given subreddits* that is sorted by given type and limited by given number.
|
||||||
|
|
||||||
|
Multiple subreddits can be given
|
||||||
|
|
||||||
|
*You may also use search in this mode. See [`py -3 script.py --help`](#using-the-command-line-arguments).*
|
||||||
|
### multireddit mode
|
||||||
|
In multireddit mode, the program gets posts from given user's given multireddit that is sorted by given type and limited by given number.
|
||||||
|
### link mode
|
||||||
|
In link mode, the program gets posts from given reddit link.
|
||||||
|
|
||||||
|
You may customize the behaviour with `--sort`, `--time`, `--limit`.
|
||||||
|
|
||||||
|
*You may also use search in this mode. See [`py -3 script.py --help`](#using-the-command-line-arguments).*
|
||||||
|
|
||||||
|
## log read mode
|
||||||
|
Two log files are created each time *script.py* runs.
|
||||||
|
- **POSTS** Saves all the posts without filtering.
|
||||||
|
- **FAILED** Keeps track of posts that are tried to be downloaded but failed.
|
||||||
|
|
||||||
|
In log mode, the program takes a log file which created by itself, reads posts and tries downloading them again.
|
||||||
|
|
||||||
|
Running log read mode for FAILED.json file once after the download is complete is **HIGHLY** recommended as unexpected problems may occur.
|
||||||
|
|
||||||
|
## Running the script
|
||||||
|
**WARNING** *DO NOT* let more than *1* instance of script run as it interferes with IMGUR Request Rate.
|
||||||
|
|
||||||
|
### Using the command line arguments
|
||||||
|
If no arguments are passed program will prompt you for arguments below which means you may start up the script with double-clicking on it (at least on Windows for sure).
|
||||||
|
|
||||||
|
Open up the [terminal](https://www.reddit.com/r/NSFW411/comments/8vtnl8/meta_i_made_reddit_downloader_that_can_download/e1rnbnl) and navigate to where script.py is. If you are unfamiliar with changing directories in terminal see Change Directories in [this article](https://lifehacker.com/5633909/who-needs-a-mouse-learn-to-use-the-command-line-for-almost-anything).
|
||||||
|
|
||||||
|
Run the script.py file from terminal with command-line arguments. Here is the help page:
|
||||||
|
|
||||||
|
**ATTENTION** Use `.\` for current directory and `..\` for upper directory when using short directories, otherwise it might act weird.
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ py -3 script.py --help
|
||||||
|
usage: script.py [-h] [--link link] [--saved] [--submitted] [--upvoted]
|
||||||
|
[--log LOG FILE] [--subreddit SUBREDDIT [SUBREDDIT ...]]
|
||||||
|
[--multireddit MULTIREDDIT] [--user redditor]
|
||||||
|
[--search query] [--sort SORT TYPE] [--limit Limit]
|
||||||
|
[--time TIME_LIMIT] [--NoDownload]
|
||||||
|
DIRECTORY
|
||||||
|
|
||||||
|
This program downloads media from reddit posts
|
||||||
|
|
||||||
|
positional arguments:
|
||||||
|
DIRECTORY Specifies the directory where posts will be downloaded
|
||||||
|
to
|
||||||
|
|
||||||
|
optional arguments:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
--link link, -l link Get posts from link
|
||||||
|
--saved Triggers saved mode
|
||||||
|
--submitted Gets posts of --user
|
||||||
|
--upvoted Gets upvoted posts of --user
|
||||||
|
--log LOG FILE Triggers log read mode and takes a log file
|
||||||
|
--subreddit SUBREDDIT [SUBREDDIT ...]
|
||||||
|
Triggers subreddit mode and takes subreddit's name
|
||||||
|
without r/. use "frontpage" for frontpage
|
||||||
|
--multireddit MULTIREDDIT
|
||||||
|
Triggers multireddit mode and takes multireddit's name
|
||||||
|
without m/
|
||||||
|
--user redditor reddit username if needed. use "me" for current user
|
||||||
|
--search query Searches for given query in given subreddits
|
||||||
|
--sort SORT TYPE Either hot, top, new, controversial, rising or
|
||||||
|
relevance default: hot
|
||||||
|
--limit Limit default: unlimited
|
||||||
|
--time TIME_LIMIT Either hour, day, week, month, year or all. default:
|
||||||
|
all
|
||||||
|
--NoDownload Just gets the posts and store them in a file for
|
||||||
|
downloading later
|
||||||
|
```
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
#### Don't include `py -3 script.py` part if you start the script by double-clicking
|
||||||
|
|
||||||
|
```console
|
||||||
|
py -3 script.py .\\NEW_FOLDER --sort new --time all --limit 10 --link "https://www.reddit.com/r/gifs/search?q=dogs&restrict_sr=on&type=link&sort=new&t=month"
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
py -3 script.py .\\NEW_FOLDER --link "https://www.reddit.com/r/learnprogramming/comments/7mjw12/"
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
py -3 script.py .\\NEW_FOLDER --search cats --sort new --time all --subreddit gifs pics --NoDownload
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
py -3 script.py .\\NEW_FOLDER --user [USER_NAME] --submitted --limit 10
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
py -3 script.py .\\NEW_FOLDER --multireddit good_subs --user [USER_NAME] --sort top --time week --limit 250
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
py -3 script.py .\\NEW_FOLDER\\ANOTHER_FOLDER --saved --limit 1000
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
py -3 script.py C:\\NEW_FOLDER\\ANOTHER_FOLDER --log UNNAMED_FOLDER\\FAILED.json
|
||||||
|
```
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
### I can't startup the script no matter what.
|
||||||
|
- Try `python3` or `python` or `py -3` as python have real issues about naming their program
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
### v1.0.0
|
||||||
|
- Initial release
|
5
_config.yml
Normal file
5
_config.yml
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
theme: jekyll-theme-minimal
|
||||||
|
show_downloads: false
|
||||||
|
#title: Bulk Downloader for Reddit
|
||||||
|
description: Code written by Ali PARLAKCI
|
||||||
|
google_analytics: UA-80780721-3
|
533
script.py
Normal file
533
script.py
Normal file
|
@ -0,0 +1,533 @@
|
||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
"""
|
||||||
|
This program downloads imgur, gfycat and direct image and video links of
|
||||||
|
saved posts from a reddit account. It is written in Python 3.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
from pathlib import Path, PurePath
|
||||||
|
|
||||||
|
from src.downloader import Direct, Gfycat, Imgur
|
||||||
|
from src.parser import LinkDesigner
|
||||||
|
from src.searcher import getPosts
|
||||||
|
from src.tools import (GLOBAL, createLogFile, jsonFile, nameCorrector,
|
||||||
|
printToFile)
|
||||||
|
from src.errors import *
|
||||||
|
|
||||||
|
__author__ = "Ali Parlakci"
|
||||||
|
__license__ = "GPL"
|
||||||
|
__version__ = "1.0.0"
|
||||||
|
__maintainer__ = "Ali Parlakci"
|
||||||
|
__email__ = "parlakciali@gmail.com"
|
||||||
|
|
||||||
|
def debug(*post):
|
||||||
|
GLOBAL.config = getConfig('config.json')
|
||||||
|
GLOBAL.directory = Path(".\\debug\\")
|
||||||
|
download([*post])
|
||||||
|
quit()
|
||||||
|
|
||||||
|
def getConfig(configFileName):
|
||||||
|
"""Read credentials from config.json file"""
|
||||||
|
|
||||||
|
keys = ['imgur_client_id',
|
||||||
|
'imgur_client_secret']
|
||||||
|
|
||||||
|
if os.path.exists(configFileName):
|
||||||
|
FILE = jsonFile(configFileName)
|
||||||
|
content = FILE.read()
|
||||||
|
if "reddit_refresh_token" in content:
|
||||||
|
if content["reddit_refresh_token"] == "":
|
||||||
|
FILE.delete("reddit_refresh_token")
|
||||||
|
for key in keys:
|
||||||
|
try:
|
||||||
|
if content[key] == "":
|
||||||
|
raise KeyError
|
||||||
|
except KeyError:
|
||||||
|
print(key,": ")
|
||||||
|
FILE.add({key:input()})
|
||||||
|
return jsonFile(configFileName).read()
|
||||||
|
|
||||||
|
else:
|
||||||
|
FILE = jsonFile(configFileName)
|
||||||
|
configDictionary = {}
|
||||||
|
for key in keys:
|
||||||
|
configDictionary[key] = input(key + ": ")
|
||||||
|
FILE.add(configDictionary)
|
||||||
|
return FILE.read()
|
||||||
|
|
||||||
|
def parseArguments(arguments=[]):
|
||||||
|
"""Initialize argparse and add arguments"""
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser(allow_abbrev=False,
|
||||||
|
description="This program downloads " \
|
||||||
|
"media from reddit " \
|
||||||
|
"posts")
|
||||||
|
parser.add_argument("directory",
|
||||||
|
help="Specifies the directory where posts will be " \
|
||||||
|
"downloaded to",
|
||||||
|
metavar="DIRECTORY")
|
||||||
|
|
||||||
|
parser.add_argument("--link","-l",
|
||||||
|
help="Get posts from link",
|
||||||
|
metavar="link")
|
||||||
|
|
||||||
|
parser.add_argument("--saved",
|
||||||
|
action="store_true",
|
||||||
|
help="Triggers saved mode")
|
||||||
|
|
||||||
|
parser.add_argument("--submitted",
|
||||||
|
action="store_true",
|
||||||
|
help="Gets posts of --user")
|
||||||
|
|
||||||
|
parser.add_argument("--upvoted",
|
||||||
|
action="store_true",
|
||||||
|
help="Gets upvoted posts of --user")
|
||||||
|
|
||||||
|
parser.add_argument("--log",
|
||||||
|
help="Triggers log read mode and takes a log file",
|
||||||
|
# type=argparse.FileType('r'),
|
||||||
|
metavar="LOG FILE")
|
||||||
|
|
||||||
|
parser.add_argument("--subreddit",
|
||||||
|
nargs="+",
|
||||||
|
help="Triggers subreddit mode and takes subreddit's " \
|
||||||
|
"name without r/. use \"frontpage\" for frontpage",
|
||||||
|
metavar="SUBREDDIT",
|
||||||
|
type=str)
|
||||||
|
|
||||||
|
parser.add_argument("--multireddit",
|
||||||
|
help="Triggers multireddit mode and takes "\
|
||||||
|
"multireddit's name without m/",
|
||||||
|
metavar="MULTIREDDIT",
|
||||||
|
type=str)
|
||||||
|
|
||||||
|
parser.add_argument("--user",
|
||||||
|
help="reddit username if needed. use \"me\" for " \
|
||||||
|
"current user",
|
||||||
|
required="--multireddit" in sys.argv or \
|
||||||
|
"--submitted" in sys.argv,
|
||||||
|
metavar="redditor",
|
||||||
|
type=str)
|
||||||
|
|
||||||
|
parser.add_argument("--search",
|
||||||
|
help="Searches for given query in given subreddits",
|
||||||
|
metavar="query",
|
||||||
|
type=str)
|
||||||
|
|
||||||
|
parser.add_argument("--sort",
|
||||||
|
help="Either hot, top, new, controversial, rising " \
|
||||||
|
"or relevance default: hot",
|
||||||
|
choices=[
|
||||||
|
"hot","top","new","controversial","rising",
|
||||||
|
"relevance"
|
||||||
|
],
|
||||||
|
metavar="SORT TYPE",
|
||||||
|
type=str)
|
||||||
|
|
||||||
|
parser.add_argument("--limit",
|
||||||
|
help="default: unlimited",
|
||||||
|
metavar="Limit",
|
||||||
|
default=None,
|
||||||
|
type=int)
|
||||||
|
|
||||||
|
parser.add_argument("--time",
|
||||||
|
help="Either hour, day, week, month, year or all." \
|
||||||
|
" default: all",
|
||||||
|
choices=["all","hour","day","week","month","year"],
|
||||||
|
metavar="TIME_LIMIT",
|
||||||
|
type=str)
|
||||||
|
|
||||||
|
parser.add_argument("--NoDownload",
|
||||||
|
help="Just gets the posts and store them in a file" \
|
||||||
|
" for downloading later",
|
||||||
|
action="store_true",
|
||||||
|
default=False)
|
||||||
|
|
||||||
|
if arguments == []:
|
||||||
|
return parser.parse_args()
|
||||||
|
else:
|
||||||
|
return parser.parse_args(arguments)
|
||||||
|
|
||||||
|
def checkConflicts():
|
||||||
|
"""Check if command-line arguments are given correcly,
|
||||||
|
if not, raise errors
|
||||||
|
"""
|
||||||
|
|
||||||
|
if GLOBAL.arguments.saved is False:
|
||||||
|
saved = 0
|
||||||
|
else:
|
||||||
|
saved = 1
|
||||||
|
|
||||||
|
if GLOBAL.arguments.subreddit is None:
|
||||||
|
subreddit = 0
|
||||||
|
else:
|
||||||
|
subreddit = 1
|
||||||
|
|
||||||
|
if GLOBAL.arguments.submitted is False:
|
||||||
|
submitted = 0
|
||||||
|
else:
|
||||||
|
submitted = 1
|
||||||
|
|
||||||
|
if GLOBAL.arguments.search is None:
|
||||||
|
search = 0
|
||||||
|
else:
|
||||||
|
search = 1
|
||||||
|
|
||||||
|
if GLOBAL.arguments.log is None:
|
||||||
|
log = 0
|
||||||
|
else:
|
||||||
|
log = 1
|
||||||
|
|
||||||
|
if GLOBAL.arguments.link is None:
|
||||||
|
link = 0
|
||||||
|
else:
|
||||||
|
link = 1
|
||||||
|
|
||||||
|
if GLOBAL.arguments.user is None:
|
||||||
|
user = 0
|
||||||
|
else:
|
||||||
|
user = 1
|
||||||
|
|
||||||
|
if GLOBAL.arguments.upvoted is False:
|
||||||
|
upvoted = 0
|
||||||
|
else:
|
||||||
|
upvoted = 1
|
||||||
|
|
||||||
|
if not saved+subreddit+log+link+submitted+upvoted == 1:
|
||||||
|
print("Program mode is invalid")
|
||||||
|
quit()
|
||||||
|
|
||||||
|
if search+subreddit == 2:
|
||||||
|
print("You cannot search in your saved posts")
|
||||||
|
quit()
|
||||||
|
|
||||||
|
if search+submitted == 2:
|
||||||
|
print("You cannot search in submitted posts")
|
||||||
|
quit()
|
||||||
|
|
||||||
|
if search+upvoted == 2:
|
||||||
|
print("You cannot search in upvoted posts")
|
||||||
|
quit()
|
||||||
|
|
||||||
|
if upvoted+subreddit == 1 and user == 0:
|
||||||
|
print("No redditor name given")
|
||||||
|
quit()
|
||||||
|
|
||||||
|
def postFromLog(fileName):
|
||||||
|
"""Analyze a log file and return a list of dictionaries containing
|
||||||
|
submissions
|
||||||
|
"""
|
||||||
|
if Path.is_file(Path(fileName)):
|
||||||
|
content = jsonFile(fileName).read()
|
||||||
|
else:
|
||||||
|
print("File not found")
|
||||||
|
quit()
|
||||||
|
|
||||||
|
try:
|
||||||
|
del content["HEADER"]
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
posts = []
|
||||||
|
|
||||||
|
for post in content:
|
||||||
|
if not content[post][-1]['postType'] == None:
|
||||||
|
posts.append(content[post][-1])
|
||||||
|
|
||||||
|
return posts
|
||||||
|
|
||||||
|
def prepareAttributes():
|
||||||
|
ATTRIBUTES = {}
|
||||||
|
|
||||||
|
if GLOBAL.arguments.user is not None:
|
||||||
|
ATTRIBUTES["user"] = GLOBAL.arguments.user
|
||||||
|
|
||||||
|
if GLOBAL.arguments.search is not None:
|
||||||
|
ATTRIBUTES["search"] = GLOBAL.arguments.search
|
||||||
|
if GLOBAL.arguments.sort == "hot" or \
|
||||||
|
GLOBAL.arguments.sort == "controversial" or \
|
||||||
|
GLOBAL.arguments.sort == "rising":
|
||||||
|
GLOBAL.arguments.sort = "relevance"
|
||||||
|
|
||||||
|
if GLOBAL.arguments.sort is not None:
|
||||||
|
ATTRIBUTES["sort"] = GLOBAL.arguments.sort
|
||||||
|
else:
|
||||||
|
if GLOBAL.arguments.submitted:
|
||||||
|
ATTRIBUTES["sort"] = "new"
|
||||||
|
else:
|
||||||
|
ATTRIBUTES["sort"] = "hot"
|
||||||
|
|
||||||
|
if GLOBAL.arguments.time is not None:
|
||||||
|
ATTRIBUTES["time"] = GLOBAL.arguments.time
|
||||||
|
else:
|
||||||
|
ATTRIBUTES["time"] = "all"
|
||||||
|
|
||||||
|
if GLOBAL.arguments.link is not None:
|
||||||
|
|
||||||
|
GLOBAL.arguments.link = GLOBAL.arguments.link.strip("\"")
|
||||||
|
|
||||||
|
try:
|
||||||
|
ATTRIBUTES = LinkDesigner(GLOBAL.arguments.link)
|
||||||
|
except InvalidRedditLink:
|
||||||
|
raise InvalidRedditLink
|
||||||
|
|
||||||
|
if GLOBAL.arguments.search is not None:
|
||||||
|
ATTRIBUTES["search"] = GLOBAL.arguments.search
|
||||||
|
|
||||||
|
if GLOBAL.arguments.sort is not None:
|
||||||
|
ATTRIBUTES["sort"] = GLOBAL.arguments.sort
|
||||||
|
|
||||||
|
if GLOBAL.arguments.time is not None:
|
||||||
|
ATTRIBUTES["time"] = GLOBAL.arguments.time
|
||||||
|
|
||||||
|
elif GLOBAL.arguments.subreddit is not None:
|
||||||
|
GLOBAL.arguments.subreddit = "+".join(GLOBAL.arguments.subreddit)
|
||||||
|
|
||||||
|
ATTRIBUTES["subreddit"] = GLOBAL.arguments.subreddit
|
||||||
|
|
||||||
|
elif GLOBAL.arguments.saved is True:
|
||||||
|
ATTRIBUTES["saved"] = True
|
||||||
|
|
||||||
|
elif GLOBAL.arguments.upvoted is True:
|
||||||
|
ATTRIBUTES["upvoted"] = True
|
||||||
|
|
||||||
|
elif GLOBAL.arguments.submitted is not None:
|
||||||
|
ATTRIBUTES["submitted"] = True
|
||||||
|
|
||||||
|
if GLOBAL.arguments.sort == "rising":
|
||||||
|
raise InvalidSortingType
|
||||||
|
|
||||||
|
ATTRIBUTES["limit"] = GLOBAL.arguments.limit
|
||||||
|
|
||||||
|
return ATTRIBUTES
|
||||||
|
|
||||||
|
def postExists(POST):
|
||||||
|
"""Figure out a file's name and checks if the file already exists"""
|
||||||
|
|
||||||
|
title = nameCorrector(POST['postTitle'])
|
||||||
|
FILENAME = title + "_" + POST['postId']
|
||||||
|
PATH = GLOBAL.directory / POST["postSubreddit"]
|
||||||
|
possibleExtensions = [".jpg",".png",".mp4",".gif",".webm"]
|
||||||
|
|
||||||
|
for i in range(2):
|
||||||
|
for extension in possibleExtensions:
|
||||||
|
FILE_PATH = PATH / (FILENAME+extension)
|
||||||
|
if FILE_PATH.exists():
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
FILENAME = POST['postId']
|
||||||
|
else:
|
||||||
|
return False
|
||||||
|
|
||||||
|
def download(submissions):
|
||||||
|
"""Analyze list of submissions and call the right function
|
||||||
|
to download each one, catch errors, update the log files
|
||||||
|
"""
|
||||||
|
|
||||||
|
subsLenght = len(submissions)
|
||||||
|
lastRequestTime = 0
|
||||||
|
downloadedCount = subsLenght
|
||||||
|
duplicates = 0
|
||||||
|
BACKUP = {}
|
||||||
|
|
||||||
|
FAILED_FILE = createLogFile("FAILED")
|
||||||
|
|
||||||
|
for i in range(subsLenght):
|
||||||
|
print("\n({}/{})".format(i+1,subsLenght))
|
||||||
|
print(
|
||||||
|
"https://reddit.com/r/{subreddit}/comments/{id}".format(
|
||||||
|
subreddit=submissions[i]['postSubreddit'],
|
||||||
|
id=submissions[i]['postId']
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
if postExists(submissions[i]):
|
||||||
|
result = False
|
||||||
|
print("It already exists")
|
||||||
|
duplicates += 1
|
||||||
|
downloadedCount -= 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
directory = GLOBAL.directory / submissions[i]['postSubreddit']
|
||||||
|
|
||||||
|
if submissions[i]['postType'] == 'imgur':
|
||||||
|
print("IMGUR",end="")
|
||||||
|
|
||||||
|
while int(time.time() - lastRequestTime) <= 2:
|
||||||
|
pass
|
||||||
|
credit = Imgur.get_credits()
|
||||||
|
|
||||||
|
IMGUR_RESET_TIME = credit['UserReset']-time.time()
|
||||||
|
USER_RESET = ("after " \
|
||||||
|
+ str(int(IMGUR_RESET_TIME/60)) \
|
||||||
|
+ " Minutes " \
|
||||||
|
+ str(int(IMGUR_RESET_TIME%60)) \
|
||||||
|
+ " Seconds")
|
||||||
|
print(
|
||||||
|
" => Client: {} - User: {} - Reset {}".format(
|
||||||
|
credit['ClientRemaining'],
|
||||||
|
credit['UserRemaining'],
|
||||||
|
USER_RESET
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
if not (credit['UserRemaining'] == 0 or \
|
||||||
|
credit['ClientRemaining'] == 0):
|
||||||
|
|
||||||
|
"""This block of code is needed
|
||||||
|
"""
|
||||||
|
while int(time.time() - lastRequestTime) <= 2:
|
||||||
|
pass
|
||||||
|
lastRequestTime = time.time()
|
||||||
|
|
||||||
|
try:
|
||||||
|
Imgur(directory,submissions[i])
|
||||||
|
|
||||||
|
except FileAlreadyExistsError:
|
||||||
|
print("It already exists")
|
||||||
|
duplicates += 1
|
||||||
|
downloadedCount -= 1
|
||||||
|
|
||||||
|
except ImgurLoginError:
|
||||||
|
print(
|
||||||
|
"Imgur login failed. Quitting the program "\
|
||||||
|
"as unexpected errors might occur."
|
||||||
|
)
|
||||||
|
quit()
|
||||||
|
|
||||||
|
except Exception as exception:
|
||||||
|
print(exception)
|
||||||
|
FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
|
||||||
|
downloadedCount -= 1
|
||||||
|
|
||||||
|
else:
|
||||||
|
if credit['UserRemaining'] == 0:
|
||||||
|
KEYWORD = "user"
|
||||||
|
elif credit['ClientRemaining'] == 0:
|
||||||
|
KEYWORD = "client"
|
||||||
|
|
||||||
|
print('{} LIMIT EXCEEDED\n'.format(KEYWORD.upper()))
|
||||||
|
FAILED_FILE.add(
|
||||||
|
{int(i+1):['{} LIMIT EXCEEDED\n'.format(KEYWORD.upper()),
|
||||||
|
submissions[i]]}
|
||||||
|
)
|
||||||
|
downloadedCount -= 1
|
||||||
|
|
||||||
|
elif submissions[i]['postType'] == 'gfycat':
|
||||||
|
print("GFYCAT")
|
||||||
|
try:
|
||||||
|
Gfycat(directory,submissions[i])
|
||||||
|
|
||||||
|
except FileAlreadyExistsError:
|
||||||
|
print("It already exists")
|
||||||
|
duplicates += 1
|
||||||
|
downloadedCount -= 1
|
||||||
|
|
||||||
|
except NotADownloadableLinkError as exception:
|
||||||
|
print("Could not read the page source")
|
||||||
|
FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
|
||||||
|
downloadedCount -= 1
|
||||||
|
|
||||||
|
except Exception as exception:
|
||||||
|
print(exception)
|
||||||
|
FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
|
||||||
|
downloadedCount -= 1
|
||||||
|
|
||||||
|
elif submissions[i]['postType'] == 'direct':
|
||||||
|
print("DIRECT")
|
||||||
|
try:
|
||||||
|
Direct(directory,submissions[i])
|
||||||
|
|
||||||
|
except FileAlreadyExistsError:
|
||||||
|
print("It already exists")
|
||||||
|
downloadedCount -= 1
|
||||||
|
duplicates += 1
|
||||||
|
|
||||||
|
except Exception as exception:
|
||||||
|
print(exception)
|
||||||
|
FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
|
||||||
|
downloadedCount -= 1
|
||||||
|
|
||||||
|
else:
|
||||||
|
print("No match found, skipping...")
|
||||||
|
downloadedCount -= 1
|
||||||
|
|
||||||
|
if duplicates:
|
||||||
|
print("\n There was {} duplicates".format(duplicates))
|
||||||
|
|
||||||
|
if downloadedCount == 0:
|
||||||
|
print(" Nothing downloaded :(")
|
||||||
|
|
||||||
|
else:
|
||||||
|
print(" Total of {} links downloaded!".format(downloadedCount))
|
||||||
|
|
||||||
|
def main():
|
||||||
|
if sys.argv[-1].endswith(__file__):
|
||||||
|
GLOBAL.arguments = parseArguments(input("> ").split())
|
||||||
|
else:
|
||||||
|
GLOBAL.arguments = parseArguments()
|
||||||
|
if GLOBAL.arguments.directory is not None:
|
||||||
|
GLOBAL.directory = Path(GLOBAL.arguments.directory)
|
||||||
|
else:
|
||||||
|
print("Invalid directory")
|
||||||
|
quit()
|
||||||
|
GLOBAL.config = getConfig(Path(PurePath(__file__).parent / 'config.json'))
|
||||||
|
|
||||||
|
checkConflicts()
|
||||||
|
|
||||||
|
mode = prepareAttributes()
|
||||||
|
|
||||||
|
print(sys.argv)
|
||||||
|
|
||||||
|
if GLOBAL.arguments.log is not None:
|
||||||
|
logDir = Path(GLOBAL.arguments.log)
|
||||||
|
download(postFromLog(logDir))
|
||||||
|
quit()
|
||||||
|
|
||||||
|
try:
|
||||||
|
POSTS = getPosts(prepareAttributes())
|
||||||
|
except InsufficientPermission:
|
||||||
|
print("You do not have permission to do that")
|
||||||
|
quit()
|
||||||
|
except NoMatchingSubmissionFound:
|
||||||
|
print("No matching submission was found")
|
||||||
|
quit()
|
||||||
|
except NoRedditSupoort:
|
||||||
|
print("Reddit does not support that")
|
||||||
|
quit()
|
||||||
|
except NoPrawSupport:
|
||||||
|
print("PRAW does not support that")
|
||||||
|
quit()
|
||||||
|
except MultiredditNotFound:
|
||||||
|
print("Multireddit not found")
|
||||||
|
quit()
|
||||||
|
except InvalidSortingType:
|
||||||
|
print("Invalid sorting type has given")
|
||||||
|
quit()
|
||||||
|
except InvalidRedditLink:
|
||||||
|
print("Invalid reddit link")
|
||||||
|
quit()
|
||||||
|
|
||||||
|
if POSTS is None:
|
||||||
|
print("I could not find any posts in that URL")
|
||||||
|
quit()
|
||||||
|
|
||||||
|
if GLOBAL.arguments.NoDownload:
|
||||||
|
quit()
|
||||||
|
|
||||||
|
else:
|
||||||
|
download(POSTS)
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
try:
|
||||||
|
VanillaPrint = print
|
||||||
|
print = printToFile
|
||||||
|
GLOBAL.RUN_TIME = time.time()
|
||||||
|
main()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
print("\nQUITTING...")
|
||||||
|
quit()
|
0
src/__init__.py
Normal file
0
src/__init__.py
Normal file
285
src/downloader.py
Normal file
285
src/downloader.py
Normal file
|
@ -0,0 +1,285 @@
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import urllib.request
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from src.errors import (AlbumNotDownloadedCompletely, FileAlreadyExistsError,
|
||||||
|
FileNameTooLong, ImgurLoginError,
|
||||||
|
NotADownloadableLinkError)
|
||||||
|
from src.tools import GLOBAL, nameCorrector, printToFile
|
||||||
|
|
||||||
|
try:
|
||||||
|
from imgurpython import *
|
||||||
|
except ModuleNotFoundError:
|
||||||
|
print("\nimgurpython not found on your computer, installing...\n")
|
||||||
|
from src.tools import install
|
||||||
|
install("imgurpython")
|
||||||
|
from imgurpython import *
|
||||||
|
|
||||||
|
|
||||||
|
print = printToFile
|
||||||
|
|
||||||
|
def dlProgress(count, blockSize, totalSize):
|
||||||
|
"""Function for writing download progress to console
|
||||||
|
"""
|
||||||
|
|
||||||
|
downloadedMbs = int(count*blockSize*(10**(-6)))
|
||||||
|
fileSize = int(totalSize*(10**(-6)))
|
||||||
|
sys.stdout.write("\r{}Mb/{}Mb".format(downloadedMbs,fileSize))
|
||||||
|
sys.stdout.write("\b"*len("\r{}Mb/{}Mb".format(downloadedMbs,fileSize)))
|
||||||
|
sys.stdout.flush()
|
||||||
|
|
||||||
|
def getExtension(link):
|
||||||
|
"""Extract file extension from image link.
|
||||||
|
If didn't find any, return '.jpg'
|
||||||
|
"""
|
||||||
|
|
||||||
|
imageTypes = ['jpg','png','mp4','webm','gif']
|
||||||
|
parsed = link.split('.')
|
||||||
|
for TYPE in imageTypes:
|
||||||
|
if TYPE in parsed:
|
||||||
|
return "."+parsed[-1]
|
||||||
|
else:
|
||||||
|
return '.jpg'
|
||||||
|
|
||||||
|
def getFile(fileDir,tempDir,imageURL,indent=0):
|
||||||
|
"""Downloads given file to given directory.
|
||||||
|
|
||||||
|
fileDir -- Full file directory
|
||||||
|
tempDir -- Full file directory with the extension of '.tmp'
|
||||||
|
imageURL -- URL to the file to be downloaded
|
||||||
|
|
||||||
|
redditID -- Post's reddit id if renaming the file is necessary.
|
||||||
|
As too long file names seem not working.
|
||||||
|
"""
|
||||||
|
|
||||||
|
if not (os.path.isfile(fileDir)):
|
||||||
|
for i in range(3):
|
||||||
|
try:
|
||||||
|
urllib.request.urlretrieve(imageURL,
|
||||||
|
tempDir,
|
||||||
|
reporthook=dlProgress)
|
||||||
|
os.rename(tempDir,fileDir)
|
||||||
|
print(" "*indent+"Downloaded"+" "*10)
|
||||||
|
break
|
||||||
|
except ConnectionResetError as exception:
|
||||||
|
print(" "*indent + str(exception))
|
||||||
|
print(" "*indent + "Trying again\n")
|
||||||
|
except FileNotFoundError:
|
||||||
|
raise FileNameTooLong
|
||||||
|
else:
|
||||||
|
raise FileAlreadyExistsError
|
||||||
|
|
||||||
|
class Imgur:
|
||||||
|
def __init__(self,directory,post):
|
||||||
|
self.imgurClient = self.initImgur()
|
||||||
|
|
||||||
|
imgurID = self.getId(post['postURL'])
|
||||||
|
content = self.getLink(imgurID)
|
||||||
|
|
||||||
|
if not os.path.exists(directory): os.makedirs(directory)
|
||||||
|
|
||||||
|
if content['type'] == 'image':
|
||||||
|
|
||||||
|
try:
|
||||||
|
post['mediaURL'] = content['object'].mp4
|
||||||
|
except AttributeError:
|
||||||
|
post['mediaURL'] = content['object'].link
|
||||||
|
|
||||||
|
post['postExt'] = getExtension(post['mediaURL'])
|
||||||
|
|
||||||
|
title = nameCorrector(post['postTitle'])
|
||||||
|
print(title+"_" +post['postId']+post['postExt'])
|
||||||
|
|
||||||
|
fileDir = title + "_" + post['postId'] + post['postExt']
|
||||||
|
fileDir = directory / fileDir
|
||||||
|
|
||||||
|
tempDir = title + "_" + post['postId'] + '.tmp'
|
||||||
|
tempDir = directory / tempDir
|
||||||
|
try:
|
||||||
|
getFile(fileDir,tempDir,post['mediaURL'])
|
||||||
|
except FileNameTooLong:
|
||||||
|
fileDir = directory / post['postId'] + post['postExt']
|
||||||
|
tempDir = directory / post['postId'] + '.tmp'
|
||||||
|
getFile(fileDir,tempDir,post['mediaURL'])
|
||||||
|
|
||||||
|
elif content['type'] == 'album':
|
||||||
|
exceptionType = ""
|
||||||
|
images = content['object'].images
|
||||||
|
imagesLenght = len(images)
|
||||||
|
howManyDownloaded = imagesLenght
|
||||||
|
duplicates = 0
|
||||||
|
|
||||||
|
title = nameCorrector(post['postTitle'])
|
||||||
|
print(title+"_"+post['postId'],end="\n\n")
|
||||||
|
|
||||||
|
folderDir = directory / (title+"_"+post['postId'])
|
||||||
|
|
||||||
|
try:
|
||||||
|
if not os.path.exists(folderDir):
|
||||||
|
os.makedirs(folderDir)
|
||||||
|
except FileNotFoundError:
|
||||||
|
folderDir = directory / post['postId']
|
||||||
|
os.makedirs(folderDir)
|
||||||
|
|
||||||
|
for i in range(imagesLenght):
|
||||||
|
try:
|
||||||
|
imageURL = images[i]['mp4']
|
||||||
|
except KeyError:
|
||||||
|
imageURL = images[i]['link']
|
||||||
|
|
||||||
|
images[i]['Ext'] = getExtension(imageURL)
|
||||||
|
|
||||||
|
fileName = (str(i+1)
|
||||||
|
+ "_"
|
||||||
|
+ nameCorrector(str(images[i]['title']))
|
||||||
|
+ "_"
|
||||||
|
+ images[i]['id'])
|
||||||
|
|
||||||
|
fileDir = folderDir / (fileName + images[i]['Ext'])
|
||||||
|
tempDir = folderDir / (fileName + ".tmp")
|
||||||
|
|
||||||
|
print(" ({}/{})".format(i+1,imagesLenght))
|
||||||
|
print(" {}".format(fileName+images[i]['Ext']))
|
||||||
|
|
||||||
|
try:
|
||||||
|
getFile(fileDir,tempDir,imageURL,indent=2)
|
||||||
|
print()
|
||||||
|
except FileAlreadyExistsError:
|
||||||
|
print(" The file already exists" + " "*10,end="\n\n")
|
||||||
|
duplicates += 1
|
||||||
|
howManyDownloaded -= 1
|
||||||
|
|
||||||
|
# IF FILE NAME IS TOO LONG, IT WONT REGISTER
|
||||||
|
except FileNameTooLong:
|
||||||
|
fileName = (str(i+1) + "_" + images[i]['id'])
|
||||||
|
fileDir = folderDir / (fileName + images[i]['Ext'])
|
||||||
|
tempDir = folderDir / (fileName + ".tmp")
|
||||||
|
try:
|
||||||
|
getFile(fileDir,tempDir,imageURL,indent=2)
|
||||||
|
# IF STILL TOO LONG
|
||||||
|
except FileNameTooLong:
|
||||||
|
fileName = str(i+1)
|
||||||
|
fileDir = folderDir / (fileName + images[i]['Ext'])
|
||||||
|
tempDir = folderDir / (fileName + ".tmp")
|
||||||
|
getFile(fileDir,tempDir,imageURL,indent=2)
|
||||||
|
|
||||||
|
except Exception as exception:
|
||||||
|
print("\n Could not get the file")
|
||||||
|
print(" " + str(exception) + "\n")
|
||||||
|
exceptionType = exception
|
||||||
|
howManyDownloaded -= 1
|
||||||
|
|
||||||
|
if duplicates == imagesLenght:
|
||||||
|
raise FileAlreadyExistsError
|
||||||
|
elif howManyDownloaded < imagesLenght:
|
||||||
|
raise AlbumNotDownloadedCompletely
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def initImgur():
|
||||||
|
"""Initialize imgur api"""
|
||||||
|
|
||||||
|
config = GLOBAL.config
|
||||||
|
return ImgurClient(
|
||||||
|
config['imgur_client_id'],
|
||||||
|
config['imgur_client_secret']
|
||||||
|
)
|
||||||
|
def getId(self,submissionURL):
|
||||||
|
"""Extract imgur post id
|
||||||
|
and determine if its a single image or album
|
||||||
|
"""
|
||||||
|
|
||||||
|
domainLenght = len("imgur.com/")
|
||||||
|
if submissionURL[-1] == "/":
|
||||||
|
submissionURL = submissionURL[:-1]
|
||||||
|
|
||||||
|
if "a/" in submissionURL or "gallery/" in submissionURL:
|
||||||
|
albumId = submissionURL.split("/")[-1]
|
||||||
|
return {'id':albumId, 'type':'album'}
|
||||||
|
|
||||||
|
else:
|
||||||
|
url = submissionURL.replace('.','/').split('/')
|
||||||
|
imageId = url[url.index('com')+1]
|
||||||
|
return {'id':imageId, 'type':'image'}
|
||||||
|
|
||||||
|
def getLink(self,identity):
|
||||||
|
"""Request imgur object from imgur api
|
||||||
|
"""
|
||||||
|
|
||||||
|
if identity['type'] == 'image':
|
||||||
|
return {'object':self.imgurClient.get_image(identity['id']),
|
||||||
|
'type':'image'}
|
||||||
|
elif identity['type'] == 'album':
|
||||||
|
return {'object':self.imgurClient.get_album(identity['id']),
|
||||||
|
'type':'album'}
|
||||||
|
|
||||||
|
def get_credits():
|
||||||
|
return Imgur.initImgur().get_credits()
|
||||||
|
|
||||||
|
class Gfycat:
|
||||||
|
def __init__(self,directory,POST):
|
||||||
|
try:
|
||||||
|
POST['mediaURL'] = self.getLink(POST['postURL'])
|
||||||
|
except IndexError:
|
||||||
|
raise NotADownloadableLinkError
|
||||||
|
except Exception as exception:
|
||||||
|
raise NotADownloadableLinkError
|
||||||
|
|
||||||
|
POST['postExt'] = getExtension(POST['mediaURL'])
|
||||||
|
|
||||||
|
if not os.path.exists(directory): os.makedirs(directory)
|
||||||
|
title = nameCorrector(POST['postTitle'])
|
||||||
|
print(title+"_"+POST['postId']+POST['postExt'])
|
||||||
|
|
||||||
|
fileDir = directory / (title+"_"+POST['postId']+POST['postExt'])
|
||||||
|
tempDir = directory / (title+"_"+POST['postId']+".tmp")
|
||||||
|
|
||||||
|
getFile(fileDir,tempDir,POST['mediaURL'])
|
||||||
|
|
||||||
|
def getLink(self, url, query='<source id="mp4Source" src=', lineNumber=105):
|
||||||
|
"""Extract direct link to the video from page's source
|
||||||
|
and return it
|
||||||
|
"""
|
||||||
|
|
||||||
|
if '.webm' in url or '.mp4' in url or '.gif' in url:
|
||||||
|
return url
|
||||||
|
|
||||||
|
if url[-1:] == '/':
|
||||||
|
url = url[:-1]
|
||||||
|
|
||||||
|
if 'gifs' in url:
|
||||||
|
url = "https://gfycat.com/" + url.split('/')[-1]
|
||||||
|
|
||||||
|
pageSource = (urllib.request.urlopen(url).read().decode().split('\n'))
|
||||||
|
|
||||||
|
theLine = pageSource[lineNumber]
|
||||||
|
lenght = len(query)
|
||||||
|
link = []
|
||||||
|
|
||||||
|
for i in range(len(theLine)):
|
||||||
|
if theLine[i:i+lenght] == query:
|
||||||
|
cursor = (i+lenght)+1
|
||||||
|
while not theLine[cursor] == '"':
|
||||||
|
link.append(theLine[cursor])
|
||||||
|
cursor += 1
|
||||||
|
break
|
||||||
|
|
||||||
|
if "".join(link) == "":
|
||||||
|
raise NotADownloadableLinkError
|
||||||
|
|
||||||
|
return "".join(link)
|
||||||
|
|
||||||
|
class Direct:
|
||||||
|
def __init__(self,directory,POST):
|
||||||
|
POST['postExt'] = getExtension(POST['postURL'])
|
||||||
|
if not os.path.exists(directory): os.makedirs(directory)
|
||||||
|
title = nameCorrector(POST['postTitle'])
|
||||||
|
print(title+"_"+POST['postId']+POST['postExt'])
|
||||||
|
|
||||||
|
fileDir = title+"_"+POST['postId']+POST['postExt']
|
||||||
|
fileDir = directory / fileDir
|
||||||
|
|
||||||
|
tempDir = title+"_"+POST['postId']+".tmp"
|
||||||
|
tempDir = directory / tempDir
|
||||||
|
|
||||||
|
getFile(fileDir,tempDir,POST['postURL'])
|
41
src/errors.py
Normal file
41
src/errors.py
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
class RedditLoginFailed(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class ImgurLoginError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class FileAlreadyExistsError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class NotADownloadableLinkError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class AlbumNotDownloadedCompletely(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class FileNameTooLong(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class InvalidRedditLink(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class NoMatchingSubmissionFound(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class NoPrawSupport(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class NoRedditSupoort(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class MultiredditNotFound(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class InsufficientPermission(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class InvalidSortingType(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
class FileNotFoundError(Exception):
|
||||||
|
pass
|
239
src/parser.py
Normal file
239
src/parser.py
Normal file
|
@ -0,0 +1,239 @@
|
||||||
|
from pprint import pprint
|
||||||
|
|
||||||
|
try:
|
||||||
|
from src.errors import InvalidRedditLink
|
||||||
|
except ModuleNotFoundError:
|
||||||
|
from errors import InvalidRedditLink
|
||||||
|
|
||||||
|
def QueryParser(PassedQueries,index):
|
||||||
|
ExtractedQueries = {}
|
||||||
|
|
||||||
|
QuestionMarkIndex = PassedQueries.index("?")
|
||||||
|
Header = PassedQueries[:QuestionMarkIndex]
|
||||||
|
ExtractedQueries["HEADER"] = Header
|
||||||
|
Queries = PassedQueries[QuestionMarkIndex+1:]
|
||||||
|
|
||||||
|
ParsedQueries = Queries.split("&")
|
||||||
|
|
||||||
|
for Query in ParsedQueries:
|
||||||
|
Query = Query.split("=")
|
||||||
|
ExtractedQueries[Query[0]] = Query[1]
|
||||||
|
|
||||||
|
if ExtractedQueries["HEADER"] == "search":
|
||||||
|
ExtractedQueries["q"] = ExtractedQueries["q"].replace("%20"," ")
|
||||||
|
|
||||||
|
return ExtractedQueries
|
||||||
|
|
||||||
|
def LinkParser(LINK):
|
||||||
|
RESULT = {}
|
||||||
|
ShortLink = False
|
||||||
|
|
||||||
|
if not "reddit.com" in LINK:
|
||||||
|
raise InvalidRedditLink
|
||||||
|
|
||||||
|
SplittedLink = LINK.split("/")
|
||||||
|
|
||||||
|
if SplittedLink[0] == "https:" or SplittedLink[0] == "http:":
|
||||||
|
SplittedLink = SplittedLink[2:]
|
||||||
|
|
||||||
|
try:
|
||||||
|
if (SplittedLink[-2].endswith("reddit.com") and \
|
||||||
|
SplittedLink[-1] == "") or \
|
||||||
|
SplittedLink[-1].endswith("reddit.com"):
|
||||||
|
|
||||||
|
RESULT["sort"] = "best"
|
||||||
|
return RESULT
|
||||||
|
except IndexError:
|
||||||
|
if SplittedLink[0].endswith("reddit.com"):
|
||||||
|
RESULT["sort"] = "best"
|
||||||
|
return RESULT
|
||||||
|
|
||||||
|
if "redd.it" in SplittedLink:
|
||||||
|
ShortLink = True
|
||||||
|
|
||||||
|
if SplittedLink[0].endswith("reddit.com"):
|
||||||
|
SplittedLink = SplittedLink[1:]
|
||||||
|
|
||||||
|
if "comments" in SplittedLink:
|
||||||
|
RESULT = {"post":LINK}
|
||||||
|
return RESULT
|
||||||
|
|
||||||
|
elif "me" in SplittedLink or \
|
||||||
|
"u" in SplittedLink or \
|
||||||
|
"user" in SplittedLink or \
|
||||||
|
"r" in SplittedLink or \
|
||||||
|
"m" in SplittedLink:
|
||||||
|
|
||||||
|
if "r" in SplittedLink:
|
||||||
|
RESULT["subreddit"] = SplittedLink[SplittedLink.index("r") + 1]
|
||||||
|
|
||||||
|
elif "m" in SplittedLink:
|
||||||
|
RESULT["multireddit"] = SplittedLink[SplittedLink.index("m") + 1]
|
||||||
|
RESULT["user"] = SplittedLink[SplittedLink.index("m") - 1]
|
||||||
|
|
||||||
|
else:
|
||||||
|
for index in range(len(SplittedLink)):
|
||||||
|
if SplittedLink[index] == "u" or \
|
||||||
|
SplittedLink[index] == "user":
|
||||||
|
|
||||||
|
RESULT["user"] = SplittedLink[index+1]
|
||||||
|
|
||||||
|
elif SplittedLink[index] == "me":
|
||||||
|
RESULT["user"] = "me"
|
||||||
|
|
||||||
|
|
||||||
|
for index in range(len(SplittedLink)):
|
||||||
|
if SplittedLink[index] in [
|
||||||
|
"hot","top","new","controversial","rising"
|
||||||
|
]:
|
||||||
|
|
||||||
|
RESULT["sort"] = SplittedLink[index]
|
||||||
|
|
||||||
|
if index == 0:
|
||||||
|
RESULT["subreddit"] = "frontpage"
|
||||||
|
|
||||||
|
elif SplittedLink[index] in ["submitted","saved","posts","upvoted"]:
|
||||||
|
if SplittedLink[index] == "submitted" or \
|
||||||
|
SplittedLink[index] == "posts":
|
||||||
|
RESULT["submitted"] = {}
|
||||||
|
|
||||||
|
elif SplittedLink[index] == "saved":
|
||||||
|
RESULT["saved"] = True
|
||||||
|
|
||||||
|
elif SplittedLink[index] == "upvoted":
|
||||||
|
RESULT["upvoted"] = True
|
||||||
|
|
||||||
|
elif "?" in SplittedLink[index]:
|
||||||
|
ParsedQuery = QueryParser(SplittedLink[index],index)
|
||||||
|
if ParsedQuery["HEADER"] == "search":
|
||||||
|
del ParsedQuery["HEADER"]
|
||||||
|
RESULT["search"] = ParsedQuery
|
||||||
|
|
||||||
|
elif ParsedQuery["HEADER"] == "submitted" or \
|
||||||
|
ParsedQuery["HEADER"] == "posts":
|
||||||
|
del ParsedQuery["HEADER"]
|
||||||
|
RESULT["submitted"] = ParsedQuery
|
||||||
|
|
||||||
|
else:
|
||||||
|
del ParsedQuery["HEADER"]
|
||||||
|
RESULT["queries"] = ParsedQuery
|
||||||
|
|
||||||
|
if not ("upvoted" in RESULT or \
|
||||||
|
"saved" in RESULT or \
|
||||||
|
"submitted" in RESULT or \
|
||||||
|
"multireddit" in RESULT) and \
|
||||||
|
"user" in RESULT:
|
||||||
|
RESULT["submitted"] = {}
|
||||||
|
|
||||||
|
return RESULT
|
||||||
|
|
||||||
|
def LinkDesigner(LINK):
|
||||||
|
|
||||||
|
attributes = LinkParser(LINK)
|
||||||
|
MODE = {}
|
||||||
|
|
||||||
|
if "post" in attributes:
|
||||||
|
MODE["post"] = attributes["post"]
|
||||||
|
MODE["sort"] = ""
|
||||||
|
MODE["time"] = ""
|
||||||
|
return MODE
|
||||||
|
|
||||||
|
elif "search" in attributes:
|
||||||
|
MODE["search"] = attributes["search"]["q"]
|
||||||
|
|
||||||
|
if "restrict_sr" in attributes["search"]:
|
||||||
|
|
||||||
|
if not (attributes["search"]["restrict_sr"] == 0 or \
|
||||||
|
attributes["search"]["restrict_sr"] == "off"):
|
||||||
|
|
||||||
|
if "subreddit" in attributes:
|
||||||
|
MODE["subreddit"] = attributes["subreddit"]
|
||||||
|
elif "multireddit" in attributes:
|
||||||
|
MODE["multreddit"] = attributes["multireddit"]
|
||||||
|
MODE["user"] = attributes["user"]
|
||||||
|
else:
|
||||||
|
MODE["subreddit"] = "all"
|
||||||
|
else:
|
||||||
|
MODE["subreddit"] = "all"
|
||||||
|
|
||||||
|
if "t" in attributes["search"]:
|
||||||
|
MODE["time"] = attributes["search"]["t"]
|
||||||
|
else:
|
||||||
|
MODE["time"] = "all"
|
||||||
|
|
||||||
|
if "sort" in attributes["search"]:
|
||||||
|
MODE["sort"] = attributes["search"]["sort"]
|
||||||
|
else:
|
||||||
|
MODE["sort"] = "relevance"
|
||||||
|
|
||||||
|
if "include_over_18" in attributes["search"]:
|
||||||
|
if attributes["search"]["include_over_18"] == 1 or \
|
||||||
|
attributes["search"]["include_over_18"] == "on":
|
||||||
|
MODE["nsfw"] = True
|
||||||
|
else:
|
||||||
|
MODE["nsfw"] = False
|
||||||
|
|
||||||
|
else:
|
||||||
|
if "queries" in attributes:
|
||||||
|
if not ("submitted" in attributes or \
|
||||||
|
"posts" in attributes):
|
||||||
|
|
||||||
|
if "t" in attributes["queries"]:
|
||||||
|
MODE["time"] = attributes["queries"]["t"]
|
||||||
|
else:
|
||||||
|
MODE["time"] = "day"
|
||||||
|
else:
|
||||||
|
if "t" in attributes["queries"]:
|
||||||
|
MODE["time"] = attributes["queries"]["t"]
|
||||||
|
else:
|
||||||
|
MODE["time"] = "all"
|
||||||
|
|
||||||
|
if "sort" in attributes["queries"]:
|
||||||
|
MODE["sort"] = attributes["queries"]["sort"]
|
||||||
|
else:
|
||||||
|
MODE["sort"] = "new"
|
||||||
|
else:
|
||||||
|
MODE["time"] = "day"
|
||||||
|
|
||||||
|
if "subreddit" in attributes and not "search" in attributes:
|
||||||
|
MODE["subreddit"] = attributes["subreddit"]
|
||||||
|
|
||||||
|
elif "user" in attributes and not "search" in attributes:
|
||||||
|
MODE["user"] = attributes["user"]
|
||||||
|
|
||||||
|
if "submitted" in attributes:
|
||||||
|
MODE["submitted"] = True
|
||||||
|
if "sort" in attributes["submitted"]:
|
||||||
|
MODE["sort"] = attributes["submitted"]["sort"]
|
||||||
|
elif "sort" in MODE:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
MODE["sort"] = "new"
|
||||||
|
|
||||||
|
if "t" in attributes["submitted"]:
|
||||||
|
MODE["time"] = attributes["submitted"]["t"]
|
||||||
|
else:
|
||||||
|
MODE["time"] = "all"
|
||||||
|
|
||||||
|
elif "saved" in attributes:
|
||||||
|
MODE["saved"] = True
|
||||||
|
|
||||||
|
elif "upvoted" in attributes:
|
||||||
|
MODE["upvoted"] = True
|
||||||
|
|
||||||
|
elif "multireddit" in attributes:
|
||||||
|
MODE["multireddit"] = attributes["multireddit"]
|
||||||
|
|
||||||
|
if "sort" in attributes:
|
||||||
|
MODE["sort"] = attributes["sort"]
|
||||||
|
elif "sort" in MODE:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
MODE["sort"] = "hot"
|
||||||
|
|
||||||
|
return MODE
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
while True:
|
||||||
|
link = input("> ")
|
||||||
|
pprint(LinkDesigner(link))
|
453
src/searcher.py
Normal file
453
src/searcher.py
Normal file
|
@ -0,0 +1,453 @@
|
||||||
|
import os
|
||||||
|
import random
|
||||||
|
import socket
|
||||||
|
import webbrowser
|
||||||
|
|
||||||
|
try:
|
||||||
|
import praw
|
||||||
|
except ModuleNotFoundError:
|
||||||
|
print("\nPRAW not found on your computer, installing...\n")
|
||||||
|
from src.tools import install
|
||||||
|
install("praw")
|
||||||
|
import praw
|
||||||
|
|
||||||
|
from prawcore.exceptions import NotFound, ResponseException, Forbidden
|
||||||
|
|
||||||
|
from src.tools import GLOBAL, createLogFile, jsonFile, printToFile
|
||||||
|
from src.errors import (NoMatchingSubmissionFound, NoPrawSupport,
|
||||||
|
NoRedditSupoort, MultiredditNotFound,
|
||||||
|
InvalidSortingType, RedditLoginFailed,
|
||||||
|
InsufficientPermission)
|
||||||
|
|
||||||
|
print = printToFile
|
||||||
|
|
||||||
|
class GetAuth:
|
||||||
|
def __init__(self,redditInstance,port):
|
||||||
|
self.redditInstance = redditInstance
|
||||||
|
self.PORT = int(port)
|
||||||
|
|
||||||
|
def recieve_connection(self):
|
||||||
|
"""Wait for and then return a connected socket..
|
||||||
|
Opens a TCP connection on port 8080, and waits for a single client.
|
||||||
|
"""
|
||||||
|
server = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||||
|
server.bind(('localhost', self.PORT))
|
||||||
|
server.listen(1)
|
||||||
|
client = server.accept()[0]
|
||||||
|
server.close()
|
||||||
|
return client
|
||||||
|
|
||||||
|
def send_message(self, message):
|
||||||
|
"""Send message to client and close the connection."""
|
||||||
|
self.client.send('HTTP/1.1 200 OK\r\n\r\n{}'.format(message).encode('utf-8'))
|
||||||
|
self.client.close()
|
||||||
|
|
||||||
|
def getRefreshToken(self,*scopes):
|
||||||
|
state = str(random.randint(0, 65000))
|
||||||
|
url = self.redditInstance.auth.url(scopes, state, 'permanent')
|
||||||
|
print("Go to this URL and login to reddit:\n\n",url)
|
||||||
|
webbrowser.open(url,new=2)
|
||||||
|
|
||||||
|
self.client = self.recieve_connection()
|
||||||
|
data = self.client.recv(1024).decode('utf-8')
|
||||||
|
param_tokens = data.split(' ', 2)[1].split('?', 1)[1].split('&')
|
||||||
|
params = {
|
||||||
|
key: value for (key, value) in [token.split('=') \
|
||||||
|
for token in param_tokens]
|
||||||
|
}
|
||||||
|
if state != params['state']:
|
||||||
|
self.send_message(
|
||||||
|
client, 'State mismatch. Expected: {} Received: {}'
|
||||||
|
.format(state, params['state'])
|
||||||
|
)
|
||||||
|
raise RedditLoginFailed
|
||||||
|
elif 'error' in params:
|
||||||
|
self.send_message(client, params['error'])
|
||||||
|
raise RedditLoginFailed
|
||||||
|
|
||||||
|
refresh_token = self.redditInstance.auth.authorize(params['code'])
|
||||||
|
self.send_message(
|
||||||
|
"<script>" \
|
||||||
|
"alert(\"You can go back to terminal window now.\");" \
|
||||||
|
"</script>"
|
||||||
|
)
|
||||||
|
return (self.redditInstance,refresh_token)
|
||||||
|
|
||||||
|
def beginPraw(config,user_agent = str(socket.gethostname())):
|
||||||
|
"""Start reddit instance"""
|
||||||
|
|
||||||
|
scopes = ['identity','history','read']
|
||||||
|
port = "1337"
|
||||||
|
arguments = {
|
||||||
|
"client_id":GLOBAL.reddit_client_id,
|
||||||
|
"client_secret":GLOBAL.reddit_client_secret,
|
||||||
|
"user_agent":user_agent
|
||||||
|
}
|
||||||
|
|
||||||
|
if "reddit_refresh_token" in GLOBAL.config:
|
||||||
|
arguments["refresh_token"] = GLOBAL.config["reddit_refresh_token"]
|
||||||
|
reddit = praw.Reddit(**arguments)
|
||||||
|
try:
|
||||||
|
reddit.auth.scopes()
|
||||||
|
except ResponseException:
|
||||||
|
arguments["redirect_uri"] = "http://localhost:" + str(port)
|
||||||
|
reddit = praw.Reddit(**arguments)
|
||||||
|
authorizedInstance = GetAuth(reddit,port).getRefreshToken(*scopes)
|
||||||
|
reddit = authorizedInstance[0]
|
||||||
|
refresh_token = authorizedInstance[1]
|
||||||
|
jsonFile("config.json").add({
|
||||||
|
"reddit_refresh_token":refresh_token
|
||||||
|
})
|
||||||
|
else:
|
||||||
|
arguments["redirect_uri"] = "http://localhost:" + str(port)
|
||||||
|
reddit = praw.Reddit(**arguments)
|
||||||
|
authorizedInstance = GetAuth(reddit,port).getRefreshToken(*scopes)
|
||||||
|
reddit = authorizedInstance[0]
|
||||||
|
refresh_token = authorizedInstance[1]
|
||||||
|
jsonFile("config.json").add({
|
||||||
|
"reddit_refresh_token":refresh_token
|
||||||
|
})
|
||||||
|
return reddit
|
||||||
|
|
||||||
|
def getPosts(args):
|
||||||
|
"""Call PRAW regarding to arguments and pass it to redditSearcher.
|
||||||
|
Return what redditSearcher has returned.
|
||||||
|
"""
|
||||||
|
|
||||||
|
config = GLOBAL.config
|
||||||
|
reddit = beginPraw(config)
|
||||||
|
|
||||||
|
if args["sort"] == "best":
|
||||||
|
raise NoPrawSupport
|
||||||
|
|
||||||
|
if "subreddit" in args:
|
||||||
|
if "search" in args:
|
||||||
|
if args["subreddit"] == "frontpage":
|
||||||
|
args["subreddit"] = "all"
|
||||||
|
|
||||||
|
if "user" in args:
|
||||||
|
if args["user"] == "me":
|
||||||
|
args["user"] = str(reddit.user.me())
|
||||||
|
|
||||||
|
print("\nGETTING POSTS\n.\n.\n.\n")
|
||||||
|
|
||||||
|
if not "search" in args:
|
||||||
|
if args["sort"] == "top" or args["sort"] == "controversial":
|
||||||
|
keyword_params = {
|
||||||
|
"time_filter":args["time"],
|
||||||
|
"limit":args["limit"]
|
||||||
|
}
|
||||||
|
# OTHER SORT TYPES DON'T TAKE TIME_FILTER
|
||||||
|
else:
|
||||||
|
keyword_params = {
|
||||||
|
"limit":args["limit"]
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
keyword_params = {
|
||||||
|
"time_filter":args["time"],
|
||||||
|
"limit":args["limit"]
|
||||||
|
}
|
||||||
|
|
||||||
|
if "search" in args:
|
||||||
|
if args["sort"] in ["hot","rising","controversial"]:
|
||||||
|
raise InvalidSortingType
|
||||||
|
|
||||||
|
if "subreddit" in args:
|
||||||
|
print (
|
||||||
|
"search for \"{search}\" in\n" \
|
||||||
|
"subreddit: {subreddit}\nsort: {sort}\n" \
|
||||||
|
"time: {time}\nlimit: {limit}\n".format(
|
||||||
|
search=args["search"],
|
||||||
|
limit=args["limit"],
|
||||||
|
sort=args["sort"],
|
||||||
|
subreddit=args["subreddit"],
|
||||||
|
time=args["time"]
|
||||||
|
).upper()
|
||||||
|
)
|
||||||
|
return redditSearcher(
|
||||||
|
reddit.subreddit(args["subreddit"]).search(
|
||||||
|
args["search"],
|
||||||
|
limit=args["limit"],
|
||||||
|
sort=args["sort"],
|
||||||
|
time_filter=args["time"]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
elif "multireddit" in args:
|
||||||
|
raise NoPrawSupport
|
||||||
|
|
||||||
|
elif "user" in args:
|
||||||
|
raise NoPrawSupport
|
||||||
|
|
||||||
|
elif "saved" in args:
|
||||||
|
raise NoRedditSupoort
|
||||||
|
|
||||||
|
if args["sort"] == "relevance":
|
||||||
|
raise InvalidSortingType
|
||||||
|
|
||||||
|
if "saved" in args:
|
||||||
|
print(
|
||||||
|
"saved posts\nuser:{username}\nlimit={limit}\n".format(
|
||||||
|
username=reddit.user.me(),
|
||||||
|
limit=args["limit"]
|
||||||
|
).upper()
|
||||||
|
)
|
||||||
|
return redditSearcher(reddit.user.me().saved(limit=args["limit"]))
|
||||||
|
|
||||||
|
if "subreddit" in args:
|
||||||
|
|
||||||
|
if args["subreddit"] == "frontpage":
|
||||||
|
|
||||||
|
print (
|
||||||
|
"subreddit: {subreddit}\nsort: {sort}\n" \
|
||||||
|
"time: {time}\nlimit: {limit}\n".format(
|
||||||
|
limit=args["limit"],
|
||||||
|
sort=args["sort"],
|
||||||
|
subreddit=args["subreddit"],
|
||||||
|
time=args["time"]
|
||||||
|
).upper()
|
||||||
|
)
|
||||||
|
return redditSearcher(
|
||||||
|
getattr(reddit.front,args["sort"]) (**keyword_params)
|
||||||
|
)
|
||||||
|
|
||||||
|
else:
|
||||||
|
print (
|
||||||
|
"subreddit: {subreddit}\nsort: {sort}\n" \
|
||||||
|
"time: {time}\nlimit: {limit}\n".format(
|
||||||
|
limit=args["limit"],
|
||||||
|
sort=args["sort"],
|
||||||
|
subreddit=args["subreddit"],
|
||||||
|
time=args["time"]
|
||||||
|
).upper()
|
||||||
|
)
|
||||||
|
return redditSearcher(
|
||||||
|
getattr(
|
||||||
|
reddit.subreddit(args["subreddit"]),args["sort"]
|
||||||
|
) (**keyword_params)
|
||||||
|
)
|
||||||
|
|
||||||
|
elif "multireddit" in args:
|
||||||
|
print (
|
||||||
|
"user: {user}\n" \
|
||||||
|
"multireddit: {multireddit}\nsort: {sort}\n" \
|
||||||
|
"time: {time}\nlimit: {limit}\n".format(
|
||||||
|
user=args["user"],
|
||||||
|
limit=args["limit"],
|
||||||
|
sort=args["sort"],
|
||||||
|
multireddit=args["multireddit"],
|
||||||
|
time=args["time"]
|
||||||
|
).upper()
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
return redditSearcher(
|
||||||
|
getattr(
|
||||||
|
reddit.multireddit(
|
||||||
|
args["user"], args["multireddit"]
|
||||||
|
),args["sort"]
|
||||||
|
) (**keyword_params)
|
||||||
|
)
|
||||||
|
except NotFound:
|
||||||
|
raise MultiredditNotFound
|
||||||
|
|
||||||
|
elif "submitted" in args:
|
||||||
|
# TODO
|
||||||
|
# USE REDDIT.USER.ME() INSTEAD WHEN "ME" PASSED AS A --USER
|
||||||
|
print (
|
||||||
|
"submitted posts of {user}\nsort: {sort}\n" \
|
||||||
|
"time: {time}\nlimit: {limit}\n".format(
|
||||||
|
limit=args["limit"],
|
||||||
|
sort=args["sort"],
|
||||||
|
user=args["user"],
|
||||||
|
time=args["time"]
|
||||||
|
).upper()
|
||||||
|
)
|
||||||
|
return redditSearcher(
|
||||||
|
getattr(
|
||||||
|
reddit.redditor(args["user"]).submissions,args["sort"]
|
||||||
|
) (**keyword_params)
|
||||||
|
)
|
||||||
|
|
||||||
|
elif "upvoted" in args:
|
||||||
|
# TODO
|
||||||
|
# USE REDDIT.USER.ME() INSTEAD WHEN "ME" PASSED AS A --USER
|
||||||
|
print (
|
||||||
|
"upvoted posts of {user}\nlimit: {limit}\n".format(
|
||||||
|
user=args["user"],
|
||||||
|
limit=args["limit"]
|
||||||
|
).upper()
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
return redditSearcher(
|
||||||
|
reddit.redditor(args["user"]).upvoted(limit=args["limit"])
|
||||||
|
)
|
||||||
|
except Forbidden:
|
||||||
|
raise InsufficientPermission
|
||||||
|
|
||||||
|
elif "post" in args:
|
||||||
|
print("post: {post}\n".format(post=args["post"]).upper())
|
||||||
|
return redditSearcher(
|
||||||
|
reddit.submission(url=args["post"]),SINGLE_POST=True
|
||||||
|
)
|
||||||
|
|
||||||
|
def redditSearcher(posts,SINGLE_POST=False):
|
||||||
|
"""Check posts and decide if it can be downloaded.
|
||||||
|
If so, create a dictionary with post details and append them to a list.
|
||||||
|
Write all of posts to file. Return the list
|
||||||
|
"""
|
||||||
|
|
||||||
|
subList = []
|
||||||
|
global subCount
|
||||||
|
subCount = 0
|
||||||
|
global orderCount
|
||||||
|
orderCount = 0
|
||||||
|
global gfycatCount
|
||||||
|
gfycatCount = 0
|
||||||
|
global imgurCount
|
||||||
|
imgurCount = 0
|
||||||
|
global directCount
|
||||||
|
directCount = 0
|
||||||
|
|
||||||
|
postsFile = createLogFile("POSTS")
|
||||||
|
|
||||||
|
if SINGLE_POST:
|
||||||
|
submission = posts
|
||||||
|
subCount += 1
|
||||||
|
try:
|
||||||
|
details = {'postId':submission.id,
|
||||||
|
'postTitle':submission.title,
|
||||||
|
'postSubmitter':str(submission.author),
|
||||||
|
'postType':None,
|
||||||
|
'postURL':submission.url,
|
||||||
|
'postSubreddit':submission.subreddit.display_name}
|
||||||
|
except AttributeError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
postsFile.add({subCount:[details]})
|
||||||
|
details = checkIfMatching(submission)
|
||||||
|
|
||||||
|
if details is not None:
|
||||||
|
if not details["postType"] == "self":
|
||||||
|
orderCount += 1
|
||||||
|
printSubmission(submission,subCount,orderCount)
|
||||||
|
subList.append(details)
|
||||||
|
else:
|
||||||
|
postsFile.add({subCount:[details]})
|
||||||
|
|
||||||
|
else:
|
||||||
|
for submission in posts:
|
||||||
|
subCount += 1
|
||||||
|
|
||||||
|
try:
|
||||||
|
details = {'postId':submission.id,
|
||||||
|
'postTitle':submission.title,
|
||||||
|
'postSubmitter':str(submission.author),
|
||||||
|
'postType':None,
|
||||||
|
'postURL':submission.url,
|
||||||
|
'postSubreddit':submission.subreddit.display_name}
|
||||||
|
except AttributeError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
postsFile.add({subCount:[details]})
|
||||||
|
details = checkIfMatching(submission)
|
||||||
|
|
||||||
|
if details is not None:
|
||||||
|
if not details["postType"] == "self":
|
||||||
|
orderCount += 1
|
||||||
|
printSubmission(submission,subCount,orderCount)
|
||||||
|
subList.append(details)
|
||||||
|
else:
|
||||||
|
postsFile.add({subCount:[details]})
|
||||||
|
|
||||||
|
if not len(subList) == 0:
|
||||||
|
print(
|
||||||
|
"\nTotal of {} submissions found!\n"\
|
||||||
|
"{} GFYCATs, {} IMGURs and {} DIRECTs\n"
|
||||||
|
.format(len(subList),gfycatCount,imgurCount,directCount)
|
||||||
|
)
|
||||||
|
return subList
|
||||||
|
else:
|
||||||
|
raise NoMatchingSubmissionFound
|
||||||
|
|
||||||
|
def checkIfMatching(submission):
|
||||||
|
global gfycatCount
|
||||||
|
global imgurCount
|
||||||
|
global directCount
|
||||||
|
|
||||||
|
try:
|
||||||
|
details = {'postId':submission.id,
|
||||||
|
'postTitle':submission.title,
|
||||||
|
'postSubmitter':str(submission.author),
|
||||||
|
'postType':None,
|
||||||
|
'postURL':submission.url,
|
||||||
|
'postSubreddit':submission.subreddit.display_name}
|
||||||
|
except AttributeError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
if ('gfycat' in submission.domain) or \
|
||||||
|
('imgur' in submission.domain):
|
||||||
|
|
||||||
|
if 'gfycat' in submission.domain:
|
||||||
|
details['postType'] = 'gfycat'
|
||||||
|
gfycatCount += 1
|
||||||
|
return details
|
||||||
|
|
||||||
|
elif 'imgur' in submission.domain:
|
||||||
|
details['postType'] = 'imgur'
|
||||||
|
|
||||||
|
imgurCount += 1
|
||||||
|
return details
|
||||||
|
|
||||||
|
elif isDirectLink(submission.url) is True:
|
||||||
|
details['postType'] = 'direct'
|
||||||
|
directCount += 1
|
||||||
|
return details
|
||||||
|
|
||||||
|
elif submission.is_self:
|
||||||
|
details['postType'] = 'self'
|
||||||
|
return details
|
||||||
|
|
||||||
|
def printSubmission(SUB,validNumber,totalNumber):
|
||||||
|
"""Print post's link, title and media link to screen"""
|
||||||
|
|
||||||
|
print(validNumber,end=") ")
|
||||||
|
print(totalNumber,end=" ")
|
||||||
|
print(
|
||||||
|
"https://www.reddit.com/"
|
||||||
|
+"r/"
|
||||||
|
+SUB.subreddit.display_name
|
||||||
|
+"/comments/"
|
||||||
|
+SUB.id
|
||||||
|
)
|
||||||
|
print(" "*(len(str(validNumber))
|
||||||
|
+(len(str(totalNumber)))+3),end="")
|
||||||
|
|
||||||
|
try:
|
||||||
|
print(SUB.title)
|
||||||
|
except:
|
||||||
|
SUB.title = "unnamed"
|
||||||
|
print("SUBMISSION NAME COULD NOT BE READ")
|
||||||
|
pass
|
||||||
|
|
||||||
|
print(" "*(len(str(validNumber))+(len(str(totalNumber)))+3),end="")
|
||||||
|
print(SUB.url,end="\n\n")
|
||||||
|
|
||||||
|
def isDirectLink(URL):
|
||||||
|
"""Check if link is a direct image link.
|
||||||
|
If so, return True,
|
||||||
|
if not, return False
|
||||||
|
"""
|
||||||
|
|
||||||
|
imageTypes = ['.jpg','.png','.mp4','.webm','.gif']
|
||||||
|
if URL[-1] == "/":
|
||||||
|
URL = URL[:-1]
|
||||||
|
|
||||||
|
if "i.reddituploads.com" in URL:
|
||||||
|
return True
|
||||||
|
|
||||||
|
for extension in imageTypes:
|
||||||
|
if extension in URL:
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
return False
|
148
src/tools.py
Normal file
148
src/tools.py
Normal file
|
@ -0,0 +1,148 @@
|
||||||
|
import io
|
||||||
|
import json
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
|
try:
|
||||||
|
from pip import main as pipmain
|
||||||
|
except:
|
||||||
|
from pip._internal import main as pipmain
|
||||||
|
|
||||||
|
from os import makedirs, path, remove
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from src.errors import FileNotFoundError
|
||||||
|
|
||||||
|
def install(package):
|
||||||
|
pipmain(['install', package])
|
||||||
|
|
||||||
|
class GLOBAL:
|
||||||
|
"""Declare global variables"""
|
||||||
|
|
||||||
|
RUN_TIME = 0
|
||||||
|
config = None
|
||||||
|
arguments = None
|
||||||
|
directory = None
|
||||||
|
reddit_client_id = "Jx3iqqGkSmE5sg"
|
||||||
|
reddit_client_secret = "PFzVAVRLN78JI48e3bQ5KsgLZp4"
|
||||||
|
printVanilla = print
|
||||||
|
|
||||||
|
class jsonFile:
|
||||||
|
""" Write and read JSON files
|
||||||
|
|
||||||
|
Use add(self,toBeAdded) to add to files
|
||||||
|
|
||||||
|
Use delete(self,*deletedKeys) to delete keys
|
||||||
|
"""
|
||||||
|
|
||||||
|
FILEDIR = ""
|
||||||
|
|
||||||
|
def __init__(self,FILEDIR):
|
||||||
|
self.FILEDIR = FILEDIR
|
||||||
|
if not path.exists(self.FILEDIR):
|
||||||
|
self.__writeToFile({},create=True)
|
||||||
|
|
||||||
|
def read(self):
|
||||||
|
with open(self.FILEDIR, 'r') as f:
|
||||||
|
return json.load(f)
|
||||||
|
|
||||||
|
def add(self,toBeAdded):
|
||||||
|
"""Takes a dictionary and merges it with json file.
|
||||||
|
It uses new key's value if a key already exists.
|
||||||
|
Returns the new content as a dictionary.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = self.read()
|
||||||
|
data = {**data, **toBeAdded}
|
||||||
|
self.__writeToFile(data)
|
||||||
|
return self.read()
|
||||||
|
|
||||||
|
def delete(self,*deleteKeys):
|
||||||
|
"""Delete given keys from JSON file.
|
||||||
|
Returns the new content as a dictionary.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = self.read()
|
||||||
|
for deleteKey in deleteKeys:
|
||||||
|
if deleteKey in data:
|
||||||
|
del data[deleteKey]
|
||||||
|
found = True
|
||||||
|
if not found:
|
||||||
|
return False
|
||||||
|
self.__writeToFile(data)
|
||||||
|
|
||||||
|
def __writeToFile(self,content,create=False):
|
||||||
|
if not create:
|
||||||
|
remove(self.FILEDIR)
|
||||||
|
with open(self.FILEDIR, 'w') as f:
|
||||||
|
json.dump(content, f, indent=4)
|
||||||
|
|
||||||
|
def createLogFile(TITLE):
|
||||||
|
"""Create a log file with given name
|
||||||
|
inside a folder time stampt in its name and
|
||||||
|
put given arguments inside \"HEADER\" key
|
||||||
|
"""
|
||||||
|
|
||||||
|
folderDirectory = GLOBAL.directory / str(time.strftime("%d-%m-%Y_%H-%M-%S",
|
||||||
|
time.localtime(GLOBAL.RUN_TIME)))
|
||||||
|
logFilename = TITLE.upper()+'.json'
|
||||||
|
|
||||||
|
if not path.exists(folderDirectory):
|
||||||
|
makedirs(folderDirectory)
|
||||||
|
|
||||||
|
FILE = jsonFile(folderDirectory / Path(logFilename))
|
||||||
|
HEADER = " ".join(sys.argv)
|
||||||
|
FILE.add({"HEADER":HEADER})
|
||||||
|
|
||||||
|
return FILE
|
||||||
|
|
||||||
|
def printToFile(*args, **kwargs):
|
||||||
|
"""Print to both CONSOLE and
|
||||||
|
CONSOLE LOG file in a folder time stampt in the name
|
||||||
|
"""
|
||||||
|
|
||||||
|
TIME = str(time.strftime("%d-%m-%Y_%H-%M-%S",
|
||||||
|
time.localtime(GLOBAL.RUN_TIME)))
|
||||||
|
folderDirectory = GLOBAL.directory / TIME
|
||||||
|
print(*args,**kwargs)
|
||||||
|
|
||||||
|
if not path.exists(folderDirectory):
|
||||||
|
makedirs(folderDirectory)
|
||||||
|
|
||||||
|
with io.open(
|
||||||
|
folderDirectory / "CONSOLE_LOG.txt","a",encoding="utf-8"
|
||||||
|
) as FILE:
|
||||||
|
print(*args, file=FILE, **kwargs)
|
||||||
|
|
||||||
|
def nameCorrector(string):
|
||||||
|
"""Swap strange characters from given string
|
||||||
|
with underscore (_) and shorten it.
|
||||||
|
Return the string
|
||||||
|
"""
|
||||||
|
|
||||||
|
stringLenght = len(string)
|
||||||
|
if stringLenght > 200:
|
||||||
|
string = string[:200]
|
||||||
|
stringLenght = len(string)
|
||||||
|
spacesRemoved = []
|
||||||
|
|
||||||
|
for b in range(stringLenght):
|
||||||
|
if string[b] == " ":
|
||||||
|
spacesRemoved.append("_")
|
||||||
|
else:
|
||||||
|
spacesRemoved.append(string[b])
|
||||||
|
|
||||||
|
string = ''.join(spacesRemoved)
|
||||||
|
correctedString = []
|
||||||
|
|
||||||
|
if len(string.split('\n')) > 1:
|
||||||
|
string = "".join(string.split('\n'))
|
||||||
|
|
||||||
|
BAD_CHARS = ['\\','/',':','*','?','"','<','>','|','.',]
|
||||||
|
|
||||||
|
if any(x in string for x in BAD_CHARS):
|
||||||
|
for char in string:
|
||||||
|
if char in BAD_CHARS:
|
||||||
|
string = string.replace(char,"_")
|
||||||
|
|
||||||
|
return string
|
Loading…
Reference in a new issue