diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml
index 90693d8..8e6f7ad 100644
--- a/.github/workflows/docker-image.yml
+++ b/.github/workflows/docker-image.yml
@@ -35,7 +35,7 @@ jobs:
uses: docker/metadata-action@v5
with:
images: |
- sunwuyuan/homeworkpage
+ sunwuyuan/classworks
ghcr.io/ClassworksDev/ClassworksServer
tags: |
type=sha
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..bae94e1
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,661 @@
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU Affero General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+.
\ No newline at end of file
diff --git a/README.md b/README.md
index 42ac860..bc52b80 100644
--- a/README.md
+++ b/README.md
@@ -1,145 +1,13 @@
-# ClassworksServer
+# Classworks KV
+[Classworks](https://cs.houlangs.com)用于班级大屏的作业板小工具
-
-
-
+## 文档
-## 📚 项目简介
+[Classworks 文档](https://docs.wuyuan.dev)
-此项目是Classworks的开源后端实现，通过 RESTful API 接口，支持前端应用实现丰富的作业管理体验，包括作业的发布、查询和管理功能。
+## 许可证
-## ✨ 主要功能
+This project is licensed under the **GNU AGPL v3.0**.
-- 📝 作业发布与管理
-- 🔍 按班级和日期查询作业
-- ⚙️ 班级配置管理
-- 🔄 数据持久化存储
-- 🐳 Docker 容器化部署
-
-## 🔌 API 接口说明
-
-### 作业管理接口
-
-| 接口 | 方法 | 描述 | 参数 |
-|------------------------|--------|--------------------------|-------------------------------------|
-| `/api/homework` | GET | 获取所有作业 | `?class=班级名&date=日期`(可选) |
-| `/api/homework/:class` | GET | 获取指定班级的所有作业 | `:class` - 班级名 |
-| `/api/homework` | POST | 创建或更新作业 | Body: `{class, date, data}` |
-| `/api/homework` | DELETE | 删除作业 | Body: `{class, date}` |
-
-### 配置管理接口
-
-| 接口 | 方法 | 描述 | 参数 |
-|----------------------|--------|------------------------|-------------------------------|
-| `/api/config` | GET | 获取所有班级配置 | 无 |
-| `/api/config/:class` | GET | 获取指定班级的配置 | `:class` - 班级名 |
-| `/api/config` | POST | 创建或更新班级配置 | Body: `{class, value}` |
-| `/api/config/:class` | DELETE | 删除指定班级的配置 | `:class` - 班级名 |
-
-## 🚀 快速开始
-
-### 前置要求
-
-- Node.js (v14+)
-- MySQL 数据库
-- Docker (可选)
-
-### 安装与运行
-
-1. 克隆仓库
-
-```bash
-git clone https://github.com/ClassworksDev/ClassworksServer.git
-cd ClassworksServer
-```
-
-2. 安装依赖
-
-```bash
-npm install
-# 或使用 pnpm
-pnpm install
-```
-
-3. 配置环境变量
-
-创建 `.env` 文件并配置以下变量：
-
-```
-DATABASE_URL="mysql://username:password@localhost:3306/classworks"
-PORT=3000
-```
-
-4. 初始化数据库
-
-```bash
-npx prisma migrate dev --name init
-```
-
-5. 启动服务
-
-```bash
-npm start
-```
-
-## 🐳 Docker 部署
-
-### 使用 Docker Compose
-
-1. 创建 `docker-compose.yml` 文件：
-
-```yaml
-version: '3'
-services:
- classworks-server:
- image: classworksdev/classworks-server:latest
- ports:
- - "3000:3000"
- environment:
- - DATABASE_URL=mysql://username:password@db:3306/classworks
- depends_on:
- - db
-
- db:
- image: mysql:8
- environment:
- - MYSQL_ROOT_PASSWORD=rootpassword
- - MYSQL_DATABASE=classworks
- - MYSQL_USER=username
- - MYSQL_PASSWORD=password
- volumes:
- - mysql-data:/var/lib/mysql
-
-volumes:
- mysql-data:
-```
-
-2. 启动服务
-
-```bash
-docker-compose up -d
-```
-
-### 手动构建 Docker 镜像
-
-1. 构建镜像
-
-```bash
-docker build -t classworks-server .
-```
-
-2. 运行容器
-
-```bash
-docker run -p 3000:3000 -e DATABASE_URL="mysql://username:password@host:3306/classworks" classworks-server
-```
-
-## 📄 许可证
-
-本项目采用 [待定] 许可证 - 详情请参阅 [LICENSE](LICENSE) 文件
-
-## 📞 联系方式
-
-项目维护者: [SunWuyuan](https://github.com/SunWuyuan)
-
-GitHub 仓库: [https://github.com/ClassworksDev/ClassworksServer](https://github.com/ClassworksDev/ClassworksServer)
+Copyright (C) 2025 **Sunwuyuan** ()
+See [LICENSE](./LICENSE) for details.
diff --git a/app.js b/app.js
index 92df0bc..a8a941d 100644
--- a/app.js
+++ b/app.js
@@ -1,25 +1,30 @@
-var createError = require("http-errors");
-var express = require("express");
-var path = require("path");
-var cookieParser = require("cookie-parser");
-var logger = require("morgan");
-const bodyParser = require("body-parser");
+import createError from "http-errors";
+import express from "express";
+import { join } from "path";
+import cookieParser from "cookie-parser";
+import logger from "morgan";
+import bodyParser from "body-parser";
+import errorHandler from "./middleware/errorHandler.js";
+import errors from "./utils/errors.js";
+import kvStore from "./models/kvStore.js";
+import { initReadme, getReadmeValue } from "./utils/siteinfo.js";
-var indexRouter = require("./routes/index");
-var usersRouter = require("./routes/users");
-var homeworkRouter = require("./routes/homework");
+import kvRouter from "./routes/kv.js";
var app = express();
-var cors = require("cors");
+import cors from "cors";
app.options("*", cors());
app.use(cors());
//全局变量
-global.dirname = __dirname;
+global.dirname = import.meta.dirname;
+
+// 初始化 readme
+initReadme();
// view engine setup
-app.set("views", path.join(__dirname, "views"));
+app.set("views", join(dirname, "views"));
app.set("view engine", "ejs");
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
@@ -27,41 +32,80 @@ app.use(logger("dev"));
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(cookieParser());
-app.use(express.static(path.join(__dirname, "public")));
+app.use(express.static(join(dirname, "public")));
-const { PrismaClient } = require("@prisma/client");
+// 添加请求超时处理中间件
+app.use((req, res, next) => {
+ // 设置默认请求超时时间为30秒
+ const timeout = 30000;
-const prisma = new PrismaClient();
+ // 设置超时回调
+ const timeoutCallback = () => {
+ const timeoutError = errors.createError(408, "请求处理超时");
+ next(timeoutError);
+ };
-// 使用路由
-app.get("/api/test", (req, res) => {
- res.json({
- status: "success",
- message: "成功",
- time: new Date().getTime(),
+ // 设置超时
+ req.setTimeout(timeout, timeoutCallback);
+
+ // 监听响应完成事件
+ res.on("finish", () => {
+ // 如果响应已经完成，清除超时处理
+ req.setTimeout(0, timeoutCallback);
});
-});
-app.use("/", homeworkRouter);
-app.use("/users", usersRouter);
-app.get("/test", async (req, res) => {
- res.render("test.ejs");
+ next();
+});
+app.get("/", (req, res) => {
+ res.render("index.ejs", { readmeValue: getReadmeValue() });
+});
+// API test endpoint
+app.get(
+ "/api/test",
+ errors.catchAsync((req, res) => {
+ res.json({
+ status: "success",
+ message: "API is running",
+ time: new Date().getTime(),
+ });
+ })
+);
+
+// Mount the KV store router
+app.use("/api/kv", kvRouter);
+
+// Test view
+app.get(
+ "/test",
+ errors.catchAsync(async (req, res) => {
+ res.render("test.ejs");
+ })
+);
+
+// 兜底404路由 - 处理所有未匹配的路由
+app.use((req, res, next) => {
+ const notFoundError = errors.createError(404, `找不到路径: ${req.path}`);
+ next(notFoundError);
});
-// catch 404 and forward to error handler
-app.use(function (req, res, next) {
- next(createError(404));
+// 全局错误处理中间件
+app.use(errorHandler);
+
+// 全局未捕获的异常处理
+process.on("uncaughtException", (error) => {
+ console.error("未捕获的异常：", error);
+ // 记录错误但不退出进程
});
-// error handler
-app.use(function (err, req, res, next) {
- // set locals, only providing error in development
- res.locals.message = err.message;
- res.locals.error = req.app.get("env") === "development" ? err : {};
-
- // render the error page
- res.status(err.status || 500);
- res.render("error");
+// 全局未处理的Promise拒绝处理
+process.on("unhandledRejection", (reason, promise) => {
+ console.error("未处理的Promise拒绝：", reason);
+ // 记录错误但不退出进程
});
-module.exports = app;
+// 处理 SIGTERM 信号
+process.on("SIGTERM", () => {
+ console.log("收到 SIGTERM 信号，准备关闭服务...");
+});
+
+export default app;
diff --git a/bin/www b/bin/www
index 89f464a..7e40943 100644
--- a/bin/www
+++ b/bin/www
@@ -4,22 +4,22 @@
* Module dependencies.
*/
-var app = require('../app');
-var debug = require('debug')('serverexpress:server');
-var http = require('http');
+import app from '../app.js';
+import debug from 'debug';
+import { createServer } from 'http';
/**
* Get port from environment and store in Express.
*/
-var port = normalizePort(process.env.PORT || '3030');
-app.set('port', port);
+var port = normalizePort(process.env.PORT || "3030");
+app.set("port", port);
/**
* Create HTTP server.
*/
-var server = http.createServer(app);
+var server = createServer(app);
/**
* Listen on provided port, on all network interfaces.
@@ -85,6 +85,6 @@ function onListening() {
var addr = server.address();
var bind = typeof addr === 'string'
? 'pipe ' + addr
- : 'port ' + addr.port;
- debug('Listening on ' + bind);
+ : "port " + addr.port;
+ debug("Listening on " + bind);
}
diff --git a/config.js b/config.js
new file mode 100644
index 0000000..e563270
--- /dev/null
+++ b/config.js
@@ -0,0 +1,5 @@
+import dotenv from "dotenv";
+dotenv.config();
+
+export const siteKey = process.env.SITE_KEY || "";
+export const isDevelopment = process.env.NODE_ENV === "development";
diff --git a/middleware/auth.js b/middleware/auth.js
new file mode 100644
index 0000000..fa90f16
--- /dev/null
+++ b/middleware/auth.js
@@ -0,0 +1,22 @@
+import { siteKey } from "../config.js";
+import AppError from "../utils/errors.js";
+
+const checkSiteKey = (req, res, next) => {
+ const providedKey = req.headers['x-site-key'];
+
+ if (!siteKey) {
+ return next();
+ }
+
+ if (!providedKey || providedKey !== siteKey) {
+ const error = AppError.createError(
+ AppError.HTTP_STATUS.UNAUTHORIZED,
+ "此服务器已开启站点密钥验证，请在请求头中添加 x-site-key 以继续访问"
+ );
+ return res.status(error.statusCode).json(error);
+ }
+
+ next();
+};
+
+export default checkSiteKey;
\ No newline at end of file
diff --git a/middleware/errorHandler.js b/middleware/errorHandler.js
new file mode 100644
index 0000000..68408ad
--- /dev/null
+++ b/middleware/errorHandler.js
@@ -0,0 +1,53 @@
+/**
+ * 全局错误处理中间件
+ * 简化版本 - 统一错误响应格式
+ */
+import errors from "../utils/errors.js";
+import { isDevelopment } from "../config.js";
+
+const errorHandler = (err, req, res, next) => {
+ // 判断响应是否已经发送
+ if (res.headersSent) {
+ return next(err);
+ }
+
+ try {
+ if (isDevelopment) {
+ // 输出错误信息到控制台
+ console.error("Error occurred:");
+ console.error(err);
+ }
+ // 提取错误信息
+ const statusCode = err.statusCode || err.status || 500;
+ const message = err.message || "服务器错误";
+ const details = err.details || null;
+
+ // 返回统一格式的错误响应
+ return res.status(statusCode).json({
+ success: false,
+ message: message,
+ details: details,
+ error:
+ process.env.NODE_ENV === "production"
+ ? undefined
+ : {
+ stack: err.stack,
+ originalError: err.originalError
+ ? err.originalError.message
+ : null,
+ },
+ });
+ } catch (handlerError) {
+ // 处理器本身出错的兜底方案
+ console.error("Error in error handler:", handlerError);
+
+ // 确保能返回响应
+ return res.status(500).json({
+ success: false,
+ message: "服务器错误",
+ details: "服务器处理错误时出现问题",
+ });
+ }
+};
+
+export default errorHandler;
diff --git a/models/kvStore.js b/models/kvStore.js
new file mode 100644
index 0000000..4baf4a8
--- /dev/null
+++ b/models/kvStore.js
@@ -0,0 +1,178 @@
+import { PrismaClient } from "@prisma/client";
+const prisma = new PrismaClient();
+class KVStore {
+ /**
+ * 通过命名空间和键名获取值
+ * @param {string} namespace - 命名空间
+ * @param {string} key - 键名
+ * @returns {object|null} 键对应的值或null
+ */
+ async get(namespace, key) {
+ const item = await prisma.kVStore.findUnique({
+ where: {
+ namespace_key: {
+ namespace: namespace,
+ key: key,
+ },
+ },
+ });
+ return item ? item.value : null;
+ }
+
+ /**
+ * 获取键的完整信息（包括元数据）
+ * @param {string} namespace - 命名空间
+ * @param {string} key - 键名
+ * @returns {object|null} 键的完整信息或null
+ */
+ async getMetadata(namespace, key) {
+ const item = await prisma.kVStore.findUnique({
+ where: {
+ namespace_key: {
+ namespace: namespace,
+ key: key,
+ },
+ },
+ select: {
+ key: true,
+ namespace: true,
+ creatorIp: true,
+ createdAt: true,
+ updatedAt: true,
+ },
+ });
+
+ if (!item) return null;
+
+ // 转换为更友好的格式
+ return {
+ namespace: item.namespace,
+ key: item.key,
+ metadata: {
+ creatorIp: item.creatorIp,
+ createdAt: item.createdAt,
+ updatedAt: item.updatedAt,
+ },
+ };
+ }
+
+ /**
+ * 在指定命名空间下创建或更新键值
+ * @param {string} namespace - 命名空间
+ * @param {string} key - 键名
+ * @param {object} value - 键值
+ * @param {string} creatorIp - 创建者IP，可选
+ * @returns {object} 创建或更新的记录
+ */
+ async upsert(namespace, key, value, creatorIp = "") {
+ const item = await prisma.kVStore.upsert({
+ where: {
+ namespace_key: {
+ namespace: namespace,
+ key: key,
+ },
+ },
+ update: {
+ value,
+ ...(creatorIp && { creatorIp }),
+ },
+ create: {
+ namespace: namespace,
+ key: key,
+ value,
+ creatorIp,
+ },
+ });
+
+ // 返回带有命名空间和原始键的结果
+ return {
+ id: item.id,
+ namespace,
+ key,
+ value: item.value,
+ creatorIp: item.creatorIp,
+ createdAt: item.createdAt,
+ updatedAt: item.updatedAt,
+ };
+ }
+
+ /**
+ * 通过命名空间和键名删除
+ * @param {string} namespace - 命名空间
+ * @param {string} key - 键名
+ * @returns {object|null} 删除的记录或null
+ */
+ async delete(namespace, key) {
+ try {
+ const item = await prisma.kVStore.delete({
+ where: {
+ namespace_key: {
+ namespace: namespace,
+ key: key,
+ },
+ },
+ });
+ return item ? { ...item, namespace, key } : null;
+ } catch (error) {
+ // 忽略记录不存在的错误
+ if (error.code === "P2025") return null;
+ throw error;
+ }
+ }
+
+ /**
+ * 列出指定命名空间下的所有键名及其元数据
+ * @param {string} namespace - 命名空间
+ * @param {object} options - 选项参数
+ * @returns {Array} 键名和元数据数组
+ */
+ async list(namespace, options = {}) {
+ const { sortBy = "key", sortDir = "asc", limit = 100, skip = 0 } = options;
+
+ // 构建排序条件
+ const orderBy = {};
+ orderBy[sortBy] = sortDir.toLowerCase();
+
+ // 查询以命名空间开头的所有键
+ const items = await prisma.kVStore.findMany({
+ where: {
+ namespace: namespace,
+ },
+ select: {
+ namespace: true,
+ key: true,
+ creatorIp: true,
+ createdAt: true,
+ updatedAt: true,
+ value: false,
+ },
+ orderBy,
+ take: limit,
+ skip: skip,
+ });
+
+ // 处理结果，从键名中移除命名空间前缀
+ return items.map((item) => ({
+ namespace: item.namespace,
+ key: item.key,
+ value: item.value,
+ metadata: item.metadata,
+ }));
+ }
+
+ /**
+ * 统计指定命名空间下的键值对数量
+ * @param {string} namespace - 命名空间
+ * @returns {number} 键值对数量
+ */
+ async count(namespace) {
+ const count = await prisma.kVStore.count({
+ where: {
+ namespace: namespace,
+ },
+ });
+ return count;
+ }
+}
+
+export default new KVStore();
diff --git a/package.json b/package.json
index cb78702..65cb081 100644
--- a/package.json
+++ b/package.json
@@ -6,22 +6,25 @@
"start": "node ./bin/www",
"prisma": "prisma generate",
"prisma:pull": "prisma db pull",
- "dev": "NODE_ENV=development nodemon node .bin/www"
-
+ "dev": "NODE_ENV=development nodemon node .bin/www",
+ "setup": "node ./scripts/setup.js"
},
+ "type": "module",
"dependencies": {
- "@prisma/client": "6.4.1",
+ "@prisma/client": "6.7.0",
"body-parser": "^1.20.3",
"cookie-parser": "~1.4.4",
"cors": "^2.8.5",
"debug": "~2.6.9",
+ "dotenv": "^16.5.0",
"ejs": "^3.1.10",
"express": "~4.16.1",
"http-errors": "~1.6.3",
"jade": "~1.11.0",
- "morgan": "~1.9.1"
+ "morgan": "~1.9.1",
+ "uuid": "^11.1.0"
},
"devDependencies": {
- "prisma": "6.4.1"
+ "prisma": "6.7.0"
}
}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 58ec6e5..23a7b44 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -9,8 +9,8 @@ importers:
.:
dependencies:
'@prisma/client':
- specifier: 6.4.1
- version: 6.4.1(prisma@6.4.1)
+ specifier: 6.7.0
+ version: 6.7.0(prisma@6.7.0)
body-parser:
specifier: ^1.20.3
version: 1.20.3
@@ -23,6 +23,9 @@ importers:
debug:
specifier: ~2.6.9
version: 2.6.9
+ dotenv:
+ specifier: ^16.5.0
+ version: 16.5.0
ejs:
specifier: ^3.1.10
version: 3.1.10
@@ -38,10 +41,13 @@ importers:
morgan:
specifier: ~1.9.1
version: 1.9.1
+ uuid:
+ specifier: ^11.1.0
+ version: 11.1.0
devDependencies:
prisma:
- specifier: 6.4.1
- version: 6.4.1
+ specifier: 6.7.0
+ version: 6.7.0
packages:
@@ -195,8 +201,8 @@ packages:
cpu: [x64]
os: [win32]
- '@prisma/client@6.4.1':
- resolution: {integrity: sha512-A7Mwx44+GVZVexT5e2GF/WcKkEkNNKbgr059xpr5mn+oUm2ZW1svhe+0TRNBwCdzhfIZ+q23jEgsNPvKD9u+6g==}
+ '@prisma/client@6.7.0':
+ resolution: {integrity: sha512-+k61zZn1XHjbZul8q6TdQLpuI/cvyfil87zqK2zpreNIXyXtpUv3+H/oM69hcsFcZXaokHJIzPAt5Z8C8eK2QA==}
engines: {node: '>=18.18'}
peerDependencies:
prisma: '*'
@@ -207,20 +213,23 @@ packages:
typescript:
optional: true
- '@prisma/debug@6.4.1':
- resolution: {integrity: sha512-Q9xk6yjEGIThjSD8zZegxd5tBRNHYd13GOIG0nLsanbTXATiPXCLyvlYEfvbR2ft6dlRsziQXfQGxAgv7zcMUA==}
+ '@prisma/config@6.7.0':
+ resolution: {integrity: sha512-di8QDdvSz7DLUi3OOcCHSwxRNeW7jtGRUD2+Z3SdNE3A+pPiNT8WgUJoUyOwJmUr5t+JA2W15P78C/N+8RXrOA==}
- '@prisma/engines-version@6.4.0-29.a9055b89e58b4b5bfb59600785423b1db3d0e75d':
- resolution: {integrity: sha512-Xq54qw55vaCGrGgIJqyDwOq0TtjZPJEWsbQAHugk99hpDf2jcEeQhUcF+yzEsSqegBaDNLA4IC8Nn34sXmkiTQ==}
+ '@prisma/debug@6.7.0':
+ resolution: {integrity: sha512-RabHn9emKoYFsv99RLxvfG2GHzWk2ZI1BuVzqYtmMSIcuGboHY5uFt3Q3boOREM9de6z5s3bQoyKeWnq8Fz22w==}
- '@prisma/engines@6.4.1':
- resolution: {integrity: sha512-KldENzMHtKYwsOSLThghOIdXOBEsfDuGSrxAZjMnimBiDKd3AE4JQ+Kv+gBD/x77WoV9xIPf25GXMWffXZ17BA==}
+ '@prisma/engines-version@6.7.0-36.3cff47a7f5d65c3ea74883f1d736e41d68ce91ed':
+ resolution: {integrity: sha512-EvpOFEWf1KkJpDsBCrih0kg3HdHuaCnXmMn7XFPObpFTzagK1N0Q0FMnYPsEhvARfANP5Ok11QyoTIRA2hgJTA==}
- '@prisma/fetch-engine@6.4.1':
- resolution: {integrity: sha512-uZ5hVeTmDspx7KcaRCNoXmcReOD+84nwlO2oFvQPRQh9xiFYnnUKDz7l9bLxp8t4+25CsaNlgrgilXKSQwrIGQ==}
+ '@prisma/engines@6.7.0':
+ resolution: {integrity: sha512-3wDMesnOxPrOsq++e5oKV9LmIiEazFTRFZrlULDQ8fxdub5w4NgRBoxtWbvXmj2nJVCnzuz6eFix3OhIqsZ1jw==}
- '@prisma/get-platform@6.4.1':
- resolution: {integrity: sha512-gXqZaDI5scDkBF8oza7fOD3Q3QMD0e0rBynlzDDZdTWbWmzjuW58PRZtj+jkvKje2+ZigCWkH8SsWZAsH6q1Yw==}
+ '@prisma/fetch-engine@6.7.0':
+ resolution: {integrity: sha512-zLlAGnrkmioPKJR4Yf7NfW3hftcvqeNNEHleMZK9yX7RZSkhmxacAYyfGsCcqRt47jiZ7RKdgE0Wh2fWnm7WsQ==}
+
+ '@prisma/get-platform@6.7.0':
+ resolution: {integrity: sha512-i9IH5lO4fQwnMLvQLYNdgVh9TK3PuWBfQd7QLk/YurnAIg+VeADcZDbmhAi4XBBDD+hDif9hrKyASu0hbjwabw==}
accepts@1.3.8:
resolution: {integrity: sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==}
@@ -414,6 +423,10 @@ packages:
resolution: {integrity: sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==}
engines: {node: '>= 0.8', npm: 1.2.8000 || >= 1.4.16}
+ dotenv@16.5.0:
+ resolution: {integrity: sha512-m/C+AwOAr9/W1UOIZUo232ejMNnJAJtYQjUbHoNTBNTJSvqzzDh7vnrei3o3r3m9blf6ZoDkvcw0VmozNRFJxg==}
+ engines: {node: '>=12'}
+
ee-first@1.1.1:
resolution: {integrity: sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==}
@@ -648,8 +661,8 @@ packages:
path-to-regexp@0.1.7:
resolution: {integrity: sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ==}
- prisma@6.4.1:
- resolution: {integrity: sha512-q2uJkgXnua/jj66mk6P9bX/zgYJFI/jn4Yp0aS6SPRrjH/n6VyOV7RDe1vHD0DX8Aanx4MvgmUPPoYnR6MJnPg==}
+ prisma@6.7.0:
+ resolution: {integrity: sha512-vArg+4UqnQ13CVhc2WUosemwh6hr6cr6FY2uzDvCIFwH8pu8BXVv38PktoMLVjtX7sbYThxbnZF5YiR8sN2clw==}
engines: {node: '>=18.18'}
hasBin: true
peerDependencies:
@@ -785,6 +798,10 @@ packages:
resolution: {integrity: sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==}
engines: {node: '>= 0.4.0'}
+ uuid@11.1.0:
+ resolution: {integrity: sha512-0/A9rDy9P7cJ+8w1c9WD9V//9Wj15Ce2MPz8Ri6032usz+NfePxx5AcN3bN+r6ZL6jEo066/yNYB3tn4pQEx+A==}
+ hasBin: true
+
vary@1.1.2:
resolution: {integrity: sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==}
engines: {node: '>= 0.8'}
@@ -888,30 +905,37 @@ snapshots:
'@esbuild/win32-x64@0.25.0':
optional: true
- '@prisma/client@6.4.1(prisma@6.4.1)':
+ '@prisma/client@6.7.0(prisma@6.7.0)':
optionalDependencies:
- prisma: 6.4.1
+ prisma: 6.7.0
- '@prisma/debug@6.4.1': {}
-
- '@prisma/engines-version@6.4.0-29.a9055b89e58b4b5bfb59600785423b1db3d0e75d': {}
-
- '@prisma/engines@6.4.1':
+ '@prisma/config@6.7.0':
dependencies:
- '@prisma/debug': 6.4.1
- '@prisma/engines-version': 6.4.0-29.a9055b89e58b4b5bfb59600785423b1db3d0e75d
- '@prisma/fetch-engine': 6.4.1
- '@prisma/get-platform': 6.4.1
+ esbuild: 0.25.0
+ esbuild-register: 3.6.0(esbuild@0.25.0)
+ transitivePeerDependencies:
+ - supports-color
- '@prisma/fetch-engine@6.4.1':
- dependencies:
- '@prisma/debug': 6.4.1
- '@prisma/engines-version': 6.4.0-29.a9055b89e58b4b5bfb59600785423b1db3d0e75d
- '@prisma/get-platform': 6.4.1
+ '@prisma/debug@6.7.0': {}
- '@prisma/get-platform@6.4.1':
+ '@prisma/engines-version@6.7.0-36.3cff47a7f5d65c3ea74883f1d736e41d68ce91ed': {}
+
+ '@prisma/engines@6.7.0':
dependencies:
- '@prisma/debug': 6.4.1
+ '@prisma/debug': 6.7.0
+ '@prisma/engines-version': 6.7.0-36.3cff47a7f5d65c3ea74883f1d736e41d68ce91ed
+ '@prisma/fetch-engine': 6.7.0
+ '@prisma/get-platform': 6.7.0
+
+ '@prisma/fetch-engine@6.7.0':
+ dependencies:
+ '@prisma/debug': 6.7.0
+ '@prisma/engines-version': 6.7.0-36.3cff47a7f5d65c3ea74883f1d736e41d68ce91ed
+ '@prisma/get-platform': 6.7.0
+
+ '@prisma/get-platform@6.7.0':
+ dependencies:
+ '@prisma/debug': 6.7.0
accepts@1.3.8:
dependencies:
@@ -1099,6 +1123,8 @@ snapshots:
destroy@1.2.0: {}
+ dotenv@16.5.0: {}
+
ee-first@1.1.1: {}
ejs@3.1.10:
@@ -1374,11 +1400,10 @@ snapshots:
path-to-regexp@0.1.7: {}
- prisma@6.4.1:
+ prisma@6.7.0:
dependencies:
- '@prisma/engines': 6.4.1
- esbuild: 0.25.0
- esbuild-register: 3.6.0(esbuild@0.25.0)
+ '@prisma/config': 6.7.0
+ '@prisma/engines': 6.7.0
optionalDependencies:
fsevents: 2.3.3
transitivePeerDependencies:
@@ -1528,6 +1553,8 @@ snapshots:
utils-merge@1.0.1: {}
+ uuid@11.1.0: {}
+
vary@1.1.2: {}
void-elements@2.0.1: {}
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
index d4b0ac9..022497f 100644
--- a/prisma/schema.prisma
+++ b/prisma/schema.prisma
@@ -21,3 +21,14 @@ model config {
class String @id @db.VarChar(45)
value Json?
}
+
+model KVStore {
+ namespace String @db.Char(36)
+ key String
+ value Json
+ creatorIp String? @default("")
+ createdAt DateTime @default(now())
+ updatedAt DateTime @updatedAt
+
+ @@id([namespace, key])
+}
diff --git a/routes/homework.js b/routes/homework.js
deleted file mode 100644
index 188e14a..0000000
--- a/routes/homework.js
+++ /dev/null
@@ -1,127 +0,0 @@
-const express = require('express');
-const router = express.Router();
-const { PrismaClient } = require("@prisma/client");
-const prisma = new PrismaClient();
-
-// 上传/更新作业数据
-router.post("/:classId/homework", async (req, res) => {
- try {
- const date = req.query.date || new Date().toISOString().split("T")[0];
- const data = req.body;
- const className = req.params.classId;
-
- await prisma.homework.upsert({
- where: {
- date_class: {
- date: date,
- class: className
- }
- },
- update: {
- data: data,
- },
- create: {
- date: date,
- class: className,
- data: data,
- },
- });
-
- res.json({
- status: true,
- msg: "上传成功",
- });
- } catch (error) {
- console.error("Upload error:", error);
- res.json({
- status: false,
- msg: "上传失败：" + error.message,
- });
- }
-});
-
-// 获取作业数据
-router.get("/:classId/homework", async (req, res) => {
- try {
- const date = req.query.date;
- const className = req.params.classId;
-
- const homework = await prisma.homework.findFirst({
- where: {
- date: date,
- class: className
- },
- });
-
- if (!homework) {
- throw new Error("该日期未上传数据");
- }
-
- res.json(homework.data);
- } catch (error) {
- console.error("Download error:", error);
- res.json({
- status: false,
- msg: "获取失败：" + error.message,
- });
- }
-});
-
-// 获取班级配置
-router.get("/:classId/config", async (req, res) => {
- try {
- const className = req.params.classId;
-
- const config = await prisma.config.findUnique({
- where: {
- class: className
- }
- });
-
- if (!config) {
- throw new Error("未找到配置信息");
- }
-
- res.json(config.value);
- } catch (error) {
- console.error("Config error:", error);
- res.json({
- status: false,
- msg: "获取配置失败：" + error.message,
- });
- }
-});
-
-// 更新班级配置
-router.put("/:classId/config", async (req, res) => {
- try {
- const className = req.params.classId;
- const configValue = req.body;
-
- await prisma.config.upsert({
- where: {
- class: className
- },
- update: {
- value: configValue
- },
- create: {
- class: className,
- value: configValue
- }
- });
-
- res.json({
- status: true,
- msg: "更新成功"
- });
- } catch (error) {
- console.error("Config update error:", error);
- res.json({
- status: false,
- msg: "更新失败：" + error.message,
- });
- }
-});
-
-module.exports = router;
\ No newline at end of file
diff --git a/routes/index.js b/routes/index.js
index ecca96a..3ee0a40 100644
--- a/routes/index.js
+++ b/routes/index.js
@@ -1,9 +1,9 @@
-var express = require('express');
-var router = express.Router();
+import { Router } from "express";
+var router = Router();
/* GET home page. */
-router.get('/', function(req, res, next) {
- res.render('index', { title: 'Express' });
+router.get("/", function (req, res, next) {
+ res.render("index", { title: "Express" });
});
-module.exports = router;
+export default router;
diff --git a/routes/kv.js b/routes/kv.js
new file mode 100644
index 0000000..0a8ebe2
--- /dev/null
+++ b/routes/kv.js
@@ -0,0 +1,204 @@
+import { Router } from "express";
+const router = Router();
+import kvStore from "../models/kvStore.js";
+import checkSiteKey from "../middleware/auth.js";
+import { v4 as uuidv4 } from "uuid";
+import errors from "../utils/errors.js";
+
+// 检查是否为受限UUID的中间件
+const checkRestrictedUUID = (req, res, next) => {
+ const restrictedUUID = "00000000-0000-4000-8000-000000000000";
+ const namespace = req.params.namespace;
+
+ if (namespace === restrictedUUID) {
+ return next(errors.createError(403, "无权限访问此命名空间"));
+ }
+ next();
+};
+
+router.use(checkSiteKey);
+/**
+ * GET /:namespace
+ * 获取指定命名空间下的所有键名及元数据列表
+ */
+router.get(
+ "/:namespace",
+ checkRestrictedUUID,
+ errors.catchAsync(async (req, res, next) => {
+ const { namespace } = req.params;
+ const { sortBy, sortDir, limit, skip } = req.query;
+
+ // 构建选项
+ const options = {
+ sortBy: sortBy || "key",
+ sortDir: sortDir || "asc",
+ limit: limit ? parseInt(limit) : 100,
+ skip: skip ? parseInt(skip) : 0,
+ };
+
+ const keys = await kvStore.list(namespace, options);
+
+ // 获取总记录数
+ const totalRows = await kvStore.count(namespace);
+
+ // 构建响应对象
+ const response = {
+ items: keys,
+ total_rows: totalRows,
+ };
+
+ // 如果还有更多数据，添加load_more字段
+ const nextSkip = options.skip + options.limit;
+ if (nextSkip < totalRows) {
+ const baseUrl = `${req.baseUrl}/${namespace}`;
+ const queryParams = new URLSearchParams({
+ sortBy: options.sortBy,
+ sortDir: options.sortDir,
+ limit: options.limit,
+ skip: nextSkip,
+ }).toString();
+
+ response.load_more = `${baseUrl}?${queryParams}`;
+ }
+
+ return res.json(response);
+ })
+);
+
+/**
+ * GET /:namespace/:key
+ * 通过命名空间和键名获取键值
+ */
+router.get(
+ "/:namespace/:key",
+ checkRestrictedUUID,
+ errors.catchAsync(async (req, res, next) => {
+ const { namespace, key } = req.params;
+
+ // 否则只返回值
+ const value = await kvStore.get(namespace, key);
+
+ if (value === null) {
+ // 创建并传递错误，而不是抛出
+ return next(
+ errors.createError(
+ 404,
+ `未找到命名空间 '${namespace}' 下键名为 '${key}' 的记录`
+ )
+ );
+ }
+
+ return res.json(value);
+ })
+);
+router.get(
+ "/:namespace/:key/metadata",
+ checkRestrictedUUID,
+ errors.catchAsync(async (req, res, next) => {
+ const { namespace, key } = req.params;
+ const metadata = await kvStore.getMetadata(namespace, key);
+ if (!metadata) {
+ return next(
+ errors.createError(
+ 404,
+ `未找到命名空间 '${namespace}' 下键名为 '${key}' 的记录`
+ )
+ );
+ }
+ return res.json(metadata);
+ })
+);
+/**
+ * POST /:namespace/:key
+ * 更新指定命名空间下的键值，如果不存在则创建
+ */
+router.post(
+ "/:namespace/:key",
+ checkRestrictedUUID,
+ errors.catchAsync(async (req, res, next) => {
+ const { namespace, key } = req.params;
+ const value = req.body;
+
+ if (!value || Object.keys(value).length === 0) {
+ // 创建并传递错误，而不是抛出
+ return next(errors.createError(400, "请提供有效的JSON值"));
+ }
+
+ // 获取客户端IP
+ const creatorIp =
+ req.headers["x-forwarded-for"] ||
+ req.connection.remoteAddress ||
+ req.socket.remoteAddress ||
+ req.connection.socket?.remoteAddress ||
+ "";
+
+ const result = await kvStore.upsert(namespace, key, value, creatorIp);
+ return res.status(200).json({
+ namespace: result.namespace,
+ key: result.key,
+ created: result.createdAt.getTime() === result.updatedAt.getTime(),
+ updatedAt: result.updatedAt,
+ });
+ })
+);
+
+/**
+ * DELETE /:namespace
+ * 删除指定命名空间及其所有键值对
+ */
+router.delete(
+ "/:namespace",
+ checkRestrictedUUID,
+ errors.catchAsync(async (req, res, next) => {
+ const { namespace } = req.params;
+ const result = await kvStore.deleteNamespace(namespace);
+
+ if (!result) {
+ // 创建并传递错误，而不是抛出
+ return next(errors.createError(404, `未找到命名空间 '${namespace}'`));
+ }
+
+ // 204状态码表示成功但无内容返回
+ return res.status(204).end();
+ })
+);
+
+/**
+ * DELETE /:namespace/:key
+ * 删除指定命名空间下的键值对
+ */
+router.delete(
+ "/:namespace/:key",
+ checkRestrictedUUID,
+ errors.catchAsync(async (req, res, next) => {
+ const { namespace, key } = req.params;
+ const result = await kvStore.delete(namespace, key);
+
+ if (!result) {
+ // 创建并传递错误，而不是抛出
+ return next(
+ errors.createError(
+ 404,
+ `未找到命名空间 '${namespace}' 下键名为 '${key}' 的记录`
+ )
+ );
+ }
+
+ // 204状态码表示成功但无内容返回
+ return res.status(204).end();
+ })
+);
+
+/**
+ * GET /uuid
+ * 生成并返回一个随机UUID，可用作新命名空间
+ */
+router.get(
+ "/uuid",
+ errors.catchAsync(async (req, res) => {
+ const namespace = uuidv4();
+ res.json({ namespace });
+ })
+);
+
+export default router;
diff --git a/routes/users.js b/routes/users.js
deleted file mode 100644
index 623e430..0000000
--- a/routes/users.js
+++ /dev/null
@@ -1,9 +0,0 @@
-var express = require('express');
-var router = express.Router();
-
-/* GET users listing. */
-router.get('/', function(req, res, next) {
- res.send('respond with a resource');
-});
-
-module.exports = router;
diff --git a/utils/errors.js b/utils/errors.js
new file mode 100644
index 0000000..fa179c7
--- /dev/null
+++ b/utils/errors.js
@@ -0,0 +1,101 @@
+/**
+ * 创建标准错误对象
+ * @param {number} statusCode - HTTP状态码
+ * @param {string} [message] - 错误消息
+ * @param {object} [details] - 附加信息
+ * @returns {object} 标准错误对象
+ */
+const createError = (statusCode, message, details = null) => {
+ // 直接返回错误对象，不抛出异常
+ const error = {
+ statusCode: statusCode,
+ message: message || '服务器错误',
+ details: details
+ };
+ return error;
+};
+
+/**
+ * 创建标准成功响应
+ * @param {object} data - 响应数据
+ * @param {string} [message] - 可选的成功消息
+ * @returns {object} 格式化的成功响应
+ */
+const createSuccessResponse = (data, message = null) => {
+ return {
+ success: true,
+ message,
+ data,
+ };
+};
+
+/**
+ * 错误处理函数 - 将错误传递给下一个中间件
+ * @param {Error|object} error - 错误对象
+ * @param {Function} next - Express中间件next函数
+ */
+const passError = (error, next) => {
+ // 不管是什么类型的错误，统一转换并传递
+ if (error instanceof Error) {
+ // 如果是标准Error，则转换为HTTP错误并保留原始信息
+ const httpError = {
+ statusCode: error.statusCode || 500,
+ message: error.message || '服务器错误',
+ details: error.details || null,
+ originalError: error
+ };
+ next(httpError);
+ } else {
+ // 已经是自定义错误对象结构，直接传递
+ next(error);
+ }
+};
+
+/**
+ * 捕获异步错误的包装器
+ * @param {Function} fn - 需要包装的异步函数
+ * @returns {Function} 包装后的函数
+ */
+const catchAsync = (fn) => {
+ return (req, res, next) => {
+ Promise.resolve(fn(req, res, next)).catch(error => {
+ passError(error, next);
+ });
+ };
+};
+
+/**
+ * 安全执行函数 - 捕获同步函数中的错误
+ * @param {Function} fn - 需要安全执行的函数
+ * @param {...any} args - 函数参数
+ * @returns {[error, result]} 包含错误和结果的数组
+ */
+const trySafe = (fn, ...args) => {
+ try {
+ const result = fn(...args);
+ return [null, result];
+ } catch (error) {
+ return [error, null];
+ }
+};
+
+// 常用状态码
+const HTTP_STATUS = {
+ OK: 200,
+ CREATED: 201,
+ NO_CONTENT: 204,
+ BAD_REQUEST: 400,
+ UNAUTHORIZED: 401,
+ FORBIDDEN: 403,
+ NOT_FOUND: 404,
+ INTERNAL_SERVER_ERROR: 500,
+};
+
+export default {
+ createError,
+ createSuccessResponse,
+ passError,
+ catchAsync,
+ trySafe,
+ HTTP_STATUS,
+};
diff --git a/utils/siteinfo.js b/utils/siteinfo.js
new file mode 100644
index 0000000..56911b8
--- /dev/null
+++ b/utils/siteinfo.js
@@ -0,0 +1,73 @@
+import kvStore from "../models/kvStore.js";
+
+// 存储 readme 值的内存变量
+let readmeValue = null;
+
+// 封装默认 readme 对象
+const defaultReadme = {
+ title: "Classworks 服务端",
+ readme: "暂无 Readme 内容",
+};
+
+/**
+ * 初始化 readme 值
+ * 在应用启动时调用此函数
+ */
+export const initReadme = async () => {
+ try {
+ const storedValue = await kvStore.get(
+ "00000000-0000-4000-8000-000000000000",
+ "info"
+ );
+
+ // 合并默认值与存储值，确保结构完整
+ readmeValue = {
+ ...defaultReadme,
+ ...(storedValue || {}),
+ };
+
+ console.log("✅ 站点信息初始化成功");
+ } catch (error) {
+ console.error("❌ 站点信息初始化失败:", {
+ message: error?.message,
+ stack: error?.stack,
+ });
+
+ // 确保在异常情况下也有默认值
+ readmeValue = { ...defaultReadme };
+ }
+};
+
+/**
+ * 获取当前的 readme 值
+ * @returns {Object} readme 值对象
+ */
+export const getReadmeValue = () => {
+ return readmeValue || { ...defaultReadme };
+};
+
+/**
+ * 更新 readme 值
+ * @param {Object} newValue - 新的 readme 值
+ * @returns {Promise}
+ */
+export const updateReadmeValue = async (newValue) => {
+ try {
+ await kvStore.upsert(
+ "00000000-0000-4000-8000-000000000000",
+ "info",
+ newValue
+ );
+ readmeValue = {
+ ...defaultReadme,
+ ...newValue,
+ };
+ console.log("✅ 站点信息更新成功");
+ } catch (error) {
+ console.error("❌ 站点信息更新失败:", {
+ message: error?.message,
+ stack: error?.stack,
+ });
+ throw error;
+ }
+};
\ No newline at end of file
diff --git a/views/footer.ejs b/views/footer.ejs
deleted file mode 100644
index 691287b..0000000
--- a/views/footer.ejs
+++ /dev/null
@@ -1,2 +0,0 @@
-
-