doc: 加入字幕相关文档

.github/workflows/docker-image-debug.yml

@@ -0,0 +1,29 @@
+name: Docker Image CI (DEBUG)
+
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            -
+                name: Checkout
+                uses: actions/checkout@v3
+            -
+                name: Login to DockerHub
+                uses: docker/login-action@v3
+                with:
+                    username: ${{ secrets.DOCKERHUB_USERNAME }}
+                    password: ${{ secrets.DOCKERHUB_TOKEN }}
+            -
+                name: Build and push images
+                uses: docker/build-push-action@v5
+                with:
+                    context: .
+                    file: ./Dockerfile
+                    push: true
+                    tags: |
+                        ${{ secrets.DOCKERHUB_USERNAME }}/bili-sync:debug

.github/workflows/docker-image.yml

@@ -19,7 +19,7 @@ jobs:
                     username: ${{ secrets.DOCKERHUB_USERNAME }}
                     password: ${{ secrets.DOCKERHUB_TOKEN }}
             -
-                name: Build and push
+                name: Build and push images
                 uses: docker/build-push-action@v5
                 with:
                     context: .
@@ -27,4 +27,11 @@ jobs:
                     push: true
                     tags: |
                         ${{ secrets.DOCKERHUB_USERNAME }}/bili-sync:${{ github.ref_name }}
-                        ${{ secrets.DOCKERHUB_USERNAME }}/bili-sync:latest
+                        ${{ secrets.DOCKERHUB_USERNAME }}/bili-sync:latest
+            -
+                name: Update DockerHub description
+                uses: peter-evans/dockerhub-description@v3
+                with:
+                    username: ${{ secrets.DOCKERHUB_USERNAME }}
+                    password: ${{ secrets.DOCKERHUB_TOKEN }}
+                    repository: ${{ secrets.DOCKERHUB_USERNAME }}/bili-sync

.gitignore

@@ -4,7 +4,7 @@ debug.py
 videos
 config.test.json
 database.test.db*
-example.json
+example*.json
 thumbs.test
 config
 data

LICENSE

@@ -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>.

Makefile

@@ -1,4 +1,4 @@
-.PHONY: install fmt start-daemon start-once
+.PHONY: install fmt start-daemon start-once db-init db-migrate db-upgrade sync-conf
 
 install:
 	@echo "Installing dependencies..."
@@ -22,4 +22,10 @@ db-migrate:
 	@poetry run aerich migrate
 
 db-upgrade:
-	@poetry run aerich upgrade
+	@poetry run aerich upgrade
+
+sync-conf:
+	@echo "Syncing config..."
+	@cp ${CONFIG_SRC} ./config/
+	@cp ${DB_SRC} ./data/
+	@echo "Done."

README.md

