From b3bf3a7c16945e59abd558b484e2ac22d81d6edf Mon Sep 17 00:00:00 2001 From: sam Date: Tue, 3 Sep 2024 00:07:12 +0200 Subject: [PATCH] init --- .gitignore | 6 + .idea/.idea.Foxcord/.idea/.gitignore | 13 + .idea/.idea.Foxcord/.idea/encodings.xml | 4 + .idea/.idea.Foxcord/.idea/indexLayout.xml | 8 + .idea/.idea.Foxcord/.idea/misc.xml | 7 + .idea/.idea.Foxcord/.idea/vcs.xml | 6 + COPYING | 674 ++++++++++++++++++ COPYING.LESSER | 165 +++++ Foxcord.sln | 22 + Foxcord.sln.DotSettings | 2 + Foxcord/Foxcord.csproj | 14 + .../Gateway/DiscordGatewayClient.Dispatch.cs | 53 ++ .../Gateway/DiscordGatewayClient.Events.cs | 17 + Foxcord/Gateway/DiscordGatewayClient.cs | 231 ++++++ Foxcord/Gateway/DiscordGatewayRequestError.cs | 3 + .../Events/Dispatch/GuildCreateEvent.cs | 9 + Foxcord/Gateway/Events/Dispatch/IDispatch.cs | 13 + .../Events/Dispatch/MessageCreateEvent.cs | 8 + Foxcord/Gateway/Events/Dispatch/ReadyEvent.cs | 18 + Foxcord/Gateway/Events/DispatchEvent.cs | 8 + Foxcord/Gateway/Events/HeartbeatEvent.cs | 5 + Foxcord/Gateway/Events/HelloEvent.cs | 6 + Foxcord/Gateway/Events/IGatewayEvent.cs | 6 + Foxcord/Gateway/Events/IdentifyEvent.cs | 15 + Foxcord/Gateway/GatewayIntent.cs | 22 + Foxcord/Gateway/GatewayPacket.cs | 33 + Foxcord/Gateway/Types/UnavailableGuild.cs | 8 + Foxcord/Models/Guild.cs | 7 + Foxcord/Models/Message.cs | 9 + Foxcord/Models/Snowflake.cs | 80 +++ Foxcord/Models/User.cs | 21 + Foxcord/Rest/BaseRestClient.cs | 128 ++++ Foxcord/Rest/DiscordRestClient.cs | 66 ++ Foxcord/Rest/DiscordRestError.cs | 22 + Foxcord/Rest/Rate/BucketKeyUtils.cs | 65 ++ .../Rest/Rate/DiscordResilienceStrategy.cs | 34 + Foxcord/Rest/Rate/RateLimiter.cs | 161 +++++ Foxcord/Rest/Types/CreateMessageParams.cs | 6 + Foxcord/Rest/Types/GetGatewayBotResponse.cs | 5 + .../Serialization/JsonSerializerExtensions.cs | 19 + FoxcordTest/FoxcordTest.csproj | 19 + FoxcordTest/Program.cs | 25 + README.md | 14 + 43 files changed, 2057 insertions(+) create mode 100644 .gitignore create mode 100644 .idea/.idea.Foxcord/.idea/.gitignore create mode 100644 .idea/.idea.Foxcord/.idea/encodings.xml create mode 100644 .idea/.idea.Foxcord/.idea/indexLayout.xml create mode 100644 .idea/.idea.Foxcord/.idea/misc.xml create mode 100644 .idea/.idea.Foxcord/.idea/vcs.xml create mode 100644 COPYING create mode 100644 COPYING.LESSER create mode 100644 Foxcord.sln create mode 100644 Foxcord.sln.DotSettings create mode 100644 Foxcord/Foxcord.csproj create mode 100644 Foxcord/Gateway/DiscordGatewayClient.Dispatch.cs create mode 100644 Foxcord/Gateway/DiscordGatewayClient.Events.cs create mode 100644 Foxcord/Gateway/DiscordGatewayClient.cs create mode 100644 Foxcord/Gateway/DiscordGatewayRequestError.cs create mode 100644 Foxcord/Gateway/Events/Dispatch/GuildCreateEvent.cs create mode 100644 Foxcord/Gateway/Events/Dispatch/IDispatch.cs create mode 100644 Foxcord/Gateway/Events/Dispatch/MessageCreateEvent.cs create mode 100644 Foxcord/Gateway/Events/Dispatch/ReadyEvent.cs create mode 100644 Foxcord/Gateway/Events/DispatchEvent.cs create mode 100644 Foxcord/Gateway/Events/HeartbeatEvent.cs create mode 100644 Foxcord/Gateway/Events/HelloEvent.cs create mode 100644 Foxcord/Gateway/Events/IGatewayEvent.cs create mode 100644 Foxcord/Gateway/Events/IdentifyEvent.cs create mode 100644 Foxcord/Gateway/GatewayIntent.cs create mode 100644 Foxcord/Gateway/GatewayPacket.cs create mode 100644 Foxcord/Gateway/Types/UnavailableGuild.cs create mode 100644 Foxcord/Models/Guild.cs create mode 100644 Foxcord/Models/Message.cs create mode 100644 Foxcord/Models/Snowflake.cs create mode 100644 Foxcord/Models/User.cs create mode 100644 Foxcord/Rest/BaseRestClient.cs create mode 100644 Foxcord/Rest/DiscordRestClient.cs create mode 100644 Foxcord/Rest/DiscordRestError.cs create mode 100644 Foxcord/Rest/Rate/BucketKeyUtils.cs create mode 100644 Foxcord/Rest/Rate/DiscordResilienceStrategy.cs create mode 100644 Foxcord/Rest/Rate/RateLimiter.cs create mode 100644 Foxcord/Rest/Types/CreateMessageParams.cs create mode 100644 Foxcord/Rest/Types/GetGatewayBotResponse.cs create mode 100644 Foxcord/Serialization/JsonSerializerExtensions.cs create mode 100644 FoxcordTest/FoxcordTest.csproj create mode 100644 FoxcordTest/Program.cs create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a6dcb0e --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +bin/ +obj/ +/packages/ +riderModule.iml +/_ReSharper.Caches/ +*.DotSettings.user \ No newline at end of file diff --git a/.idea/.idea.Foxcord/.idea/.gitignore b/.idea/.idea.Foxcord/.idea/.gitignore new file mode 100644 index 0000000..9c82f76 --- /dev/null +++ b/.idea/.idea.Foxcord/.idea/.gitignore @@ -0,0 +1,13 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Rider ignored files +/contentModel.xml +/projectSettingsUpdater.xml +/modules.xml +/.idea.Foxcord.iml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/.idea.Foxcord/.idea/encodings.xml b/.idea/.idea.Foxcord/.idea/encodings.xml new file mode 100644 index 0000000..df87cf9 --- /dev/null +++ b/.idea/.idea.Foxcord/.idea/encodings.xml @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/.idea/.idea.Foxcord/.idea/indexLayout.xml b/.idea/.idea.Foxcord/.idea/indexLayout.xml new file mode 100644 index 0000000..7b08163 --- /dev/null +++ b/.idea/.idea.Foxcord/.idea/indexLayout.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/.idea.Foxcord/.idea/misc.xml b/.idea/.idea.Foxcord/.idea/misc.xml new file mode 100644 index 0000000..30bab2a --- /dev/null +++ b/.idea/.idea.Foxcord/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + \ No newline at end of file diff --git a/.idea/.idea.Foxcord/.idea/vcs.xml b/.idea/.idea.Foxcord/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/.idea.Foxcord/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/COPYING.LESSER b/COPYING.LESSER new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/COPYING.LESSER @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Foxcord.sln b/Foxcord.sln new file mode 100644 index 0000000..35ac145 --- /dev/null +++ b/Foxcord.sln @@ -0,0 +1,22 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Foxcord", "Foxcord\Foxcord.csproj", "{ED72AB3E-F424-4D1C-B134-F6CC7D45A37E}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FoxcordTest", "FoxcordTest\FoxcordTest.csproj", "{6A5F7346-ABC6-480D-938E-E97ECB7D1125}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {ED72AB3E-F424-4D1C-B134-F6CC7D45A37E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {ED72AB3E-F424-4D1C-B134-F6CC7D45A37E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {ED72AB3E-F424-4D1C-B134-F6CC7D45A37E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {ED72AB3E-F424-4D1C-B134-F6CC7D45A37E}.Release|Any CPU.Build.0 = Release|Any CPU + {6A5F7346-ABC6-480D-938E-E97ECB7D1125}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6A5F7346-ABC6-480D-938E-E97ECB7D1125}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6A5F7346-ABC6-480D-938E-E97ECB7D1125}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6A5F7346-ABC6-480D-938E-E97ECB7D1125}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/Foxcord.sln.DotSettings b/Foxcord.sln.DotSettings new file mode 100644 index 0000000..29c9df7 --- /dev/null +++ b/Foxcord.sln.DotSettings @@ -0,0 +1,2 @@ + + True \ No newline at end of file diff --git a/Foxcord/Foxcord.csproj b/Foxcord/Foxcord.csproj new file mode 100644 index 0000000..9903640 --- /dev/null +++ b/Foxcord/Foxcord.csproj @@ -0,0 +1,14 @@ + + + + net8.0 + enable + enable + + + + + + + + diff --git a/Foxcord/Gateway/DiscordGatewayClient.Dispatch.cs b/Foxcord/Gateway/DiscordGatewayClient.Dispatch.cs new file mode 100644 index 0000000..37ae970 --- /dev/null +++ b/Foxcord/Gateway/DiscordGatewayClient.Dispatch.cs @@ -0,0 +1,53 @@ +using System.Text.Json; +using Foxcord.Gateway.Events.Dispatch; +using Foxcord.Rest; +using Foxcord.Rest.Types; + +namespace Foxcord.Gateway; + +public partial class DiscordGatewayClient +{ + private IDispatch ParseDispatchEvent(string rawType, JsonElement rawPayload) + { + switch (rawType) + { + case DispatchEventTypeName.Ready: + return rawPayload.Deserialize(_jsonSerializerOptions)!; + case DispatchEventTypeName.GuildCreate: + return rawPayload.Deserialize(_jsonSerializerOptions)!; + case DispatchEventTypeName.MessageCreate: + return rawPayload.Deserialize(_jsonSerializerOptions)!; + default: + throw new ArgumentOutOfRangeException(nameof(rawType), $"Unknown dispatch event '{rawType}'"); + } + } + + private async Task HandleDispatch(IDispatch dispatch, CancellationToken ct = default) + { + switch (dispatch) + { + case ReadyEvent ready: + _logger.Debug("Received READY! API version: {Version}, user: {UserId}, shard: {Id}/{Total}", + ready.Version, ready.User.Id, ready.Shard.ShardId, ready.Shard.NumShards); + break; + case GuildCreateEvent guildCreate: + _logger.Debug("Received guild create for guild {Id} / {Name}", guildCreate.Id, guildCreate.Name); + break; + case MessageCreateEvent m: + _logger.Debug("Received message create from {User} in {Channel}. Content: {Content}", m.Author.Tag, + m.ChannelId, m.Content); + if (m.Content == "!ping") + { + var rest = new DiscordRestClient(_logger, + new DiscordRestClientOptions { Token = _token["Bot ".Length..] }); + await rest.CreateMessageAsync(m.ChannelId, + new CreateMessageParams(Content: $"Pong! Latency: {Latency.TotalMilliseconds}ms"), ct); + } + + break; + default: + _logger.Debug("Received dispatch event {DispatchType}", dispatch.GetType().Name); + break; + } + } +} \ No newline at end of file diff --git a/Foxcord/Gateway/DiscordGatewayClient.Events.cs b/Foxcord/Gateway/DiscordGatewayClient.Events.cs new file mode 100644 index 0000000..6d90c4b --- /dev/null +++ b/Foxcord/Gateway/DiscordGatewayClient.Events.cs @@ -0,0 +1,17 @@ +namespace Foxcord.Gateway; + +public partial class DiscordGatewayClient +{ + private void HandleHeartbeatAck() + { + _lastHeartbeatAck = DateTimeOffset.UtcNow; + _logger.Verbose("Received heartbeat ACK after {Latency}", _lastHeartbeatAck - _lastHeartbeatSend); + } + + private async Task HandleHeartbeatRequest(CancellationToken ct = default) + { + _logger.Information("Early heartbeat requested, sending heartbeat"); + await WritePacket(new GatewayPacket { Opcode = GatewayOpcode.Heartbeat, Payload = _lastSequence }, ct); + _lastHeartbeatSend = DateTimeOffset.UtcNow; + } +} \ No newline at end of file diff --git a/Foxcord/Gateway/DiscordGatewayClient.cs b/Foxcord/Gateway/DiscordGatewayClient.cs new file mode 100644 index 0000000..8e472b2 --- /dev/null +++ b/Foxcord/Gateway/DiscordGatewayClient.cs @@ -0,0 +1,231 @@ +using System.Buffers; +using System.Diagnostics.CodeAnalysis; +using System.Net.WebSockets; +using System.Text.Json; +using Foxcord.Gateway.Events; +using Foxcord.Serialization; +using Serilog; + +namespace Foxcord.Gateway; + +public partial class DiscordGatewayClient +{ + private const int GatewayVersion = 10; + private const int BufferSize = 64 * 1024; + + private readonly ILogger _logger; + private ClientWebSocket? _ws; + private readonly string _token; + private readonly Uri _gatewayUri; + private readonly GatewayIntent _intents; + private readonly JsonSerializerOptions _jsonSerializerOptions = JsonSerializerExtensions.CreateSerializer(); + + private long? _lastSequence = null; + private DateTimeOffset _lastHeartbeatSend = DateTimeOffset.UnixEpoch; + private DateTimeOffset _lastHeartbeatAck = DateTimeOffset.UnixEpoch; + public TimeSpan Latency => _lastHeartbeatAck - _lastHeartbeatSend; + + public DiscordGatewayClient(ILogger logger, DiscordGatewayClientOptions opts) + { + _logger = logger.ForContext(); + _token = $"Bot {opts.Token}"; + var uriBuilder = new UriBuilder(opts.Uri) + { + Query = $"v={GatewayVersion}&encoding=json" + }; + _gatewayUri = uriBuilder.Uri; + _intents = opts.Intents; + } + + public ConnectionStatus Status { get; private set; } = ConnectionStatus.Dead; + + /// + /// Connects to the gateway. This method returns after a connection is established. + /// ct is stored by the client and cancelling it will close the connection. + /// The caller must pause indefinitely or the bot will shut down immediately. + /// + [MemberNotNull("_ws")] + public async Task ConnectAsync(CancellationToken ct = default) + { + if (Status != ConnectionStatus.Dead) + throw new DiscordGatewayRequestError( + "Gateway is connecting or connected, only one concurrent connection allowed."); + + try + { + _ws = new ClientWebSocket(); + Status = ConnectionStatus.Connecting; + await _ws.ConnectAsync(_gatewayUri, ct); + + using var cts = CancellationTokenSource.CreateLinkedTokenSource(ct); + cts.CancelAfter(TimeSpan.FromSeconds(30)); + var (rawHelloPacketType, rawHelloPacket) = await ReadPacket(cts.Token); + if (rawHelloPacketType == WebSocketMessageType.Close) + throw new DiscordGatewayRequestError("First packet received was a close message"); + + if (!TryDeserializeEvent(rawHelloPacket, out var rawHelloEvent)) + throw new DiscordGatewayRequestError("First packet was not a valid event"); + if (rawHelloEvent is not HelloEvent hello) + throw new DiscordGatewayRequestError("First event was not a HELLO event"); + + _logger.Debug("Received HELLO, heartbeat interval is {HeartbeatInterval}", hello.HeartbeatInterval); + var _ = HeartbeatLoopAsync(hello.HeartbeatInterval, ct); + var __ = ReceiveLoopAsync(ct); + + _logger.Debug("Sending IDENTIFY"); + await WritePacket(new GatewayPacket + { + Opcode = GatewayOpcode.Identify, + Payload = new IdentifyEvent { Token = _token, Intents = _intents } + }, ct); + } + catch (Exception e) + { + _logger.Error(e, "Error connecting to gateway"); + Status = ConnectionStatus.Dead; + _ws = null; + throw; + } + } + + private async Task HeartbeatLoopAsync(int heartbeatInterval, CancellationToken ct = default) + { + var delay = TimeSpan.FromMilliseconds(heartbeatInterval * Random.Shared.NextDouble()); + _logger.Debug("Waiting {Delay} before sending first heartbeat", delay); + + using var timer = new PeriodicTimer(TimeSpan.FromMilliseconds(heartbeatInterval)); + while (await timer.WaitForNextTickAsync(ct)) + { + _logger.Debug("Sending heartbeat with sequence {Sequence}", _lastSequence); + _lastHeartbeatSend = DateTimeOffset.UtcNow; + await WritePacket(new GatewayPacket { Opcode = GatewayOpcode.Heartbeat, Payload = _lastSequence }, ct); + } + } + + private async Task ReceiveLoopAsync(CancellationToken ct = default) + { + while (!ct.IsCancellationRequested) + { + try + { + var (type, packet) = await ReadPacket(ct); + if (type == WebSocketMessageType.Close || packet == null) + { + // TODO: close websocket + return; + } + + _ = ReceiveAsync(packet, ct); + } + catch (Exception e) + { + _logger.Error(e, "Error while receiving data"); + } + } + + async Task ReceiveAsync(GatewayPacket packet, CancellationToken ct2 = default) + { + if (!TryDeserializeEvent(packet, out var gatewayEvent)) + { + _logger.Debug("Event {EventType} didn't have payload", packet.Opcode); + return; + } + + switch (gatewayEvent) + { + case HeartbeatEvent: + await HandleHeartbeatRequest(ct2); + break; + case HeartbeatAckEvent: + HandleHeartbeatAck(); + break; + case DispatchEvent dispatch: + await HandleDispatch(dispatch.Payload, ct2); + break; + } + } + } + + private async ValueTask WritePacket(GatewayPacket packet, CancellationToken ct = default) + { + using var buf = MemoryPool.Shared.Rent(BufferSize); + var json = JsonSerializer.SerializeToUtf8Bytes(packet, _jsonSerializerOptions); + await _ws!.SendAsync(json.AsMemory(), WebSocketMessageType.Text, true, ct); + } + + private async ValueTask<(WebSocketMessageType type, GatewayPacket? packet)> ReadPacket( + CancellationToken ct = default) + { + using var buf = MemoryPool.Shared.Rent(BufferSize); + var res = await _ws!.ReceiveAsync(buf.Memory, ct); + if (res.MessageType == WebSocketMessageType.Close) return (res.MessageType, null); + + if (res.EndOfMessage) + return DeserializePacket(res, buf.Memory.Span[..res.Count]); + + return await DeserializeMultipleBuffer(res, buf); + } + + private async Task<(WebSocketMessageType type, GatewayPacket packet)> DeserializeMultipleBuffer( + ValueWebSocketReceiveResult res, IMemoryOwner buf) + { + await using var stream = new MemoryStream(BufferSize * 4); + stream.Write(buf.Memory.Span.Slice(0, res.Count)); + + while (!res.EndOfMessage) + { + res = await _ws!.ReceiveAsync(buf.Memory, default); + stream.Write(buf.Memory.Span.Slice(0, res.Count)); + } + + return DeserializePacket(res, stream.GetBuffer().AsSpan(0, (int)stream.Length)); + } + + private (WebSocketMessageType type, GatewayPacket packet) DeserializePacket( + ValueWebSocketReceiveResult res, Span span) => (res.MessageType, + JsonSerializer.Deserialize(span, _jsonSerializerOptions)!); + + private bool TryDeserializeEvent(GatewayPacket? packet, [NotNullWhen(true)] out IGatewayEvent? gatewayEvent) + { + gatewayEvent = null; + if (packet == null) return false; + var payload = packet.Payload is JsonElement element ? element : default; + switch (packet.Opcode) + { + case GatewayOpcode.Hello: + gatewayEvent = payload.Deserialize(_jsonSerializerOptions)!; + break; + case GatewayOpcode.Dispatch: + _lastSequence = packet.Sequence; + gatewayEvent = new DispatchEvent { Payload = ParseDispatchEvent(packet.EventType!, payload) }; + break; + case GatewayOpcode.Heartbeat: + gatewayEvent = new HeartbeatEvent(); + break; + case GatewayOpcode.Reconnect: + case GatewayOpcode.InvalidSession: + throw new NotImplementedException(); + case GatewayOpcode.HeartbeatAck: + gatewayEvent = new HeartbeatAckEvent(); + break; + default: + throw new ArgumentOutOfRangeException(); + } + + return true; + } + + public enum ConnectionStatus + { + Dead, + Connecting, + Connected + } +} + +public class DiscordGatewayClientOptions +{ + public required string Token { get; init; } + public required string Uri { get; init; } + public required GatewayIntent Intents { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Gateway/DiscordGatewayRequestError.cs b/Foxcord/Gateway/DiscordGatewayRequestError.cs new file mode 100644 index 0000000..1b6cb01 --- /dev/null +++ b/Foxcord/Gateway/DiscordGatewayRequestError.cs @@ -0,0 +1,3 @@ +namespace Foxcord.Gateway; + +public class DiscordGatewayRequestError(string message) : Exception(message); \ No newline at end of file diff --git a/Foxcord/Gateway/Events/Dispatch/GuildCreateEvent.cs b/Foxcord/Gateway/Events/Dispatch/GuildCreateEvent.cs new file mode 100644 index 0000000..ae5e212 --- /dev/null +++ b/Foxcord/Gateway/Events/Dispatch/GuildCreateEvent.cs @@ -0,0 +1,9 @@ +using Foxcord.Models; + +namespace Foxcord.Gateway.Events.Dispatch; + +public class GuildCreateEvent : Guild, IDispatch +{ + public bool Unavailable { get; init; } = false; + public int MemberCount { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Gateway/Events/Dispatch/IDispatch.cs b/Foxcord/Gateway/Events/Dispatch/IDispatch.cs new file mode 100644 index 0000000..7d6d502 --- /dev/null +++ b/Foxcord/Gateway/Events/Dispatch/IDispatch.cs @@ -0,0 +1,13 @@ +namespace Foxcord.Gateway.Events.Dispatch; + +public interface IDispatch +{ + +} + +public static class DispatchEventTypeName +{ + public const string Ready = "READY"; + public const string GuildCreate = "GUILD_CREATE"; + public const string MessageCreate = "MESSAGE_CREATE"; +} \ No newline at end of file diff --git a/Foxcord/Gateway/Events/Dispatch/MessageCreateEvent.cs b/Foxcord/Gateway/Events/Dispatch/MessageCreateEvent.cs new file mode 100644 index 0000000..8ed04de --- /dev/null +++ b/Foxcord/Gateway/Events/Dispatch/MessageCreateEvent.cs @@ -0,0 +1,8 @@ +using Foxcord.Models; + +namespace Foxcord.Gateway.Events.Dispatch; + +public class MessageCreateEvent : Message, IDispatch +{ + +} \ No newline at end of file diff --git a/Foxcord/Gateway/Events/Dispatch/ReadyEvent.cs b/Foxcord/Gateway/Events/Dispatch/ReadyEvent.cs new file mode 100644 index 0000000..3508383 --- /dev/null +++ b/Foxcord/Gateway/Events/Dispatch/ReadyEvent.cs @@ -0,0 +1,18 @@ +using System.Text.Json.Serialization; +using Foxcord.Models; + +namespace Foxcord.Gateway.Events.Dispatch; + +public class ReadyEvent : IDispatch +{ + [JsonPropertyName("v")] public int Version { get; init; } + public required User User { get; init; } + public string? SessionId { get; init; } + public string? ResumeGatewayUrl { get; init; } + [JsonPropertyName("shard")] public int[]? RawShard { private get; init; } + + [JsonIgnore] public ShardInfo Shard => new(RawShard?[0] ?? 0, RawShard?[1] ?? 1); + [JsonIgnore] public bool CanResume => !string.IsNullOrEmpty(SessionId) && !string.IsNullOrEmpty(ResumeGatewayUrl); +} + +public record ShardInfo(int ShardId, int NumShards); \ No newline at end of file diff --git a/Foxcord/Gateway/Events/DispatchEvent.cs b/Foxcord/Gateway/Events/DispatchEvent.cs new file mode 100644 index 0000000..5359f6a --- /dev/null +++ b/Foxcord/Gateway/Events/DispatchEvent.cs @@ -0,0 +1,8 @@ +using Foxcord.Gateway.Events.Dispatch; + +namespace Foxcord.Gateway.Events; + +internal class DispatchEvent : IGatewayEvent +{ + public required IDispatch Payload { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Gateway/Events/HeartbeatEvent.cs b/Foxcord/Gateway/Events/HeartbeatEvent.cs new file mode 100644 index 0000000..0bac0c5 --- /dev/null +++ b/Foxcord/Gateway/Events/HeartbeatEvent.cs @@ -0,0 +1,5 @@ +namespace Foxcord.Gateway.Events; + +internal class HeartbeatEvent : IGatewayEvent; + +internal class HeartbeatAckEvent : IGatewayEvent; \ No newline at end of file diff --git a/Foxcord/Gateway/Events/HelloEvent.cs b/Foxcord/Gateway/Events/HelloEvent.cs new file mode 100644 index 0000000..eccce72 --- /dev/null +++ b/Foxcord/Gateway/Events/HelloEvent.cs @@ -0,0 +1,6 @@ +namespace Foxcord.Gateway.Events; + +internal class HelloEvent : IGatewayEvent +{ + public int HeartbeatInterval { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Gateway/Events/IGatewayEvent.cs b/Foxcord/Gateway/Events/IGatewayEvent.cs new file mode 100644 index 0000000..982f688 --- /dev/null +++ b/Foxcord/Gateway/Events/IGatewayEvent.cs @@ -0,0 +1,6 @@ +namespace Foxcord.Gateway.Events; + +internal interface IGatewayEvent +{ + +} \ No newline at end of file diff --git a/Foxcord/Gateway/Events/IdentifyEvent.cs b/Foxcord/Gateway/Events/IdentifyEvent.cs new file mode 100644 index 0000000..7a11e8b --- /dev/null +++ b/Foxcord/Gateway/Events/IdentifyEvent.cs @@ -0,0 +1,15 @@ +namespace Foxcord.Gateway.Events; + +public class IdentifyEvent : IGatewayEvent +{ + public required string Token { get; init; } + public IdentifyProperties Properties { get; init; } = new(); + public GatewayIntent Intents { get; init; } +} + +public class IdentifyProperties +{ + public string Os { get; init; } = "Linux"; + public string Browser { get; init; } = "Foxcord"; + public string Device { get; init; } = "Foxcord"; +} \ No newline at end of file diff --git a/Foxcord/Gateway/GatewayIntent.cs b/Foxcord/Gateway/GatewayIntent.cs new file mode 100644 index 0000000..ea88b54 --- /dev/null +++ b/Foxcord/Gateway/GatewayIntent.cs @@ -0,0 +1,22 @@ +namespace Foxcord.Gateway; + +[Flags] +public enum GatewayIntent +{ + Guilds = 1 << 0, + GuildMembers = 1 << 1, + GuildBans = 1 << 2, + GuildEmojis = 1 << 3, + GuildIntegrations = 1 << 4, + GuildWebhooks = 1 << 5, + GuildInvites = 1 << 6, + GuildVoiceStates = 1 << 7, + GuildPresences = 1 << 8, + GuildMessages = 1 << 9, + GuildMessageReactions = 1 << 10, + GuildMessageTyping = 1 << 11, + DirectMessages = 1 << 12, + DirectMessageReactions = 1 << 13, + DirectMessageTyping = 1 << 14, + MessageContent = 1 << 15, +} \ No newline at end of file diff --git a/Foxcord/Gateway/GatewayPacket.cs b/Foxcord/Gateway/GatewayPacket.cs new file mode 100644 index 0000000..ffc28f2 --- /dev/null +++ b/Foxcord/Gateway/GatewayPacket.cs @@ -0,0 +1,33 @@ +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Foxcord.Gateway; + +public record GatewayPacket +{ + [JsonPropertyName("op")] public GatewayOpcode Opcode { get; init; } + [JsonPropertyName("d")] public object? Payload { get; init; } + + [JsonPropertyName("s")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public int? Sequence { get; init; } + + [JsonPropertyName("t")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? EventType { get; init; } +} + +public enum GatewayOpcode +{ + Dispatch = 0, + Heartbeat = 1, + Identify = 2, + PresenceUpdate = 3, + VoiceStateUpdate = 4, + Resume = 6, + Reconnect = 7, + RequestGuildMembers = 8, + InvalidSession = 9, + Hello = 10, + HeartbeatAck = 11 +} \ No newline at end of file diff --git a/Foxcord/Gateway/Types/UnavailableGuild.cs b/Foxcord/Gateway/Types/UnavailableGuild.cs new file mode 100644 index 0000000..4a42508 --- /dev/null +++ b/Foxcord/Gateway/Types/UnavailableGuild.cs @@ -0,0 +1,8 @@ +using Foxcord.Models; + +namespace Foxcord.Gateway.Types; + +public class UnavailableGuild +{ + public Snowflake Id { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Models/Guild.cs b/Foxcord/Models/Guild.cs new file mode 100644 index 0000000..8768f8d --- /dev/null +++ b/Foxcord/Models/Guild.cs @@ -0,0 +1,7 @@ +namespace Foxcord.Models; + +public class Guild +{ + public Snowflake Id { get; init; } + public string Name { get; init; } = string.Empty; +} \ No newline at end of file diff --git a/Foxcord/Models/Message.cs b/Foxcord/Models/Message.cs new file mode 100644 index 0000000..5b3e671 --- /dev/null +++ b/Foxcord/Models/Message.cs @@ -0,0 +1,9 @@ +namespace Foxcord.Models; + +public class Message +{ + public Snowflake Id { get; init; } + public Snowflake ChannelId { get; init; } + public string Content { get; init; } = string.Empty; + public required User Author { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Models/Snowflake.cs b/Foxcord/Models/Snowflake.cs new file mode 100644 index 0000000..d403568 --- /dev/null +++ b/Foxcord/Models/Snowflake.cs @@ -0,0 +1,80 @@ +using System.Diagnostics.CodeAnalysis; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Foxcord.Models; + +[JsonConverter(typeof(JsonConverter))] +public readonly struct Snowflake(ulong value) : IEquatable +{ + public const long Epoch = 1_420_070_400_000; // 2015-01-01 at 00:00:00 UTC + public readonly ulong Value = value; + + /// + /// The time this snowflake was created. + /// + public DateTimeOffset Time => DateTimeOffset.FromUnixTimeMilliseconds(Timestamp); + + /// + /// The Unix timestamp embedded in this snowflake, in milliseconds. + /// + public long Timestamp => (long)((Value >> 22) + Epoch); + + /// + /// The worker ID embedded in this snowflake. + /// + public byte WorkerId => (byte)((Value & 0x3E0000) >> 17); + + /// + /// The process ID embedded in this snowflake. + /// + public byte ProcessId => (byte)((Value & 0x1F000) >> 12); + + /// + /// The increment embedded in this snowflake. + /// + public short Increment => (short)(Value & 0xFFF); + + public static bool operator <(Snowflake arg1, Snowflake arg2) => arg1.Value < arg2.Value; + public static bool operator >(Snowflake arg1, Snowflake arg2) => arg1.Value > arg2.Value; + public static bool operator ==(Snowflake arg1, Snowflake arg2) => arg1.Value == arg2.Value; + public static bool operator !=(Snowflake arg1, Snowflake arg2) => arg1.Value != arg2.Value; + + public static implicit operator ulong(Snowflake s) => s.Value; + public static implicit operator long(Snowflake s) => (long)s.Value; + public static implicit operator Snowflake(ulong n) => new(n); + public static implicit operator Snowflake(long n) => new((ulong)n); + + public static bool TryParse(string? input, [NotNullWhen(true)] out Snowflake? snowflake) + { + snowflake = null; + if (!ulong.TryParse(input, out var res)) return false; + snowflake = new Snowflake(res); + return true; + } + + public override bool Equals(object? obj) => obj is Snowflake other && Value == other.Value; + + public bool Equals(Snowflake other) + { + return Value == other.Value; + } + + public override int GetHashCode() => Value.GetHashCode(); + public override string ToString() => Value.ToString(); + + public class JsonConverter : JsonConverter + { + public override Snowflake Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var raw = reader.GetString(); + if (!TryParse(raw, out var snowflake)) throw new FormatException("Snowflake is not a long within a string"); + return snowflake.Value; + } + + public override void Write(Utf8JsonWriter writer, Snowflake value, JsonSerializerOptions options) + { + writer.WriteStringValue(value.ToString()); + } + } +} \ No newline at end of file diff --git a/Foxcord/Models/User.cs b/Foxcord/Models/User.cs new file mode 100644 index 0000000..ec0a169 --- /dev/null +++ b/Foxcord/Models/User.cs @@ -0,0 +1,21 @@ +using System.Text.Json.Serialization; + +namespace Foxcord.Models; + +public class User +{ + public Snowflake Id { get; init; } + public required string Username { get; init; } + public required string Discriminator { get; init; } + [JsonIgnore] public string Tag => Discriminator != "0" ? $"{Username}#{Discriminator}" : Username; + public string? GlobalName { get; init; } + public string? Avatar { get; init; } + public string? Banner { get; init; } + public int? AccentColor { get; init; } + public string? Locale { get; init; } + public bool Bot { get; init; } = false; + public bool System { get; init; } = false; + public bool? MfaEnabled { get; init; } + public bool? Verified { get; init; } + public string? Email { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Rest/BaseRestClient.cs b/Foxcord/Rest/BaseRestClient.cs new file mode 100644 index 0000000..e54bf8b --- /dev/null +++ b/Foxcord/Rest/BaseRestClient.cs @@ -0,0 +1,128 @@ +using System.Diagnostics; +using System.Net.Http.Headers; +using System.Net.Http.Json; +using System.Text.Json; +using Polly; +using Serilog; + +namespace Foxcord.Rest; + +public class BaseRestClient +{ + public HttpClient Client { get; } + private readonly ILogger _logger; + private readonly JsonSerializerOptions _jsonSerializerOptions; + private readonly Func? _tokenFactory; + private readonly Func _pathCleaner; + private readonly Func _errorHandler; + + protected ResiliencePipeline Pipeline { get; set; } = + new ResiliencePipelineBuilder().Build(); + + private readonly string _apiBaseUrl; + + public BaseRestClient(ILogger logger, RestClientOptions options) + { + Client = new HttpClient(); + Client.DefaultRequestHeaders.TryAddWithoutValidation("User-Agent", options.UserAgent); + + _logger = logger.ForContext(); + _jsonSerializerOptions = options.JsonSerializerOptions ?? JsonSerializerOptions.Default; + _apiBaseUrl = options.ApiBaseUrl; + _tokenFactory = options.TokenFactory; + _pathCleaner = options.PathLogCleaner ?? (s => s); + _errorHandler = options.ErrorHandler; + } + + public async Task RequestAsync(HttpMethod method, string path, CancellationToken ct = default) + where T : class + { + var req = new HttpRequestMessage(method, $"{_apiBaseUrl}{path}"); + if (_tokenFactory != null) + req.Headers.Add("Authorization", _tokenFactory()); + + var resp = await DoRequestAsync(path, req, ct); + return await resp.Content.ReadFromJsonAsync(_jsonSerializerOptions, ct) ?? + throw new DiscordRequestError("Content was deserialized as null"); + } + + public async Task RequestAsync(HttpMethod method, string path, TRequest reqBody, + CancellationToken ct = default) + { + var req = new HttpRequestMessage(method, $"{_apiBaseUrl}{path}"); + if (_tokenFactory != null) + req.Headers.Add("Authorization", _tokenFactory()); + + + var body = JsonSerializer.Serialize(reqBody, _jsonSerializerOptions); + req.Content = new StringContent(body, new MediaTypeHeaderValue("application/json", "utf-8")); + + var resp = await DoRequestAsync(path, req, ct); + return await resp.Content.ReadFromJsonAsync(_jsonSerializerOptions, ct) ?? + throw new DiscordRequestError("Content was deserialized as null"); + } + + private async Task DoRequestAsync(string path, HttpRequestMessage req, + CancellationToken ct = default) + { + var context = ResilienceContextPool.Shared.Get(ct); + context.Properties.Set(new ResiliencePropertyKey("Path"), path); + try + { + return await Pipeline.ExecuteAsync(async ctx => + { + HttpResponseMessage resp; + + var stopwatch = new Stopwatch(); + stopwatch.Start(); + try + { + resp = await Client.SendAsync(req, HttpCompletionOption.ResponseHeadersRead, + ctx.CancellationToken); + stopwatch.Stop(); + } + catch (Exception e) + { + _logger.Error(e, "HTTP error: {Method} {Path}", req.Method, _pathCleaner(path)); + throw; + } + + _logger.Debug("Response: {Method} {Path} -> {StatusCode} {ReasonPhrase} (in {ResponseMs} ms)", + req.Method, _pathCleaner(path), (int)resp.StatusCode, resp.ReasonPhrase, + stopwatch.ElapsedMilliseconds); + + await _errorHandler(resp, context.CancellationToken); + + return resp; + }, context); + } + finally + { + ResilienceContextPool.Shared.Return(context); + } + } +} + +public class RestClientOptions +{ + public JsonSerializerOptions? JsonSerializerOptions { get; init; } + public required string UserAgent { get; init; } + public required string ApiBaseUrl { get; init; } + + /// + /// A function that converts non-2XX responses to errors. This should usually throw; + /// if not, the request will continue to be handled normally, which will probably cause errors. + /// + public required Func ErrorHandler { get; init; } + + /// + /// A function that returns a token. If not set, the client will not add an Authorization header. + /// + public Func? TokenFactory { get; init; } + + /// + /// A function that cleans up paths for logging. This should remove sensitive content (i.e. tokens). + /// If not set, paths will not be cleaned before being logged. + /// + public Func? PathLogCleaner { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Rest/DiscordRestClient.cs b/Foxcord/Rest/DiscordRestClient.cs new file mode 100644 index 0000000..97377f7 --- /dev/null +++ b/Foxcord/Rest/DiscordRestClient.cs @@ -0,0 +1,66 @@ +using System.Net; +using System.Net.Http.Json; +using System.Text.Json; +using Foxcord.Models; +using Foxcord.Rest.Rate; +using Foxcord.Rest.Types; +using Foxcord.Serialization; +using Polly; +using Serilog; + +namespace Foxcord.Rest; + +public class DiscordRestClient : BaseRestClient +{ + public DiscordRestClient(ILogger logger, DiscordRestClientOptions options) : base(logger, new RestClientOptions + { + JsonSerializerOptions = JsonSerializerOptions, + ApiBaseUrl = options.ApiBaseUrl ?? DefaultApiBaseUrl, + UserAgent = options.UserAgent ?? DefaultUserAgent, + TokenFactory = () => $"Bot {options.Token}", + ErrorHandler = HandleError, + }) + { + Pipeline = new ResiliencePipelineBuilder() + .AddDiscordStrategy(new RateLimiter(logger.ForContext())) + .Build(); + } + + public const string DefaultUserAgent = "DiscordBot (https://code.vulpine.solutions/sam/Foxcord, v1)"; + public const string DefaultApiBaseUrl = "https://discord.com/api/v10"; + + public async Task GatewayBotAsync(CancellationToken ct = default) => + await RequestAsync(HttpMethod.Get, "/gateway/bot", ct); + + public async Task CreateMessageAsync(Snowflake channelId, CreateMessageParams message, + CancellationToken ct = default) => + await RequestAsync(HttpMethod.Post, $"/channels/{channelId}/messages", message, + ct); + + #region BaseRestClient parameters + + private static readonly JsonSerializerOptions JsonSerializerOptions = JsonSerializerExtensions.CreateSerializer(); + + private static async Task HandleError(HttpResponseMessage resp, CancellationToken ct) + { + if (resp.IsSuccessStatusCode) return; + + if (resp.StatusCode == HttpStatusCode.TooManyRequests) + { + throw new RateLimitError(resp.Headers); + } + + var error = await resp.Content.ReadFromJsonAsync(JsonSerializerOptions, ct); + if (error == null) throw new ArgumentNullException(nameof(resp), "Response was deserialized as null"); + throw error; + } + + #endregion +} + +public class DiscordRestClientOptions +{ + public required string Token { get; init; } + public string? UserAgent { get; init; } + public string? ApiBaseUrl { get; init; } +} \ No newline at end of file diff --git a/Foxcord/Rest/DiscordRestError.cs b/Foxcord/Rest/DiscordRestError.cs new file mode 100644 index 0000000..6c12252 --- /dev/null +++ b/Foxcord/Rest/DiscordRestError.cs @@ -0,0 +1,22 @@ +using System.Net.Http.Headers; + +namespace Foxcord.Rest; + +public class DiscordRestError : Exception +{ + public required DiscordErrorCode Code { get; init; } + public new required string Message { get; init; } +} + +public enum DiscordErrorCode +{ + GeneralError = 0, + UnknownAccount = 10001, +} + +public class DiscordRequestError(string message) : Exception(message); + +public class RateLimitError(HttpHeaders headers) : Exception("Rate limit error") +{ + public HttpHeaders Headers { get; } = headers; +} \ No newline at end of file diff --git a/Foxcord/Rest/Rate/BucketKeyUtils.cs b/Foxcord/Rest/Rate/BucketKeyUtils.cs new file mode 100644 index 0000000..a31c06e --- /dev/null +++ b/Foxcord/Rest/Rate/BucketKeyUtils.cs @@ -0,0 +1,65 @@ +using System.Text; + +namespace Foxcord.Rest.Rate; + +// All of this code is taken from Arikawa: +// https://github.com/diamondburned/arikawa/blob/v3/api/rate/rate.go +internal static class BucketKeyUtils +{ + private static readonly string[] MajorRootPaths = ["channels", "guilds"]; + + internal static string Parse(string path) + { + path = path.Split("?", 2)[0]; + var parts = path.Split("/"); + if (parts.Length == 0) return path; + parts = parts.Skip(1).ToArray(); + + var skip = 0; + if (MajorRootPaths.Contains(parts[0])) skip = 2; + + skip++; + for (; skip < parts.Length; skip += 2) + { + if (long.TryParse(parts[skip], out _) || StringIsEmojiOnly(parts[skip]) || StringIsCustomEmoji(parts[skip])) + parts[skip] = ""; + } + + path = string.Join("/", parts); + return $"/{path}"; + } + + private static bool StringIsCustomEmoji(string emoji) + { + var parts = emoji.Split(":"); + if (parts.Length != 2) return false; + + if (!long.TryParse(parts[1], out _)) return false; + if (parts[0].Contains(' ')) return false; + + return true; + } + + private static bool StringIsEmojiOnly(string emoji) + { + var runes = emoji.EnumerateRunes().ToArray(); + switch (runes.Length) + { + case 0: + return false; + case 1: + case 2: + return EmojiRune(runes[0]); + } + + return false; + } + + private static bool EmojiRune(Rune r) + { + if (r == new Rune('\u00a9') || r == new Rune('\u00ae') || + (r >= new Rune('\u2000') && r <= new Rune('\u3300'))) return true; + + return false; + } +} \ No newline at end of file diff --git a/Foxcord/Rest/Rate/DiscordResilienceStrategy.cs b/Foxcord/Rest/Rate/DiscordResilienceStrategy.cs new file mode 100644 index 0000000..4f53b14 --- /dev/null +++ b/Foxcord/Rest/Rate/DiscordResilienceStrategy.cs @@ -0,0 +1,34 @@ +using Polly; + +namespace Foxcord.Rest.Rate; + +public class DiscordResilienceStrategy(RateLimiter rateLimiter) + : ResilienceStrategy +{ + protected override async ValueTask> ExecuteCore( + Func>> callback, ResilienceContext context, + TState state) + { + var path = context.Properties.GetValue(new ResiliencePropertyKey("Path"), string.Empty); + if (path == string.Empty) throw new DiscordRequestError("Path was not set in Polly context"); + + var b = await rateLimiter.LockBucket(BucketKeyUtils.Parse(path), context.CancellationToken); + + var response = await callback(context, state).ConfigureAwait(context.ContinueOnCapturedContext); + if (response.Exception is RateLimitError rateLimitError) + b.Release(rateLimitError.Headers); + else if (response.Result != null) + b.Release(response.Result.Headers); + + return response; + } +} + +public class DiscordResilienceStrategyOptions : ResilienceStrategyOptions; + +public static class DiscordResilienceStrategyExtensions +{ + public static ResiliencePipelineBuilder AddDiscordStrategy( + this ResiliencePipelineBuilder builder, RateLimiter rateLimiter) => + builder.AddStrategy(_ => new DiscordResilienceStrategy(rateLimiter), new DiscordResilienceStrategyOptions()); +} \ No newline at end of file diff --git a/Foxcord/Rest/Rate/RateLimiter.cs b/Foxcord/Rest/Rate/RateLimiter.cs new file mode 100644 index 0000000..791ff34 --- /dev/null +++ b/Foxcord/Rest/Rate/RateLimiter.cs @@ -0,0 +1,161 @@ +using System.Collections.Concurrent; +using System.Globalization; +using System.Net.Http.Headers; +using Serilog; + +namespace Foxcord.Rest.Rate; + +// Most of this code is taken from discordgo: +// https://github.com/bwmarrin/discordgo/blob/master/ratelimit.go +public class RateLimiter(ILogger logger) +{ + private readonly ILogger _logger = logger.ForContext(); + private readonly ConcurrentDictionary _buckets = new(); + + private readonly ConcurrentDictionary _customRateLimits = new([ + new KeyValuePair("//reactions//", new CustomRateLimit + { + Requests = 1, + Reset = TimeSpan.FromMilliseconds(200) + }) + ]); + + internal long Global; + + + internal Bucket GetBucket(string key) + { + key = BucketKeyUtils.Parse(key); + + var bucket = _buckets.GetOrAdd(key, _ => new Bucket + { + Key = key, + Remaining = 1, + RateLimiter = this, + Logger = _logger + }); + + if (_customRateLimits.Any(r => key.EndsWith(r.Key))) + bucket.CustomRateLimit = _customRateLimits.First(r => key.EndsWith(r.Key)).Value; + + return bucket; + } + + internal TimeSpan GetWaitTime(Bucket b, int minRemaining) + { + if (b.Remaining < minRemaining && b.Reset > DateTimeOffset.UtcNow) + return b.Reset - DateTimeOffset.UtcNow; + + var sleepTo = DateTimeOffset.FromUnixTimeMilliseconds(Global); + if (sleepTo > DateTimeOffset.UtcNow) + return sleepTo - DateTimeOffset.UtcNow; + + return TimeSpan.Zero; + } + + internal async Task LockBucket(string bucketId, CancellationToken ct = default) => + await LockBucket(GetBucket(bucketId), ct); + + internal async Task LockBucket(Bucket b, CancellationToken ct = default) + { + _logger.Verbose("Locking bucket {Bucket}", b.Key); + await b.Semaphore.WaitAsync(ct); + var waitTime = GetWaitTime(b, 1); + if (waitTime > TimeSpan.Zero) await Task.Delay(waitTime, ct); + b.Remaining--; + _logger.Verbose("Letting request for bucket {Bucket} through", b.Key); + return b; + } +} + +internal class CustomRateLimit +{ + internal int Requests; + internal TimeSpan Reset; +} + +internal class Bucket +{ + internal readonly SemaphoreSlim Semaphore = new(1); + internal required string Key; + internal required ILogger Logger { private get; init; } + internal int Remaining; + internal DateTimeOffset Reset; + + private DateTimeOffset _lastReset; + internal CustomRateLimit? CustomRateLimit; + + internal required RateLimiter RateLimiter; + + // discordgo mentions that this is required to prevent 429s, I trust that + private static readonly TimeSpan ExtraResetTime = TimeSpan.FromMilliseconds(250); + + internal void Release(HttpHeaders headers) + { + try + { + if (CustomRateLimit != null) + { + if (DateTimeOffset.UtcNow - _lastReset >= CustomRateLimit.Reset) + { + Remaining = CustomRateLimit.Requests - 1; + _lastReset = DateTimeOffset.UtcNow; + } + + if (Remaining < 1) + { + Reset = DateTimeOffset.UtcNow + CustomRateLimit.Reset; + } + + return; + } + + var remaining = TryGetHeaderValue(headers, "X-RateLimit-Remaining"); + var reset = TryGetHeaderValue(headers, "X-RateLimit-Reset"); + var global = TryGetHeaderValue(headers, "X-RateLimit-Global"); + var resetAfter = TryGetHeaderValue(headers, "X-RateLimit-Reset-After"); + + if (resetAfter != null) + { + if (!double.TryParse(resetAfter, out var parsedResetAfter)) + throw new InvalidRateLimitHeaderException("X-RateLimit-Reset-After was not a valid double"); + + var resetAt = DateTimeOffset.UtcNow + TimeSpan.FromSeconds(parsedResetAfter); + if (global != null) RateLimiter.Global = resetAt.ToUnixTimeMilliseconds(); + else Reset = resetAt; + } + else if (reset != null) + { + var dateHeader = TryGetHeaderValue(headers, "Date"); + if (dateHeader == null) throw new InvalidRateLimitHeaderException("Date header was not set"); + + if (!DateTimeOffset.TryParseExact(dateHeader, "r", CultureInfo.InvariantCulture, + DateTimeStyles.AssumeUniversal, out var parsedDate)) + throw new InvalidRateLimitHeaderException("Date was not a valid date"); + + if (!long.TryParse(reset, out var parsedReset)) + throw new InvalidRateLimitHeaderException("X-RateLimit-Reset was not a valid long"); + + var delta = DateTimeOffset.FromUnixTimeMilliseconds(parsedReset) - parsedDate + ExtraResetTime; + Reset = DateTimeOffset.UtcNow + delta; + } + + if (remaining == null) return; + + if (!int.TryParse(remaining, out var parsedRemaining)) + throw new InvalidRateLimitHeaderException("X-RateLimit-Remaining was not a valid integer"); + Remaining = parsedRemaining; + Logger.Verbose("New remaining for bucket {Bucket} is {Remaining}", Key, Remaining); + } + finally + { + Logger.Verbose("Releasing bucket {Bucket}", Key); + Semaphore.Release(); + } + } + + private static string? TryGetHeaderValue(HttpHeaders headers, string key) => + headers.TryGetValues(key, out var values) ? values.FirstOrDefault() : null; +} + +public class InvalidRateLimitHeaderException(string message) : Exception(message); \ No newline at end of file diff --git a/Foxcord/Rest/Types/CreateMessageParams.cs b/Foxcord/Rest/Types/CreateMessageParams.cs new file mode 100644 index 0000000..f1f7098 --- /dev/null +++ b/Foxcord/Rest/Types/CreateMessageParams.cs @@ -0,0 +1,6 @@ +namespace Foxcord.Rest.Types; + +public record CreateMessageParams( + string? Content = null, + object? Nonce = null, + bool Tts = false); \ No newline at end of file diff --git a/Foxcord/Rest/Types/GetGatewayBotResponse.cs b/Foxcord/Rest/Types/GetGatewayBotResponse.cs new file mode 100644 index 0000000..65a4102 --- /dev/null +++ b/Foxcord/Rest/Types/GetGatewayBotResponse.cs @@ -0,0 +1,5 @@ +namespace Foxcord.Rest.Types; + +public record GetGatewayBotResponse(string Url, int Shards, SessionStartLimit SessionStartLimit); + +public record SessionStartLimit(int Total, int Remaining, int ResetAfter, int MaxConcurrency); \ No newline at end of file diff --git a/Foxcord/Serialization/JsonSerializerExtensions.cs b/Foxcord/Serialization/JsonSerializerExtensions.cs new file mode 100644 index 0000000..87cee21 --- /dev/null +++ b/Foxcord/Serialization/JsonSerializerExtensions.cs @@ -0,0 +1,19 @@ +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Foxcord.Serialization; + +public static class JsonSerializerExtensions +{ + public static JsonSerializerOptions CreateSerializer() + { + var opts = new JsonSerializerOptions + { + PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower, + NumberHandling = JsonNumberHandling.AllowReadingFromString, + IncludeFields = true + }; + + return opts; + } +} \ No newline at end of file diff --git a/FoxcordTest/FoxcordTest.csproj b/FoxcordTest/FoxcordTest.csproj new file mode 100644 index 0000000..6602f04 --- /dev/null +++ b/FoxcordTest/FoxcordTest.csproj @@ -0,0 +1,19 @@ + + + + Exe + net8.0 + enable + enable + + + + + + + + + + + + diff --git a/FoxcordTest/Program.cs b/FoxcordTest/Program.cs new file mode 100644 index 0000000..76f237f --- /dev/null +++ b/FoxcordTest/Program.cs @@ -0,0 +1,25 @@ +using Foxcord.Gateway; +using Serilog; +using Foxcord.Rest; + +Log.Logger = new LoggerConfiguration() + .MinimumLevel.Verbose() + .WriteTo.Console() + .CreateLogger(); + +var client = new DiscordRestClient(Log.Logger, new DiscordRestClientOptions +{ + Token = Environment.GetEnvironmentVariable("TOKEN")! +}); + +var gatewayBot = await client.GatewayBotAsync(); + +var gateway = new DiscordGatewayClient(Log.Logger, new DiscordGatewayClientOptions +{ + Token = Environment.GetEnvironmentVariable("TOKEN")!, + Uri = gatewayBot.Url, + Intents = GatewayIntent.Guilds | GatewayIntent.GuildMessages | GatewayIntent.MessageContent +}); + +await gateway.ConnectAsync(); +await Task.Delay(-1); \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..728687a --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Foxcord + +yet another c# discord library, because i want to suffer + +## Acknowledgements + +- a handful of functions were taken from [Myriad](https://github.com/PluralKit/PluralKit/tree/main/Myriad), especially + related to websocket reading/writing +- the ratelimit code is a mix of [discordgo](https://github.com/bwmarrin/discordgo) + and [arikawa](https://github.com/diamondburned/arikawa/tree/v3). not the best porting job ever, that's for sure + +## License + +\*pulls out a copy of the GNU LGPL, but with a giant "PLEASE DON'T USE THIS" sticker slapped on top of it\*