├── .gitignore
├── LICENSE
├── README.md
├── build.gradle.kts
├── gradle.properties
├── gradle
├── libs.versions.toml
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── qqbot-api
├── build.gradle.kts
└── src
│ └── main
│ └── kotlin
│ └── me
│ └── zhenxin
│ └── qqbot
│ ├── api
│ ├── ApiManager.kt
│ ├── OpenApi.kt
│ └── v1
│ │ └── GatewayApi.kt
│ └── exception
│ └── ApiException.kt
├── qqbot-common
├── build.gradle.kts
└── src
│ └── main
│ └── kotlin
│ └── me
│ └── zhenxin
│ └── qqbot
│ ├── entity
│ ├── AccessInfo.kt
│ ├── Channel.kt
│ ├── Gateway.kt
│ ├── Guild.kt
│ ├── Member.kt
│ └── User.kt
│ └── enums
│ ├── ChannelSubType.kt
│ ├── ChannelType.kt
│ ├── Intent.kt
│ ├── PrivateType.kt
│ └── SpeakPermission.kt
├── qqbot-logging
├── build.gradle.kts
└── src
│ └── main
│ └── resources
│ └── logback.xml
├── qqbot-sdk
├── build.gradle.kts
└── src
│ ├── main
│ └── kotlin
│ │ └── me
│ │ └── zhenxin
│ │ └── qqbot
│ │ └── BotCore.kt
│ └── test
│ ├── java
│ └── BotTest.java
│ └── kotlin
│ └── BotTest.kt
├── qqbot-websocket
├── build.gradle.kts
└── src
│ └── main
│ └── kotlin
│ └── me
│ └── zhenxin
│ └── qqbot
│ ├── entity
│ ├── Identify.kt
│ ├── Payload.kt
│ ├── Ready.kt
│ └── Resume.kt
│ └── websocket
│ ├── WebSocketClient.kt
│ ├── WebSocketEvent.kt
│ └── WebSocketListener.kt
└── settings.gradle.kts
/.gitignore:
--------------------------------------------------------------------------------
1 | # Created by .ignore support plugin (hsz.mobi)
2 | ### Gradle template
3 | .gradle
4 | **/build/
5 | !src/**/build/
6 |
7 | # Ignore Gradle GUI config
8 | gradle-app.setting
9 |
10 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
11 | !gradle-wrapper.jar
12 |
13 | # Cache of project
14 | .gradletasknamecache
15 |
16 | # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
17 | # gradle/wrapper/gradle-wrapper.properties
18 |
19 | local.properties
20 |
21 | # IntelliJ IDEA
22 | .idea
23 | *.iml
24 | *.ipr
25 | *.iws
26 |
27 | # Logs
28 | logs
29 | *.log
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | QQBot SDK - QQ Official Bot SDK For Java
635 | Copyright (C) 2023 ZhenXin
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | QQBot SDK Copyright (C) 2023 ZhenXin
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 |
668 | https://www.gnu.org/licenses/>.
669 |
670 | The GNU General Public License does not permit incorporating your program
671 | into proprietary programs. If your program is a subroutine library, you
672 | may consider it more useful to permit linking proprietary applications with
673 | the library. If this is what you want to do, use the GNU Lesser General
674 | Public License instead of this License. But first, please read
675 | .
676 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | ![][banner]
4 |
5 | [![][maven-central]][maven-central-link] [![][license]](LICENSE)
6 |
7 |
8 |
9 | ## 使用
10 |
11 | 其中 `${version}` 为 [Maven Central][maven-central-link] 上的最新版本号。
12 |
13 | ### Gradle 项目
14 |
15 | ```groovy
16 | implementation 'me.zhenxin:qqbot-sdk:${version}' // Groovy DSL
17 | implementation("me.zhenxin:qqbot-sdk:${version}") // Kotlin DSL
18 | ```
19 |
20 | ### Maven 项目
21 |
22 | ```xml
23 |
24 |
25 | me.zhenxin
26 | qqbot-sdk
27 | ${version}
28 |
29 | ```
30 |
31 | ## 日志级别
32 |
33 | 设置环境变量 `QQBOT_LOG_LEVEL` 来设置日志级别
34 |
35 | | 日志级别 | 说明 |
36 | |---------|------|
37 | | `DEBUG` | 调试信息 |
38 | | `INFO` | 信息 |
39 | | `WARN` | 警告 |
40 | | `ERROR` | 错误 |
41 |
42 | ## 开源协议
43 |
44 | 本项目使用 [GPL-3.0](LICENSE) 协议开放源代码
45 |
46 | ```text
47 | QQBot SDK - QQ Official Bot SDK for Java/Kotlin
48 | Copyright (C) 2023 ZhenXin
49 | This program is free software: you can redistribute it and/or modify
50 | it under the terms of the GNU General Public License as published by
51 | the Free Software Foundation, either version 3 of the License, or
52 | (at your option) any later version.
53 | This program is distributed in the hope that it will be useful,
54 | but WITHOUT ANY WARRANTY; without even the implied warranty of
55 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
56 | GNU General Public License for more details.
57 | You should have received a copy of the GNU General Public License
58 | along with this program. If not, see .
59 | ```
60 |
61 | ## 赞助
62 |
63 | 如果您觉得本项目对您有帮助，欢迎赞助我们
64 |
65 | ![][donate-image]
66 |
67 | [banner]: https://socialify.git.ci/armoe-project/qqbot-sdk/image?description=1&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&stargazers=1&theme=Auto
68 |
69 | [maven-central]: https://img.shields.io/maven-central/v/me.zhenxin/qqbot-sdk?style=for-the-badge
70 |
71 | [maven-central-link]: https://central.sonatype.com/artifact/me.zhenxin/qqbot-sdk
72 |
73 | [license]: https://img.shields.io/github/license/armoe-project/qqbot-sdk?style=for-the-badge
74 |
75 | [docs-link]: https://qqbot.armoe.cn
76 |
77 | [qq-group-link]: https://qm.qq.com/q/yvYAnJEzsW
78 |
79 | [donate-image]: https://s2.loli.net/2022/01/12/wqhXNKAlnMZ5oci.png
80 |
--------------------------------------------------------------------------------
/build.gradle.kts:
--------------------------------------------------------------------------------
1 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
2 |
3 | plugins {
4 | alias(libs.plugins.kotlin.jvm)
5 | }
6 |
7 | allprojects {
8 | group = "me.zhenxin"
9 | version = "2.0.0-dev"
10 | }
11 |
12 | subprojects {
13 | apply {
14 | plugin("org.jetbrains.kotlin.jvm")
15 | }
16 |
17 | tasks.withType {
18 | kotlinOptions.jvmTarget = "1.8"
19 | }
20 | }
21 |
22 |
23 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | #
2 | # QQBot SDK - QQ Official Bot SDK For Java
3 | # Copyright (C) 2023 ZhenXin
4 | #
5 | # This program is free software: you can redistribute it and/or modify
6 | # it under the terms of the GNU General Public License as published by
7 | # the Free Software Foundation, either version 3 of the License, or
8 | # (at your option) any later version.
9 | #
10 | # This program is distributed in the hope that it will be useful,
11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | # GNU General Public License for more details.
14 | #
15 | # You should have received a copy of the GNU General Public License
16 | # along with this program. If not, see .
17 | #
18 |
19 | kotlin.code.style=official
20 | org.gradle.jvmargs=-Xmx1G
21 |
--------------------------------------------------------------------------------
/gradle/libs.versions.toml:
--------------------------------------------------------------------------------
1 | [versions]
2 | kotlin = "1.9.10"
3 | blossom = "1.3.1"
4 | okhttp = "4.11.0"
5 | java-websocket = "1.5.4"
6 | fastjson = "2.0.40"
7 | kotlin-logging = "5.1.0"
8 | logback = "1.3.11"
9 |
10 | [plugins]
11 | kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
12 | kyori-blossom = { id = "net.kyori.blossom", version.ref = "blossom" }
13 |
14 | [libraries]
15 | okhttp = { group = "com.squareup.okhttp3", name = "okhttp", version.ref = "okhttp" }
16 | java-websocket = { group = "org.java-websocket", name = "Java-WebSocket", version.ref = "java-websocket" }
17 | fastjson-kotlin = { group = "com.alibaba.fastjson2", name = "fastjson2-kotlin", version.ref = "fastjson" }
18 | kotlin-reflect = { group = "org.jetbrains.kotlin", name = "kotlin-reflect", version.ref = "kotlin" }
19 | kotlin-logging = { group = "io.github.oshai", name = "kotlin-logging-jvm", version.ref = "kotlin-logging" }
20 | logback-classic = { group = "ch.qos.logback", name = "logback-classic", version.ref = "logback" }
21 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/armoe-project/qqbot-sdk/dfac38624edbc76b34341437d2e049de2257a513/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #
2 | # QQBot SDK - QQ Official Bot SDK For Java
3 | # Copyright (C) 2023 ZhenXin
4 | #
5 | # This program is free software: you can redistribute it and/or modify
6 | # it under the terms of the GNU General Public License as published by
7 | # the Free Software Foundation, either version 3 of the License, or
8 | # (at your option) any later version.
9 | #
10 | # This program is distributed in the hope that it will be useful,
11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | # GNU General Public License for more details.
14 | #
15 | # You should have received a copy of the GNU General Public License
16 | # along with this program. If not, see .
17 | #
18 |
19 | distributionBase=GRADLE_USER_HOME
20 | distributionPath=wrapper/dists
21 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip
22 | networkTimeout=10000
23 | validateDistributionUrl=true
24 | zipStoreBase=GRADLE_USER_HOME
25 | zipStorePath=wrapper/dists
26 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #
4 | # QQBot SDK - QQ Official Bot SDK For Java
5 | # Copyright (C) 2023 ZhenXin
6 | #
7 | # This program is free software: you can redistribute it and/or modify
8 | # it under the terms of the GNU General Public License as published by
9 | # the Free Software Foundation, either version 3 of the License, or
10 | # (at your option) any later version.
11 | #
12 | # This program is distributed in the hope that it will be useful,
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 | # GNU General Public License for more details.
16 | #
17 | # You should have received a copy of the GNU General Public License
18 | # along with this program. If not, see .
19 | #
20 |
21 | ##############################################################################
22 | #
23 | # Gradle start up script for POSIX generated by Gradle.
24 | #
25 | # Important for running:
26 | #
27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
28 | # noncompliant, but you have some other compliant shell such as ksh or
29 | # bash, then to run this script, type that shell name before the whole
30 | # command line, like:
31 | #
32 | # ksh Gradle
33 | #
34 | # Busybox and similar reduced shells will NOT work, because this script
35 | # requires all of these POSIX shell features:
36 | # * functions;
37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»;
39 | # * compound commands having a testable exit status, especially «case»;
40 | # * various built-in commands including «command», «set», and «ulimit».
41 | #
42 | # Important for patching:
43 | #
44 | # (2) This script targets any POSIX shell, so it avoids extensions provided
45 | # by Bash, Ksh, etc; in particular arrays are avoided.
46 | #
47 | # The "traditional" practice of packing multiple parameters into a
48 | # space-separated string is a well documented source of bugs and security
49 | # problems, so this is (mostly) avoided, by progressively accumulating
50 | # options in "$@", and eventually passing that to Java.
51 | #
52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
54 | # see the in-line comments for details.
55 | #
56 | # There are tweaks for specific operating systems such as AIX, CygWin,
57 | # Darwin, MinGW, and NonStop.
58 | #
59 | # (3) This script is generated from the Groovy template
60 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
61 | # within the Gradle project.
62 | #
63 | # You can find Gradle at https://github.com/gradle/gradle/.
64 | #
65 | ##############################################################################
66 |
67 | # Attempt to set APP_HOME
68 |
69 | # Resolve links: $0 may be a link
70 | app_path=$0
71 |
72 | # Need this for daisy-chained symlinks.
73 | while
74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
75 | [ -h "$app_path" ]
76 | do
77 | ls=$( ls -ld "$app_path" )
78 | link=${ls#*' -> '}
79 | case $link in #(
80 | /*) app_path=$link ;; #(
81 | *) app_path=$APP_HOME$link ;;
82 | esac
83 | done
84 |
85 | # This is normally unused
86 | # shellcheck disable=SC2034
87 | APP_BASE_NAME=${0##*/}
88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
89 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
90 |
91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
92 | MAX_FD=maximum
93 |
94 | warn () {
95 | echo "$*"
96 | } >&2
97 |
98 | die () {
99 | echo
100 | echo "$*"
101 | echo
102 | exit 1
103 | } >&2
104 |
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in #(
111 | CYGWIN* ) cygwin=true ;; #(
112 | Darwin* ) darwin=true ;; #(
113 | MSYS* | MINGW* ) msys=true ;; #(
114 | NONSTOP* ) nonstop=true ;;
115 | esac
116 |
117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118 |
119 |
120 | # Determine the Java command to use to start the JVM.
121 | if [ -n "$JAVA_HOME" ] ; then
122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123 | # IBM's JDK on AIX uses strange locations for the executables
124 | JAVACMD=$JAVA_HOME/jre/sh/java
125 | else
126 | JAVACMD=$JAVA_HOME/bin/java
127 | fi
128 | if [ ! -x "$JAVACMD" ] ; then
129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130 |
131 | Please set the JAVA_HOME variable in your environment to match the
132 | location of your Java installation."
133 | fi
134 | else
135 | JAVACMD=java
136 | if ! command -v java >/dev/null 2>&1
137 | then
138 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
139 |
140 | Please set the JAVA_HOME variable in your environment to match the
141 | location of your Java installation."
142 | fi
143 | fi
144 |
145 | # Increase the maximum file descriptors if we can.
146 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
147 | case $MAX_FD in #(
148 | max*)
149 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
150 | # shellcheck disable=SC3045
151 | MAX_FD=$( ulimit -H -n ) ||
152 | warn "Could not query maximum file descriptor limit"
153 | esac
154 | case $MAX_FD in #(
155 | '' | soft) :;; #(
156 | *)
157 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
158 | # shellcheck disable=SC3045
159 | ulimit -n "$MAX_FD" ||
160 | warn "Could not set maximum file descriptor limit to $MAX_FD"
161 | esac
162 | fi
163 |
164 | # Collect all arguments for the java command, stacking in reverse order:
165 | # * args from the command line
166 | # * the main class name
167 | # * -classpath
168 | # * -D...appname settings
169 | # * --module-path (only if needed)
170 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
171 |
172 | # For Cygwin or MSYS, switch paths to Windows format before running java
173 | if "$cygwin" || "$msys" ; then
174 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
175 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
176 |
177 | JAVACMD=$( cygpath --unix "$JAVACMD" )
178 |
179 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
180 | for arg do
181 | if
182 | case $arg in #(
183 | -*) false ;; # don't mess with options #(
184 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
185 | [ -e "$t" ] ;; #(
186 | *) false ;;
187 | esac
188 | then
189 | arg=$( cygpath --path --ignore --mixed "$arg" )
190 | fi
191 | # Roll the args list around exactly as many times as the number of
192 | # args, so each arg winds up back in the position where it started, but
193 | # possibly modified.
194 | #
195 | # NB: a `for` loop captures its iteration list before it begins, so
196 | # changing the positional parameters here affects neither the number of
197 | # iterations, nor the values presented in `arg`.
198 | shift # remove old arg
199 | set -- "$@" "$arg" # push replacement arg
200 | done
201 | fi
202 |
203 |
204 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
205 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
206 |
207 | # Collect all arguments for the java command;
208 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
209 | # shell script including quotes and variable substitutions, so put them in
210 | # double quotes to make sure that they get re-expanded; and
211 | # * put everything else in single quotes, so that it's not re-expanded.
212 |
213 | set -- \
214 | "-Dorg.gradle.appname=$APP_BASE_NAME" \
215 | -classpath "$CLASSPATH" \
216 | org.gradle.wrapper.GradleWrapperMain \
217 | "$@"
218 |
219 | # Stop when "xargs" is not available.
220 | if ! command -v xargs >/dev/null 2>&1
221 | then
222 | die "xargs is not available"
223 | fi
224 |
225 | # Use "xargs" to parse quoted args.
226 | #
227 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
228 | #
229 | # In Bash we could simply go:
230 | #
231 | # readarray ARGS < <( xargs -n1 <<<"$var" ) &&
232 | # set -- "${ARGS[@]}" "$@"
233 | #
234 | # but POSIX shell has neither arrays nor command substitution, so instead we
235 | # post-process each arg (as a line of input to sed) to backslash-escape any
236 | # character that might be a shell metacharacter, then use eval to reverse
237 | # that process (while maintaining the separation between arguments), and wrap
238 | # the whole thing up as a single "set" statement.
239 | #
240 | # This will of course break if any of these variables contains a newline or
241 | # an unmatched quote.
242 | #
243 |
244 | eval "set -- $(
245 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
246 | xargs -n1 |
247 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
248 | tr '\n' ' '
249 | )" '"$@"'
250 |
251 | exec "$JAVACMD" "$@"
252 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 |
17 | @if "%DEBUG%"=="" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 |
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 |
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%"=="" set DIRNAME=.
29 | @rem This is normally unused
30 | set APP_BASE_NAME=%~n0
31 | set APP_HOME=%DIRNAME%
32 |
33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
35 |
36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
38 |
39 | @rem Find java.exe
40 | if defined JAVA_HOME goto findJavaFromJavaHome
41 |
42 | set JAVA_EXE=java.exe
43 | %JAVA_EXE% -version >NUL 2>&1
44 | if %ERRORLEVEL% equ 0 goto execute
45 |
46 | echo.
47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
48 | echo.
49 | echo Please set the JAVA_HOME variable in your environment to match the
50 | echo location of your Java installation.
51 |
52 | goto fail
53 |
54 | :findJavaFromJavaHome
55 | set JAVA_HOME=%JAVA_HOME:"=%
56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
57 |
58 | if exist "%JAVA_EXE%" goto execute
59 |
60 | echo.
61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
62 | echo.
63 | echo Please set the JAVA_HOME variable in your environment to match the
64 | echo location of your Java installation.
65 |
66 | goto fail
67 |
68 | :execute
69 | @rem Setup the command line
70 |
71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
72 |
73 |
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
76 |
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if %ERRORLEVEL% equ 0 goto mainEnd
80 |
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | set EXIT_CODE=%ERRORLEVEL%
85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1
86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
87 | exit /b %EXIT_CODE%
88 |
89 | :mainEnd
90 | if "%OS%"=="Windows_NT" endlocal
91 |
92 | :omega
93 |
--------------------------------------------------------------------------------
/qqbot-api/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.kyori.blossom)
3 | }
4 |
5 | blossom {
6 | replaceToken("#VERSION#", project.version.toString())
7 | }
8 |
9 | dependencies {
10 | api(project(":qqbot-common"))
11 |
12 | api(libs.okhttp)
13 | }
--------------------------------------------------------------------------------
/qqbot-api/src/main/kotlin/me/zhenxin/qqbot/api/ApiManager.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.api
20 |
21 | import me.zhenxin.qqbot.api.v1.GatewayApi
22 | import me.zhenxin.qqbot.entity.AccessInfo
23 |
24 | /**
25 | * API 管理器
26 | *
27 | * @author 真心
28 | * @since 2023/10/3 20:37
29 | */
30 | class ApiManager(private val accessInfo: AccessInfo) {
31 |
32 | fun getGatewayApi(): GatewayApi {
33 | return GatewayApi(accessInfo)
34 | }
35 | }
--------------------------------------------------------------------------------
/qqbot-api/src/main/kotlin/me/zhenxin/qqbot/api/OpenApi.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.api
20 |
21 | import com.alibaba.fastjson2.JSON
22 | import com.alibaba.fastjson2.toJSONString
23 | import io.github.oshai.kotlinlogging.KotlinLogging
24 | import me.zhenxin.qqbot.entity.AccessInfo
25 | import me.zhenxin.qqbot.exception.ApiException
26 | import okhttp3.MediaType.Companion.toMediaType
27 | import okhttp3.OkHttpClient
28 | import okhttp3.Request
29 | import okhttp3.RequestBody
30 | import okhttp3.RequestBody.Companion.toRequestBody
31 |
32 | val logger = KotlinLogging.logger {}
33 |
34 | /**
35 | * 基本接口
36 | *
37 | * @author 真心
38 | * @since 2023/10/3 20:38
39 | */
40 | abstract class OpenApi(accessInfo: AccessInfo) {
41 | private val base = if (accessInfo.isSandbox) "https://sandbox.api.sgroup.qq.com" else "https://api.sgroup.qq.com"
42 | private val botAppId = accessInfo.botAppId
43 | private val botToken = accessInfo.botToken
44 |
45 | private val client = OkHttpClient()
46 |
47 | protected fun get(url: String, clazz: Class): T {
48 | val request = Request.Builder().url(base + url).get().addBotHeader().build()
49 | return request(request, clazz)
50 | }
51 |
52 | protected fun post(url: String, data: Map, clazz: Class): T {
53 | val builder = Request.Builder().url(base + url)
54 | val body = requestBody(data)
55 | val request = builder.post(body).addBotHeader().build()
56 | return request(request, clazz)
57 | }
58 |
59 | protected fun put(url: String, data: Map, clazz: Class): T {
60 | val builder = Request.Builder().url(base + url)
61 | val body = requestBody(data)
62 | val request = builder.put(body).addBotHeader().build()
63 | return request(request, clazz)
64 | }
65 |
66 | protected fun delete(url: String, clazz: Class): T {
67 | val request = Request.Builder().url(base + url).delete().addBotHeader().build()
68 | return request(request, clazz)
69 | }
70 |
71 | protected fun patch(url: String, data: Map, clazz: Class): T {
72 | val builder = Request.Builder().url(base + url)
73 | val body = requestBody(data)
74 | val request = builder.patch(body).addBotHeader().build()
75 | return request(request, clazz)
76 | }
77 |
78 | private fun requestBody(data: Map): RequestBody {
79 | val json = data.toJSONString()
80 | val mediaType = "application/json; charset=utf-8".toMediaType()
81 | return json.toRequestBody(mediaType)
82 | }
83 |
84 |
85 | private fun request(request: Request, clazz: Class): T {
86 | logger.debug { "HTTP Request: ${request.method} ${request.url}" }
87 | if (request.body != null) {
88 | logger.debug { "HTTP Request Body: ${request.body}" }
89 | }
90 |
91 | val call = client.newCall(request)
92 | val response = call.execute()
93 | val body = response.body?.string()
94 | ?: throw RuntimeException("HTTP Request failed with code ${response.code}, message: ${response.message}")
95 |
96 | logger.debug { "HTTP Response: ${response.code} ${response.message}" }
97 | logger.debug { "HTTP Response Body: $body" }
98 |
99 | if (response.code != 200) {
100 | throw ApiException(
101 | response.code,
102 | body,
103 | response.headers["X-Trace-Id"] ?: "N/A"
104 | )
105 | }
106 |
107 | return JSON.to(clazz, body)
108 | ?: throw RuntimeException("JSON parse failed, body: $body")
109 | }
110 |
111 | private fun Request.Builder.addBotHeader(): Request.Builder {
112 | addHeader("User-Agent", "qqbot-sdk/#VERSION#")
113 | addHeader("Authorization", "Bot $botAppId.$botToken")
114 | return this
115 | }
116 |
117 | }
--------------------------------------------------------------------------------
/qqbot-api/src/main/kotlin/me/zhenxin/qqbot/api/v1/GatewayApi.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.api.v1
20 |
21 | import me.zhenxin.qqbot.api.OpenApi
22 | import me.zhenxin.qqbot.entity.AccessInfo
23 | import me.zhenxin.qqbot.entity.Gateway
24 |
25 | /**
26 | * 网关接口
27 | *
28 | * @author 真心
29 | * @since 2023/10/3 20:37
30 | */
31 | class GatewayApi(accessInfo: AccessInfo) : OpenApi(accessInfo) {
32 | fun getGateway(): Gateway {
33 | return get("/gateway", Gateway::class.java)
34 | }
35 |
36 | fun getBotGateway(): Gateway {
37 | return get("/gateway/bot", Gateway::class.java)
38 | }
39 | }
--------------------------------------------------------------------------------
/qqbot-api/src/main/kotlin/me/zhenxin/qqbot/exception/ApiException.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.exception
20 |
21 | /**
22 | * API 请求异常
23 | *
24 | * @author 真心
25 | * @since 2023/10/5 20:30
26 | */
27 | class ApiException(
28 | /**
29 | * 错误码
30 | */
31 | val code: Int,
32 | /**
33 | * 错误详情
34 | */
35 | val detail: String,
36 | /**
37 | * 错误 ID
38 | */
39 | val traceId: String,
40 | /**
41 | * 错误信息
42 | */
43 | override val message: String = "Status Code: $code, Detail: $detail, TraceId: $traceId"
44 | ) : RuntimeException(message)
--------------------------------------------------------------------------------
/qqbot-common/build.gradle.kts:
--------------------------------------------------------------------------------
1 | dependencies {
2 | api(libs.fastjson.kotlin)
3 | api(libs.kotlin.reflect)
4 |
5 | api(libs.kotlin.logging)
6 | }
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/entity/AccessInfo.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | /**
22 | * 访问信息
23 | *
24 | * @author 真心
25 | * @since 2023/10/1 23:55
26 | */
27 | data class AccessInfo(
28 | /**
29 | * 管理端的 BotAppID
30 | */
31 | var botAppId: Int = 0,
32 | /**
33 | * 管理端的 机器人令牌
34 | */
35 | var botToken: String = "",
36 | /**
37 | * 管理端的 机器人密钥
38 | */
39 | var botSecret: String = "",
40 | /**
41 | * 是否使用沙箱环境
42 | */
43 | var isSandbox: Boolean = false
44 | )
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/entity/Channel.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | import com.alibaba.fastjson2.annotation.JSONField
22 | import me.zhenxin.qqbot.enums.ChannelSubType
23 | import me.zhenxin.qqbot.enums.ChannelType
24 | import me.zhenxin.qqbot.enums.PrivateType
25 | import me.zhenxin.qqbot.enums.SpeakPermission
26 |
27 | /**
28 | * 子频道
29 | *
30 | * @author 真心
31 | * @since 2023/10/23 10:23
32 | */
33 | data class Channel(
34 | /**
35 | * 子频道 ID
36 | */
37 | var id: Long = 0,
38 | /**
39 | * 频道 ID
40 | */
41 | @JSONField(name = "guild_id")
42 | var guildId: Long = 0,
43 | /**
44 | * 名称
45 | */
46 | var name: String = "",
47 | /**
48 | * 子频道类型
49 | */
50 | var type: ChannelType = ChannelType.TEXT,
51 | /**
52 | * 子频道子类型
53 | */
54 | @JSONField(name = "sub_type")
55 | var subType: ChannelSubType = ChannelSubType.CHAT,
56 | /**
57 | * 排序
58 | */
59 | var position: Int = 0,
60 | /**
61 | * 所属分组 ID (在类型是分组时无效)
62 | */
63 | @JSONField(name = "parent_id")
64 | var parentId: String = "",
65 | /**
66 | * 创建人 ID
67 | */
68 | @JSONField(name = "owner_id")
69 | var ownerId: String = "",
70 | /**
71 | * 子频道私密类型
72 | */
73 | @JSONField(name = "private_type")
74 | var privateType: PrivateType = PrivateType.PUBLIC,
75 | /**
76 | * 子频道发言权限
77 | */
78 | @JSONField(name = "speak_permission")
79 | var speakPermission: SpeakPermission = SpeakPermission.ALL,
80 | /**
81 | * 子频道应用类型
82 | */
83 | @JSONField(name = "application_id")
84 | var applicationId: String = "",
85 | /**
86 | * 用户拥有的子频道权限
87 | */
88 | @JSONField(name = "permissions")
89 | var permissions: String = "",
90 | )
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/entity/Gateway.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | /**
22 | * 网关
23 | *
24 | * @author 真心
25 | * @since 2023/10/3 21:03
26 | */
27 | data class Gateway(
28 | /**
29 | * WebSocket 的连接地址
30 | */
31 | var url: String = "",
32 | /**
33 | * 建议 Shard 数量
34 | */
35 | var shards: Int = 1,
36 | /**
37 | * Session 限制信息
38 | */
39 | var sessionStartLimit: SessionStartLimit = SessionStartLimit(),
40 | )
41 |
42 | /**
43 | * Session 限制信息
44 | */
45 | data class SessionStartLimit(
46 | /**
47 | * 总数
48 | */
49 | var total: Int = 0,
50 | /**
51 | * 剩余
52 | */
53 | var remaining: Int = 0,
54 | /**
55 | * 重置时间
56 | */
57 | var resetAfter: Int = 0,
58 | /**
59 | * 最大并发数
60 | */
61 | var maxConcurrency: Int = 0,
62 | )
63 |
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/entity/Guild.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | import com.alibaba.fastjson2.annotation.JSONField
22 |
23 | /**
24 | * 频道
25 | *
26 | * @author 真心
27 | * @since 2023/10/23 10:00
28 | */
29 | data class Guild(
30 | /**
31 | * 频道 ID
32 | */
33 | var id: Long = 0,
34 | /**
35 | * 频道名称
36 | */
37 | var name: String = "",
38 | /**
39 | * 频道头像地址
40 | */
41 | var icon: String = "",
42 | /**
43 | * 创建人用户 ID
44 | */
45 | @JSONField(name = "owner_id")
46 | var ownerId: Long = 0,
47 | /**
48 | * 当前是否为创建人
49 | */
50 | @JSONField(name = "owner")
51 | var isOwner: Boolean = false,
52 | /**
53 | * 成员数量
54 | */
55 | @JSONField(name = "member_count")
56 | var memberCount: Int = 0,
57 | /**
58 | * 最大成员数量
59 | */
60 | @JSONField(name = "max_members")
61 | var maxMembers: Int = 0,
62 | /**
63 | * 描述
64 | */
65 | var description: String = "",
66 | /**
67 | * 加入时间
68 | */
69 | @JSONField(name = "joined_at")
70 | var joinedAt: String = "",
71 | /**
72 | * 操作用户 ID (仅在事件中存在)
73 | */
74 | @JSONField(name = "op_user_id")
75 | var opUserId: Long = 0,
76 | )
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/entity/Member.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | import com.alibaba.fastjson2.annotation.JSONField
22 |
23 | /**
24 | * 成员
25 | *
26 | * @author 真心
27 | * @since 2023/10/23 14:10
28 | */
29 | data class Member(
30 | /**
31 | * 频道 ID
32 | */
33 | @JSONField(name = "guild_id")
34 | val guildId: String = "",
35 | /**
36 | * 用户
37 | */
38 | var user: User = User(),
39 | /**
40 | * 昵称
41 | */
42 | @JSONField(name = "nick")
43 | var nickname: String = "",
44 | /**
45 | * 身份组
46 | */
47 | var roles: List = emptyList(),
48 | /**
49 | * 加入时间
50 | */
51 | @JSONField(name = "joined_at")
52 | var joinedAt: String = "",
53 | )
54 |
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/entity/User.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | import com.alibaba.fastjson2.annotation.JSONField
22 |
23 | /**
24 | * 用户
25 | *
26 | * @author 真心
27 | * @since 2023/10/6 17:06
28 | */
29 | data class User(
30 | /**
31 | * 用户 ID
32 | */
33 | var id: Long = 0,
34 | /**
35 | * 用户名
36 | */
37 | var username: String = "",
38 | /**
39 | * 用户的头像地址
40 | */
41 | var avatar: String = "",
42 | /**
43 | * 是否是机器人
44 | */
45 | @JSONField(name = "bot")
46 | var isBot: Boolean = false,
47 | /**
48 | * UnionOpenId
49 | */
50 | @JSONField(name = "union_openid")
51 | var unionOpenId: String = "",
52 | /**
53 | * UnionUserAccount
54 | */
55 | @JSONField(name = "union_user_account")
56 | var unionUserAccount: String = "",
57 | )
58 |
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/enums/ChannelSubType.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.enums
20 |
21 | /**
22 | * 子频道子类型
23 | *
24 | * @author 真心
25 | * @since 2023/10/23 10:33
26 | */
27 | enum class ChannelSubType(val value: Int) {
28 | /**
29 | * 闲聊
30 | */
31 | CHAT(0),
32 |
33 | /**
34 | * 公告
35 | */
36 | ANNOUNCEMENT(1),
37 |
38 | /**
39 | * 攻略
40 | */
41 | GUIDE(2),
42 |
43 | /**
44 | * 开黑
45 | */
46 | TEAM(3),
47 | }
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/enums/ChannelType.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.enums
20 |
21 | /**
22 | * 子频道类型
23 | *
24 | * @author 真心
25 | * @since 2023/10/23 10:27
26 | */
27 | enum class ChannelType(val value: Int) {
28 | /**
29 | * 文字子频道
30 | */
31 | TEXT(0),
32 |
33 | /**
34 | * 语音子频道
35 | */
36 | VOICE(2),
37 |
38 | /**
39 | * 子频道分组
40 | */
41 | CATEGORY(4),
42 |
43 | /**
44 | * 直播子频道
45 | */
46 | LIVE(10005),
47 |
48 | /**
49 | * 应用子频道
50 | */
51 | APP(10006),
52 |
53 | /**
54 | * 论坛子频道
55 | */
56 | FORUM(10007),
57 | }
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/enums/Intent.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.enums
20 |
21 | /**
22 | * 消息类型
23 | *
24 | * @author 真心
25 | * @since 2023/10/6 0:41
26 | */
27 |
28 | enum class Intent(val value: Int) {
29 | /**
30 | * 频道相关事件
31 | */
32 | GUILDS(1 shl 0),
33 |
34 | /**
35 | * 频道成员相关事件
36 | */
37 | GUILD_MEMBERS(1 shl 1),
38 |
39 | /**
40 | * 频道消息事件 (仅私域可用)
41 | */
42 | GUILD_MESSAGES(1 shl 9),
43 |
44 | /**
45 | * 消息表态相关事件
46 | */
47 | GUILD_MESSAGE_REACTIONS(1 shl 10),
48 |
49 | /**
50 | * 私聊消息相关事件
51 | */
52 | DIRECT_MESSAGE(1 shl 12),
53 |
54 | /**
55 | * 论坛相关事件 (公域可用)
56 | */
57 | OPEN_FORUMS_EVENTS(1 shl 18),
58 |
59 | /**
60 | * 音视频/直播子频道相关事件
61 | */
62 | AUDIO_OR_LIVE_CHANNEL_MEMBERS(1 shl 19),
63 |
64 | /**
65 | * 互动相关事件
66 | */
67 | INTERACTION(1 shl 26),
68 |
69 | /**
70 | * 消息审核相关事件
71 | */
72 | MESSAGE_AUDIT(1 shl 27),
73 |
74 | /**
75 | * 论坛相关事件 (私域可用)
76 | */
77 | FORUM_EVENT(1 shl 28),
78 |
79 | /**
80 | * 音频相关事件
81 | */
82 | AUDIO_ACTION(1 shl 29),
83 |
84 | /**
85 | * 频道消息事件 (公域可用)
86 | */
87 | PUBLIC_GUILD_MESSAGES(1 shl 30);
88 | }
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/enums/PrivateType.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.enums
20 |
21 | /**
22 | * 子频道私密类型
23 | *
24 | * @author 真心
25 | * @since 2023/10/23 10:38
26 | */
27 | enum class PrivateType(val value: Int) {
28 | /**
29 | * 公开
30 | */
31 | PUBLIC(0),
32 |
33 | /**
34 | * 群主/管理员可见
35 | */
36 | PRIVATE(1),
37 |
38 | /**
39 | * 群主/管理员/指定用户可见
40 | */
41 | CUSTOM(2),
42 | }
--------------------------------------------------------------------------------
/qqbot-common/src/main/kotlin/me/zhenxin/qqbot/enums/SpeakPermission.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.enums
20 |
21 | /**
22 | * 子频道发言权限
23 | *
24 | * @author 真心
25 | * @since 2023/10/23 10:41
26 | */
27 | enum class SpeakPermission(val value: Int) {
28 | /**
29 | * 无效类型
30 | */
31 | INVALID(0),
32 |
33 | /**
34 | * 所有人
35 | */
36 | ALL(1),
37 |
38 | /**
39 | * 群主/管理员/指定用户
40 | */
41 | CUSTOM(2),
42 | }
--------------------------------------------------------------------------------
/qqbot-logging/build.gradle.kts:
--------------------------------------------------------------------------------
1 | dependencies {
2 | implementation(libs.logback.classic)
3 | }
--------------------------------------------------------------------------------
/qqbot-logging/src/main/resources/logback.xml:
--------------------------------------------------------------------------------
1 |
18 |
19 |
20 |
21 |
22 |
23 | [%green(%d{yyyy-MM-dd HH:mm:ss}) %cyan(%-30.30c{29}) %yellow(%10.10t) %highlight(%5p)]: %msg%n
24 |
25 |
26 |
27 |
28 | ${QQBOT_LOG_PATH:-./logs}/latest.log
29 |
30 | ${QQBOT_LOG_PATH:-./logs}/%d{yyyy-MM-dd}.log
31 |
32 |
33 | [%d{yyyy-MM-dd HH:mm:ss} %-30.30c{29} %10.10t %5p]: %msg%n
34 | UTF-8
35 |
36 |
37 |
38 |
39 |
40 |
41 |
--------------------------------------------------------------------------------
/qqbot-sdk/build.gradle.kts:
--------------------------------------------------------------------------------
1 | dependencies {
2 | implementation(project(":qqbot-websocket"))
3 | implementation(project(":qqbot-logging"))
4 | }
5 |
--------------------------------------------------------------------------------
/qqbot-sdk/src/main/kotlin/me/zhenxin/qqbot/BotCore.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot
20 |
21 | import io.github.oshai.kotlinlogging.KotlinLogging
22 | import me.zhenxin.qqbot.api.ApiManager
23 | import me.zhenxin.qqbot.entity.AccessInfo
24 | import me.zhenxin.qqbot.enums.Intent
25 | import me.zhenxin.qqbot.websocket.WebSocketClient
26 | import java.net.URI
27 |
28 | val logger = KotlinLogging.logger {}
29 |
30 | /**
31 | * Bot 核心
32 | *
33 | * @author 真心
34 | * @since 2023/10/5 22:38
35 | */
36 | class BotCore(private val accessInfo: AccessInfo) {
37 | private var intents: MutableList = mutableListOf()
38 | private var shards: Int = 1
39 |
40 | fun start() {
41 | val url = getGatewayUrl()
42 | logger.info { "正在连接至网关：$url" }
43 | for (i in 0 until shards) {
44 | val uri = URI(url)
45 | val client = WebSocketClient(uri, accessInfo, intents)
46 | client.connect()
47 | }
48 | }
49 |
50 | fun getApiManager(): ApiManager {
51 | return ApiManager(accessInfo)
52 | }
53 |
54 | private fun getGatewayUrl(): String {
55 | val api = getApiManager().getGatewayApi()
56 | val gateway = api.getBotGateway()
57 | shards = gateway.shards
58 | return gateway.url
59 | }
60 |
61 | fun registerIntents(vararg intents: Intent) {
62 | this.intents.addAll(intents)
63 | }
64 | }
--------------------------------------------------------------------------------
/qqbot-sdk/src/test/java/BotTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | import me.zhenxin.qqbot.BotCore;
20 | import me.zhenxin.qqbot.entity.AccessInfo;
21 | import me.zhenxin.qqbot.enums.Intent;
22 |
23 | /**
24 | * 机器人测试类
25 | *
26 | * @author 真心
27 | * @since 2023/10/6 11:27
28 | */
29 | public class BotTest {
30 |
31 | public static void main(String[] args) {
32 | String botAppId = System.getenv("BOT_APP_ID");
33 | String botToken = System.getenv("BOT_TOKEN");
34 |
35 | AccessInfo accessInfo = new AccessInfo();
36 | accessInfo.setBotAppId(Integer.parseInt(botAppId));
37 | accessInfo.setBotToken(botToken);
38 | accessInfo.setSandbox(true);
39 |
40 | BotCore bot = new BotCore(accessInfo);
41 | bot.registerIntents(
42 | Intent.GUILDS,
43 | Intent.GUILD_MEMBERS,
44 | Intent.GUILD_MESSAGE_REACTIONS,
45 | Intent.DIRECT_MESSAGE,
46 | Intent.OPEN_FORUMS_EVENTS,
47 | Intent.AUDIO_OR_LIVE_CHANNEL_MEMBERS,
48 | Intent.INTERACTION,
49 | Intent.MESSAGE_AUDIT,
50 | Intent.PUBLIC_GUILD_MESSAGES
51 | );
52 | bot.start();
53 | }
54 | }
55 |
--------------------------------------------------------------------------------
/qqbot-sdk/src/test/kotlin/BotTest.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | import io.github.oshai.kotlinlogging.KotlinLogging
20 | import me.zhenxin.qqbot.BotCore
21 | import me.zhenxin.qqbot.entity.AccessInfo
22 | import me.zhenxin.qqbot.enums.Intent
23 | import me.zhenxin.qqbot.exception.ApiException
24 |
25 | val logger = KotlinLogging.logger {}
26 |
27 | /**
28 | * 机器人测试
29 | *
30 | * @author 真心
31 | * @since 2023/10/1 13:49
32 | */
33 |
34 | fun main() {
35 | val accessInfo = AccessInfo().apply {
36 | botAppId = System.getenv("BOT_APP_ID")?.toInt() ?: 0
37 | botToken = System.getenv("BOT_TOKEN") ?: ""
38 | isSandbox = System.getenv("IS_SANDBOX")?.toBoolean() ?: true
39 | }
40 |
41 | try {
42 | val bot = BotCore(accessInfo)
43 | bot.registerIntents(
44 | Intent.GUILDS,
45 | Intent.GUILD_MEMBERS,
46 | Intent.GUILD_MESSAGE_REACTIONS,
47 | Intent.DIRECT_MESSAGE,
48 | Intent.OPEN_FORUMS_EVENTS,
49 | Intent.AUDIO_OR_LIVE_CHANNEL_MEMBERS,
50 | Intent.INTERACTION,
51 | Intent.MESSAGE_AUDIT,
52 | Intent.PUBLIC_GUILD_MESSAGES,
53 | )
54 | bot.start()
55 | } catch (e: ApiException) {
56 | logger.debug { "ApiException: ${e.code} ${e.message} ${e.detail} ${e.traceId}" }
57 | e.printStackTrace()
58 | }
59 | }
--------------------------------------------------------------------------------
/qqbot-websocket/build.gradle.kts:
--------------------------------------------------------------------------------
1 | dependencies {
2 | api(project(":qqbot-api"))
3 |
4 | api(libs.java.websocket)
5 | }
--------------------------------------------------------------------------------
/qqbot-websocket/src/main/kotlin/me/zhenxin/qqbot/entity/Identify.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | import com.alibaba.fastjson2.annotation.JSONField
22 |
23 | /**
24 | * WebSocket 鉴权信息
25 | *
26 | * @author 真心
27 | * @since 2023/10/6 0:31
28 | */
29 | data class Identify(
30 | /**
31 | * Token
32 | */
33 | @JSONField(name = "token")
34 | var token: String,
35 | /**
36 | * 订阅事件
37 | */
38 | @JSONField(name = "intents")
39 | var intents: Int,
40 | /**
41 | * 分片数量
42 | */
43 | @JSONField(name = "shard")
44 | val shard: List = listOf(0, 1),
45 | /**
46 | * 配置信息
47 | */
48 | @JSONField(name = "properties")
49 | val properties: Map = mapOf()
50 | )
51 |
--------------------------------------------------------------------------------
/qqbot-websocket/src/main/kotlin/me/zhenxin/qqbot/entity/Payload.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | import com.alibaba.fastjson2.annotation.JSONField
22 |
23 | /**
24 | * 机器人 WebSocket 消息载荷
25 | *
26 | * @author 真心
27 | * @since 2023/10/5 22:27
28 | */
29 | data class Payload(
30 | /**
31 | * 操作
32 | */
33 | @JSONField(name = "op")
34 | val op: Int = 0,
35 | /**
36 | * 数据
37 | */
38 | @JSONField(name = "d")
39 | val data: Any = Any(),
40 | /**
41 | * 序号
42 | */
43 | @JSONField(name = "s")
44 | val seq: Long? = null,
45 | /**
46 | * 事件类型
47 | */
48 | @JSONField(name = "t")
49 | val type: String? = null
50 | )
51 |
--------------------------------------------------------------------------------
/qqbot-websocket/src/main/kotlin/me/zhenxin/qqbot/entity/Ready.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | import com.alibaba.fastjson2.annotation.JSONField
22 |
23 | /**
24 | * 准备就绪
25 | *
26 | * @author 真心
27 | * @since 2023/10/23 10:57
28 | */
29 | data class Ready(
30 | /**
31 | * 版本
32 | */
33 | val version: String,
34 | /**
35 | * 会话 ID
36 | */
37 | @JSONField(name = "session_id")
38 | val sessionId: String,
39 | /**
40 | * 用户
41 | */
42 | val user: User,
43 | /**
44 | * 分片数据
45 | */
46 | val shard: List,
47 | )
48 |
--------------------------------------------------------------------------------
/qqbot-websocket/src/main/kotlin/me/zhenxin/qqbot/entity/Resume.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.entity
20 |
21 | import com.alibaba.fastjson2.annotation.JSONField
22 |
23 | /**
24 | * WebSocket 恢复
25 | *
26 | * @author 真心
27 | * @since 2023/10/21 15:34
28 | */
29 | data class Resume(
30 | /**
31 | * Token
32 | */
33 | @JSONField(name = "token")
34 | val token: String,
35 | /**
36 | * 会话ID
37 | */
38 | @JSONField(name = "session_id")
39 | val sessionId: String,
40 | /**
41 | * 序号
42 | */
43 | @JSONField(name = "seq")
44 | val seq: Long
45 | )
--------------------------------------------------------------------------------
/qqbot-websocket/src/main/kotlin/me/zhenxin/qqbot/websocket/WebSocketClient.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.websocket
20 |
21 | import com.alibaba.fastjson2.to
22 | import com.alibaba.fastjson2.toJSONString
23 | import io.github.oshai.kotlinlogging.KotlinLogging
24 | import me.zhenxin.qqbot.entity.AccessInfo
25 | import me.zhenxin.qqbot.entity.Identify
26 | import me.zhenxin.qqbot.entity.Payload
27 | import me.zhenxin.qqbot.entity.Resume
28 | import me.zhenxin.qqbot.enums.Intent
29 | import org.java_websocket.client.WebSocketClient
30 | import org.java_websocket.handshake.ServerHandshake
31 | import java.net.URI
32 | import java.util.*
33 |
34 |
35 | private val logger = KotlinLogging.logger {}
36 |
37 | /**
38 | * WebSocket 客户端
39 | *
40 | * @author 真心
41 | * @since 2023/10/5 21:46
42 | */
43 | class WebSocketClient(
44 | serverUri: URI?,
45 | private val accessInfo: AccessInfo,
46 | private var intents: MutableList
47 | ) : WebSocketClient(serverUri) {
48 | private val token = "Bot ${accessInfo.botAppId}.${accessInfo.botToken}"
49 | private var heartbeatTimer: Timer? = null
50 |
51 | private var sequence: Long = 0
52 |
53 | var sessionId: String = ""
54 | var heartbeatInterval: Long = 0
55 |
56 | override fun onOpen(handshakedata: ServerHandshake?) {
57 | Thread.currentThread().name = "websocket"
58 | val status = "${handshakedata?.httpStatus} ${handshakedata?.httpStatusMessage}"
59 | logger.info { "已连接至网关，状态：$status" }
60 | }
61 |
62 | override fun send(text: String?) {
63 | logger.debug { "发送消息：$text" }
64 | super.send(text)
65 | }
66 |
67 | override fun onMessage(message: String?) {
68 | logger.debug { "收到消息：$message" }
69 | val payload = message.to() ?: return
70 | val listener = WebSocketListener(this)
71 |
72 | if (payload.seq != null) {
73 | sequence = payload.seq
74 | }
75 |
76 | when (payload.op) {
77 | 0 -> listener.onDispatch(payload) // 事件分发
78 | 10 -> listener.onHello(payload) // 连接成功之后，会收到该消息
79 | 7 -> listener.onReconnect() // 重连通知
80 | 9 -> listener.onInvalidSession() // 鉴权失败
81 | }
82 | }
83 |
84 | override fun onClose(code: Int, reason: String?, remote: Boolean) {
85 | when (code) {
86 | 4001 -> logger.info { "连接已关闭，错误码：$code，原因：无效的操作码(op)" }
87 | 4002 -> logger.info { "连接已关闭，错误码：$code，原因：无效的 Payload 数据($reason)" }
88 | 4007 -> logger.info { "连接已关闭，错误码：$code，原因：无效的序号($reason)" }
89 | 4008 -> logger.info { "连接已关闭，错误码：$code，原因：发送 Payload 太快($reason)" }
90 | 4009 -> logger.info { "连接已关闭，错误码：$code，原因：连接已过期，需要重新连接($reason)" }
91 | 4010 -> logger.info { "连接已关闭，错误码：$code，原因：无效的 Shard 数据($reason)" }
92 | 4011 -> logger.info { "连接已关闭，错误码：$code，原因：连接需要处理过多的事件，请使用分片($reason)" }
93 | 4012 -> logger.info { "连接已关闭，错误码：$code，原因：无效的版本($reason)" }
94 | 4013 -> logger.info { "连接已关闭，错误码：$code，原因：无效的 Intents 数据($reason)" }
95 | 4014 -> logger.info { "连接已关闭，错误码：$code，原因：订阅的 Intents 没有权限($reason)" }
96 | 4914 -> logger.info { "连接已关闭，错误码：$code，原因：机器人已下架，只允许使用沙箱环境($reason)" }
97 | 4915 -> logger.info { "连接已关闭，错误码：$code，原因：机器人已被封禁，不允许连接($reason)" }
98 | else -> logger.info { "连接已关闭，错误码：$code，原因：$reason，是否远程：$remote" }
99 | }
100 | logger.info { "5 秒后开始尝试重新连接..." }
101 | Thread.sleep(5000)
102 | reconnect(code)
103 | }
104 |
105 | override fun onError(ex: Exception?) {
106 | logger.error(ex) { "连接出现异常，错误信息：${ex?.localizedMessage}" }
107 | }
108 |
109 | private fun reconnect(code: Int) {
110 | logger.info { "正在重新连接..." }
111 | if (code != 4009) sessionId = ""
112 | val thread = Thread {
113 | Thread.currentThread().name = "websocket"
114 | reconnect()
115 | }
116 | thread.start()
117 | }
118 |
119 | fun startHeartbeat() {
120 | if (heartbeatTimer != null) heartbeatTimer?.cancel()
121 | heartbeatTimer = Timer()
122 | val task = object : TimerTask() {
123 | override fun run() {
124 | Thread.currentThread().name = "heartbeat"
125 | sendHeartbeat()
126 | }
127 | }
128 | heartbeatTimer?.schedule(task, 0, heartbeatInterval)
129 | }
130 |
131 | private fun sendHeartbeat() {
132 | val payload = Payload(
133 | op = 1,
134 | data = sequence
135 | )
136 | send(payload.toJSONString())
137 | }
138 |
139 | fun sendIdentify() {
140 | logger.info { "正在发送鉴权信息..." }
141 | var intentsNum = 0
142 | for (intent in intents) {
143 | intentsNum = intentsNum or intent.value
144 | }
145 | val identify = Identify(
146 | token = token,
147 | intents = intentsNum,
148 | )
149 | val payload = Payload(
150 | op = 2,
151 | data = identify
152 | )
153 | send(payload.toJSONString())
154 | }
155 |
156 | fun sendResume() {
157 | logger.info { "正在发送恢复信息..." }
158 | val resume = Resume(
159 | token = token,
160 | sessionId = sessionId,
161 | seq = sequence
162 | )
163 | val payload = Payload(
164 | op = 6,
165 | data = resume
166 | )
167 | send(payload.toJSONString())
168 | }
169 | }
--------------------------------------------------------------------------------
/qqbot-websocket/src/main/kotlin/me/zhenxin/qqbot/websocket/WebSocketEvent.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.websocket
20 |
21 | import com.alibaba.fastjson2.parseObject
22 | import com.alibaba.fastjson2.toJSONString
23 | import io.github.oshai.kotlinlogging.KotlinLogging
24 | import me.zhenxin.qqbot.entity.*
25 |
26 | private val logger = KotlinLogging.logger {}
27 |
28 | /**
29 | * WebSocket 事件
30 | *
31 | * @author 真心
32 | * @since 2023/10/6 1:17
33 | */
34 | class WebSocketEvent(
35 | private val client: WebSocketClient
36 | ) {
37 | fun onReady(payload: Payload) {
38 | val ready = payload.data()
39 | client.sessionId = ready.sessionId
40 | logger.info { "机器人 ${ready.user.username} 已上线，会话ID：${ready.sessionId}" }
41 | }
42 |
43 | fun onGuildCreate(payload: Payload) {
44 | val guild = payload.data()
45 | logger.info { "机器人加入：${guild.name}(${guild.id})" }
46 | }
47 |
48 | fun onGuildUpdate(payload: Payload) {
49 | val guild = payload.data()
50 | logger.info { "频道资料更新：${guild.name}(${guild.id})" }
51 | }
52 |
53 | fun onGuildDelete(payload: Payload) {
54 | val guild = payload.data()
55 | logger.info { "机器人离开频道：${guild.name}(${guild.id})" }
56 | }
57 |
58 | fun onChannelCreate(payload: Payload) {
59 | val channel = payload.data()
60 | logger.info { "子频道创建：${channel.name}(${channel.id})" }
61 | }
62 |
63 | fun onChannelUpdate(payload: Payload) {
64 | val channel = payload.data()
65 | logger.info { "子频道更新：${channel.name}(${channel.id})" }
66 | }
67 |
68 | fun onChannelDelete(payload: Payload) {
69 | val channel = payload.data()
70 | logger.info { "子频道删除：${channel.name}(${channel.id})" }
71 | }
72 |
73 | fun onGuildMemberAdd(payload: Payload) {
74 | val member = payload.data()
75 | logger.info { "频道成员加入：${member.user.username}(${member.user.id})" }
76 | }
77 |
78 | fun onGuildMemberUpdate(payload: Payload) {
79 | val member = payload.data()
80 | logger.info { "频道成员更新：${member.user.username}(${member.user.id})" }
81 | }
82 |
83 | fun onGuildMemberRemove(payload: Payload) {
84 | val member = payload.data()
85 | logger.info { "频道成员离开：${member.user.username}(${member.user.id})" }
86 | }
87 |
88 | private inline fun Payload.data(): T {
89 | val data = this.data.toJSONString().parseObject()
90 | logger.debug { "事件数据：$data" }
91 | return data
92 | }
93 | }
--------------------------------------------------------------------------------
/qqbot-websocket/src/main/kotlin/me/zhenxin/qqbot/websocket/WebSocketListener.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * QQBot SDK - QQ Official Bot SDK
3 | * Copyright (C) 2023 ZhenXin
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | package me.zhenxin.qqbot.websocket
20 |
21 | import com.alibaba.fastjson2.parseObject
22 | import com.alibaba.fastjson2.toJSONString
23 | import io.github.oshai.kotlinlogging.KotlinLogging
24 | import me.zhenxin.qqbot.entity.Payload
25 | import kotlin.system.exitProcess
26 |
27 | private val logger = KotlinLogging.logger {}
28 |
29 | /**
30 | * WebSocket 监听器
31 | *
32 | * @author 真心
33 | * @since 2023/10/5 23:10
34 | */
35 | class WebSocketListener(
36 | private val client: WebSocketClient
37 | ) {
38 | private val event = WebSocketEvent(client)
39 |
40 | fun onDispatch(payload: Payload) {
41 | when (payload.type) {
42 | "READY" -> event.onReady(payload)
43 | "RESUMED" -> logger.info { "恢复连接成功，离线事件已处理" }
44 | "GUILD_CREATE" -> event.onGuildCreate(payload)
45 | "GUILD_UPDATE" -> event.onGuildUpdate(payload)
46 | "GUILD_DELETE" -> event.onGuildDelete(payload)
47 | "CHANNEL_CREATE" -> event.onChannelCreate(payload)
48 | "CHANNEL_UPDATE" -> event.onChannelUpdate(payload)
49 | "CHANNEL_DELETE" -> event.onChannelDelete(payload)
50 | "GUILD_MEMBER_ADD" -> event.onGuildMemberAdd(payload)
51 | "GUILD_MEMBER_UPDATE" -> event.onGuildMemberUpdate(payload)
52 | "GUILD_MEMBER_REMOVE" -> event.onGuildMemberRemove(payload)
53 | else -> logger.warn { "未知事件：${payload.type}" }
54 | }
55 | }
56 |
57 | fun onReconnect() {
58 | logger.info { "服务端下发重连通知，准备开始重连" }
59 | }
60 |
61 | fun onInvalidSession() {
62 | logger.warn { "鉴权失败！请检查 AccessInfo 是否正确，并查看是否注册了正确的 Intent" }
63 | exitProcess(9)
64 | }
65 |
66 | fun onHello(payload: Payload) {
67 | val data = payload.data.toJSONString().parseObject()
68 | client.heartbeatInterval = data.getLong("heartbeat_interval")
69 |
70 | if (client.sessionId.isNotEmpty()) {
71 | client.sendResume()
72 | } else {
73 | client.sendIdentify()
74 | }
75 |
76 | client.startHeartbeat()
77 | }
78 | }
--------------------------------------------------------------------------------
/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | rootProject.name = "qqbot-sdk"
2 |
3 | include(
4 | ":qqbot-api",
5 | ":qqbot-common",
6 | ":qqbot-logging",
7 | ":qqbot-sdk",
8 | ":qqbot-websocket"
9 | )
10 |
--------------------------------------------------------------------------------