@@ -1,11 +1,15 @@
-# bili-sync
+![bili-sync](https://socialify.git.ci/amtoaer/bili-sync/image?description=1&font=KoHo&issues=1&language=1&logo=https%3A%2F%2Fs2.loli.net%2F2023%2F12%2F02%2F9EwT2yInOu1d3zm.png&name=1&owner=1&pattern=Signal&pulls=1&stargazers=1&theme=Light)
 
-为 NAS 用户编写的 BILIBILI 收藏夹同步工具。
+## 简介
+
+为 NAS 用户编写的 BILIBILI 收藏夹同步工具，可方便导入 EMBY 等媒体库工具浏览。
 
 > 经常在点进自己的收藏夹时看到一大堆失效视频，简直逼死强迫症。想到自己 NAS 还有多余的 20T 存储空间，于是简单写了一个小工具用来实时把收藏夹内容同步下载到 NAS 上。
 > ![](asset/space.png)
 
-骄傲地由 python 驱动！（第三方库是真多啊）
+骄傲地由 python 驱动！
+
+~~之前基本没有用过 python 的 asyncio，拿这个小工具练练手！（不是~~
 
 ## 工作截图
 
@@ -13,6 +17,113 @@
 
 ![EMBY 识别](asset/emby.png)
 
+## 配置文件
+
+对于配置文件的前五项，请参考[凭据获取流程](https://nemo2011.github.io/bilibili-api/#/get-credential)。
+
+```python
+@dataclass
+class SubtitleConfig(DataClassJsonMixin):
+    font_name: str = "微软雅黑，黑体"  # 字体
+    font_size: float = 40  # 字号
+    alpha: float = 0.8  # 透明度
+    fly_time: float = 5  # 滚动弹幕持续时间
+    static_time: float = 10  # 静态弹幕持续时间
+
+class Config(DataClassJsonMixin):
+    sessdata: str = ""
+    bili_jct: str = ""
+    buvid3: str = ""
+    dedeuserid: str = ""
+    ac_time_value: str = ""
+    interval: int = 20    # 任务执行的间隔时间
+    path_mapper: dict[int, str] = field(default_factory=dict)  # 收藏夹的 id 到存储目录的映射
+    subtitle: SubtitleConfig = field(default_factory=SubtitleConfig)  # 字幕相关设置
+```
+
+程序默认会将配置文件存储于 `${程序路径}/config/config.json`，数据库文件存储于 `${程序路径}/data/data.db`，如果发现不存在则新建并写入初始配置。
+
+配置文件加载时会校验内容是否为空，对于默认的空配置，校验将会报错，程序将会终止运行。
+
+即：我们可以通过运行一次程序，等程序写入初始配置并提示配置错误终止后编辑 `config.json` 文件，编辑后即可重新运行。
+
+
+## Docker 运行示例
+
+docker compose 文件：
+```yaml
+services:
+  bili-sync:
+    image: amtoaer/bili-sync:latest
+    user: 1000:1000  # 此处可以指定以哪个用户的权限运行，不填写的话默认 root，推荐填写。
+    tty: true  # 加上这一行可以让日志变成彩色
+    volumes:
+      - /home/amtoaer/Videos/Bilibilis/:/Videos/Bilibilis/  # 视频文件
+      - /home/amtoaer/.config/nas/bili-sync/config/:/app/config/  # 配置文件
+      - /home/amtoaer/.config/nas/bili-sync/data/:/app/data/  # 数据库
+      # 注：如需在 emby 内查看 up 主头像，需要将 emby 的 metadata/people/ 配置目录挂载至容器的 /app/thumb/
+      - /home/amtoaer/.config/nas/emby/metadata/people/:/app/thumb/
+    environment:
+      - TZ=Asia/Shanghai
+    restart: always
+    network_mode: bridge
+    hostname: bili-sync
+    container_name: bili-sync
+    logging:
+      driver: "local"
+```
+
+对应的配置文件：
+
+```json
+{
+    "sessdata": "xxxxxxxxxxxxxxxxxx",
+    "bili_jct": "xxxxxxxxxxxxxxxxxx",
+    "buvid3": "xxxxxxxxxxxxxxxxxx",
+    "dedeuserid": "xxxxxxxxxxxxxxxxxx",
+    "ac_time_value": "xxxxxxxxxxxxxxxxxx",
+    "interval": 20,
+    "path_mapper": {
+        "711322958": "/Videos/Bilibilis/Bilibili-711322958/"
+    },
+    "subtitle": {
+        "font_name": "微软雅黑，黑体",
+        "font_size": 40.0,
+        "alpha": 0.8,
+        "fly_time": 5.0,
+        "static_time": 10.0
+    }
+}
+```
+
+## 支持的额外命令
+
+为满足需要，该应用包含几个单独的命令，可在程序目录下使用 `python entry.py ${command name}` 运行。
+
+1. `once`
+
+    处理收藏夹，和一般定时任务触发时执行的操作完全相同，但仅运行一次。
+2. `recheck` 
+
+    将本地不存在的视频文件标记成未下载，下次定时任务触发时将一并下载。
+3. `refresh_refresh_poster`
+
+    更新本地视频的封面。
+3. `refresh_upper`
+
+    更新本地up的头像和元数据。
+3. `refresh_nfo`
+
+    更新本地视频的元数据。（如标签、标题等信息）
+3. `refresh_video`
+
+    更新本地的视频源文件。
+3. `refresh_subtitle`
+
+    更新本地的弹幕文件。
+
+**对于以 refresh 开头的命令，均支持 --force 参数，如果有 --force 参数，将全量覆盖对应内容，否则默认仅更新缺失的部分。**
+
 ## 路线图
 
 - [x] 凭证认证
@@ -23,4 +134,4 @@
 - [x] 构建 nfo 和 poster 文件，方便以单集形式导入 emby
 - [x] 支持收藏夹翻页，下载全部历史视频
 - [x] 对接数据库，提前检查，按需下载
-- [ ] 提供简单易用的打包（如 docker）
+- [x] 提供简单易用的打包（如 docker）

commands.py

@@ -0,0 +1,101 @@
+import asyncio
+import functools
+from pathlib import Path
+from typing import Callable
+
+from loguru import logger
+
+from constants import MediaStatus, MediaType
+from models import FavoriteItem
+from processor import process_favorite_item
+from utils import aexists, aremove
+
+
+async def recheck():
+    """刷新数据库中视频的状态，如果发现文件不存在则标记未下载，以便在下次任务重新下载，在自己手动删除文件后调用"""
+    items = await FavoriteItem.filter(
+        type=MediaType.VIDEO,
+        status=MediaStatus.NORMAL,
+        downloaded=True,
+    )
+    exists = await asyncio.gather(*[aexists(item.video_path) for item in items])
+    for item, exist in zip(items, exists):
+        if isinstance(exist, Exception):
+            logger.error(
+                "Error when checking file {} {}: {}",
+                item.bvid,
+                item.name,
+                exist,
+            )
+            continue
+        if not exist:
+            logger.info(
+                "File {} {} not exists, mark as not downloaded.",
+                item.bvid,
+                item.name,
+            )
+            item.downloaded = False
+    logger.info("Updating database...")
+    await FavoriteItem.bulk_update(items, fields=["downloaded"])
+    logger.info("Database updated.")
+
+
+async def _refresh_favorite_item_info(
+    path_getter: Callable[[FavoriteItem], list[Path]],
+    process_poster: bool = False,
+    process_video: bool = False,
+    process_nfo: bool = False,
+    process_upper: bool = False,
+    process_subtitle: bool = False,
+    force: bool = False,
+):
+    items = await FavoriteItem.filter(downloaded=True).prefetch_related("upper")
+    if force:
+        # 如果强制刷新，那么就先把现存的所有内容删除
+        await asyncio.gather(
+            *[aremove(path) for item in items for path in path_getter(item)],
+            return_exceptions=True,
+        )
+    await asyncio.gather(
+        *[
+            process_favorite_item(
+                item,
+                process_poster=process_poster,
+                process_video=process_video,
+                process_nfo=process_nfo,
+                process_upper=process_upper,
+                process_subtitle=process_subtitle,
+            )
+            for item in items
+        ],
+        return_exceptions=True,
+    )
+
+
+refresh_nfo = functools.partial(
+    _refresh_favorite_item_info, lambda item: [item.nfo_path], process_nfo=True
+)
+
+refresh_poster = functools.partial(
+    _refresh_favorite_item_info,
+    lambda item: [item.poster_path],
+    process_poster=True,
+)
+
+refresh_video = functools.partial(
+    _refresh_favorite_item_info,
+    lambda item: [item.video_path],
+    process_video=True,
+)
+
+refresh_upper = functools.partial(
+    _refresh_favorite_item_info,
+    lambda item: item.upper_path,
+    process_upper=True,
+)
+
+refresh_subtitle = functools.partial(
+    _refresh_favorite_item_info,
+    lambda item: [item.subtitle_path],
+    process_subtitle=True,
+)

entry.py

@@ -4,6 +4,14 @@ import sys
 import uvloop
 from loguru import logger
 
+from commands import (
+    recheck,
+    refresh_nfo,
+    refresh_poster,
+    refresh_subtitle,
+    refresh_upper,
+    refresh_video,
+)
 from models import init_model
 from processor import cleanup, process
 from settings import settings
@@ -13,11 +21,23 @@ asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
 
 async def entry() -> None:
     await init_model()
-    if any("once" in _ for _ in sys.argv):
+    force = any("force" in _ for _ in sys.argv)
-        # 单次运行
+    for command, func in (
-        logger.info("Running once...")
+        ("once", process),
-        await process()
+        ("recheck", recheck),
-        return
+        ("refresh_poster", refresh_poster),
+        ("refresh_upper", refresh_upper),
+        ("refresh_nfo", refresh_nfo),
+        ("refresh_video", refresh_video),
+        ("refresh_subtitle", refresh_subtitle),
+    ):
+        if any(command in _ for _ in sys.argv):
+            logger.info("Running {}...", command)
+            if command.startswith("refresh"):
+                await func(force=force)
+            else:
+                await func()
+            return
     logger.info("Running daemon...")
     while True:
         await process()

migrations/models/2_20231204003326_update.py

@@ -0,0 +1,11 @@
+from tortoise import BaseDBAsyncClient
+
+
+async def upgrade(db: BaseDBAsyncClient) -> str:
+    return """
+        ALTER TABLE "favoriteitem" ADD "tags" JSON;"""
+
+
+async def downgrade(db: BaseDBAsyncClient) -> str:
+    return """
+        ALTER TABLE "favoriteitem" DROP COLUMN "tags";"""

models.py

@@ -13,6 +13,7 @@ from constants import (
     MediaType,
 )
 from settings import settings
+from utils import aopen
 
 
 class FavoriteList(Model):
@@ -39,7 +40,31 @@ class Upper(Model):
 
     @property
     def thumb_path(self) -> Path:
-        return DEFAULT_THUMB_PATH / f"{self.mid}.jpg"
+        return (
+            DEFAULT_THUMB_PATH / str(self.mid)[0] / f"{self.mid}" / "folder.jpg"
+        )
+
+    @property
+    def meta_path(self) -> Path:
+        return (
+            DEFAULT_THUMB_PATH / str(self.mid)[0] / f"{self.mid}" / "person.nfo"
+        )
+
+    async def save_metadata(self):
+        async with aopen(self.meta_path, "w") as f:
+            await f.write(
+                f"""
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<person>
+  <plot />
+  <outline />
+  <lockdata>false</lockdata>
+  <dateadded>{self.created_at.strftime("%Y-%m-%d %H:%M:%S")}</dateadded>
+  <title>{self.mid}</title>
+  <sorttitle>{self.mid}</sorttitle>
+</person>
+""".strip()
+            )
 
 
 class FavoriteItem(Model):
@@ -54,6 +79,7 @@ class FavoriteItem(Model):
     bvid = fields.CharField(max_length=255)
     desc = fields.TextField()
     cover = fields.TextField()
+    tags = fields.JSONField(null=True)
     favorite_list = fields.ForeignKeyField(
         "models.FavoriteList", related_name="items"
     )
@@ -107,6 +133,20 @@ class FavoriteItem(Model):
             / f"{self.bvid}-poster.jpg"
         )
 
+    @property
+    def upper_path(self) -> list[Path]:
+        return [
+            self.upper.thumb_path,
+            self.upper.meta_path,
+        ]
+
+    @property
+    def subtitle_path(self) -> Path:
+        return (
+            Path(settings.path_mapper[self.favorite_list_id])
+            / f"{self.bvid}.zh-CN.default.ass"
+        )
+
 
 async def init_model() -> None:
     await Tortoise.init(config=TORTOISE_ORM)

nfo.py

@@ -2,19 +2,19 @@ import datetime
 from dataclasses import dataclass
 from pathlib import Path
 
+from utils import aopen
+
 
 @dataclass
 class Actor:
     name: str
     role: str
-    thumb: Path
 
     def to_xml(self) -> str:
         return f"""
     <actor>
         <name>{self.name}</name>
         <role>{self.role}</role>
-        <thumb>{self.thumb.resolve()}</thumb>
     </actor>
 """.strip(
             "\n"
@@ -25,16 +25,22 @@ class Actor:
 class EpisodeInfo:
     title: str
     plot: str
+    tags: list[str]
     actor: list[Actor]
     bvid: str
     aired: datetime.datetime
 
-    def write_nfo(self, path: Path) -> None:
+    async def write_nfo(self, path: Path) -> None:
-        with path.open("w", encoding="utf-8") as f:
+        async with aopen(path, "w", encoding="utf-8") as f:
-            f.write(self.to_xml())
+            await f.write(self.to_xml())
 
     def to_xml(self) -> str:
         actor = "\n".join(_.to_xml() for _ in self.actor)
+        tags = (
+            "\n".join(f"    <genre>{_}</genre>" for _ in self.tags)
+            if isinstance(self.tags, list)
+            else ""
+        )
         return f"""
 <?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <episodedetails>
@@ -43,6 +49,7 @@ class EpisodeInfo:
     <title>{self.title}</title>
 {actor}
     <year>{self.aired.year}</year>
+{tags}
     <uniqueid type="bilibili">{self.bvid}</uniqueid>
     <aired>{self.aired.strftime("%Y-%m-%d")}</aired>
 </episodedetails>

poetry.lock

@@ -1,4 +1,4 @@
-# This file is automatically @generated by Poetry 1.7.0 and should not be changed by hand.
+# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand.
 
 [[package]]
 name = "aerich"
@@ -301,7 +301,7 @@ pillow = ">=10.1.0,<10.2.0"
 pycryptodomex = ">=3.19.0,<3.20.0"
 pyyaml = ">=6.0,<7.0"
 qrcode = ">=7.4.2,<7.5.0"
-qrcode-terminal = ">=0.8,<1.0"
+qrcode_terminal = ">=0.8,<1.0"
 requests = ">=2.31.0,<2.32.0"
 rsa = ">=4.9,<5.0"
 tqdm = ">=4.66.1,<4.67.0"
@@ -311,7 +311,7 @@ yarl = ">=1.9.2,<1.10.0"
 type = "git"
 url = "https://github.com/amtoaer/bilibili-api.git"
 reference = "dev"
-resolved_reference = "30db504b410787bdc8a5cd1ff63bacf6b365f393"
+resolved_reference = "0281d7c58e8a26706cefc96e7e427cb05a26d866"
 
 [[package]]
 name = "black"

processor.py

@@ -2,29 +2,25 @@ import asyncio
 import datetime
 from asyncio import Semaphore, create_subprocess_exec
 from asyncio.subprocess import DEVNULL
-from pathlib import Path
 
-import aiofiles
+from bilibili_api import ass, favorite_list, video
-import httpx
-from bilibili_api import HEADERS, favorite_list, video
 from bilibili_api.exceptions import ResponseCodeException
 from loguru import logger
-from tortoise import Tortoise
+from tortoise.connection import connections
 
 from constants import FFMPEG_COMMAND, MediaStatus, MediaType
 from credential import credential
 from models import FavoriteItem, FavoriteList, Upper
 from nfo import Actor, EpisodeInfo
 from settings import settings
+from utils import aexists, amakedirs, client, download_content
 
-anchor = datetime.datetime.today()
+anchor = datetime.date.today()
-
-client = httpx.AsyncClient(headers=HEADERS)
 
 
 async def cleanup() -> None:
     await client.aclose()
-    await Tortoise.close_connections()
+    await connections.close_all()
 
 
 def concurrent_decorator(concurrency: int) -> callable:
@@ -40,16 +36,6 @@ def concurrent_decorator(concurrency: int) -> callable:
     return decorator
 
 
-async def download_content(url: str, path: Path) -> None:
-    async with client.stream("GET", url) as resp, aiofiles.open(
-        path, "wb"
-    ) as f:
-        async for chunk in resp.aiter_bytes(40960):
-            if not chunk:
-                return
-            await f.write(chunk)
-
-
 async def manage_model(medias: list[dict], fav_list: FavoriteList) -> None:
     uppers = [
         Upper(
@@ -95,21 +81,17 @@ async def manage_model(medias: list[dict], fav_list: FavoriteList) -> None:
 
 async def process() -> None:
     global anchor
-    if (datetime.datetime.now() - anchor).days >= 3:
+    if (today := datetime.date.today()) > anchor:
-        # 暂定三天刷新一次凭据，具体看情况调整
+        anchor = today
-        try:
+        logger.info("Check credential.")
-            credential.refresh()
+        if await credential.check_refresh():
-            anchor = datetime.datetime.today()
+            try:
-            logger.info("Credential refreshed.")
+                await credential.refresh()
-        except Exception:
+                logger.info("Credential refreshed.")
-            logger.exception("Failed to refresh credential.")
+            except Exception:
-            return
+                logger.exception("Failed to refresh credential.")
-    for favorite_id in settings.favorite_ids:
+                return
-        if favorite_id not in settings.path_mapper:
+    for favorite_id in settings.path_mapper:
-            logger.warning(
-                f"Favorite {favorite_id} not in path mapper, ignored."
-            )
-            continue
         await process_favorite(favorite_id)
 
 
@@ -118,10 +100,11 @@ async def process_favorite(favorite_id: int) -> None:
     favorite_video_list = await favorite_list.get_video_favorite_list_content(
         favorite_id, page=1, credential=credential
     )
+    title = favorite_video_list["info"]["title"]
     logger.info(
         "Start to process favorite {}: {}",
         favorite_id,
-        favorite_video_list["info"]["title"],
+        title,
     )
     fav_list, _ = await FavoriteList.get_or_create(
         id=favorite_id, defaults={"name": favorite_video_list["info"]["title"]}
@@ -161,111 +144,226 @@ async def process_favorite(favorite_id: int) -> None:
         downloaded=False,
     ).prefetch_related("upper")
     await asyncio.gather(
-        *[process_video(item) for item in all_unprocessed_items],
+        *[process_favorite_item(item) for item in all_unprocessed_items],
         return_exceptions=True,
     )
+    logger.info("Favorite {} {} processed successfully.", favorite_id, title)
 
 
 @concurrent_decorator(4)
-async def process_video(fav_item: FavoriteItem) -> None:
+async def process_favorite_item(
+    fav_item: FavoriteItem,
+    process_poster=True,
+    process_video=True,
+    process_nfo=True,
+    process_upper=True,
+    process_subtitle=True,
+) -> None:
     logger.info("Start to process video {} {}", fav_item.bvid, fav_item.name)
     if fav_item.type != MediaType.VIDEO:
         logger.warning("Media {} is not a video, skipped.", fav_item.name)
         return
+    v = video.Video(fav_item.bvid, credential=credential)
+    # 如果没有获取过 tags，那么尝试获取一下
     try:
-        if fav_item.video_path.exists():
+        if fav_item.tags is None:
-            fav_item.downloaded = True
+            fav_item.tags = [_["tag_name"] for _ in await v.get_tags()]
-            await fav_item.save()
-            logger.info(
-                "{} {} already exists, skipped.", fav_item.bvid, fav_item.name
-            )
-            return
-        # 写入 up 主头像
-        if not fav_item.upper.thumb_path.exists():
-            await download_content(
-                fav_item.upper.thumb, fav_item.upper.thumb_path
-            )
-        # 写入 nfo
-        EpisodeInfo(
-            title=fav_item.name,
-            plot=fav_item.desc,
-            actor=[
-                Actor(
-                    name=fav_item.upper.mid,
-                    role=fav_item.upper.name,
-                    thumb=fav_item.upper.thumb_path,
-                )
-            ],
-            bvid=fav_item.bvid,
-            aired=fav_item.ctime,
-        ).write_nfo(fav_item.nfo_path)
-        # 写入 poster
-        await download_content(fav_item.cover, fav_item.poster_path)
-        # 开始处理视频内容
-        v = video.Video(fav_item.bvid, credential=credential)
-        detector = video.VideoDownloadURLDataDetecter(
-            await v.get_download_url(page_index=0)
-        )
-        streams = detector.detect_best_streams()
-        if detector.check_flv_stream():
-            await download_content(streams[0].url, fav_item.tmp_video_path)
-            process = await create_subprocess_exec(
-                FFMPEG_COMMAND,
-                "-i",
-                str(fav_item.tmp_video_path),
-                str(fav_item.video_path),
-                stdout=DEVNULL,
-                stderr=DEVNULL,
-            )
-            await process.communicate()
-            fav_item.tmp_video_path.unlink()
-        else:
-            await asyncio.gather(
-                download_content(streams[0].url, fav_item.tmp_video_path),
-                download_content(streams[1].url, fav_item.tmp_audio_path),
-            )
-            process = await create_subprocess_exec(
-                FFMPEG_COMMAND,
-                "-i",
-                str(fav_item.tmp_video_path),
-                "-i",
-                str(fav_item.tmp_audio_path),
-                "-c",
-                "copy",
-                str(fav_item.video_path),
-                stdout=DEVNULL,
-                stderr=DEVNULL,
-            )
-            await process.communicate()
-            fav_item.tmp_video_path.unlink()
-            fav_item.tmp_audio_path.unlink()
-        fav_item.downloaded = True
-        await fav_item.save()
-        logger.info(
-            "{} {} processed successfully.", fav_item.bvid, fav_item.name
-        )
-    except ResponseCodeException as e:
-        match e.code:
-            case 62002:
-                fav_item.status = MediaStatus.INVISIBLE
-            case -404:
-                fav_item.status = MediaStatus.DELETED
-            case _:
-                logger.exception(
-                    "Failed to process video {} {}, error_code: {}",
-                    fav_item.bvid,
-                    fav_item.name,
-                    e.code,
-                )
-                return
-        await fav_item.save()
-        logger.error(
-            "Video {} {} is not available, marked as {}",
-            fav_item.bvid,
-            fav_item.name,
-            fav_item.status.text,
-        )
     except Exception:
         logger.exception(
-            "Failed to process video {} {}", fav_item.bvid, fav_item.name
+            "Failed to get tags of video {} {}",
+            fav_item.bvid,
+            fav_item.name,
         )
+
+    if process_upper:
+        try:
+            if not all(
+                await asyncio.gather(
+                    aexists(fav_item.upper.thumb_path),
+                    aexists(fav_item.upper.meta_path),
+                )
+            ):
+                await amakedirs(fav_item.upper.thumb_path.parent, exist_ok=True)
+                await asyncio.gather(
+                    fav_item.upper.save_metadata(),
+                    download_content(
+                        fav_item.upper.thumb, fav_item.upper.thumb_path
+                    ),
+                    return_exceptions=True,
+                )
+            else:
+                logger.info(
+                    "Upper {} {} already exists, skipped.",
+                    fav_item.upper.mid,
+                    fav_item.upper.name,
+                )
+        except Exception:
+            logger.exception(
+                "Failed to process upper {} {}",
+                fav_item.upper.mid,
+                fav_item.upper.name,
+            )
+
+    if process_nfo:
+        try:
+            if not await aexists(fav_item.nfo_path):
+                await EpisodeInfo(
+                    title=fav_item.name,
+                    plot=fav_item.desc,
+                    actor=[
+                        Actor(
+                            name=fav_item.upper.mid,
+                            role=fav_item.upper.name,
+                        )
+                    ],
+                    tags=fav_item.tags,
+                    bvid=fav_item.bvid,
+                    aired=fav_item.ctime,
+                ).write_nfo(fav_item.nfo_path)
+            else:
+                logger.info(
+                    "NFO of {} {} already exists, skipped.",
+                    fav_item.bvid,
+                    fav_item.name,
+                )
+        except Exception:
+            logger.exception(
+                "Failed to process nfo of video {} {}",
+                fav_item.bvid,
+                fav_item.name,
+            )
+
+    if process_poster:
+        try:
+            if not await aexists(fav_item.poster_path):
+                try:
+                    await download_content(fav_item.cover, fav_item.poster_path)
+                except Exception:
+                    logger.exception(
+                        "Failed to download poster of video {} {}",
+                        fav_item.bvid,
+                        fav_item.name,
+                    )
+            else:
+                logger.info(
+                    "Poster of {} {} already exists, skipped.",
+                    fav_item.bvid,
+                    fav_item.name,
+                )
+        except Exception:
+            logger.exception(
+                "Failed to process poster of video {} {}",
+                fav_item.bvid,
+                fav_item.name,
+            )
+
+    if process_subtitle:
+        try:
+            if not await aexists(fav_item.subtitle_path):
+                await ass.make_ass_file_danmakus_protobuf(
+                    v,
+                    0,
+                    str(fav_item.subtitle_path.resolve()),
+                    credential=credential,
+                    font_name=settings.subtitle.font_name,
+                    font_size=settings.subtitle.font_size,
+                    alpha=settings.subtitle.alpha,
+                    fly_time=settings.subtitle.fly_time,
+                    static_time=settings.subtitle.static_time,
+                )
+            else:
+                logger.info(
+                    "Subtitle of {} {} already exists, skipped.",
+                    fav_item.bvid,
+                    fav_item.name,
+                )
+        except Exception:
+            logger.exception(
+                "Failed to process subtitle of video {} {}",
+                fav_item.bvid,
+                fav_item.name,
+            )
+    if process_video:
+        try:
+            if await aexists(fav_item.video_path):
+                fav_item.downloaded = True
+                logger.info(
+                    "Video {} {} already exists, skipped.",
+                    fav_item.bvid,
+                    fav_item.name,
+                )
+            else:
+                # 开始处理视频内容
+                detector = video.VideoDownloadURLDataDetecter(
+                    await v.get_download_url(page_index=0)
+                )
+                streams = detector.detect_best_streams()
+                if detector.check_flv_stream():
+                    await download_content(
+                        streams[0].url, fav_item.tmp_video_path
+                    )
+                    process = await create_subprocess_exec(
+                        FFMPEG_COMMAND,
+                        "-i",
+                        str(fav_item.tmp_video_path),
+                        str(fav_item.video_path),
+                        stdout=DEVNULL,
+                        stderr=DEVNULL,
+                    )
+                    await process.communicate()
+                    fav_item.tmp_video_path.unlink()
+                else:
+                    await asyncio.gather(
+                        download_content(
+                            streams[0].url, fav_item.tmp_video_path
+                        ),
+                        download_content(
+                            streams[1].url, fav_item.tmp_audio_path
+                        ),
+                    )
+                    process = await create_subprocess_exec(
+                        FFMPEG_COMMAND,
+                        "-i",
+                        str(fav_item.tmp_video_path),
+                        "-i",
+                        str(fav_item.tmp_audio_path),
+                        "-c",
+                        "copy",
+                        str(fav_item.video_path),
+                        stdout=DEVNULL,
+                        stderr=DEVNULL,
+                    )
+                    await process.communicate()
+                    fav_item.tmp_video_path.unlink()
+                    fav_item.tmp_audio_path.unlink()
+                fav_item.downloaded = True
+        except ResponseCodeException as e:
+            match e.code:
+                case 62002:
+                    fav_item.status = MediaStatus.INVISIBLE
+                case -404:
+                    fav_item.status = MediaStatus.DELETED
+                case _:
+                    logger.exception(
+                        "Failed to process video {} {}, error_code: {}",
+                        fav_item.bvid,
+                        fav_item.name,
+                        e.code,
+                    )
+            if fav_item.status != MediaStatus.NORMAL:
+                logger.error(
+                    "Video {} {} is not available, marked as {}",
+                    fav_item.bvid,
+                    fav_item.name,
+                    fav_item.status.text,
+                )
+        except Exception:
+            logger.exception(
+                "Failed to process video {} {}", fav_item.bvid, fav_item.name
+            )
+    await fav_item.save()
+    logger.info(
+        "{} {} is processed successfully.",
+        fav_item.bvid,
+        fav_item.name,
+    )

pyproject.toml

@@ -1,9 +1,9 @@
 [tool.poetry]
 name = "bili-sync"
-version = "1.0.0"
+version = "1.0.1"
 description = ""
 authors = ["amtoaer <amtoaer@gmail.com>"]
-license = "MIT"
+license = "GPL-3.0"
 readme = "README.md"
 
 [tool.poetry.dependencies]

settings.py

@@ -2,21 +2,34 @@ from dataclasses import dataclass, field, fields
 from pathlib import Path
 from typing import Self
 
-from dataclasses_json import DataClassJsonMixin
+from dataclasses_json import DataClassJsonMixin, Undefined
 
 from constants import DEFAULT_CONFIG_PATH
 
 
+@dataclass
+class SubtitleConfig(DataClassJsonMixin):
+    dataclass_json_config = {"undefined": Undefined.EXCLUDE}
+
+    font_name: str = "微软雅黑，黑体"  # 字体
+    font_size: float = 40  # 字号
+    alpha: float = 0.8  # 透明度
+    fly_time: float = 5  # 滚动弹幕持续时间
+    static_time: float = 10  # 静态弹幕持续时间
+
+
 @dataclass
 class Config(DataClassJsonMixin):
+    dataclass_json_config = {"undefined": Undefined.EXCLUDE}
+
     sessdata: str = ""
     bili_jct: str = ""
     buvid3: str = ""
     dedeuserid: str = ""
     ac_time_value: str = ""
     interval: int = 20
-    favorite_ids: list[int] = field(default_factory=list)
     path_mapper: dict[int, str] = field(default_factory=dict)
+    subtitle: SubtitleConfig = field(default_factory=SubtitleConfig)
 
     def validate(self) -> Self:
         """所有值必须被设置"""

utils.py

@@ -0,0 +1,37 @@
+from pathlib import Path
+
+import aiofiles
+import httpx
+from aiofiles.base import AiofilesContextManager
+from aiofiles.os import makedirs, remove
+from aiofiles.ospath import exists
+from aiofiles.threadpool.text import AsyncTextIOWrapper
+from bilibili_api import HEADERS
+
+client = httpx.AsyncClient(headers=HEADERS)
+
+
+async def download_content(url: str, path: Path) -> None:
+    async with client.stream("GET", url) as resp, aopen(path, "wb") as f:
+        async for chunk in resp.aiter_bytes(40960):
+            if not chunk:
+                return
+            await f.write(chunk)
+
+
+async def aexists(path: Path) -> bool:
+    return await exists(path)
+
+
+async def amakedirs(path: Path, exist_ok=False) -> None:
+    await makedirs(path, exist_ok=exist_ok)
+
+
+def aopen(
+    path: Path, mode: str = "r", **kwargs
+) -> AiofilesContextManager[None, None, AsyncTextIOWrapper]:
+    return aiofiles.open(path, mode, **kwargs)
+
+
+async def aremove(path: Path) -> None:
+    await remove(path)