commit a3c2446a82b043d6a44af8131f4be0e6f1bef337 Author: HCha Date: Mon Jun 19 02:46:09 2023 +0800 初始化 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..46be705 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/demo* +/__pycache__* +config.json diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENCE @@ -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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..49107b2 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# OpenAI API 函数调用 DEMO + +该项目是一个 Python 程序，在与 OpenAI 的 GPT 模型对话时提供插件支持。 + +## 功能 + +- 支持设置代理服务器 +- 往消息列表中添加条目 +- 与用户进行对话并调用插件函数提供额外功能 +- 加载配置文件 +- 其他辅助函数 + +## 用法 + +1. 在 config.json 中配置项目所需的参数，例如 API 密钥、模型等。 + +2. 运行 main.py 文件。程序会读取配置文件，并根据配置的参数和提示，生成 OpenAI API 的请求并打印出回应。 + +## 插件功能 + +该项目提供了以下插件功能： + +1. 获取当前时间 +2. 运行系统指令 +3. 调用 Wolfram Alpha 的数学计算接口 +4. 爬取指定网页的文本内容 +5. 读取本地文件内容 +6. 将数据写入本地文件中 + +## 安装 + +克隆项目到本地： + +```bash +git clone https://github.com/PeterBilly/OpenAI-Functions.git +``` + +进入项目目录： + +```bash +cd OpenAI-Functions +``` + +安装依赖： + +```bash +pip install -r requirements.txt +``` + +## 配置文件 + +使用 config.json 文件进行配置，模板见 [config_template](config_template.json) + +## 许可证 + +该项目使用 AGPL v3 开源许可证。详情请参阅 [LICENCE](LICENCE) 文件。 diff --git a/config_template.json b/config_template.json new file mode 100644 index 0000000..178883d --- /dev/null +++ b/config_template.json @@ -0,0 +1,11 @@ +{ + "PROXY": false, // 是否使用代理 + "HTTP_PROXY": ["地址", 端口号], + "SOCKS_PROXY": ["地址", 端口号], + "api_key": "sk-OpenAI API key", + "wolfram_api_key": "Wolfram APP ID", + "model": "欲使用的端口号", + "base": "API 网址, e.g https://api.openai.com/v1", + "always_authenticate": false, // 永远批准AI的所有插件请求 + "system_prompt": "你的System Prompt" +} \ No newline at end of file diff --git a/function_generator.py b/function_generator.py new file mode 100644 index 0000000..cae946a --- /dev/null +++ b/function_generator.py @@ -0,0 +1,236 @@ +import datetime +import json +import os +import subprocess + +import bs4 +import requests + +wolfram_api_key = None +always_authenticate = False + +def gen_functions(functions_def: list) -> list: + function_params_list = [] + for user_function in functions_def: + try: + function = { + "name": user_function["name"], + "description": "\n".join([line.strip() for line in user_function["description"].strip().split("\n")]), + "parameters": { + "type": "object", + "properties": user_function["params"] + }, + "requires": list(user_function["params"].keys()) + } + function_params_list.append(function) + except KeyError: + print(f"函数 {user_function.get('name', '未知')} 无法识别") + return function_params_list + +def get_time(args: dict=None) -> dict: + if args is None: + args = {} + return json.dumps({"time": str(datetime.datetime.now())}) + +def run_cmd(args: dict=None) -> dict: + if args is None: + args = {} + cmd = args.get("cmd", "") + print(f"请求执行指令：{cmd}, 你是否授权这一行为? [Y/n/用户反馈] ", end="") + authorization = "y" if always_authenticate else input("") + if authorization.lower() == "n": + return json.dumps({"result": "User rejected the request"}) + elif authorization.lower() == "y" or authorization == "": + try: + result = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True, encoding='gbk') + return json.dumps( + { + "result": f"成功运行了指令：{cmd} {result.stdout.strip()}" + if result.returncode == 0 and result.stdout is not None + else f"运行指令时发生了错误：{cmd} {result.stderr.strip()}" + } + ) + except Exception as e: + return json.dumps({"result": str(e)}) + else: + return json.dumps({"result": f"User rejected the request with a feedback: {authorization}"}) + +def wolframalpha(args: dict=None) -> dict: + if args is None: + args = {} + query = args.get("query", "") + full_results = args.get("full_results", False) + base_url = "http://api.wolframalpha.com/v2/query" if full_results else "http://api.wolframalpha.com/v1/result" + if query == "": + return json.dumps({"error": "query is empty"}) + if wolfram_api_key is None: + return json.dumps({"error": "wolfram_api_key is empty"}) + + params = { + "input": query, + "format": "plaintext", + "appid": wolfram_api_key + } + if full_results: + params["output"] = "JSON" + + try: + response = requests.get(base_url, params=params) + response.raise_for_status() + result = response.json() if full_results else {"result": response.text} + return json.dumps(result) + except requests.exceptions.RequestException as e: + return json.dumps({"error": f"Request failed: {e}"}) + +def spider(args: dict=None) -> dict: + if args is None: + args = {} + url = args.get("url", "") + print(f"尝试爬取内容: {url}") + response = requests.get(url) + soup = bs4.BeautifulSoup(response.text, "html.parser") + text = ' '.join(soup.stripped_strings) + return json.dumps({"result": text}) + +def get_absolute_path(path): + return path if os.path.isabs(path) else os.path.abspath(path) + +def write(args: dict=None) -> dict: + if args is None: + args = {} + result = {'result': ""} + try: + path = args['path'] + content = args['content'] + encoding = args.get('encoding', 'utf-8') + if path == "": + path = "./" + path = get_absolute_path(path) + print(f"请求保存文件到：{path}, 你是否授权这一行为? [Y/n/用户反馈] ", end="") + authorization = "y" if always_authenticate else input("") + if authorization.lower() == "n": + result['result'] = "User rejected the request" + return json.dumps(result) + elif authorization.lower() == "y" or authorization == "": + os.makedirs(os.path.dirname(path), exist_ok=True) + # file deepcode ignore BinaryWrite: encoding be decided by AI + with open(path, 'w', encoding=encoding) as f: + f.write(content) + result['result'] = f"File saved successfully at {path}" + else: + result['result'] = f"User rejected the request with a feedback: {authorization}" + return json.dumps(result) + except Exception as e: + result['result'] = f"An error occurred while saving the file: {str(e)}" + return json.dumps(result) + +def read(args): + result = {'success': False, 'content': None, 'error': None} + try: + path = args['path'] + encoding = args['encoding'] if 'encoding' in args else 'utf-8' + print(f"请求读取文件：{path}, 你是否授权这一行为? [Y/n/用户反馈] ", end="") + authorization = "y" if always_authenticate else input("") + if authorization.lower() == "n": + result['error'] = "User rejected the request" + return json.dumps(result) + elif authorization.lower() == "y" or authorization == "": + with open(path, 'r', encoding=encoding) as f: + content = f.read() + result['success'] = True + result['content'] = content + else: + result['error'] = f"User rejected the request with a feedback: {authorization}" + return json.dumps(result) + except Exception as e: + result['error'] = str(e) + return json.dumps(result) + +functions_def = [ + { + "name": "get_time", + "user_friendly_name": "获取时间", + "description": "Get the current date time in YYYY-MM-DD HH:mm:SS.millisecond", + "params": {}, + "function": get_time + }, + { + "name": "run_cmd", + "user_friendly_name": "运行指令", + "description": """run a Windows command and get command output + Your command will be be running in a safe environment. + For file paths that has spaces, use double quotes to wrap the path.""", + "params": { + "cmd": { + "type": "string", + "description": "The command you would like to execute" + } + }, + "function": run_cmd + }, + { + "name": "wolframalpha", + "user_friendly_name": "Wolfram Alpha", + "description": """to get math answers using natural language + If the function fails, notify the user and try solve the problem""", + "params": { + "query": { + "type": "string", + "description": "describe your math question in natural language, you MUST use english language." + }, + "full_results": { + "type": "boolean", + "description": "set to true will return the answer in full, vice versa." + } + }, + "function": wolframalpha + }, + { + "name": "spider", + "user_friendly_name": "爬虫", + "description": "for getting text from a dedicated url", + "params": { + "url": { + "type": "string", + "description": "your dedicated url" + } + }, + "function": spider + }, + { + "name": "read", + "user_friendly_name": "读取文件", + "description": "read local file from a given path and encoding", + "params": { + "path": { + "type": "string", + "description": "Path to the file you would like to read" + }, + "encoding":{ + "type": "string", + "description": "The Encoding of the file you would like to read" + } + }, + "function": read + }, + { + "name": "write", + "user_friendly_name": "写入文件", + "description": "write data to local file from a given path and encoding", + "params": { + "path": { + "type": "string", + "description": "Path to the file you would like to write" + }, + "encoding":{ + "type": "string", + "description": "The Encoding of the file you would like to write" + }, + "content":{ + "type": "string", + "description": "Content you would like to write to the file" + } + }, + "function": write + } +] \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..af62807 --- /dev/null +++ b/main.py @@ -0,0 +1,170 @@ +import json +import os +import sys + +import openai +import socks + +import function_generator as fun + +SUPPORTED_MODELS = ["gpt-3.5-turbo-0613", "gpt-4-0613"] + +def set_proxy(HTTP_PROXY = None, SOCKS_PROXY = None): + """ + 设置代理服务器 + + Args: + HTTP_PROXY: HTTP代理服务器地址和端口号 + SOCKS_PROXY: SOCKS代理服务器地址和端口号 + """ + os.environ["http_proxy"] = f"http://{HTTP_PROXY[0]}:{HTTP_PROXY[1]}" + os.environ["https_proxy"] = f"http://{HTTP_PROXY[0]}:{HTTP_PROXY[1]}" + socks.set_default_proxy(socks.SOCKS5, SOCKS_PROXY[0], SOCKS_PROXY[1]) + +def add_msg(messages, role, msg, name = None): + """ + 往消息列表中添加条目 + + Args: + messages: 消息列表 + role: 发送者角色 (user/assistant/system/function) + msg: 消息内容 + name: 插件名称 + """ + if not name: + messages.append({"role": role, "content": msg}) + else: + messages.append({"role": role, "name": name, "content": msg}) + +def chat(messages, api_key, model, functions, base): + """ + 发起对话 + + Args: + messages: 消息列表 + api_key: OpenAI API密钥 + model: 使用的模型 + functions: 定义的插件函数 + base: API基础路径 + """ + while True: + openai.api_key = api_key + openai.api_base = base + try: + function_call = { + "name": "", + "arguments": "", + } + use_function = False + answer = "" + response = openai.ChatCompletion.create( + model = model, + messages = messages, + functions = functions, + function_call = "auto", + temperature = 1, + stream = True + ) + for chunk in response: + message = chunk["choices"][0] + if not message.get("finish_reason", None): + if message["delta"].get("function_call"): + use_function = True + function_call["name"] += message["delta"]["function_call"].get("name", "") + function_call["arguments"] += message["delta"]["function_call"].get("arguments", "") + if not use_function: + answer += message["delta"].get("content", "") + print(message["delta"].get("content", ""), end="") + elif not use_function: + return answer + try: + function_call["arguments"] = json.loads(function_call["arguments"]) + except json.JSONDecodeError: + function_call["arguments"] = {} + if use_function: + if function_call["name"] != "exit": + print(f"\n正在调用插件：{function_call['name']}") + function_response = eval(f"fun.{function_call['name']}({function_call['arguments']})") + add_msg(messages, "function", function_response, function_call["name"]) + except Exception as e: + print(f"调用OpenAI API时发生了错误: {str(e)}") + break + +def load_config(config_file): + """ + 加载配置文件 + + Args: + config_file: 配置文件路径 + + Returns: + config: 配置文件的字典 + """ + try: + with open(config_file, 'r', encoding="utf-8") as f: + config = json.load(f) + except Exception as e: + print(f"无法加载配置文件 {config_file}: {str(e)}") + config = {} + return config + +def main(): + config = load_config("config.json") + if config.get("PROXY", False): + HTTP_PROXY = config.get("HTTP_PROXY", None) + SOCKS_PROXY = config.get("SOCKS_PROXY", None) + if HTTP_PROXY is not None and SOCKS_PROXY is not None: + set_proxy(HTTP_PROXY, SOCKS_PROXY) + else: + print("HTTP_PROXY 或 SOCKS_PROXY 在 config.json 中为空, 将不会设置代理") + + api_key = config.get("api_key", None) + model = config.get("model", "gpt-3.5-turbo-0613") + base = config.get("base", "https://api.openai.com/v1") + system_prompt = config.get("system_prompt", None) + fun.wolfram_api_key = config.get("wolfram_api_key", None) + fun.always_authenticate = config.get("always_authenticate", False) + + messages = [] + functions = fun.gen_functions(fun.functions_def) + + if model not in SUPPORTED_MODELS: + print(f"你所使用的模型: {model} 当前无法使用函数功能 \ + \n请使用以下模型中的一个: {SUPPORTED_MODELS}") + sys.exit(1) + + if not api_key: + api_key = input("请输入你的api key: ") + + if not api_key.startswith("sk-"): + print("API key 无效, 正在退出...") + sys.exit(1) + + if system_prompt is not None: + add_msg(messages, "system", system_prompt) + + if fun.wolfram_api_key is None: + print("wolfram_api_key 并未在配置文件中给出, Wolfram Alpha将不可用.") + + if fun.always_authenticate: + print("**警告**: always_authenticate 已启用, 任何AI尝试执行的指令将不会征得你的同意") + print("你依然想要开启 always_authenticate 吗? [y/N] ", end="") + if input().lower() != "y": + fun.always_authenticate = False + print("always_authenticate 已关闭.") + while True: + prompt = input("\n>") + if prompt.startswith("/"): + if prompt == "/clear": + messages.clear() + os.system("cls") + print("消息已被清空") + else: + print(f"无法识别命令: {prompt}.") + continue + add_msg(messages, "user", prompt) + response = chat(messages, api_key, model, functions, base) + add_msg(messages, "assistant", response) + +if __name__ == "__main__": + main() \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..05b52e8 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +beautifulsoup4 +requests +openai +PySocks \ No newline at end of file