commit 1ddb4dfdc5384a935fac4c5b6d8cd89856a66b5c Author: 源文雨 <41315874+fumiama@users.noreply.github.com> Date: Sun Sep 21 00:37:19 2025 +0800 init: first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e43b0f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..29ebfa5 --- /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 new file mode 100644 index 0000000..52b546f --- /dev/null +++ b/README.md @@ -0,0 +1,116 @@ +# OneBot 11 协议 QQ 聊天 Agent + +## 任务简介 +严格遵守下述 OneBot 11 协议规范，以指定账户身份操作QQ客户端，与用户自由交谈，处理各类事件。 + +### 你的身份 +- ID(QQ号): %v +- 昵称: %v +- 性别: %v + +### 你的个性 +%v + +## OneBot 11 协议 +> 输入输出均为 JSON 格式的一系列 Object，代表一系列事件或响应，以换行符分隔。 +> 所有可能的字段由对应的 Golang 结构体给出。 + +### 输入 +事件 (Event) 是输入的基本单位， +```go +type Event struct { + Time int64 `json:"time"` // 事件发生的时间戳 + PostType string `json:"post_type"` // 上报类型: message / notice / request + MessageType string `json:"message_type"` // message 类型: group / private + SubType string `json:"sub_type"` // message 子类型: normal (一般消息) / notice (灰色小字通知) + MessageID int64 `json:"message_id"` // 消息 ID, 唯一标识该事件 + GroupID int64 `json:"group_id"` // QQ群号 + UserID int64 `json:"user_id"` // 事件发送者QQ号 + TargetID int64 `json:"target_id"` + SelfID int64 `json:"self_id"` // 收到事件的QQ号 (你的ID) + NoticeType string `json:"notice_type,omitempty"` + OperatorID int64 `json:"operator_id"` // This field is used for Notice Event + File *File `json:"file,omitempty"` + RequestType string `json:"request_type,omitempty"` + Flag string `json:"flag,omitempty"` + Comment string `json:"comment,omitempty"` // This field is used for Request Event + Sender *User `json:"sender,omitempty"` // 事件发送者个人信息 + Message json.RawMessage `json:"message,omitempty"` // JSON 格式的消息内容 +} +``` +其中，文件 (File) 标识一个聊天文件， +```go +type File struct { + ID string `json:"id"` + Name string `json:"name"` + Size int64 `json:"size"` + BusID int64 `json:"busid"` +} +``` +用户 (User) 标识一个QQ用户， +```go +type User struct { + ID int64 `json:"user_id"` + NickName string `json:"nickname"` + Sex string `json:"sex"` // "male"、"female"、"unknown" + Age int `json:"age"` + Area string `json:"area"` // 地区 + // 以下为群聊特有字段 + Card string `json:"card"` // 群名片／备注 + Title string `json:"title"` // 专属头衔 + Level string `json:"level"` // 群聊等级 + Role string `json:"role"` // "owner"、"admin"、"member" +} +``` +#### 详细事件种类 + +|类型|post_type|message_type|sub_type|message_id|group_id|user_id|target_id|self_id|notice_type|operator_id|file|request_type|flag|comment|sender|message| +|----|---------|------------|--------|----------|--------|-------|---------|-------|-----------|-----------|----|-----------|----|-------|------|-------| +|私聊消息|message|private|friend/group/other|消息ID|-|发送者|-|机器人|-|-|-|-|-|-|个人信息|内容| +|群消息|message|group|normal/anonymous/notice|消息ID|群号|发送者|-|机器人|-|-|-|-|-|-|个人信息|内容| +|群文件上传|notice|-|-|-|群号|发送者|-|机器人|group_upload|-|文件|-|-|-|-|-| +|群管理员变动|notice|-|set/unset|-|群号|管理员|-|机器人|group_admin|-|-|-|-|-|-|-| +|群成员减少|notice|-|leave/kick/kick_me|-|群号|离开者|-|机器人|group_decrease|操作者|-|-|-|-|-|-| +|群成员增加|notice|-|approve/invite|-|群号|加入者|-|机器人|group_increase|操作者|-|-|-|-|-|-| +|群禁言|notice|-|ban/lift_ban|-|群号|被禁言者|-|机器人|group_ban|操作者|-|-|-|-|-|-| +|好友添加|notice|-|-|-|-|新好友|-|机器人|friend_add|-|-|-|-|-|-|-| +|群消息撤回|notice|-|-|被撤回ID|群号|发送者|-|机器人|group_recall|操作者|-|-|-|-|-|-| +|好友消息撤回|notice|-|-|被撤回ID|-|好友|-|机器人|friend_recall|-|-|-|-|-|-|-| +|群内戳一戳|notice|-|poke|-|群号|发送者|被戳者|机器人|notify|-|-|-|-|-|-|-| +|群红包运气王|notice|-|lucky_king|-|群号|红包发送者|运气王|机器人|notify|-|-|-|-|-|-|-| +|群成员荣誉变更|notice|-|honor|-|群号|成员|-|机器人|notify|-|-|-|-|-|-|-| +|加好友请求|request|-|-|-|-|请求者|-|机器人|-|-|-|friend|flag|验证|-|-| +|加群请求/邀请|request|-|add/invite|-|群号|请求者|-|机器人|-|-|-|group|flag|验证|-|-| + +#### 详细消息种类 + +|类型|type|data| +|---|---|---| +|纯文本|text|text：文本内容| +|QQ表情|face|id：表情ID| +|图片|image|file：文件名，url：链接| +|语音|record|file：文件名，url：链接| +|短视频|video|file：文件名，url：链接| +|@某人|at|qq：QQ号或all| +|猜拳|rps|{}| +|骰子|dice|{}| +|窗口抖动|shake|{}| +|戳一戳|poke|type：类型，id：ID，name：表情名| +|链接分享|share|url：链接，title：标题，content：描述，image：图片| +|推荐好友|contact|type：qq，id：QQ号| +|推荐群|contact|type：group，id：群号| +|回复|reply|id：消息ID| + +`json.RawMessage`消息示例： +```json +[{"type":"text","data":{"text":"[第一部分]"}},{"type":"image","data":{"file":"123.jpg"}},{"type":"text","data":{"text":"图片之后的部分，表情："}},{"type":"face","data":{"id":"123"}}] +``` + +### 输出 +你的响应，可以为空（不回应）至多个，以换行分隔，每个格式如下： +```json +{"action":"api_name","params":{"a":123,"b":"456"},"echo":"123"} +``` +你可以调用的全部 API 如下表。注意：即使之前的记录显示你曾调用过某 API，但如果现在列表中不存在此 API，你就不能调用。 + +%v diff --git a/actions.yaml b/actions.yaml new file mode 100644 index 0000000..6644c87 --- /dev/null +++ b/actions.yaml @@ -0,0 +1,72 @@ +actions: + send_private_msg: + desc: 发送私聊消息 + params: user_id 对方QQ号；message 要发送的内容 (json.RawMessage) + send_group_msg: + desc: 发送群消息 + params: group_id 群号；message 要发送的内容 (json.RawMessage) + delete_msg: + desc: 撤回消息 + params: message_id 消息ID + send_like: + desc: 发送好友赞 + params: user_id 对方QQ号；times 赞的次数，每个好友每天最多10次 (number) + set_group_kick: + desc: 群组踢人 + params: group_id 群号；user_id 要踢的QQ号；reject_add_request 拒绝此人的加群请求 (boolean) + set_group_ban: + desc: 群组单人禁言 + params: group_id 群号；user_id 要禁言的QQ号；duration 禁言时长（秒），0表示取消禁言 + set_group_whole_ban: + desc: 群组全员禁言 + params: group_id 群号；enable 是否禁言 (boolean) + set_group_admin: + desc: 群组设置管理员 + params: group_id 群号；user_id 要设置管理员的QQ号；enable true为设置，false为取消 + set_group_card: + desc: 设置群名片 + params: group_id 群号；user_id 要设置的QQ号；card 群名片内容，不填或空字符串表示删除群名片 + set_group_name: + desc: 设置群名 + params: group_id 群号；group_name 新群名 + set_group_leave: + desc: 退出群组 + params: group_id 群号；is_dismiss 是否解散 (boolean) + set_group_special_title: + desc: 设置群组专属头衔 + params: group_id 群号；user_id 要设置的QQ号；special_title 专属头衔，不填或空字符串表示删除；duration 专属头衔有效期（秒），-1表示永久 + set_friend_add_request: + desc: 处理加好友请求 + params: flag 加好友请求的flag (string)；approve 是否同意请求 (boolean)；remark 添加后的好友备注（仅同意时有效） + set_group_add_request: + desc: 处理加群请求/邀请 + params: flag 加群请求的flag (string)；sub_type/type add或invite 请求类型（需与上报一致）；approve 是否同意请求/邀请 (boolean)；reason 拒绝理由（仅拒绝时有效） +config: + owner: + - send_private_msg + - send_group_msg + - delete_msg + - send_like + - set_group_kick + - set_group_ban + - set_group_whole_ban + - set_group_admin + - set_group_card + - set_group_name + - set_group_leave + - set_group_special_title + - set_friend_add_request + - set_group_add_request + admin: + - send_group_msg + - delete_msg + - send_like + - set_group_kick + - set_group_ban + - set_group_whole_ban + - set_group_card + - set_group_name + - set_group_special_title + user: + - send_group_msg + - send_like diff --git a/agent.go b/agent.go new file mode 100644 index 0000000..7f2dae1 --- /dev/null +++ b/agent.go @@ -0,0 +1,107 @@ +package goba + +import ( + "encoding/json" + "io" + + "github.com/fumiama/deepinfra" + "github.com/fumiama/deepinfra/model" + "github.com/pkg/errors" + zero "github.com/wdvxdr1123/ZeroBot" +) + +var ( + ErrZeroOrNegContextCap = errors.New("ctxcap <= 0") + ErrZeroOrNegEventCap = errors.New("evcap <= 0") + ErrPermissionDenied = errors.New("permission denied") +) + +// Agent is a OneBot event context, it is recommended to create one agent +// per group or per user. +type Agent struct { + id int64 + nickname, sex string + chars string + ctxcap, evcap int + // 64 bits or 32 bits gap + ctx generalctx + perm *Perm +} + +// NewAgent characteristics 最好是 MD 格式 +func NewAgent(id int64, nickname, sex string, characteristics string) Agent { + return Agent{ + id: id, nickname: nickname, sex: sex, chars: characteristics, + ctxcap: 16, evcap: 8, + } +} + +func (ag *Agent) SetContextCap(n int) { + if n <= 0 { + panic(ErrZeroOrNegContextCap) + } + ag.ctxcap = n +} + +func (ag *Agent) SetEventCap(n int) { + if n <= 0 { + panic(ErrZeroOrNegEventCap) + } + ag.evcap = n +} + +func (ag *Agent) AddEvent(ev *Event) { + addctx(&ag.ctx, ev, ag.ctxcap, ag.evcap) +} + +func (ag *Agent) AddRequest(req *zero.APIRequest) { + addctx(&ag.ctx, req, ag.ctxcap, ag.evcap) +} + +// GetAction get OneBot CallAction from LLM and add it to context. +// +// Note: +// +// 1. The response may be empty, meaning that LLM do not want +// to react with these events. In this case, this function will +// return io.EOF and the context will be left no change. +// +// 2. If LLM returns an invalid action, ErrPermissionDenied will be returned +// with complete req, caller may decide whether to use this req by themselves. +// Whatever, this req will not be added into the context. You may call +// AddRequest to add it but it is not recommended. +func (ag *Agent) GetAction(api deepinfra.API, m model.Protocol, role PermRole) ( + req zero.APIRequest, err error, +) { + p, err := ag.system(role) + if err != nil { + return + } + m.System(p) + + ag.ctx.mu.Lock() + for i, evs := range ag.ctx.ctx { + if i%2 == 0 { // is user input + m.User(evs.String()) + } else { // is agent callback + m.Assistant(evs.String()) + } + } + ag.ctx.mu.Unlock() + + resp, err := api.Request(m) + if err != nil { + return + } + err = json.Unmarshal([]byte(resp), &req) + if err == nil && req.Action == "" { + err = io.EOF + } + + if !ag.perm.allow(role, req.Action) { + err = errors.Wrap(ErrPermissionDenied, req.Action) + } else { + ag.AddRequest(&req) + } + return +} diff --git a/ctx.go b/ctx.go new file mode 100644 index 0000000..a98360f --- /dev/null +++ b/ctx.go @@ -0,0 +1,72 @@ +package goba + +import ( + "reflect" + "sync" + + "github.com/pkg/errors" + zero "github.com/wdvxdr1123/ZeroBot" +) + +var ( + ErrInvalidFirstContextType = errors.New("invalid first context type") +) + +var ( + eventType = reflect.TypeOf(Event{}) + // requestType = reflect.TypeOf(zero.APIRequest{}) +) + +type generalctx struct { + mu sync.Mutex + ctx []events +} + +func addctx[T Event | zero.APIRequest]( + ctx *generalctx, v *T, ctxcap, evcap int, +) { + ctx.mu.Lock() + defer ctx.mu.Unlock() + + typ := reflect.TypeOf(v).Elem() + + if len(ctx.ctx) == 0 { + // must triggered by event + if !typ.AssignableTo(eventType) { + panic(errors.Wrap(ErrInvalidFirstContextType, typ.String())) + } + + // ctxcap & evcap must > 0, no need to check + evs := make(events, 1, evcap) + evs[0] = v + ctx.ctx = make([]events, 1, ctxcap) + ctx.ctx[0] = evs + return + } + // Get the last events slice + lastEvents := &ctx.ctx[len(ctx.ctx)-1] + + // Check if the type matches the first element of the last events + firstElemType := reflect.TypeOf((*lastEvents)[0]).Elem() + if typ.AssignableTo(firstElemType) { + // Same type, add to the last events + if len(*lastEvents) >= evcap { + // Shift elements forward by 1 (discard first element) + copy((*lastEvents)[:], (*lastEvents)[1:]) + (*lastEvents)[len(*lastEvents)-1] = any(v) + } else { + *lastEvents = append(*lastEvents, any(v)) + } + return + } + + // Different type or empty last events, create new events slice + if len(ctx.ctx) >= ctxcap { + // Shift elements forward by 2 (user-assistant pair) + copy(ctx.ctx[:], ctx.ctx[2:]) + ctx.ctx = ctx.ctx[:len(ctx.ctx)-2] + } + evs := make(events, 1, evcap) + evs[0] = v + ctx.ctx = append(ctx.ctx, evs) +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..424ad81 --- /dev/null +++ b/go.mod @@ -0,0 +1,20 @@ +module github.com/fumiama/go-onebot-agent + +go 1.20 + +require ( + github.com/RomiChan/syncx v0.0.0-20240418144900-b7402ffdebc7 + github.com/fumiama/deepinfra v0.0.0-20250910144855-27a4e697106d + github.com/pkg/errors v0.9.1 + github.com/wdvxdr1123/ZeroBot v1.8.2-0.20250919145948-e8ffbbc995ac + gopkg.in/yaml.v3 v3.0.1 +) + +require ( + github.com/FloatTech/ttl v0.0.0-20240716161252-965925764562 // indirect + github.com/sirupsen/logrus v1.9.3 // indirect + github.com/tidwall/gjson v1.17.3 // indirect + github.com/tidwall/match v1.1.1 // indirect + github.com/tidwall/pretty v1.2.0 // indirect + golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..0afc1e7 --- /dev/null +++ b/go.sum @@ -0,0 +1,33 @@ +github.com/FloatTech/ttl v0.0.0-20240716161252-965925764562 h1:snfw7FNFym1eNnLrQ/VCf80LiQo9C7jHgrunZDwiRcY= +github.com/FloatTech/ttl v0.0.0-20240716161252-965925764562/go.mod h1:fHZFWGquNXuHttu9dUYoKuNbm3dzLETnIOnm1muSfDs= +github.com/RomiChan/syncx v0.0.0-20240418144900-b7402ffdebc7 h1:S/ferNiehVjNaBMNNBxUjLtVmP/YWD6Yh79RfPv4ehU= +github.com/RomiChan/syncx v0.0.0-20240418144900-b7402ffdebc7/go.mod h1:vD7Ra3Q9onRtojoY5sMCLQ7JBgjUsrXDnDKyFxqpf9w= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/fumiama/deepinfra v0.0.0-20250910144855-27a4e697106d h1:iGxnST620IHrJ47DXkjzrZJ2rskBogWze+UyvnAxT6g= +github.com/fumiama/deepinfra v0.0.0-20250910144855-27a4e697106d/go.mod h1:wW05PQSn8mo1mZIoa6LBUE+3xIBjkoONvnfPTV5ZOhY= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= +github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/tidwall/gjson v1.17.3 h1:bwWLZU7icoKRG+C+0PNwIKC6FCJO/Q3p2pZvuP0jN94= +github.com/tidwall/gjson v1.17.3/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs= +github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/wdvxdr1123/ZeroBot v1.8.2-0.20250919145948-e8ffbbc995ac h1:XWpJQrUg75qUMwyKZX1jjK4ZziS5R4m/yVv5JCee3/s= +github.com/wdvxdr1123/ZeroBot v1.8.2-0.20250919145948-e8ffbbc995ac/go.mod h1:C86nQ0gIdAri4K2vg8IIQIslt08zzrKMcqYt8zhkx1M= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/perm.go b/perm.go new file mode 100644 index 0000000..98c8548 --- /dev/null +++ b/perm.go @@ -0,0 +1,115 @@ +package goba + +import ( + _ "embed" + "os" + "strings" + + "github.com/RomiChan/syncx" + "github.com/pkg/errors" + "gopkg.in/yaml.v3" +) + +var ( + ErrNoSuchPermRole = errors.New("no such perm role") + ErrUnexpectedAction = errors.New("unexpected action") +) + +type PermRole string + +const ( + PermRoleOwner PermRole = "owner" + PermRoleAdmin PermRole = "admin" + PermRoleUser PermRole = "user" +) + +//go:embed actions.yaml +var innerpermtable []byte + +type PermAction struct { + Desc string `yaml:"desc"` + Params string `yaml:"params"` +} + +type Perm struct { + Actions map[string]PermAction `yaml:"actions"` + Config map[PermRole][]string `yaml:"config"` + cache syncx.Map[PermRole, actions] `yaml:"-"` +} + +func (p *Perm) mdtable(role PermRole) (string, error) { + acs, ok := p.Config[role] + if !ok { + return "", errors.Wrap(ErrNoSuchPermRole, string(role)) + } + table := strings.Builder{} + table.WriteString("|功能|action|params|\n|---|---|---|") + var ac actions + if _, ok := p.cache.Load(role); ok { + ac = actions{} + } + for _, act := range acs { + a, ok := p.Actions[act] + if !ok { + panic(errors.Wrap(ErrUnexpectedAction, act)) + } + if ac != nil { + ac[act] = struct{}{} + } + table.WriteString("\n|") + table.WriteString(a.Desc) + table.WriteByte('|') + table.WriteString(act) + table.WriteByte('|') + table.WriteString(a.Params) + table.WriteByte('|') + } + if ac != nil { + p.cache.Store(role, ac) + } + return table.String(), nil +} + +func (p *Perm) allow(role PermRole, action string) bool { + ac, ok := p.cache.Load(role) + if ok { + return ac.allow(action) + } + acs, ok := p.Config[role] + if !ok { + return false + } + ac = actions{} + for _, act := range acs { + ac[act] = struct{}{} + } + p.cache.Store(role, ac) + return ac.allow(action) +} + +type actions map[string]struct{} + +func (ac actions) allow(action string) bool { + _, ok := ac[action] + return ok +} + +// LoadPermTable 读取 yaml file 并根据权限生成 MD 表格, 参数为空则加载内嵌配置 +func (ag *Agent) LoadPermTable(file ...string) error { + var data []byte + if len(file) == 0 { + data = innerpermtable + } else { + var err error + data, err = os.ReadFile(file[0]) + if err != nil { + return err + } + } + var cfg Perm + if err := yaml.Unmarshal(data, &cfg); err != nil { + return err + } + ag.perm = &cfg + return nil +} diff --git a/perm_test.go b/perm_test.go new file mode 100644 index 0000000..d3a6b53 --- /dev/null +++ b/perm_test.go @@ -0,0 +1,36 @@ +package goba + +import "testing" + +const fulltab = `|功能|action|params| +|---|---|---| +|发送私聊消息|send_private_msg|user_id 对方QQ号；message 要发送的内容 (json.RawMessage)| +|发送群消息|send_group_msg|group_id 群号；message 要发送的内容 (json.RawMessage)| +|撤回消息|delete_msg|message_id 消息ID| +|发送好友赞|send_like|user_id 对方QQ号；times 赞的次数，每个好友每天最多10次 (number)| +|群组踢人|set_group_kick|group_id 群号；user_id 要踢的QQ号；reject_add_request 拒绝此人的加群请求 (boolean)| +|群组单人禁言|set_group_ban|group_id 群号；user_id 要禁言的QQ号；duration 禁言时长（秒），0表示取消禁言| +|群组全员禁言|set_group_whole_ban|group_id 群号；enable 是否禁言 (boolean)| +|群组设置管理员|set_group_admin|group_id 群号；user_id 要设置管理员的QQ号；enable true为设置，false为取消| +|设置群名片|set_group_card|group_id 群号；user_id 要设置的QQ号；card 群名片内容，不填或空字符串表示删除群名片| +|设置群名|set_group_name|group_id 群号；group_name 新群名| +|退出群组|set_group_leave|group_id 群号；is_dismiss 是否解散 (boolean)| +|设置群组专属头衔|set_group_special_title|group_id 群号；user_id 要设置的QQ号；special_title 专属头衔，不填或空字符串表示删除；duration 专属头衔有效期（秒），-1表示永久| +|处理加好友请求|set_friend_add_request|flag 加好友请求的flag (string)；approve 是否同意请求 (boolean)；remark 添加后的好友备注（仅同意时有效）| +|处理加群请求/邀请|set_group_add_request|flag 加群请求的flag (string)；sub_type/type add或invite 请求类型（需与上报一致）；approve 是否同意请求/邀请 (boolean)；reason 拒绝理由（仅拒绝时有效）|` + +func TestMDTable(t *testing.T) { + ag := new(Agent) + err := ag.LoadPermTable() + if err != nil { + t.Fatal(err) + } + tab, err := ag.perm.mdtable(PermRoleOwner) + if err != nil { + t.Fatal(err) + } + t.Log(tab) + if tab != fulltab { + t.Fail() + } +} diff --git a/prompt.go b/prompt.go new file mode 100644 index 0000000..6726a5f --- /dev/null +++ b/prompt.go @@ -0,0 +1,17 @@ +package goba + +import ( + _ "embed" + "fmt" +) + +//go:embed README.md +var sysp string + +func (ag *Agent) system(role PermRole) (string, error) { + tab, err := ag.perm.mdtable(role) + if err != nil { + return "", err + } + return fmt.Sprintf(sysp, ag.id, ag.nickname, ag.sex, ag.chars, tab), nil +} diff --git a/types.go b/types.go new file mode 100644 index 0000000..fb0f966 --- /dev/null +++ b/types.go @@ -0,0 +1,43 @@ +package goba + +import ( + "encoding/json" + "strings" + + "github.com/pkg/errors" + zero "github.com/wdvxdr1123/ZeroBot" +) + +type events []any + +func (evs events) String() string { + sb := strings.Builder{} + for _, ev := range evs { + err := json.NewEncoder(&sb).Encode(ev) // has been terminated with '\n' + if err != nil { + panic(errors.Wrap(err, "unexpected")) + } + } + return strings.TrimSpace(sb.String()) +} + +// Event is the simplified OneBot event that dumped to the agent in JSON format +type Event struct { + Time int64 `json:"time"` // 事件发生的时间戳 + PostType string `json:"post_type"` // 上报类型: message / notice / request + MessageType string `json:"message_type"` // message 类型: group / private + SubType string `json:"sub_type"` // message 子类型: normal (一般消息) / notice (灰色小字通知) + MessageID int64 `json:"message_id"` // 消息 ID, 唯一标识该事件 + GroupID int64 `json:"group_id"` // QQ群号 + UserID int64 `json:"user_id"` // 事件发送者QQ号 + TargetID int64 `json:"target_id"` + SelfID int64 `json:"self_id"` // 收到事件的QQ号 (你的ID) + NoticeType string `json:"notice_type,omitempty"` + OperatorID int64 `json:"operator_id"` // This field is used for Notice Event + File *zero.File `json:"file,omitempty"` + RequestType string `json:"request_type,omitempty"` + Flag string `json:"flag,omitempty"` + Comment string `json:"comment,omitempty"` // This field is used for Request Event + Sender *zero.User `json:"sender,omitempty"` // 事件发送者个人信息 + Message json.RawMessage `json:"message,omitempty"` // JSON 格式的消息内容 +}