From ffe4aae90962bd7a28ad1087432cc3f7666d1f3c Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 00:07:41 -0600 Subject: [PATCH 01/20] added bot activity config & config parser --- src/config.rs | 30 +++++++++++++++++++++++++++--- src/discord/framework.rs | 8 +++++++- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/src/config.rs b/src/config.rs index 498021b..ee2a37a 100644 --- a/src/config.rs +++ b/src/config.rs @@ -1,6 +1,6 @@ -use poise::serenity_prelude::{ChannelId, GuildId, UserId}; +use poise::serenity_prelude::{ChannelId, GuildId, UserId, Activity}; use serde::Deserialize; -use tracing::{info, warn}; +use tracing::{info, warn, error}; use tracing_unwrap::OptionExt; use crate::DiscordToken; @@ -18,7 +18,7 @@ pub struct BotConfig { token: Option, id: Option, pub testing_server: Option, - pub status: Option, + activity: Option, } impl BotConfig { @@ -32,6 +32,30 @@ impl BotConfig { self.id .expect_or_log("no user id in config or environment!") } + + pub fn activity(&self) -> Option { + if let Some(activity) = &self.activity { + let (activity_type, name) = if activity.starts_with("listening to") { + ("listening to", activity.strip_prefix("listening to").unwrap()) + } else { + activity.split_once(' ').unwrap() + }; + + match activity_type.to_lowercase().as_str() { + "playing" => Some(Activity::playing(name)), + "listening to" => Some(Activity::listening(name)), + "watching" => Some(Activity::watching(name)), + "competing" => Some(Activity::competing(name)), + _ => { + error!("activity '{activity_type}' is unsupported - please use 'playing', 'listening to', 'watching' or 'competing'"); + warn!("disabling bot activity"); + None + } + } + } else { + None + } + } } #[derive(Deserialize, Debug, Clone)] diff --git a/src/discord/framework.rs b/src/discord/framework.rs index e1fa75e..330c90b 100644 --- a/src/discord/framework.rs +++ b/src/discord/framework.rs @@ -1,4 +1,4 @@ -use poise::serenity_prelude::{self as serenity, Interaction}; +use poise::serenity_prelude::{self as serenity, Interaction, Ready}; use std::sync::atomic::AtomicBool; use tokio::sync::Mutex; @@ -60,6 +60,12 @@ impl serenity::EventHandler for Handler { .await .ok(); } + + async fn ready(&self, ctx: serenity::Context, _: Ready) { + if let Some(activity) = self.data.config().bot.activity() { + ctx.set_activity(activity).await + } + } } /*pub async fn manual_dispatch(token: String) { From 185b0fd935a0df10e9fde4790e822dc02acf27d2 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 00:20:12 -0600 Subject: [PATCH 02/20] example .env, compose.yaml & slimebot.toml --- .env.example | 3 +++ compose.yaml.example | 20 ++++++++++++++++++++ slimebot.toml.example | 18 ++++++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 .env.example create mode 100644 compose.yaml.example create mode 100644 slimebot.toml.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..6327a27 --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +# example slimebot .env + +RUST_LOG = "slimebot,tracing_unwrap" # crates allowed to emit logs - should not need editing \ No newline at end of file diff --git a/compose.yaml.example b/compose.yaml.example new file mode 100644 index 0000000..af7f0c6 --- /dev/null +++ b/compose.yaml.example @@ -0,0 +1,20 @@ +# example slimebot compose.toml + +services: + db: + image: mongo + restart: always + environment: + MONGO_INITDB_ROOT_USERNAME: # mongodb root username + MONGO_INITDB_ROOT_PASSWORD: # mongodb root password + ports: + - 27017:27017 # mongodb port + + bot: + build: . + restart: always + volumes: + - ./.env:/.env # mounr .env to /.env in the container + - ./slimebot.toml:/slimebot.toml # mount slimebot.toml to /slimebot.toml in the container + ports: + - 443:443 \ No newline at end of file diff --git a/slimebot.toml.example b/slimebot.toml.example new file mode 100644 index 0000000..457fea7 --- /dev/null +++ b/slimebot.toml.example @@ -0,0 +1,18 @@ +# example slimebot.toml + +[bot] +token = # bot token +id = 0000000000000000000 # bot id +activity = "playing on YOUR SERVER" # activity options: 'playing', 'listening to', 'watching', 'competing' + +[db] +url = "localhost:27017" #mongodb host (without `mongodb://`) +username = # mongodb username +password = # mongodb password + +[watchers] +allow_by_default = true # enables watchers for all channels not specifically disallowed + +[[watchers.channels]] +id = 0000000000000000000 # channel id +allow = false # disables watchers for this channel \ No newline at end of file From ced893cac19684f3da4b17f077ecbe3726e12485 Mon Sep 17 00:00:00 2001 From: perpetualcacophony <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 12:08:57 -0600 Subject: [PATCH 03/20] Create README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..40c35c5 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# 🌸 slimebot 🌸 +slimebot is a small self-hosted discord bot made for a private server with friends. + +# 🐞 coming from the server? +hey, thanks for checking out the code!! if you have a feature to request or a bug to report, you can always dm it to me directly, but i would really really appreciate if you put it in the [issues](https://github.com/perpetualcacophony/slimebot/issues) page. + +## want to contribute? +developing this bot *is* fun, but does take a good amount of time and effort, so contributing would be super helpful!! the bot itself is entirely written in rust, which i can absolutely help you learn if you're interested, but in the future there might be additional features that involve web development. + +## what's with slimebot-dev? +slimebot-dev also runs on this codebase! slimebot proper runs on an actual webserver that lets it stay up all the time, while slimebot-dev just runs off my computer. additionally, slimebot proper runs on the stable code in the [`prod`](https://github.com/perpetualcacophony/slimebot/tree/prod) branch, while slimebot-dev runs on whatever unstable branch i'm currently writing and testing. slimebot-dev exists so i can develop the bot while keeping your experience using slimebot relatively seamless! + +# 🐞 coming from somewhere else? +hi!! this bot (and the server it's built for) is riddled with in-jokes and dumb features. it *is* a bot that *does* work—the [`prod`](https://github.com/perpetualcacophony/slimebot/tree/prod) branch is, at least—and you could probably deploy it to your own hardware, but you're probably just better off taking what you like from the codebase. unless you *want* the bot to post an image of joe biden every time someone says "L", i guess? + +## can i use this bot in my own server? +yes and no. you're completely free to compile and run the code yourself, or use the docker image at [`ghcr.io/perpetualcacophony/slimebot:prod`](https://ghcr.io/perpetualcacophony/slimebot) (check out the example [`compose.yaml`](compose.yaml.example)!) however, you'll need to use your own bot user—the bot application i operate is private server-only, which is why you won't find any invite link for slimebot. From f4a34d4a19a973c98e7a2aa5a8c42cf226061e41 Mon Sep 17 00:00:00 2001 From: perpetualcacophony <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 13:52:36 -0600 Subject: [PATCH 04/20] add gnu affero gplv3 license --- LICENSE | 661 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 661 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. From 51ed5d63e48327089afcfa95797520d5eadc7c69 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 17:50:27 -0600 Subject: [PATCH 05/20] add option to configure bot prefix --- src/config.rs | 5 +++++ src/main.rs | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/config.rs b/src/config.rs index d6434c3..7bcdd6d 100644 --- a/src/config.rs +++ b/src/config.rs @@ -18,6 +18,7 @@ pub struct BotConfig { id: Option, pub testing_server: Option, pub status: Option, + prefix: String } impl BotConfig { @@ -31,6 +32,10 @@ impl BotConfig { self.id .expect_or_log("no user id in config or environment!") } + + pub fn prefix(&self) -> &str { + &self.prefix + } } #[derive(Deserialize, Debug, Clone)] diff --git a/src/main.rs b/src/main.rs index 9c12c29..e0e0b12 100644 --- a/src/main.rs +++ b/src/main.rs @@ -87,7 +87,7 @@ async fn main() { options: poise::FrameworkOptions { commands: vec![ping(), pfp(), watch_fic(), echo(), ban(), banban()], prefix_options: PrefixFrameworkOptions { - prefix: Some("..".to_string()), + prefix: Some(config.bot.prefix().to_string()), ..Default::default() }, ..Default::default() From 8465a321c3cfb75b9823a09e0d0d895198f56751 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 18:08:03 -0600 Subject: [PATCH 06/20] reformatting for readability --- compose.yaml.example | 20 -------------------- example-compose.yaml | 21 +++++++++++++++++++++ .env.example => example-dotenv.env | 1 + example-slimebot.toml | 19 +++++++++++++++++++ slimebot.toml.example | 18 ------------------ 5 files changed, 41 insertions(+), 38 deletions(-) delete mode 100644 compose.yaml.example create mode 100644 example-compose.yaml rename .env.example => example-dotenv.env (63%) create mode 100644 example-slimebot.toml delete mode 100644 slimebot.toml.example diff --git a/compose.yaml.example b/compose.yaml.example deleted file mode 100644 index af7f0c6..0000000 --- a/compose.yaml.example +++ /dev/null @@ -1,20 +0,0 @@ -# example slimebot compose.toml - -services: - db: - image: mongo - restart: always - environment: - MONGO_INITDB_ROOT_USERNAME: # mongodb root username - MONGO_INITDB_ROOT_PASSWORD: # mongodb root password - ports: - - 27017:27017 # mongodb port - - bot: - build: . - restart: always - volumes: - - ./.env:/.env # mounr .env to /.env in the container - - ./slimebot.toml:/slimebot.toml # mount slimebot.toml to /slimebot.toml in the container - ports: - - 443:443 \ No newline at end of file diff --git a/example-compose.yaml b/example-compose.yaml new file mode 100644 index 0000000..d4b64e2 --- /dev/null +++ b/example-compose.yaml @@ -0,0 +1,21 @@ +# example slimebot compose.toml +# IMPORTANT: docker compose will accept `compose.yaml`, NOT `example-compose.yaml` + +services: + db: + image: mongo + restart: always + environment: + MONGO_INITDB_ROOT_USERNAME: #mongodb root username + MONGO_INITDB_ROOT_PASSWORD: #mongodb root password + ports: + - 27017:27017 #mongodb port + + bot: + build: . + restart: always + volumes: + - ./.env:/.env #mount .env to /.env in the container + - ./slimebot.toml:/slimebot.toml #mount slimebot.toml to /slimebot.toml in the container + ports: + - 443:443 \ No newline at end of file diff --git a/.env.example b/example-dotenv.env similarity index 63% rename from .env.example rename to example-dotenv.env index 6327a27..5c6fb9a 100644 --- a/.env.example +++ b/example-dotenv.env @@ -1,3 +1,4 @@ # example slimebot .env +# IMPORTANT: slimebot will accept `.env`, NOT `example-dotenv.env` RUST_LOG = "slimebot,tracing_unwrap" # crates allowed to emit logs - should not need editing \ No newline at end of file diff --git a/example-slimebot.toml b/example-slimebot.toml new file mode 100644 index 0000000..14d6e45 --- /dev/null +++ b/example-slimebot.toml @@ -0,0 +1,19 @@ +# example slimebot.toml +# IMPORTANT: slimebot will accept `slimebot.toml`, NOT `example-slimebot.toml` + +[bot] +token = "your token here" +id = 1111111111111111111 #bot id +activity = "playing on YOUR SERVER" #activity options: 'playing', 'listening to', 'watching', 'competing' + +[db] +url = "localhost:27017" #mongodb host (without `mongodb://`) +username = "mongodb username" +password = "mongodb password" + +[watchers] +allow_by_default = true #enables watchers for all channels not specifically disallowed + +[[watchers.channels]] +id = 1111111111111111111 #channel id +allow = false #disables watchers for this channel \ No newline at end of file diff --git a/slimebot.toml.example b/slimebot.toml.example deleted file mode 100644 index 457fea7..0000000 --- a/slimebot.toml.example +++ /dev/null @@ -1,18 +0,0 @@ -# example slimebot.toml - -[bot] -token = # bot token -id = 0000000000000000000 # bot id -activity = "playing on YOUR SERVER" # activity options: 'playing', 'listening to', 'watching', 'competing' - -[db] -url = "localhost:27017" #mongodb host (without `mongodb://`) -username = # mongodb username -password = # mongodb password - -[watchers] -allow_by_default = true # enables watchers for all channels not specifically disallowed - -[[watchers.channels]] -id = 0000000000000000000 # channel id -allow = false # disables watchers for this channel \ No newline at end of file From b6b02b0eeafd2d2e5e92b7dad6bed1865e695692 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 20:16:55 -0600 Subject: [PATCH 07/20] inelegant but readable status parsing from config --- src/config.rs | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/src/config.rs b/src/config.rs index ee2a37a..594c468 100644 --- a/src/config.rs +++ b/src/config.rs @@ -1,6 +1,6 @@ use poise::serenity_prelude::{ChannelId, GuildId, UserId, Activity}; use serde::Deserialize; -use tracing::{info, warn, error}; +use tracing::{info, warn, error, debug}; use tracing_unwrap::OptionExt; use crate::DiscordToken; @@ -35,24 +35,31 @@ impl BotConfig { pub fn activity(&self) -> Option { if let Some(activity) = &self.activity { - let (activity_type, name) = if activity.starts_with("listening to") { - ("listening to", activity.strip_prefix("listening to").unwrap()) + if activity.is_empty() { + warn!("bot.activity provided in config as empty string, defaulting to none"); + return None; + } + + let parsed_activity = if activity.starts_with("playing ") { + Activity::playing(activity.strip_prefix("playing ").unwrap()) + } else if activity.starts_with("listening to ") { + Activity::playing(activity.strip_prefix("listening to ").unwrap()) + } else if activity.starts_with("watching ") { + Activity::playing(activity.strip_prefix("watching ").unwrap()) + } else if activity.starts_with("competing in ") { + Activity::playing(activity.strip_prefix("competing in ").unwrap()) } else { - activity.split_once(' ').unwrap() + error!("bot.activity in config could not be parsed - must start with `playing`, `listening to`, `watching` or `competing in`"); + warn!("disabling bot activity"); + return None; }; - match activity_type.to_lowercase().as_str() { - "playing" => Some(Activity::playing(name)), - "listening to" => Some(Activity::listening(name)), - "watching" => Some(Activity::watching(name)), - "competing" => Some(Activity::competing(name)), - _ => { - error!("activity '{activity_type}' is unsupported - please use 'playing', 'listening to', 'watching' or 'competing'"); - warn!("disabling bot activity"); - None - } - } + debug!("bot.activity parsed as {:?}: {}", parsed_activity.kind, parsed_activity.name); + info!("successfully parsed bot activity from config"); + + Some(parsed_activity) } else { + warn!("no bot.activity provided in config, defaulting to none"); None } } From 0d948dd5a69ff66e4c045ea680cd126ff7603a1a Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 00:20:12 -0600 Subject: [PATCH 08/20] example .env, compose.yaml & slimebot.toml --- .env.example | 3 +++ compose.yaml.example | 20 ++++++++++++++++++++ slimebot.toml.example | 18 ++++++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 .env.example create mode 100644 compose.yaml.example create mode 100644 slimebot.toml.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..6327a27 --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +# example slimebot .env + +RUST_LOG = "slimebot,tracing_unwrap" # crates allowed to emit logs - should not need editing \ No newline at end of file diff --git a/compose.yaml.example b/compose.yaml.example new file mode 100644 index 0000000..af7f0c6 --- /dev/null +++ b/compose.yaml.example @@ -0,0 +1,20 @@ +# example slimebot compose.toml + +services: + db: + image: mongo + restart: always + environment: + MONGO_INITDB_ROOT_USERNAME: # mongodb root username + MONGO_INITDB_ROOT_PASSWORD: # mongodb root password + ports: + - 27017:27017 # mongodb port + + bot: + build: . + restart: always + volumes: + - ./.env:/.env # mounr .env to /.env in the container + - ./slimebot.toml:/slimebot.toml # mount slimebot.toml to /slimebot.toml in the container + ports: + - 443:443 \ No newline at end of file diff --git a/slimebot.toml.example b/slimebot.toml.example new file mode 100644 index 0000000..457fea7 --- /dev/null +++ b/slimebot.toml.example @@ -0,0 +1,18 @@ +# example slimebot.toml + +[bot] +token = # bot token +id = 0000000000000000000 # bot id +activity = "playing on YOUR SERVER" # activity options: 'playing', 'listening to', 'watching', 'competing' + +[db] +url = "localhost:27017" #mongodb host (without `mongodb://`) +username = # mongodb username +password = # mongodb password + +[watchers] +allow_by_default = true # enables watchers for all channels not specifically disallowed + +[[watchers.channels]] +id = 0000000000000000000 # channel id +allow = false # disables watchers for this channel \ No newline at end of file From 0e44f551061387193ed5f3b4045e92d987ae7ba1 Mon Sep 17 00:00:00 2001 From: perpetualcacophony <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 12:08:57 -0600 Subject: [PATCH 09/20] Create README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..40c35c5 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# 🌸 slimebot 🌸 +slimebot is a small self-hosted discord bot made for a private server with friends. + +# 🐞 coming from the server? +hey, thanks for checking out the code!! if you have a feature to request or a bug to report, you can always dm it to me directly, but i would really really appreciate if you put it in the [issues](https://github.com/perpetualcacophony/slimebot/issues) page. + +## want to contribute? +developing this bot *is* fun, but does take a good amount of time and effort, so contributing would be super helpful!! the bot itself is entirely written in rust, which i can absolutely help you learn if you're interested, but in the future there might be additional features that involve web development. + +## what's with slimebot-dev? +slimebot-dev also runs on this codebase! slimebot proper runs on an actual webserver that lets it stay up all the time, while slimebot-dev just runs off my computer. additionally, slimebot proper runs on the stable code in the [`prod`](https://github.com/perpetualcacophony/slimebot/tree/prod) branch, while slimebot-dev runs on whatever unstable branch i'm currently writing and testing. slimebot-dev exists so i can develop the bot while keeping your experience using slimebot relatively seamless! + +# 🐞 coming from somewhere else? +hi!! this bot (and the server it's built for) is riddled with in-jokes and dumb features. it *is* a bot that *does* work—the [`prod`](https://github.com/perpetualcacophony/slimebot/tree/prod) branch is, at least—and you could probably deploy it to your own hardware, but you're probably just better off taking what you like from the codebase. unless you *want* the bot to post an image of joe biden every time someone says "L", i guess? + +## can i use this bot in my own server? +yes and no. you're completely free to compile and run the code yourself, or use the docker image at [`ghcr.io/perpetualcacophony/slimebot:prod`](https://ghcr.io/perpetualcacophony/slimebot) (check out the example [`compose.yaml`](compose.yaml.example)!) however, you'll need to use your own bot user—the bot application i operate is private server-only, which is why you won't find any invite link for slimebot. From f7203b50a93f93fa4eda1008de19bb7ef8d616f3 Mon Sep 17 00:00:00 2001 From: perpetualcacophony <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 13:52:36 -0600 Subject: [PATCH 10/20] add gnu affero gplv3 license --- LICENSE | 661 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 661 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. From 72b4312959bdce3ed1c2cbaf953e03c401164af4 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 17:50:27 -0600 Subject: [PATCH 11/20] add option to configure bot prefix --- src/config.rs | 6 ++++++ src/main.rs | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/config.rs b/src/config.rs index 594c468..21aaec9 100644 --- a/src/config.rs +++ b/src/config.rs @@ -19,6 +19,8 @@ pub struct BotConfig { id: Option, pub testing_server: Option, activity: Option, + pub status: Option, + prefix: String } impl BotConfig { @@ -63,6 +65,10 @@ impl BotConfig { None } } + + pub fn prefix(&self) -> &str { + &self.prefix + } } #[derive(Deserialize, Debug, Clone)] diff --git a/src/main.rs b/src/main.rs index 6e0cfd7..50ef039 100644 --- a/src/main.rs +++ b/src/main.rs @@ -84,7 +84,7 @@ async fn main() { options: poise::FrameworkOptions { commands: vec![ping(), pfp(), watch_fic(), echo(), ban(), banban()], prefix_options: PrefixFrameworkOptions { - prefix: Some("..".to_string()), + prefix: Some(config.bot.prefix().to_string()), ..Default::default() }, ..Default::default() From c1d558920852ad17b1ca4471b08cb2ecc13e6d0a Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 18:08:03 -0600 Subject: [PATCH 12/20] reformatting for readability --- compose.yaml.example | 20 -------------------- example-compose.yaml | 21 +++++++++++++++++++++ .env.example => example-dotenv.env | 1 + example-slimebot.toml | 19 +++++++++++++++++++ slimebot.toml.example | 18 ------------------ 5 files changed, 41 insertions(+), 38 deletions(-) delete mode 100644 compose.yaml.example create mode 100644 example-compose.yaml rename .env.example => example-dotenv.env (63%) create mode 100644 example-slimebot.toml delete mode 100644 slimebot.toml.example diff --git a/compose.yaml.example b/compose.yaml.example deleted file mode 100644 index af7f0c6..0000000 --- a/compose.yaml.example +++ /dev/null @@ -1,20 +0,0 @@ -# example slimebot compose.toml - -services: - db: - image: mongo - restart: always - environment: - MONGO_INITDB_ROOT_USERNAME: # mongodb root username - MONGO_INITDB_ROOT_PASSWORD: # mongodb root password - ports: - - 27017:27017 # mongodb port - - bot: - build: . - restart: always - volumes: - - ./.env:/.env # mounr .env to /.env in the container - - ./slimebot.toml:/slimebot.toml # mount slimebot.toml to /slimebot.toml in the container - ports: - - 443:443 \ No newline at end of file diff --git a/example-compose.yaml b/example-compose.yaml new file mode 100644 index 0000000..d4b64e2 --- /dev/null +++ b/example-compose.yaml @@ -0,0 +1,21 @@ +# example slimebot compose.toml +# IMPORTANT: docker compose will accept `compose.yaml`, NOT `example-compose.yaml` + +services: + db: + image: mongo + restart: always + environment: + MONGO_INITDB_ROOT_USERNAME: #mongodb root username + MONGO_INITDB_ROOT_PASSWORD: #mongodb root password + ports: + - 27017:27017 #mongodb port + + bot: + build: . + restart: always + volumes: + - ./.env:/.env #mount .env to /.env in the container + - ./slimebot.toml:/slimebot.toml #mount slimebot.toml to /slimebot.toml in the container + ports: + - 443:443 \ No newline at end of file diff --git a/.env.example b/example-dotenv.env similarity index 63% rename from .env.example rename to example-dotenv.env index 6327a27..5c6fb9a 100644 --- a/.env.example +++ b/example-dotenv.env @@ -1,3 +1,4 @@ # example slimebot .env +# IMPORTANT: slimebot will accept `.env`, NOT `example-dotenv.env` RUST_LOG = "slimebot,tracing_unwrap" # crates allowed to emit logs - should not need editing \ No newline at end of file diff --git a/example-slimebot.toml b/example-slimebot.toml new file mode 100644 index 0000000..14d6e45 --- /dev/null +++ b/example-slimebot.toml @@ -0,0 +1,19 @@ +# example slimebot.toml +# IMPORTANT: slimebot will accept `slimebot.toml`, NOT `example-slimebot.toml` + +[bot] +token = "your token here" +id = 1111111111111111111 #bot id +activity = "playing on YOUR SERVER" #activity options: 'playing', 'listening to', 'watching', 'competing' + +[db] +url = "localhost:27017" #mongodb host (without `mongodb://`) +username = "mongodb username" +password = "mongodb password" + +[watchers] +allow_by_default = true #enables watchers for all channels not specifically disallowed + +[[watchers.channels]] +id = 1111111111111111111 #channel id +allow = false #disables watchers for this channel \ No newline at end of file diff --git a/slimebot.toml.example b/slimebot.toml.example deleted file mode 100644 index 457fea7..0000000 --- a/slimebot.toml.example +++ /dev/null @@ -1,18 +0,0 @@ -# example slimebot.toml - -[bot] -token = # bot token -id = 0000000000000000000 # bot id -activity = "playing on YOUR SERVER" # activity options: 'playing', 'listening to', 'watching', 'competing' - -[db] -url = "localhost:27017" #mongodb host (without `mongodb://`) -username = # mongodb username -password = # mongodb password - -[watchers] -allow_by_default = true # enables watchers for all channels not specifically disallowed - -[[watchers.channels]] -id = 0000000000000000000 # channel id -allow = false # disables watchers for this channel \ No newline at end of file From 75e442ad727b3b6c30620c721a52fed0dfd1698f Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 20:37:06 -0600 Subject: [PATCH 13/20] tidying up after battling with git --- src/config.rs | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/config.rs b/src/config.rs index 96eb2e1..d0e8c26 100644 --- a/src/config.rs +++ b/src/config.rs @@ -19,7 +19,6 @@ pub struct BotConfig { id: Option, pub testing_server: Option, activity: Option, - pub status: Option, prefix: String } @@ -69,10 +68,6 @@ impl BotConfig { pub fn prefix(&self) -> &str { &self.prefix } - - pub fn prefix(&self) -> &str { - &self.prefix - } } #[derive(Deserialize, Debug, Clone)] From 4d1d9b954f1ebe9e4158ab1b4aea8372c2b4cef6 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 21:41:41 -0600 Subject: [PATCH 14/20] heavy clippy linting, cleanup --- Cargo.toml | 2 ++ README.md | 2 +- example-slimebot.toml | 1 + src/config.rs | 46 ++++++++++++++++--------------- src/db.rs | 2 +- src/discord/commands/ban.rs | 10 +++---- src/discord/commands/mod.rs | 15 +++++----- src/discord/commands/watch_fic.rs | 6 ++-- src/discord/framework.rs | 3 +- src/logging.rs | 8 +++--- src/main.rs | 13 +++++---- 11 files changed, 58 insertions(+), 50 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index d645184..1cdefdf 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,8 @@ name = "slimebot" version = "1.2.0" edition = "2021" +readme = "README.md" +license = "AGPL-3.0" [profile.release] strip = true diff --git a/README.md b/README.md index 40c35c5..c3cb69b 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,4 @@ slimebot-dev also runs on this codebase! slimebot proper runs on an actual webse hi!! this bot (and the server it's built for) is riddled with in-jokes and dumb features. it *is* a bot that *does* work—the [`prod`](https://github.com/perpetualcacophony/slimebot/tree/prod) branch is, at least—and you could probably deploy it to your own hardware, but you're probably just better off taking what you like from the codebase. unless you *want* the bot to post an image of joe biden every time someone says "L", i guess? ## can i use this bot in my own server? -yes and no. you're completely free to compile and run the code yourself, or use the docker image at [`ghcr.io/perpetualcacophony/slimebot:prod`](https://ghcr.io/perpetualcacophony/slimebot) (check out the example [`compose.yaml`](compose.yaml.example)!) however, you'll need to use your own bot user—the bot application i operate is private server-only, which is why you won't find any invite link for slimebot. +yes and no. you're completely free to compile and run the code yourself, or use the docker image at [`ghcr.io/perpetualcacophony/slimebot:prod`](https://ghcr.io/perpetualcacophony/slimebot) (check out the example [`compose.yaml`](example-compose.yaml)!) however, you'll need to use your own bot user—the bot application i operate is private server-only, which is why you won't find any invite link for slimebot. diff --git a/example-slimebot.toml b/example-slimebot.toml index 14d6e45..ecc6179 100644 --- a/example-slimebot.toml +++ b/example-slimebot.toml @@ -5,6 +5,7 @@ token = "your token here" id = 1111111111111111111 #bot id activity = "playing on YOUR SERVER" #activity options: 'playing', 'listening to', 'watching', 'competing' +prefix = ".." [db] url = "localhost:27017" #mongodb host (without `mongodb://`) diff --git a/src/config.rs b/src/config.rs index d0e8c26..c71a282 100644 --- a/src/config.rs +++ b/src/config.rs @@ -1,6 +1,6 @@ -use poise::serenity_prelude::{ChannelId, GuildId, UserId, Activity}; +use poise::serenity_prelude::{Activity, ChannelId, GuildId, UserId}; use serde::Deserialize; -use tracing::{info, warn, error, debug}; +use tracing::{debug, error, info, warn}; use tracing_unwrap::OptionExt; use crate::DiscordToken; @@ -19,7 +19,7 @@ pub struct BotConfig { id: Option, pub testing_server: Option, activity: Option, - prefix: String + prefix: String, } impl BotConfig { @@ -55,9 +55,12 @@ impl BotConfig { return None; }; - debug!("bot.activity parsed as {:?}: {}", parsed_activity.kind, parsed_activity.name); + debug!( + "bot.activity parsed as {:?}: {}", + parsed_activity.kind, parsed_activity.name + ); info!("successfully parsed bot activity from config"); - + Some(parsed_activity) } else { warn!("no bot.activity provided in config, defaulting to none"); @@ -93,12 +96,11 @@ impl DiscordConfig { pub fn channel(&self) -> Option { if self.enabled { - match self.channel { - Some(_) => Some(self.channel.unwrap()), - None => { - warn!("no channel configured for discord logger"); - None - } + if let Some(channel) = self.channel { + Some(channel) + } else { + warn!("no channel configured for discord logger"); + None } } else { None @@ -134,24 +136,24 @@ pub struct WatchersConfig { } impl WatchersConfig { - pub fn allow_by_default(&self) -> bool { + pub const fn allow_by_default(&self) -> bool { self.allow_by_default } - pub fn channels(&self) -> Option<&Vec> { + pub const fn channels(&self) -> Option<&Vec> { self.channels.as_ref() } pub fn channel_allowed(&self, id: ChannelId) -> bool { - if let Some(channels) = self.channels() { - if let Some(channel) = channels.iter().find(|c| c.id == id) { - channel.allow - } else { - self.allow_by_default() - } - } else { - self.allow_by_default() - } + self.channels().map_or_else( + || self.allow_by_default(), + |channels| { + channels + .iter() + .find(|c| c.id == id) + .map_or_else(|| self.allow_by_default(), |channel| channel.allow) + }, + ) } } diff --git a/src/db.rs b/src/db.rs index 9f9f003..cefaa0d 100644 --- a/src/db.rs +++ b/src/db.rs @@ -5,7 +5,7 @@ use mongodb::{ use crate::config::DbConfig; -pub async fn connect(config: &DbConfig) -> Database { +pub fn database(config: &DbConfig) -> Database { let credential = Credential::builder() .username(config.username().to_string()) .password(config.password().to_string()) diff --git a/src/discord/commands/ban.rs b/src/discord/commands/ban.rs index b5ad762..af2a23e 100644 --- a/src/discord/commands/ban.rs +++ b/src/discord/commands/ban.rs @@ -12,9 +12,9 @@ pub async fn joke_ban( moderator_id: u64, reason: impl Into>, ) -> Result<(), Error> { - let reason = reason.into().unwrap_or("No reason".to_string()); + let reason = reason.into().unwrap_or_else(|| "No reason".to_string()); - let embed = ban_embed(&reason, &moderator_id, &user.name); + let embed = ban_embed(&reason, moderator_id, &user.name); let webhook = wick_webhook(ctx).await; webhook .execute(ctx.http(), false, |w| w.embeds(vec![embed])) @@ -60,7 +60,7 @@ async fn wick_webhook(ctx: Context<'_>) -> Webhook { if &hook.name.clone().unwrap() != wick.display_name().as_ref() { hook.edit_name(ctx.http(), wick.display_name().as_ref()) .await - .unwrap_or_log() + .unwrap_or_log(); } if hook.avatar.clone().is_none() || hook.avatar.clone().unwrap() != wick.face() { @@ -69,13 +69,13 @@ async fn wick_webhook(ctx: Context<'_>) -> Webhook { AttachmentType::Image(Url::parse(&wick.face()).unwrap()), ) .await - .unwrap_or_log() + .unwrap_or_log(); } hook } -fn ban_embed(reason: &str, moderator_id: &u64, user: &str) -> serde_json::value::Value { +fn ban_embed(reason: &str, moderator_id: u64, user: &str) -> serde_json::value::Value { Embed::fake(|e| { e .title("Ban result:") diff --git a/src/discord/commands/mod.rs b/src/discord/commands/mod.rs index e747fdc..d11bd70 100644 --- a/src/discord/commands/mod.rs +++ b/src/discord/commands/mod.rs @@ -53,7 +53,7 @@ pub async fn pfp( // debug!("{:?}", ctx.guild_id()); if ctx.defer().await.is_err() { - error!("failed to defer - lag will cause errors!") + error!("failed to defer - lag will cause errors!"); } let user = match user { @@ -74,18 +74,19 @@ pub async fn pfp( // required args are ugly let global = global.map_or(false, |b| b); - let (pfp, pfp_type) = match global { - true => ( + let (pfp, pfp_type) = if global { + ( user.user.face(), user.avatar_url() .map_or(PfpType::Unset, |_| PfpType::Global), - ), - false => ( + ) + } else { + ( user.face(), user.user .avatar_url() - .map_or(PfpType::Unset, |_| PfpType::Guild), - ), + .map_or(PfpType::Unset, |_| PfpType::Guild) + ) }; let flavor_text = match pfp_type { diff --git a/src/discord/commands/watch_fic.rs b/src/discord/commands/watch_fic.rs index 5d68191..8d8aec8 100644 --- a/src/discord/commands/watch_fic.rs +++ b/src/discord/commands/watch_fic.rs @@ -41,7 +41,7 @@ pub async fn watch_fic( if stored_chapter_count < chapter_ids.len() { info!("request made. update!"); - store_chapter_count(id, chapter_ids.len()).await.unwrap(); + store_chapter_count(id, chapter_ids.len()).unwrap(); channel .id() @@ -85,7 +85,7 @@ fn _has_updated(work_id: usize, current_chapter_count: usize) -> Result Result, anyhow::Error> { - let work_index = format!("https://archiveofourown.org/works/{}/navigate", work_id); + let work_index = format!("https://archiveofourown.org/works/{work_id}/navigate"); let Ok(html) = reqwest::get(work_index).await else { error!("d"); @@ -125,7 +125,7 @@ async fn get_chapter_ids(work_id: usize) -> Result, anyhow::Error> { // it's tied to, like, an explicit work right? why supply the chapter count? // if i could work with an api, i probably *would* have this func call ao3 // but. i can't. i think i've minimized ao3 calls to, like, 1 every loop -async fn store_chapter_count(work_id: usize, chapter_count: usize) -> Result<(), Error> { +fn store_chapter_count(work_id: usize, chapter_count: usize) -> Result<(), Error> { fs::write(format!("works/{work_id}.len"), chapter_count.to_string())?; Ok(()) diff --git a/src/discord/framework.rs b/src/discord/framework.rs index 330c90b..6fc4732 100644 --- a/src/discord/framework.rs +++ b/src/discord/framework.rs @@ -30,6 +30,7 @@ impl serenity::EventHandler for Handler { .watchers .channel_allowed(new_message.channel_id) { + #[allow(clippy::wildcard_imports)] use super::watchers::*; vore(&ctx, self, &new_message).await; @@ -63,7 +64,7 @@ impl serenity::EventHandler for Handler { async fn ready(&self, ctx: serenity::Context, _: Ready) { if let Some(activity) = self.data.config().bot.activity() { - ctx.set_activity(activity).await + ctx.set_activity(activity).await; } } } diff --git a/src/logging.rs b/src/logging.rs index a14a388..708f65b 100644 --- a/src/logging.rs +++ b/src/logging.rs @@ -64,7 +64,7 @@ impl DiscordSender { .await .is_err() { - error!(no_discord = true, "log failed to reach discord") + error!(no_discord = true, "log failed to reach discord"); } } } @@ -79,7 +79,7 @@ struct DiscordLayer { } impl DiscordLayer { - pub fn new(tx: UnboundedSender) -> Self { + pub const fn new(tx: UnboundedSender) -> Self { Self { tx } } } @@ -96,7 +96,7 @@ impl Layer for DiscordLayer { let message = format!("`[{}] {}`", event.metadata().level(), visitor.message); if event.metadata().fields().field("no_discord").is_none() { - self.tx.send(message).expect("subscriber threading failed") + self.tx.send(message).expect("subscriber threading failed"); } } } @@ -108,6 +108,6 @@ struct DiscordVisitor { impl tracing::field::Visit for DiscordVisitor { fn record_debug(&mut self, _field: &tracing::field::Field, value: &dyn std::fmt::Debug) { - write!(self.message, "{:?}", value).unwrap(); + write!(self.message, "{value:?}").unwrap(); } } diff --git a/src/main.rs b/src/main.rs index 50ef039..49def46 100644 --- a/src/main.rs +++ b/src/main.rs @@ -5,6 +5,7 @@ use logging::DiscordSubscriber; /// Functionality called from Discord. mod discord; +#[allow(clippy::wildcard_imports)] use discord::commands::*; use discord::framework::Handler; use mongodb::Database; @@ -30,7 +31,7 @@ pub struct Data { } impl Data { - async fn new() -> Self { + fn new() -> Self { let config: crate::config::Config = ::config::Config::builder() .add_source(::config::File::with_name("slimebot.toml")) .add_source(::config::Environment::with_prefix("SLIMEBOT")) @@ -39,16 +40,16 @@ impl Data { .try_deserialize() .expect_or_log("configuration could not be parsed"); - let db = db::connect(&config.db).await; + let db = db::database(&config.db); Self { config, db } } - fn config(&self) -> &crate::config::Config { + const fn config(&self) -> &crate::config::Config { &self.config } - fn db(&self) -> &Database { + const fn db(&self) -> &Database { &self.db } } @@ -76,7 +77,7 @@ async fn main() { // now the first log can be sent! trace!("hi!"); - let data = Data::new().await; + let data = Data::new(); let config = data.config.clone(); let mut handler = Handler { @@ -173,7 +174,7 @@ async fn main() { loop { let before = SystemTime::now(); if http.get_bot_gateway().await.is_err() { - error!("failed to connect to discord!") + error!("failed to connect to discord!"); } let ping = SystemTime::now() .duration_since(before) From 77071218fe75c859684499cca3bca0addd521ce3 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Wed, 17 Jan 2024 21:57:34 -0600 Subject: [PATCH 15/20] updated the image of joe biden in the code & readme --- README.md | 2 +- src/discord/watchers/mod.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c3cb69b..136e1e9 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ developing this bot *is* fun, but does take a good amount of time and effort, so slimebot-dev also runs on this codebase! slimebot proper runs on an actual webserver that lets it stay up all the time, while slimebot-dev just runs off my computer. additionally, slimebot proper runs on the stable code in the [`prod`](https://github.com/perpetualcacophony/slimebot/tree/prod) branch, while slimebot-dev runs on whatever unstable branch i'm currently writing and testing. slimebot-dev exists so i can develop the bot while keeping your experience using slimebot relatively seamless! # 🐞 coming from somewhere else? -hi!! this bot (and the server it's built for) is riddled with in-jokes and dumb features. it *is* a bot that *does* work—the [`prod`](https://github.com/perpetualcacophony/slimebot/tree/prod) branch is, at least—and you could probably deploy it to your own hardware, but you're probably just better off taking what you like from the codebase. unless you *want* the bot to post an image of joe biden every time someone says "L", i guess? +hi!! this bot (and the server it's built for) is riddled with in-jokes and dumb features. it *is* a bot that *does* work—the [`prod`](https://github.com/perpetualcacophony/slimebot/tree/prod) branch is, at least—and you could probably deploy it to your own hardware, but you're probably just better off taking what you like from the codebase. unless you *want* the bot to post [this image of joe biden](https://files.catbox.moe/v7itt0.webp) every time someone says "L", i guess? ## can i use this bot in my own server? yes and no. you're completely free to compile and run the code yourself, or use the docker image at [`ghcr.io/perpetualcacophony/slimebot:prod`](https://ghcr.io/perpetualcacophony/slimebot) (check out the example [`compose.yaml`](example-compose.yaml)!) however, you'll need to use your own bot user—the bot application i operate is private server-only, which is why you won't find any invite link for slimebot. diff --git a/src/discord/watchers/mod.rs b/src/discord/watchers/mod.rs index 43a1314..1af75b0 100644 --- a/src/discord/watchers/mod.rs +++ b/src/discord/watchers/mod.rs @@ -121,7 +121,7 @@ pub async fn l_biden(ctx: &Context, new_message: &Message) { ctx.http().send_message( new_message.channel_id.into(), &json!({ - "content": "https://cdn.discordapp.com/attachments/1126687533900771429/1149042466327109814/IMG_3244.webp?ex=65b15130&is=659edc30&hm=189463085657b1bf66f7ea9daf5b341dc16a53c8485e6b1aa55705a2a22522c6&" + "content": "https://files.catbox.moe/v7itt0.webp" }) ).await.unwrap(); } From 1d13dc6ba33a90d0de20de5215e9012cf02cb859 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Thu, 18 Jan 2024 01:09:25 -0600 Subject: [PATCH 16/20] instrumeting, updated ping & pong commands --- src/discord/commands/mod.rs | 45 +++++++++++++++++++++++++++++++------ src/discord/watchers/mod.rs | 5 ++++- src/main.rs | 2 +- 3 files changed, 43 insertions(+), 9 deletions(-) diff --git a/src/discord/commands/mod.rs b/src/discord/commands/mod.rs index d11bd70..c37359f 100644 --- a/src/discord/commands/mod.rs +++ b/src/discord/commands/mod.rs @@ -2,6 +2,7 @@ mod ban; mod watch_fic; use poise::serenity_prelude::{Channel, Member, User}; +use tokio::join; use tracing::{error, info, instrument}; type Error = Box; @@ -14,19 +15,49 @@ pub use watch_fic::watch_fic; #[instrument(skip_all)] #[poise::command(slash_command, prefix_command)] pub async fn ping(ctx: Context<'_>) -> Result<(), Error> { - let channel = ctx - .channel_id() - .name(ctx.cache()) - .await - .map_or("dms".to_string(), |c| format!("#{c}")); + let (channel, ping) = join!( + ctx.channel_id().name(ctx.cache()), + ctx.ping(), + ); + info!( "@{} ({}): {}", ctx.author().name, - channel, + channel.map_or("dms".to_string(), |c| format!("#{c}")), + ctx.invocation_string() + ); + + let ping = ping.as_millis(); + if ping == 0 { + ctx.say("pong! (please try again later to display latency)").await?; + } else { + ctx.say(format!("pong! ({}ms)", ping)).await?; + } + + Ok(()) +} + +#[instrument(skip_all)] +#[poise::command(slash_command, prefix_command)] +pub async fn pong(ctx: Context<'_>) -> Result<(), Error> { + let (channel, ping) = join!( + ctx.channel_id().name(ctx.cache()), + ctx.ping(), + ); + + info!( + "@{} ({}): {}", + ctx.author().name, + channel.map_or("dms".to_string(), |c| format!("#{c}")), ctx.invocation_string() ); - ctx.say("pong!").await?; + let ping = ping.as_millis(); + if ping == 0 { + ctx.say("ping! (please try again later to display latency)").await?; + } else { + ctx.say(format!("ping! ({}ms)", ping)).await?; + } Ok(()) } diff --git a/src/discord/watchers/mod.rs b/src/discord/watchers/mod.rs index 1af75b0..44bf380 100644 --- a/src/discord/watchers/mod.rs +++ b/src/discord/watchers/mod.rs @@ -3,11 +3,12 @@ use mongodb::{bson::doc, options::FindOneOptions}; use poise::serenity_prelude::{CacheHttp, Context, Message, UserId}; use serde::{Deserialize, Serialize}; use serde_json::json; -use tracing::info; +use tracing::{info, instrument}; use super::framework::Handler; // watches all channels for a mention of vore and responds with time statistics +#[instrument(skip_all, level = "trace")] pub async fn vore(ctx: &Context, handler: &Handler, new_message: &Message) { if new_message .content @@ -103,6 +104,7 @@ pub async fn vore(ctx: &Context, handler: &Handler, new_message: &Message) { } // watches all channels for "L" and responds with the biden image +#[instrument(skip_all, level = "trace")] pub async fn l_biden(ctx: &Context, new_message: &Message) { if new_message.content == "L" { info!( @@ -128,6 +130,7 @@ pub async fn l_biden(ctx: &Context, new_message: &Message) { } // watches all channels for "CL" and reponds with the Look CL copypasta +#[instrument(skip_all, level = "trace")] pub async fn look_cl(ctx: &Context, new_message: &Message) { if new_message .content diff --git a/src/main.rs b/src/main.rs index 49def46..f594146 100644 --- a/src/main.rs +++ b/src/main.rs @@ -83,7 +83,7 @@ async fn main() { let mut handler = Handler { data, options: poise::FrameworkOptions { - commands: vec![ping(), pfp(), watch_fic(), echo(), ban(), banban()], + commands: vec![ping(), pong(), pfp(), watch_fic(), echo(), ban(), banban()], prefix_options: PrefixFrameworkOptions { prefix: Some(config.bot.prefix().to_string()), ..Default::default() From f4ece958b10ac2ba3cbac077948a93c401b4da0a Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Thu, 18 Jan 2024 20:04:32 -0600 Subject: [PATCH 17/20] tidying up, new command uptime --- src/discord/commands/mod.rs | 43 ++++++++++++++++++------- src/discord/framework.rs | 21 ++++++++++++- src/discord/watchers/mod.rs | 37 +++++++--------------- src/main.rs | 62 +++++++++++++++++++------------------ 4 files changed, 96 insertions(+), 67 deletions(-) diff --git a/src/discord/commands/mod.rs b/src/discord/commands/mod.rs index c37359f..8765124 100644 --- a/src/discord/commands/mod.rs +++ b/src/discord/commands/mod.rs @@ -10,15 +10,14 @@ type Context<'a> = poise::Context<'a, crate::Data, Error>; pub use watch_fic::watch_fic; +use crate::format_time; + /// Responds on successful execution. #[instrument(skip_all)] #[poise::command(slash_command, prefix_command)] pub async fn ping(ctx: Context<'_>) -> Result<(), Error> { - let (channel, ping) = join!( - ctx.channel_id().name(ctx.cache()), - ctx.ping(), - ); + let (channel, ping) = join!(ctx.channel_id().name(ctx.cache()), ctx.ping(),); info!( "@{} ({}): {}", @@ -29,7 +28,8 @@ pub async fn ping(ctx: Context<'_>) -> Result<(), Error> { let ping = ping.as_millis(); if ping == 0 { - ctx.say("pong! (please try again later to display latency)").await?; + ctx.say("pong! (please try again later to display latency)") + .await?; } else { ctx.say(format!("pong! ({}ms)", ping)).await?; } @@ -40,10 +40,7 @@ pub async fn ping(ctx: Context<'_>) -> Result<(), Error> { #[instrument(skip_all)] #[poise::command(slash_command, prefix_command)] pub async fn pong(ctx: Context<'_>) -> Result<(), Error> { - let (channel, ping) = join!( - ctx.channel_id().name(ctx.cache()), - ctx.ping(), - ); + let (channel, ping) = join!(ctx.channel_id().name(ctx.cache()), ctx.ping(),); info!( "@{} ({}): {}", @@ -54,7 +51,8 @@ pub async fn pong(ctx: Context<'_>) -> Result<(), Error> { let ping = ping.as_millis(); if ping == 0 { - ctx.say("ping! (please try again later to display latency)").await?; + ctx.say("ping! (please try again later to display latency)") + .await?; } else { ctx.say(format!("ping! ({}ms)", ping)).await?; } @@ -116,7 +114,7 @@ pub async fn pfp( user.face(), user.user .avatar_url() - .map_or(PfpType::Unset, |_| PfpType::Guild) + .map_or(PfpType::Unset, |_| PfpType::Guild), ) }; @@ -222,3 +220,26 @@ pub async fn banban(ctx: Context<'_>) -> Result<(), Error> { Ok(()) } + +#[instrument(skip(ctx))] +#[poise::command(prefix_command)] +pub async fn uptime(ctx: Context<'_>) -> Result<(), Error> { + let channel = ctx + .channel_id() + .name(ctx.cache()) + .await + .map_or("dms".to_string(), |c| format!("#{c}")); + info!( + "@{} ({}): {}", + ctx.author().name, + channel, + ctx.invocation_string() + ); + + let started = ctx.data().started; + let uptime = chrono::Utc::now() - started; + + ctx.say(format_time(uptime)).await.unwrap(); + + Ok(()) +} \ No newline at end of file diff --git a/src/discord/framework.rs b/src/discord/framework.rs index 6fc4732..a3dae02 100644 --- a/src/discord/framework.rs +++ b/src/discord/framework.rs @@ -1,4 +1,5 @@ -use poise::serenity_prelude::{self as serenity, Interaction, Ready}; +use poise::serenity_prelude::{self as serenity, Interaction, Ready, CacheHttp}; +use tracing::trace; use std::sync::atomic::AtomicBool; use tokio::sync::Mutex; @@ -63,9 +64,27 @@ impl serenity::EventHandler for Handler { } async fn ready(&self, ctx: serenity::Context, _: Ready) { + trace!("Ready event received from discord!"); + if let Some(activity) = self.data.config().bot.activity() { ctx.set_activity(activity).await; } + + let mut keep_alive = tokio::time::interval(std::time::Duration::from_secs(600)); + keep_alive.tick().await; + loop { + let before = std::time::SystemTime::now(); + if ctx.http().get_bot_gateway().await.is_err() { + tracing::error!("failed to connect to discord!"); + } + let ping = std::time::SystemTime::now() + .duration_since(before) + .unwrap() + .as_millis(); + tracing::info!("discord connection active! ({ping}ms)"); + + keep_alive.tick().await; + } } } diff --git a/src/discord/watchers/mod.rs b/src/discord/watchers/mod.rs index 44bf380..65108a1 100644 --- a/src/discord/watchers/mod.rs +++ b/src/discord/watchers/mod.rs @@ -5,6 +5,8 @@ use serde::{Deserialize, Serialize}; use serde_json::json; use tracing::{info, instrument}; +use crate::format_time; + use super::framework::Handler; // watches all channels for a mention of vore and responds with time statistics @@ -71,25 +73,7 @@ pub async fn vore(ctx: &Context, handler: &Handler, new_message: &Message) { }; let time = recent - last; - - let (d, h, m, s) = ( - time.num_days(), - time.num_hours(), - time.num_minutes(), - time.num_seconds(), - ); - - let time_text = match (d, h, m, s) { - (1, _, _, _) => ("1 day").to_string(), - (2.., _, _, _) => format!("{d} days"), - (_, 1, _, _) => ("1 hour").to_string(), - (_, 2.., _, _) => format!("{h} hours"), - (_, _, 1, _) => ("1 minute").to_string(), - (_, _, 2.., _) => format!("{m} minutes"), - (_, _, _, 1) => ("1 second").to_string(), - (_, _, _, 2..) => format!("{s} seconds"), - (_, _, _, _) => "less than a second".to_string(), - }; + let time_text = format_time(time); ctx.http() .send_message( @@ -120,12 +104,15 @@ pub async fn l_biden(ctx: &Context, new_message: &Message) { new_message.content ); - ctx.http().send_message( - new_message.channel_id.into(), - &json!({ - "content": "https://files.catbox.moe/v7itt0.webp" - }) - ).await.unwrap(); + ctx.http() + .send_message( + new_message.channel_id.into(), + &json!({ + "content": "https://files.catbox.moe/v7itt0.webp" + }), + ) + .await + .unwrap(); } } diff --git a/src/main.rs b/src/main.rs index f594146..6ee5e2b 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,6 +1,5 @@ /// Logging frontends, with [`tracing`](https://docs.rs/tracing/latest/tracing/) backend. mod logging; -use chrono::{DateTime, Utc}; use logging::DiscordSubscriber; /// Functionality called from Discord. @@ -9,7 +8,6 @@ mod discord; use discord::commands::*; use discord::framework::Handler; use mongodb::Database; -use serde::{Deserialize, Serialize}; /// Config file parsing and option access. mod config; @@ -20,14 +18,18 @@ use poise::{ serenity_prelude::{self as serenity, GatewayIntents}, PrefixFrameworkOptions, }; -use std::time::{Duration, SystemTime}; -use tracing::{error, info, trace}; +use std::{time::Duration, thread}; +use tracing::trace; use tracing_unwrap::ResultExt; +use chrono::Utc; +type UtcDateTime = chrono::DateTime; + #[derive(Debug)] pub struct Data { config: config::Config, db: Database, + started: UtcDateTime } impl Data { @@ -42,7 +44,9 @@ impl Data { let db = db::database(&config.db); - Self { config, db } + let started = Utc::now(); + + Self { config, db, started } } const fn config(&self) -> &crate::config::Config { @@ -54,11 +58,6 @@ impl Data { } } -#[derive(Debug, Deserialize, Clone, Serialize)] -pub struct MoreData { - last_vore_mention: DateTime, -} - // i should replace this with anyhow::Error type Error = Box; @@ -83,7 +82,7 @@ async fn main() { let mut handler = Handler { data, options: poise::FrameworkOptions { - commands: vec![ping(), pong(), pfp(), watch_fic(), echo(), ban(), banban()], + commands: vec![ping(), pong(), pfp(), watch_fic(), echo(), ban(), banban(), uptime()], prefix_options: PrefixFrameworkOptions { prefix: Some(config.bot.prefix().to_string()), ..Default::default() @@ -160,28 +159,31 @@ async fn main() { trace!("hi discord!"); } - // i think this is an okay pattern? - // it's probably a bad idea for *all* of the bot's - // functionality to be defined by command responses. - // right now it's silly though. the ao3 pinger - // *should* be a command handler. tokio::spawn(async move { client.start().await }); - trace!("discord framework started"); - let mut keep_alive = tokio::time::interval(Duration::from_secs(600)); - keep_alive.tick().await; loop { - let before = SystemTime::now(); - if http.get_bot_gateway().await.is_err() { - error!("failed to connect to discord!"); - } - let ping = SystemTime::now() - .duration_since(before) - .unwrap() - .as_millis(); - info!("discord connection active! ({ping}ms)"); - - keep_alive.tick().await; + thread::sleep(Duration::from_millis(1000)); } } + +fn format_time(time: chrono::Duration) -> String { + let (d, h, m, s) = ( + time.num_days(), + time.num_hours(), + time.num_minutes(), + time.num_seconds(), + ); + + match (d, h, m, s) { + (1, _, _, _) => ("1 day").to_string(), + (2.., _, _, _) => format!("{d} days"), + (_, 1, _, _) => ("1 hour").to_string(), + (_, 2.., _, _) => format!("{h} hours"), + (_, _, 1, _) => ("1 minute").to_string(), + (_, _, 2.., _) => format!("{m} minutes"), + (_, _, _, 1) => ("1 second").to_string(), + (_, _, _, 2..) => format!("{s} seconds"), + (_, _, _, _) => "less than a second".to_string(), + } +} \ No newline at end of file From 1b2e186a3d9792b5f89ba50a995cfcaad41009d4 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Thu, 18 Jan 2024 22:51:02 -0600 Subject: [PATCH 18/20] stabilized duration formatting, uptime command --- src/discord/commands/mod.rs | 8 +++-- src/discord/watchers/mod.rs | 4 +-- src/main.rs | 59 ++++++++++++++++++++++++++----------- 3 files changed, 49 insertions(+), 22 deletions(-) diff --git a/src/discord/commands/mod.rs b/src/discord/commands/mod.rs index 8765124..b142a83 100644 --- a/src/discord/commands/mod.rs +++ b/src/discord/commands/mod.rs @@ -10,7 +10,7 @@ type Context<'a> = poise::Context<'a, crate::Data, Error>; pub use watch_fic::watch_fic; -use crate::format_time; +use crate::FormatDuration; /// Responds on successful execution. @@ -239,7 +239,11 @@ pub async fn uptime(ctx: Context<'_>) -> Result<(), Error> { let started = ctx.data().started; let uptime = chrono::Utc::now() - started; - ctx.say(format_time(uptime)).await.unwrap(); + ctx.say(format!( + "uptime: {} (since {})", + uptime.format_full(), + started.format("%Y-%m-%d %H:%M UTC") + )).await.unwrap(); Ok(()) } \ No newline at end of file diff --git a/src/discord/watchers/mod.rs b/src/discord/watchers/mod.rs index 65108a1..1ff539a 100644 --- a/src/discord/watchers/mod.rs +++ b/src/discord/watchers/mod.rs @@ -5,7 +5,7 @@ use serde::{Deserialize, Serialize}; use serde_json::json; use tracing::{info, instrument}; -use crate::format_time; +use crate::FormatDuration; use super::framework::Handler; @@ -73,7 +73,7 @@ pub async fn vore(ctx: &Context, handler: &Handler, new_message: &Message) { }; let time = recent - last; - let time_text = format_time(time); + let time_text = time.format_largest(); ctx.http() .send_message( diff --git a/src/main.rs b/src/main.rs index 6ee5e2b..79a6456 100644 --- a/src/main.rs +++ b/src/main.rs @@ -167,23 +167,46 @@ async fn main() { } } -fn format_time(time: chrono::Duration) -> String { - let (d, h, m, s) = ( - time.num_days(), - time.num_hours(), - time.num_minutes(), - time.num_seconds(), - ); - - match (d, h, m, s) { - (1, _, _, _) => ("1 day").to_string(), - (2.., _, _, _) => format!("{d} days"), - (_, 1, _, _) => ("1 hour").to_string(), - (_, 2.., _, _) => format!("{h} hours"), - (_, _, 1, _) => ("1 minute").to_string(), - (_, _, 2.., _) => format!("{m} minutes"), - (_, _, _, 1) => ("1 second").to_string(), - (_, _, _, 2..) => format!("{s} seconds"), - (_, _, _, _) => "less than a second".to_string(), +trait FormatDuration { + fn format_largest(&self) -> String; + fn format_full(&self) -> String; +} + +impl FormatDuration for chrono::Duration { + fn format_largest(&self) -> String { + let (d, h, m, s) = ( + self.num_days(), + self.num_hours(), + self.num_minutes(), + self.num_seconds(), + ); + + match (d, h, m, s) { + (1, _, _, _) => ("1 day").to_string(), + (2.., _, _, _) => format!("{d} days"), + (_, 1, _, _) => ("1 hour").to_string(), + (_, 2.., _, _) => format!("{h} hours"), + (_, _, 1, _) => ("1 minute").to_string(), + (_, _, 2.., _) => format!("{m} minutes"), + (_, _, _, 1) => ("1 second").to_string(), + (_, _, _, 2..) => format!("{s} seconds"), + (_, _, _, _) => "less than a second".to_string(), + } + } + + fn format_full(&self) -> String { + let mut formatted = String::new(); + + if self.num_days() > 0 { + formatted += &format!("{}d", self.num_days()); + } else if self.num_hours() > 0 { + formatted += &format!("{}h", self.num_hours()); + } else if self.num_minutes() > 0 { + formatted += &format!("{}m", self.num_minutes()); + } else { + formatted = "less than a minute".to_string(); + } + + formatted } } \ No newline at end of file From 0c2a9c762ab04661ab51ac2799d0267e20687c2b Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Thu, 18 Jan 2024 22:53:03 -0600 Subject: [PATCH 19/20] hoping this fixes the image tagging --- .github/workflows/docker-publish.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index 8e9e60b..1906d03 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -9,7 +9,7 @@ on: push: branches: [ "prod" ] # Publish semver tags as releases. - tags: [ 'v*.*.*' ] + tags: [ 'v*.*' ] env: # Use docker.io for Docker Hub if empty From 23d06b06f794bd027c69d2f45794920283319787 Mon Sep 17 00:00:00 2001 From: kate <142743629+perpetualcacophony@users.noreply.github.com> Date: Thu, 18 Jan 2024 22:54:35 -0600 Subject: [PATCH 20/20] bump to v1.3, new schema! --- Cargo.lock | 2 +- Cargo.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index ca17291..dc3d65d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2219,7 +2219,7 @@ dependencies = [ [[package]] name = "slimebot" -version = "1.2.0" +version = "1.3.0" dependencies = [ "anyhow", "chrono", diff --git a/Cargo.toml b/Cargo.toml index 1cdefdf..1fcfb7d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "slimebot" -version = "1.2.0" +version = "1.3.0" edition = "2021" readme = "README.md" license = "AGPL-3.0"