diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..0ffeae3
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto eol=lf
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a73abf4
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,120 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEA
+.idea/
+
+cache.db
+config.json
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e62ec04
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/Letter_R_blue.ico b/Letter_R_blue.ico
new file mode 100644
index 0000000..15a601b
Binary files /dev/null and b/Letter_R_blue.ico differ
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb67d21
--- /dev/null
+++ b/README.md
@@ -0,0 +1,2 @@
+# dlsite-doujin-renamer
+
diff --git a/build.py b/build.py
new file mode 100644
index 0000000..4d1349f
--- /dev/null
+++ b/build.py
@@ -0,0 +1,13 @@
+import PyInstaller.__main__
+
+if __name__ == '__main__':
+ PyInstaller.__main__.run([
+ 'main.py',
+ '--onefile',
+ '--windowed',
+ '--clean',
+ '--icon',
+ 'Letter_R_blue.ico', # https://icon-icons.com/icon/letter-r-blue/34893
+ '--add-data',
+ 'Letter_R_blue.ico;.',
+ ])
diff --git a/config_file.py b/config_file.py
new file mode 100644
index 0000000..9c9d421
--- /dev/null
+++ b/config_file.py
@@ -0,0 +1,115 @@
+import json
+import os
+import re
+from typing import TypedDict, Final, Optional
+
+from scraper import Locale
+
+
+class Config(TypedDict):
+ scaner_max_depth: int
+ scraper_locale: str
+ scraper_connect_timeout: int
+ scraper_read_timeout: int
+ scraper_sleep_interval: int
+ scraper_http_proxy: Optional[str]
+ renamer_template: str
+ renamer_exclude_square_brackets_in_work_name_flag: bool
+
+
+class ConfigFile(object):
+ DEFAULT_CONFIG: Final[Config] = {
+ 'scaner_max_depth': 5,
+ 'scraper_locale': 'zh_cn',
+ 'scraper_connect_timeout': 10,
+ 'scraper_read_timeout': 10,
+ 'scraper_sleep_interval': 3,
+ 'scraper_http_proxy': None,
+ 'renamer_template': '[maker_name][rjcode] work_name cv_list_str',
+ 'renamer_exclude_square_brackets_in_work_name_flag': False,
+ }
+
+ def __init__(self, file_path: str):
+ self.__file_path = file_path
+ if not os.path.isfile(file_path):
+ self.save_config(ConfigFile.DEFAULT_CONFIG)
+
+ def load_config(self):
+ """
+ 从配置文件中读取配置
+ """
+ with open(self.__file_path, encoding='UTF-8') as file:
+ config_dict: Config = json.load(file)
+ return config_dict
+
+ def save_config(self, config_dict: Config):
+ """
+ 保存配置到文件
+ """
+ with open(self.__file_path, 'w', encoding='UTF-8') as file:
+ json.dump(config_dict, file, indent=2, ensure_ascii=False)
+
+ @property
+ def file_path(self):
+ return self.__file_path
+
+ @staticmethod
+ def verify_config(config_dict: Config):
+ """
+ 验证配置是否合理
+ """
+ scaner_max_depth = config_dict.get('scaner_max_depth', None)
+ scraper_locale = config_dict.get('scraper_locale', None)
+ scraper_connect_timeout = config_dict.get('scraper_connect_timeout', None)
+ scraper_read_timeout = config_dict.get('scraper_read_timeout', None)
+ scraper_http_proxy = config_dict.get('scraper_http_proxy', None)
+ scraper_sleep_interval = config_dict.get('scraper_sleep_interval', None)
+ renamer_template = config_dict.get('renamer_template', None)
+ renamer_exclude_square_brackets_in_work_name_flag = \
+ config_dict.get('renamer_exclude_square_brackets_in_work_name_flag', None)
+
+ strerror_list = []
+
+ # 检查 scaner_max_depth
+ if not isinstance(scaner_max_depth, int) or scaner_max_depth < 0:
+ strerror_list.append('scaner_max_depth 应是一个大于等于 0 的整数')
+
+ # 检查 scraper_locale
+ locale_name_list: list[str] = []
+ for locale in Locale:
+ locale_name_list.append(locale.name)
+ if scraper_locale not in locale_name_list:
+ strerror_list.append(f'scraper_locale 应是 {locale_name_list} 中的一个')
+
+ # 检查 scraper_connect_timeout
+ if not isinstance(scraper_connect_timeout, int) or scraper_connect_timeout <= 0:
+ strerror_list.append('scraper_connect_timeout 应是一个大于 0 的整数')
+
+ # 检查 scraper_read_timeout
+ if not isinstance(scraper_read_timeout, int) or scraper_read_timeout <= 0:
+ strerror_list.append('scraper_read_timeout 应是一个大于 0 的整数')
+
+ # 检查 scraper_sleep_interval
+ if not isinstance(scraper_sleep_interval, int) or scraper_sleep_interval < 0:
+ strerror_list.append('scraper_sleep_interval 应是一个大于等于 0 的整数')
+
+ # 检查 scraper_http_proxy
+ http_proxy_pattern = re.compile(r"\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:(\d+)")
+ str_error_http_proxy = f'scraper_http_proxy 应是形如 "http://127.0.0.1:7890" 的 http 代理;或设为 null,这将使用系统代理'
+ if isinstance(scraper_http_proxy, str):
+ if not http_proxy_pattern.fullmatch(scraper_http_proxy):
+ # 是字符串但不匹配正则规则
+ strerror_list.append(str_error_http_proxy)
+ elif scraper_http_proxy is not None:
+ # 既不是字符串也不是 None
+ strerror_list.append(str_error_http_proxy)
+
+ # 检查 renamer_template
+ if not isinstance(renamer_template, str) or 'rjcode' not in renamer_template:
+ strerror_list.append('renamer_template 应是一个包含 "rjcode" 的字符串')
+
+ # 检查 renamer_exclude_square_brackets_in_work_name_flag
+ if not isinstance(renamer_exclude_square_brackets_in_work_name_flag, bool):
+ strerror_list.append('renamer_exclude_square_brackets_in_work_name_flag 应是一个布尔值')
+
+ return strerror_list
diff --git a/main.py b/main.py
new file mode 100644
index 0000000..c36cf8b
--- /dev/null
+++ b/main.py
@@ -0,0 +1,197 @@
+import logging
+import os
+import sys
+from json import JSONDecodeError
+from threading import Thread
+from typing import Optional, Callable
+
+import wx
+
+from config_file import ConfigFile
+from renamer import Renamer
+from scaner import Scaner
+from scraper import Locale, CachedScraper
+from my_frame import MyFrame
+from wx_log_handler import EVT_WX_LOG_EVENT, WxLogHandler
+
+VERSION = '0.1.0'
+
+
+class MyFileDropTarget(wx.FileDropTarget):
+ def __init__(self, window):
+ wx.FileDropTarget.__init__(self)
+ self.window = window
+
+ def OnDropFiles(self, x, y, filenames):
+ """
+ 当接收到用户拖拽的文件时,运行 renamer
+ """
+ dirname_list = [filename for filename in filenames if os.path.isdir(filename)]
+ self.window.thread_it(self.window.run_renamer, dirname_list)
+ return True
+
+
+class AppFrame(MyFrame):
+ def __init__(self, parent):
+ MyFrame.__init__(self, parent)
+
+ # 使文件能被拖拽到 wx.TextCtrl 组件
+ drop_target = MyFileDropTarget(self)
+ self.text_ctrl.SetDropTarget(drop_target)
+
+ # 配置文件
+ config_file_path = os.path.join('config.json')
+ self.__config_file = ConfigFile(config_file_path)
+
+ # 工作线程。耗时长的任务应放在工作线程执行,避免阻塞 GUI 线程
+ self.__worker_thread: Optional[Thread] = None
+
+ # 为 logger 添加 wxLogHandler
+ self.text_ctrl.Bind(EVT_WX_LOG_EVENT, self.on_log_event)
+ wx_log_handler = WxLogHandler(self.text_ctrl)
+ wx_log_handler.setLevel(logging.INFO)
+ wx_log_handler.setFormatter(logging.Formatter('%(asctime)s - %(message)s'))
+ Renamer.logger.addHandler(wx_log_handler)
+
+ def thread_it(self, func: Callable, *args):
+ """
+ 将函数打包进线程执行
+ """
+ if self.__worker_thread and self.__worker_thread.is_alive():
+ return
+ self.__worker_thread = Thread(target=func, args=args)
+ self.__worker_thread.start()
+
+ def on_log_event(self, event):
+ """
+ 转发日志到 wx.TextCtrl 组件
+ """
+ if event.levelno <= logging.INFO:
+ text_color = wx.BLACK
+ elif event.levelno <= logging.WARNING:
+ text_color = wx.BLUE
+ else:
+ text_color = wx.RED
+ self.text_ctrl.SetDefaultStyle(wx.TextAttr(text_color))
+ msg = event.message.strip("\r") + "\n"
+ self.text_ctrl.AppendText(msg)
+ event.Skip()
+
+ def on_dir_changed_event(self, event):
+ """
+ 当 wx.DirPickerCtrl 组件接收到用户选择的文件夹时,运行 renamer
+ """
+ root_path = self.dir_picker.GetPath()
+ self.thread_it(self.run_renamer, [root_path])
+
+ def __print_info(self, message: str):
+ self.text_ctrl.SetDefaultStyle(wx.TextAttr(wx.BLACK))
+ self.text_ctrl.AppendText(message + '\n')
+
+ def __print_warning(self, message: str):
+ self.text_ctrl.SetDefaultStyle(wx.TextAttr(wx.BLUE))
+ self.text_ctrl.AppendText(message + '\n')
+
+ def __print_error(self, message: str):
+ self.text_ctrl.SetDefaultStyle(wx.TextAttr(wx.RED))
+ self.text_ctrl.AppendText(message + '\n')
+
+ def __before_worker_thread_start(self):
+ thread_id = self.__worker_thread.native_id # 线程 ID
+ self.__print_info(f'******************************运行开始({thread_id})******************************')
+ self.dir_picker.Disable() # 禁用【浏览】按钮
+ self.text_ctrl.SetDropTarget(None) # 禁用文件拖拽
+
+ def __before_worker_thread_end(self):
+ self.dir_picker.Enable() # 恢复【浏览】按钮
+ self.text_ctrl.SetDropTarget(MyFileDropTarget(self)) # 恢复文件拖拽
+ thread_id = self.__worker_thread.native_id # 线程 ID
+ self.__print_info(f'******************************运行结束({thread_id})******************************\n\n')
+
+ def run_renamer(self, root_path_list: list[str]):
+ self.__before_worker_thread_start()
+
+ try:
+ config = self.__config_file.load_config() # 从配置文件中读取配置
+ except JSONDecodeError as err:
+ self.__print_error(f'配置文件解析失败:"{os.path.normpath(self.__config_file.file_path)}"')
+ self.__print_error(f'JSONDecodeError: {str(err)}')
+ self.__before_worker_thread_end()
+ return
+ except FileNotFoundError as err:
+ self.__print_error(f'配置文件加载失败:"{os.path.normpath(self.__config_file.file_path)}"')
+ self.__print_error(f'FileNotFoundError: {err.strerror}')
+ self.__before_worker_thread_end()
+ return
+
+ # 检查配置是否合法
+ strerror_list = ConfigFile.verify_config(config)
+ if len(strerror_list) > 0:
+ self.__print_error(f'配置文件验证失败:"{os.path.normpath(self.__config_file.file_path)}"')
+ for strerror in strerror_list:
+ self.__print_error(strerror)
+ self.__before_worker_thread_end()
+ return
+
+ # 配置 scaner
+ scaner_max_depth = config['scaner_max_depth']
+ scaner = Scaner(max_depth=scaner_max_depth)
+
+ # 配置 scraper
+ scraper_locale = config['scraper_locale']
+ scraper_http_proxy = config['scraper_http_proxy']
+ if scraper_http_proxy:
+ proxies = {
+ 'http': scraper_http_proxy,
+ 'https': scraper_http_proxy
+ }
+ else:
+ proxies = None
+ scraper_connect_timeout = config['scraper_connect_timeout']
+ scraper_read_timeout = config['scraper_read_timeout']
+ scraper_sleep_interval = config['scraper_sleep_interval']
+ cached_scraper = CachedScraper(
+ locale=Locale[scraper_locale],
+ connect_timeout=scraper_connect_timeout,
+ read_timeout=scraper_read_timeout,
+ sleep_interval=scraper_sleep_interval,
+ proxies=proxies)
+
+ # 配置 renamer
+ renamer = Renamer(
+ scaner=scaner,
+ scraper=cached_scraper,
+ template=config['renamer_template'],
+ exclude_square_brackets_in_work_name_flag=config['renamer_exclude_square_brackets_in_work_name_flag'])
+
+ # 执行重命名
+ for root_path in root_path_list:
+ renamer.rename(root_path)
+
+ self.__before_worker_thread_end()
+
+
+def get_application_path():
+ """
+ https://pyinstaller.readthedocs.io/en/stable/runtime-information.html#run-time-information
+ """
+ if getattr(sys, 'frozen', False) and hasattr(sys, '_MEIPASS'):
+ # running in a PyInstaller bundle
+ application_path = sys._MEIPASS
+ else:
+ # running in a normal Python process
+ application_path = os.path.dirname(__file__)
+ return application_path
+
+
+if __name__ == '__main__':
+ app_path = get_application_path()
+ icon_path = os.path.join(app_path, 'Letter_R_blue.ico')
+
+ app = wx.App(False)
+ frame = AppFrame(None)
+ frame.SetIcon(wx.Icon(icon_path))
+ frame.SetTitle(f'DLSite 同人作品重命名工具 v{VERSION}')
+ frame.Show(True)
+ # start the applications
+ app.MainLoop()
diff --git a/my_frame.py b/my_frame.py
new file mode 100644
index 0000000..8a468ab
--- /dev/null
+++ b/my_frame.py
@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+
+###########################################################################
+## Python code generated with wxFormBuilder (version 3.10.1-0-g8feb16b3)
+## http://www.wxformbuilder.org/
+##
+## PLEASE DO *NOT* EDIT THIS FILE!
+###########################################################################
+
+import wx
+import wx.xrc
+
+
+###########################################################################
+## Class MyFrame
+###########################################################################
+
+class MyFrame(wx.Frame):
+
+ def __init__(self, parent):
+ wx.Frame.__init__(self, parent, id=wx.ID_ANY, title=wx.EmptyString, pos=wx.DefaultPosition,
+ size=wx.Size(500, 300), style=wx.DEFAULT_FRAME_STYLE | wx.TAB_TRAVERSAL)
+
+ self.SetSizeHints(wx.DefaultSize, wx.DefaultSize)
+
+ box_sizer = wx.BoxSizer(wx.VERTICAL)
+
+ self.static_text = wx.StaticText(self, wx.ID_ANY, u"Tip:手动选择文件夹或拖拽文件夹到软件窗口", wx.DefaultPosition, wx.DefaultSize,
+ 0)
+ self.static_text.Wrap(-1)
+ box_sizer.Add(self.static_text, 0, wx.ALL | wx.EXPAND, 5)
+
+ self.text_ctrl = wx.TextCtrl(self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize,
+ wx.TE_MULTILINE | wx.TE_READONLY | wx.TE_RICH | wx.TE_RICH2 | wx.HSCROLL | wx.TE_AUTO_URL)
+ box_sizer.Add(self.text_ctrl, 1, wx.ALL | wx.EXPAND, 5)
+
+ self.dir_picker = wx.DirPickerCtrl(self, wx.ID_ANY, '',
+ u"Select a folder", wx.DefaultPosition, wx.DefaultSize,
+ wx.DIRP_DIR_MUST_EXIST)
+ box_sizer.Add(self.dir_picker, 0, wx.ALL | wx.ALIGN_CENTER_HORIZONTAL, 5)
+
+ self.SetSizer(box_sizer)
+ self.Layout()
+
+ self.Centre(wx.BOTH)
+
+ # Connect Events
+ self.dir_picker.Bind(wx.EVT_DIRPICKER_CHANGED, self.on_dir_changed_event)
+
+ def __del__(self):
+ pass
+
+ # Virtual event handlers, override them in your derived class
+ def on_dir_changed_event(self, event):
+ event.Skip()
diff --git a/renamer.py b/renamer.py
new file mode 100644
index 0000000..1ce934b
--- /dev/null
+++ b/renamer.py
@@ -0,0 +1,118 @@
+import logging
+import os
+import re
+
+from requests.exceptions import RequestException, ConnectionError, HTTPError, Timeout
+
+from scaner import Scaner
+from scraper import WorkMetadata, Scraper
+
+# Windows 系统的保留字符
+# https://docs.microsoft.com/zh-cn/windows/win32/fileio/naming-a-file
+# <(小于)
+# >(大于)
+# : (冒号)
+# "(双引号)
+# /(正斜杠)
+# \ (反反)
+# | (竖线或竖线)
+# ? (问号)
+# * (星号)
+WINDOWS_RESERVED_CHARACTER_PATTERN = re.compile(r'[\\/*?:"<>|]')
+
+
+def _get_logger():
+ # create logger
+ logger = logging.getLogger('Renamer')
+ logger.setLevel(logging.DEBUG)
+
+ # create console handler and set level to debug
+ ch = logging.StreamHandler()
+ ch.setLevel(logging.DEBUG)
+ # create formatter
+ formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+ # add formatter to ch
+ ch.setFormatter(formatter)
+
+ # add ch to logger
+ logger.addHandler(ch)
+
+ return logger
+
+
+class Renamer(object):
+ logger = _get_logger()
+
+ def __init__(
+ self,
+ scaner: Scaner,
+ scraper: Scraper,
+ template: str = '[maker_name][rjcode] work_name cv_list_str', # 模板
+ exclude_square_brackets_in_work_name_flag: bool = False, # 设为 True 时,移除 work_name 中【】及其间的内容
+ ):
+ if 'rjcode' not in template:
+ raise ValueError # 重命名不能丢失 rjcode
+ self.__scaner = scaner
+ self.__scraper = scraper
+ self.__template = template
+ self.__exclude_square_brackets_in_work_name_flag = exclude_square_brackets_in_work_name_flag
+
+ def __compile_new_name(self, metadata: WorkMetadata):
+ """
+ 根据作品的元数据编写出新的文件名
+ """
+ work_name = re.sub(r'【.*?】', '', metadata['work_name']).strip() \
+ if self.__exclude_square_brackets_in_work_name_flag \
+ else metadata['work_name']
+
+ template = self.__template
+ new_name = template.replace('rjcode', metadata['rjcode'])
+ new_name = new_name.replace('work_name', work_name)
+ new_name = new_name.replace('maker_id', metadata['maker_id'])
+ new_name = new_name.replace('maker_name', metadata['maker_name'])
+ new_name = new_name.replace('release_date', metadata['release_date'])
+
+ cv_list = metadata['cvs']
+ cv_list_str = '(' + ' '.join(cv_list) + ')' if len(cv_list) > 0 else ''
+ new_name = new_name.replace('cv_list_str', cv_list_str)
+
+ # 文件名中不能包含 Windows 系统的保留字符
+ new_name = WINDOWS_RESERVED_CHARACTER_PATTERN.sub('', new_name)
+
+ return new_name.strip()
+
+ def rename(self, root_path: str):
+ work_folders = self.__scaner.scan(root_path)
+ for rjcode, folder_path in work_folders:
+ Renamer.logger.info(f'[{rjcode}] -> 发现 RJ 文件夹:"{os.path.normpath(folder_path)}"')
+ dirname, basename = os.path.split(folder_path)
+ try:
+ metadata = self.__scraper.scrape_metadata(rjcode)
+ except Timeout:
+ # 请求超时
+ Renamer.logger.warning(f'[{rjcode}] -> 重命名失败:dlsite.com 请求超时!\n')
+ continue
+ except ConnectionError as err:
+ # 遇到其它网络问题(如:DNS 查询失败、拒绝连接等)
+ Renamer.logger.warning(f'[{rjcode}] -> 重命名失败:{str(err)}\n')
+ continue
+ except HTTPError as err:
+ # HTTP 请求返回了不成功的状态码
+ Renamer.logger.warning(f'[{rjcode}] -> 重命名失败:{err.response.status_code} {err.response.reason}\n')
+ continue
+ except RequestException as err:
+ # requests 引发的其它异常
+ Renamer.logger.error(f'[{rjcode}] -> 重命名失败:{str(err)}\n')
+ continue
+
+ new_basename = self.__compile_new_name(metadata)
+ new_folder_path = os.path.join(dirname, new_basename)
+ try:
+ os.rename(folder_path, new_folder_path)
+ Renamer.logger.info(f'[{rjcode}] -> 重命名成功:"{os.path.normpath(new_folder_path)}"\n')
+ except FileExistsError as err:
+ filename = os.path.normpath(err.filename)
+ filename2 = os.path.normpath(err.filename2)
+ Renamer.logger.warning(f'[{rjcode}] -> 重命名失败:{err.strerror}:"{filename}" -> "{filename2}"\n')
+ except OSError as err:
+ Renamer.logger.error(f'[{rjcode}] -> 重命名失败:{str(err)}\n')
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..8932b43
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,19 @@
+altgraph==0.17.2
+certifi==2021.10.8
+charset-normalizer==2.0.10
+cssselect==1.1.0
+future==0.18.2
+idna==3.3
+lxml==4.7.1
+numpy==1.22.0
+peewee==3.14.8
+pefile==2021.9.3
+Pillow==9.0.0
+pyinstaller==4.7
+pyinstaller-hooks-contrib==2021.4
+pyquery==1.4.3
+pywin32-ctypes==0.2.0
+requests==2.27.1
+six==1.16.0
+urllib3==1.26.7
+wxPython==4.1.1
diff --git a/scaner/__init__.py b/scaner/__init__.py
new file mode 100644
index 0000000..2122ecf
--- /dev/null
+++ b/scaner/__init__.py
@@ -0,0 +1 @@
+from scaner.scaner import Scaner
diff --git a/scaner/scaner.py b/scaner/scaner.py
new file mode 100644
index 0000000..90bad98
--- /dev/null
+++ b/scaner/scaner.py
@@ -0,0 +1,23 @@
+import os
+
+from scraper import Dlsite
+
+
+class Scaner(object):
+ def __init__(self, max_depth=5):
+ self.__max_depth = max_depth
+
+ def scan(self, root_path: str, _depth=0):
+ """
+ 生成器。深层遍历所有含 rjcode 的文件夹
+ """
+ if os.path.isdir(root_path): # 检查是否是文件夹
+ folder = os.path.basename(root_path)
+ rjcode = Dlsite.parse_rjcode(folder)
+ if rjcode: # 检查文件夹名称中是否含RJ号
+ yield rjcode, root_path
+ elif _depth < self.__max_depth:
+ dir_list = os.listdir(root_path)
+ for folder in dir_list:
+ folder_path = os.path.join(root_path, folder)
+ yield from self.scan(folder_path, _depth + 1)
diff --git a/scraper/__init__.py b/scraper/__init__.py
new file mode 100644
index 0000000..0ed8e6c
--- /dev/null
+++ b/scraper/__init__.py
@@ -0,0 +1,5 @@
+from scraper.cached_scraper import CachedScraper
+from scraper.dlsite import Dlsite
+from scraper.locale import Locale
+from scraper.scraper import Scraper
+from scraper.work_metadata import WorkMetadata
diff --git a/scraper/cached_scraper.py b/scraper/cached_scraper.py
new file mode 100644
index 0000000..d1d9229
--- /dev/null
+++ b/scraper/cached_scraper.py
@@ -0,0 +1,29 @@
+import json
+
+from scraper.db import db, WorkMetadataCache
+from scraper.locale import Locale
+from scraper.scraper import Scraper
+from scraper.work_metadata import WorkMetadata
+
+
+class CachedScraper(Scraper):
+ def __init__(self, locale: Locale, proxies=None, connect_timeout: int = 10, read_timeout: int = 10, sleep_interval=3):
+ super().__init__(locale, proxies, connect_timeout, read_timeout, sleep_interval)
+ db.connect()
+ db.create_tables([WorkMetadataCache])
+
+ def __del__(self):
+ db.close()
+
+ def scrape_metadata(self, rjcode: str):
+ # 在数据库中查找
+ metadata_cache = WorkMetadataCache.get_or_none(WorkMetadataCache.rjcode == rjcode)
+ if metadata_cache:
+ # 已缓存,返回数据库中缓存的 metadata
+ metadata: WorkMetadata = json.loads(metadata_cache.metadata)
+ return metadata
+ else:
+ # 未缓存,从 scraper 抓取 metadata 并缓存到数据库
+ metadata = super().scrape_metadata(rjcode)
+ WorkMetadataCache.create(rjcode=rjcode, metadata=json.dumps(metadata, indent=2, ensure_ascii=False))
+ return metadata
diff --git a/scraper/db.py b/scraper/db.py
new file mode 100644
index 0000000..f2c27e0
--- /dev/null
+++ b/scraper/db.py
@@ -0,0 +1,11 @@
+from peewee import *
+
+db = SqliteDatabase('cache.db')
+
+
+class WorkMetadataCache(Model):
+ rjcode = CharField(primary_key=True)
+ metadata = TextField()
+
+ class Meta:
+ database = db # This model uses the "work_metadata_cache.db" database.
diff --git a/scraper/dlsite.py b/scraper/dlsite.py
new file mode 100644
index 0000000..4b79fca
--- /dev/null
+++ b/scraper/dlsite.py
@@ -0,0 +1,54 @@
+import re
+from typing import Final
+from urllib.parse import unquote
+
+from scraper.locale import Locale
+from scraper.langs import EN_US, JA_JP, KO_KR, ZH_CN, ZH_TW
+from scraper.translation import Translation
+
+
+# 读取翻译文件
+def _load_translations():
+ translations: dict[Locale, Translation] = {
+ Locale.en_us: EN_US,
+ Locale.ja_jp: JA_JP,
+ Locale.ko_kr: KO_KR,
+ Locale.zh_cn: ZH_CN,
+ Locale.zh_tw: ZH_TW,
+ }
+ return translations
+
+
+class Dlsite(object):
+ TRANSLATIONS: Final = _load_translations()
+ RJCODE_PATTERN: Final = re.compile(r'RJ(\d{6})(?!\d+)')
+ RGCODE_PATTERN: Final = re.compile(r'RG(\d{5})(?!\d+)')
+ SRICODE_PATTERN: Final = re.compile(r'SRI(\d{10})(?!\d+)')
+
+ # 提取字符串中的 rjcode
+ @staticmethod
+ def parse_rjcode(string: str):
+ match = Dlsite.RJCODE_PATTERN.search(string.upper())
+ if match:
+ return match.group()
+ else:
+ return None
+
+ # 根据 rjcode 拼接出同人作品页面的 url
+ @staticmethod
+ def compile_work_page_url(rjcode: str):
+ return f'https://www.dlsite.com/maniax/work/=/product_id/{rjcode}.html'
+
+ # 解析 scraper 链接中携带的参数 (scraper 服务端使用 mod_rewrite 优化 SEO)
+ @staticmethod
+ def parse_url_params(url: str):
+ url = unquote(url)
+ split_url = url.split(r'/=/', 1)
+ params_str = split_url[1] if len(split_url) == 2 else ''
+ params_str_1 = re.sub(r'\?.*$', '', params_str, count=1)
+ params_str_2 = re.sub(r'(\.html)?/?$', '', params_str_1) # 去除 url 的 .html/ 后缀
+ params_list = params_str_2.split('/')
+ params = {}
+ for i in range(0, len(params_list), 2):
+ params[params_list[i]] = params_list[i + 1] if i + 1 < len(params_list) else ''
+ return params
diff --git a/scraper/langs/__init__.py b/scraper/langs/__init__.py
new file mode 100644
index 0000000..8330f45
--- /dev/null
+++ b/scraper/langs/__init__.py
@@ -0,0 +1,5 @@
+from scraper.langs.en_us import EN_US
+from scraper.langs.ja_jp import JA_JP
+from scraper.langs.ko_kr import KO_KR
+from scraper.langs.zh_cn import ZH_CN
+from scraper.langs.zh_tw import ZH_TW
diff --git a/scraper/langs/en_us.py b/scraper/langs/en_us.py
new file mode 100644
index 0000000..13da2e8
--- /dev/null
+++ b/scraper/langs/en_us.py
@@ -0,0 +1,13 @@
+EN_US = {
+ "AGE": "Age",
+ "GENRE": "Genre",
+ "RELEASE_DATE": "Release date",
+ "SERIES_NAME": "Series name",
+ "PRODUCT_FORMAT": "Product format",
+ "EVENT": "Event",
+ "AUTHOR": "Author",
+ "SCENARIO": "Scenario",
+ "ILLUSTRATION": "Illustration",
+ "MUSIC": "Music",
+ "VOICE_ACTOR": "Voice Actor"
+}
diff --git a/scraper/langs/ja_jp.py b/scraper/langs/ja_jp.py
new file mode 100644
index 0000000..038ab55
--- /dev/null
+++ b/scraper/langs/ja_jp.py
@@ -0,0 +1,13 @@
+JA_JP = {
+ "AGE": "年齢指定",
+ "GENRE": "ジャンル",
+ "RELEASE_DATE": "販売日",
+ "SERIES_NAME": "シリーズ名",
+ "PRODUCT_FORMAT": "作品形式",
+ "EVENT": "イベント",
+ "AUTHOR": "作者",
+ "SCENARIO": "シナリオ",
+ "ILLUSTRATION": "イラスト",
+ "MUSIC": "音楽",
+ "VOICE_ACTOR": "声優"
+}
diff --git a/scraper/langs/ko_kr.py b/scraper/langs/ko_kr.py
new file mode 100644
index 0000000..9beacf9
--- /dev/null
+++ b/scraper/langs/ko_kr.py
@@ -0,0 +1,13 @@
+KO_KR = {
+ "AGE": "연령 지정",
+ "GENRE": "장르",
+ "RELEASE_DATE": "판매일",
+ "SERIES_NAME": "시리즈명",
+ "PRODUCT_FORMAT": "작품 형식",
+ "EVENT": "이벤트",
+ "AUTHOR": "저자",
+ "SCENARIO": "시나리오",
+ "ILLUSTRATION": "일러스트",
+ "MUSIC": "음악",
+ "VOICE_ACTOR": "성우"
+}
diff --git a/scraper/langs/zh_cn.py b/scraper/langs/zh_cn.py
new file mode 100644
index 0000000..c5510f9
--- /dev/null
+++ b/scraper/langs/zh_cn.py
@@ -0,0 +1,13 @@
+ZH_CN = {
+ "AGE": "年龄指定",
+ "GENRE": "分类",
+ "RELEASE_DATE": "贩卖日",
+ "SERIES_NAME": "系列名",
+ "PRODUCT_FORMAT": "作品类型",
+ "EVENT": "活动",
+ "AUTHOR": "作者",
+ "SCENARIO": "剧情",
+ "ILLUSTRATION": "插画",
+ "MUSIC": "音乐",
+ "VOICE_ACTOR": "声优"
+}
diff --git a/scraper/langs/zh_tw.py b/scraper/langs/zh_tw.py
new file mode 100644
index 0000000..3cfa1d8
--- /dev/null
+++ b/scraper/langs/zh_tw.py
@@ -0,0 +1,13 @@
+ZH_TW = {
+ "AGE": "年齡指定",
+ "GENRE": "分類",
+ "RELEASE_DATE": "販賣日",
+ "SERIES_NAME": "系列名",
+ "PRODUCT_FORMAT": "作品形式",
+ "EVENT": "活動",
+ "AUTHOR": "作者",
+ "SCENARIO": "劇本",
+ "ILLUSTRATION": "插畫",
+ "MUSIC": "音樂",
+ "VOICE_ACTOR": "聲優"
+}
diff --git a/scraper/locale.py b/scraper/locale.py
new file mode 100644
index 0000000..0135137
--- /dev/null
+++ b/scraper/locale.py
@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+# 枚举类 - scraper 支持的语言
+class Locale(Enum):
+ en_us = 'en_us'
+ ja_jp = 'ja_jp'
+ ko_kr = 'ko_kr'
+ zh_cn = 'zh_cn'
+ zh_tw = 'zh_tw'
diff --git a/scraper/scraper.py b/scraper/scraper.py
new file mode 100644
index 0000000..491ae24
--- /dev/null
+++ b/scraper/scraper.py
@@ -0,0 +1,140 @@
+import re
+import time
+from urllib.request import getproxies
+
+import requests
+from pyquery import PyQuery as pq
+
+from scraper.dlsite import Dlsite
+from scraper.locale import Locale
+from scraper.work_metadata import WorkMetadata
+
+
+def _getproxies():
+ """
+ 获取系统代理
+ """
+ proxies = getproxies()
+ # https://github.com/psf/requests/issues/5943
+ https_proxy = proxies.get('https', None)
+ http_proxy = proxies.get('http', None)
+ if https_proxy and https_proxy.startswith(r'https://'):
+ proxies['https'] = http_proxy
+ return proxies
+
+
+class Scraper(object):
+ def __init__(self, locale: Locale, proxies=None, connect_timeout: int = 10, read_timeout: int = 10, sleep_interval=3):
+ self.__locale = locale
+ self.__connect_timeout = connect_timeout
+ self.__read_timeout = read_timeout
+ self.__sleep_interval = sleep_interval
+ if not proxies:
+ # 获取系统代理
+ proxies = _getproxies()
+ self.__proxies = proxies
+
+ def __request_work_page(self, rjcode: str):
+ url = Dlsite.compile_work_page_url(rjcode)
+ params = {'locale': self.__locale.name}
+ response = requests.get(url,
+ params,
+ timeout=(self.__connect_timeout, self.__read_timeout),
+ proxies=self.__proxies)
+ response.raise_for_status() # 如果返回了不成功的状态码,Response.raise_for_status() 会抛出一个 HTTPError 异常
+ html = response.text
+ time.sleep(self.__sleep_interval)
+ return html
+
+ def __parse_metadata(self, html: str, rjcode: str):
+ d = pq(html)
+ metadata: WorkMetadata = {
+ 'rjcode': rjcode,
+ 'work_name': '',
+ 'maker_id': '',
+ 'maker_name': '',
+ 'release_date': '',
+ 'series_name': '',
+ 'series_id': '',
+ 'age_category': '',
+ 'tags': [],
+ 'cvs': []
+ }
+
+ # parse work_name
+ work_name = d('#work_name').text()
+ metadata['work_name'] = work_name
+
+ # parse maker_name
+ maker_anchor_element = d('span.maker_name > a')
+ maker_name = maker_anchor_element.text()
+ metadata['maker_name'] = maker_name
+
+ # parse maker_id
+ maker_url = maker_anchor_element.attr('href')
+ maker_id = Dlsite.parse_url_params(maker_url).get('maker_id', '')
+ if Dlsite.RGCODE_PATTERN.fullmatch(maker_id):
+ metadata['maker_id'] = maker_id
+
+ translation = Dlsite.TRANSLATIONS[self.__locale]
+ table_rows = d('#work_outline > tr').items()
+ for table_row in table_rows:
+ table_header: str = table_row.children('th').text()
+ table_data = table_row.children('td')
+ # parse release_date
+ if table_header == translation['RELEASE_DATE']:
+ release_url = table_data.children('a').attr('href')
+ if release_url is not None:
+ parse_result = Dlsite.parse_url_params(release_url)
+ year = parse_result.get('year', '')
+ mon = parse_result.get('mon', '')
+ day = parse_result.get('day', '')
+ if year and mon and day:
+ release_date = f'{year}-{mon}-{day}'
+ metadata['release_date'] = release_date
+ # parse series_id & series_name
+ elif table_header == translation['SERIES_NAME']:
+ series_anchor_element = table_data.children('a')
+ series_name = series_anchor_element.text()
+ series_url = series_anchor_element.attr('href')
+ metadata['series_name'] = series_name
+ keyword_work_name = Dlsite.parse_url_params(series_url).get('keyword_work_name', '')
+ split_keyword_work_name = keyword_work_name.split('+')
+ if len(split_keyword_work_name) == 2:
+ series_id = split_keyword_work_name[1]
+ if Dlsite.SRICODE_PATTERN.fullmatch(series_id):
+ metadata['series_id'] = series_id
+ # parse age_category
+ elif table_header == translation['AGE']:
+ age_icon_element = table_data.find('span')
+ age_icon_name = age_icon_element.attr('class')
+ if re.fullmatch(r'icon_(GEN|R15|ADL)', age_icon_name):
+ if age_icon_name == 'icon_GEN':
+ metadata['age_category'] = 'GEN'
+ elif age_icon_name == 'icon_R15':
+ metadata['age_category'] = 'R15'
+ else:
+ metadata['age_category'] = 'ADL'
+ # parse tags
+ elif table_header == translation['GENRE']:
+ genre_anchor_elements = table_data.children('div.main_genre').children('a').items()
+ for genre_anchor_element in genre_anchor_elements:
+ genre_name = genre_anchor_element.text()
+ if genre_name:
+ metadata['tags'].append(genre_name)
+ # parse cvs
+ elif table_header == translation['VOICE_ACTOR']:
+ cv_anchor_elements = table_data.children('a').items()
+ for cv_anchor_element in cv_anchor_elements:
+ cv_name = cv_anchor_element.text()
+ if cv_name:
+ metadata['cvs'].append(cv_name)
+ return metadata
+
+ def scrape_metadata(self, rjcode: str):
+ rjcode = rjcode.upper()
+ if not Dlsite.RJCODE_PATTERN.fullmatch(rjcode):
+ raise ValueError
+ html = self.__request_work_page(rjcode)
+ metadata = self.__parse_metadata(html, rjcode)
+ return metadata
diff --git a/scraper/translation.py b/scraper/translation.py
new file mode 100644
index 0000000..89576be
--- /dev/null
+++ b/scraper/translation.py
@@ -0,0 +1,16 @@
+from typing import TypedDict
+
+
+# 同人作品页面翻译
+class Translation(TypedDict):
+ AGE: str # 年龄指定
+ GENRE: str # 分类
+ RELEASE_DATE: str # 贩卖日
+ SERIES_NAME: str # 系列名
+ PRODUCT_FORMAT: str # 作品类型
+ EVENT: str # 活动
+ AUTHOR: str # 作者
+ SCENARIO: str # 剧情
+ ILLUSTRATION: str # 插画
+ MUSIC: str # 音乐
+ VOICE_ACTOR: str # 声优
diff --git a/scraper/work_metadata.py b/scraper/work_metadata.py
new file mode 100644
index 0000000..80e549c
--- /dev/null
+++ b/scraper/work_metadata.py
@@ -0,0 +1,15 @@
+from typing import TypedDict
+
+
+# 同人作品元数据
+class WorkMetadata(TypedDict):
+ rjcode: str
+ work_name: str
+ maker_id: str
+ maker_name: str
+ release_date: str
+ series_id: str
+ series_name: str
+ age_category: str
+ tags: list[str]
+ cvs: list[str]
diff --git a/wx_log_handler.py b/wx_log_handler.py
new file mode 100644
index 0000000..1598299
--- /dev/null
+++ b/wx_log_handler.py
@@ -0,0 +1,41 @@
+import logging
+
+import wx
+import wx.lib.newevent
+
+# create event type
+wxLogEvent, EVT_WX_LOG_EVENT = wx.lib.newevent.NewEvent()
+
+
+class WxLogHandler(logging.Handler):
+ """
+ A handler class which sends log strings to a wx object
+ https://stackoverflow.com/a/2820928
+ """
+
+ def __init__(self, wx_dest: wx.Window):
+ """
+ Initialize the handler
+ @param wx_dest: the destination object to post the event to
+ """
+ logging.Handler.__init__(self)
+ self.__wxDest = wx_dest
+ self.level = logging.DEBUG
+
+ def flush(self):
+ """
+ does nothing for this handler
+ """
+
+ def emit(self, record):
+ """
+ Emit a record.
+ """
+ try:
+ msg = self.format(record)
+ evt = wxLogEvent(message=msg, levelno=record.levelno)
+ wx.PostEvent(self.__wxDest, evt)
+ except (KeyboardInterrupt, SystemExit) as err:
+ raise err
+ except Exception:
+ self.handleError(record)