1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
#[cfg(feature = "serenity")]
use crate::shards::SerenitySharder;
use crate::{
error::{JoinError, JoinResult},
id::{ChannelId, GuildId, UserId},
shards::Sharder,
Call,
Config,
ConnectionInfo,
};
#[cfg(feature = "serenity")]
use async_trait::async_trait;
use dashmap::DashMap;
#[cfg(feature = "serenity")]
use futures::channel::mpsc::UnboundedSender as Sender;
use once_cell::sync::OnceCell;
use parking_lot::RwLock as PRwLock;
#[cfg(feature = "serenity")]
use serenity::{
gateway::{ShardRunnerMessage, VoiceGatewayManager},
model::{
id::{GuildId as SerenityGuild, UserId as SerenityUser},
voice::VoiceState,
},
};
use std::sync::Arc;
use tokio::sync::Mutex;
#[cfg(feature = "serenity")]
use tracing::debug;
#[cfg(feature = "twilight")]
use twilight_model::gateway::event::Event as TwilightEvent;
#[derive(Clone, Copy, Debug)]
struct ClientData {
shard_count: u64,
user_id: UserId,
}
/// A shard-aware struct responsible for managing [`Call`]s.
///
/// This manager transparently maps guild state and a source of shard information
/// into individual calls, and forwards state updates which affect call state.
///
/// [`Call`]: Call
#[derive(Debug)]
pub struct Songbird {
client_data: OnceCell<ClientData>,
calls: DashMap<GuildId, Arc<Mutex<Call>>>,
sharder: Sharder,
config: PRwLock<Config>,
}
impl Songbird {
#[cfg(feature = "serenity")]
/// Create a new Songbird instance for serenity.
///
/// This must be [registered] after creation.
///
/// [registered]: crate::serenity::register_with
#[must_use]
pub fn serenity() -> Arc<Self> {
Self::serenity_from_config(Config::default())
}
#[cfg(feature = "serenity")]
/// Create a new Songbird instance for serenity, using the given configuration.
///
/// This must be [registered] after creation.
///
/// [registered]: crate::serenity::register_with
#[must_use]
pub fn serenity_from_config(config: Config) -> Arc<Self> {
Arc::new(Self {
client_data: OnceCell::new(),
calls: DashMap::new(),
sharder: Sharder::Serenity(SerenitySharder::default()),
config: config.initialise_disposer().into(),
})
}
#[cfg(feature = "twilight")]
/// Create a new Songbird instance for twilight.
///
/// Twilight handlers do not need to be registered, but
/// users are responsible for passing in any events using
/// [`process`].
///
/// [`process`]: Songbird::process
pub fn twilight<U>(cluster: Arc<crate::shards::TwilightMap>, user_id: U) -> Self
where
U: Into<UserId>,
{
Self::twilight_from_config(cluster, user_id, Config::default())
}
#[cfg(feature = "twilight")]
/// Create a new Songbird instance for twilight.
///
/// Twilight handlers do not need to be registered, but
/// users are responsible for passing in any events using
/// [`process`].
///
/// [`process`]: Songbird::process
pub fn twilight_from_config<U>(
sender_map: Arc<crate::shards::TwilightMap>,
user_id: U,
config: Config,
) -> Self
where
U: Into<UserId>,
{
Self {
client_data: OnceCell::with_value(ClientData {
shard_count: sender_map.shard_count(),
user_id: user_id.into(),
}),
calls: DashMap::new(),
sharder: Sharder::Twilight(sender_map),
config: config.initialise_disposer().into(),
}
}
/// Set the bot's user, and the number of shards in use.
///
/// If this struct is already initialised (e.g., from [`::twilight`]),
/// or a previous call, then this function is a no-op.
///
/// [`::twilight`]: #method.twilight
pub fn initialise_client_data<U: Into<UserId>>(&self, shard_count: u64, user_id: U) {
self.client_data
.set(ClientData {
shard_count,
user_id: user_id.into(),
})
.ok();
}
/// Retrieves a [`Call`] for the given guild, if one already exists.
///
/// [`Call`]: Call
pub fn get<G: Into<GuildId>>(&self, guild_id: G) -> Option<Arc<Mutex<Call>>> {
self.calls
.get(&guild_id.into())
.map(|mapref| Arc::clone(&mapref))
}
/// Retrieves a [`Call`] for the given guild, creating a new one if
/// none is found.
///
/// This will not join any calls, or cause connection state to change.
///
/// [`Call`]: Call
#[inline]
pub fn get_or_insert<G>(&self, guild_id: G) -> Arc<Mutex<Call>>
where
G: Into<GuildId>,
{
self._get_or_insert(guild_id.into())
}
fn _get_or_insert(&self, guild_id: GuildId) -> Arc<Mutex<Call>> {
self.get(guild_id).unwrap_or_else(|| {
self.calls
.entry(guild_id)
.or_insert_with(|| {
let info = self
.client_data
.get()
.expect("Manager has not been initialised");
let shard = shard_id(guild_id.0.get(), info.shard_count);
let shard_handle = self
.sharder
.get_shard(shard)
.expect("Failed to get shard handle: shard_count incorrect?");
let call = Call::from_config(
guild_id,
shard_handle,
info.user_id,
self.config.read().clone(),
);
Arc::new(Mutex::new(call))
})
.clone()
})
}
/// Creates an iterator for all [`Call`]s currently managed.
pub fn iter(&self) -> Iter<'_> {
Iter {
inner: self.calls.iter().map(|x| (*x.key(), Arc::clone(x.value()))),
}
}
/// Sets a shared configuration for all drivers created from this
/// manager.
///
/// Changes made here will apply to new Call and Driver instances only.
///
/// Requires the `"driver"` feature.
pub fn set_config(&self, new_config: Config) {
let mut config = self.config.write();
*config = new_config;
}
#[cfg(feature = "driver")]
/// Connects to a target by retrieving its relevant [`Call`] and
/// connecting, or creating the handler if required.
///
/// This can also switch to the given channel, if a handler already exists
/// for the target and the current connected channel is not equal to the
/// given channel.
///
/// The provided channel ID is used as a connection target. The
/// channel _must_ be in the provided guild. This is _not_ checked by the
/// library, and will result in an error. If there is already a connected
/// handler for the guild, _and_ the provided channel is different from the
/// channel that the connection is already connected to, then the handler
/// will switch the connection to the provided channel.
///
/// If you _only_ need to retrieve the handler for a target, then use
/// [`get`].
///
/// Twilight users should read the caveats mentioned in [`process`].
///
/// NOTE: an `Err(..)` value will still create a [`Call`] accessible via [`get`].
///
/// [`Call`]: Call
/// [`get`]: Songbird::get
/// [`process`]: #method.process
#[inline]
pub async fn join<C, G>(&self, guild_id: G, channel_id: C) -> JoinResult<Arc<Mutex<Call>>>
where
C: Into<ChannelId>,
G: Into<GuildId>,
{
self._join(guild_id.into(), channel_id.into()).await
}
#[cfg(feature = "driver")]
async fn _join(
&self,
guild_id: GuildId,
channel_id: ChannelId,
) -> JoinResult<Arc<Mutex<Call>>> {
let call = self.get_or_insert(guild_id);
let stage_1 = {
let mut handler = call.lock().await;
handler.join(channel_id).await
};
match stage_1 {
Ok(chan) => chan.await.map(|()| call),
Err(e) => Err(e),
}
}
/// Partially connects to a target by retrieving its relevant [`Call`] and
/// connecting, or creating the handler if required.
///
/// This method returns the handle and the connection info needed for other libraries
/// or drivers, such as lavalink, and does not actually start or run a voice call.
///
/// NOTE: an `Err(..)` value will still create a [`Call`] accessible via [`get`].
///
/// [`Call`]: Call
/// [`get`]: Songbird::get
#[inline]
pub async fn join_gateway<C, G>(
&self,
guild_id: G,
channel_id: C,
) -> JoinResult<(ConnectionInfo, Arc<Mutex<Call>>)>
where
C: Into<ChannelId>,
G: Into<GuildId>,
{
self._join_gateway(guild_id.into(), channel_id.into()).await
}
async fn _join_gateway(
&self,
guild_id: GuildId,
channel_id: ChannelId,
) -> JoinResult<(ConnectionInfo, Arc<Mutex<Call>>)> {
let call = self.get_or_insert(guild_id);
let stage_1 = {
let mut handler = call.lock().await;
handler.join_gateway(channel_id).await
};
match stage_1 {
Ok(chan) => chan
.await
.map_err(|_| JoinError::Dropped)
.map(|info| (info, call)),
Err(e) => Err(e),
}
}
/// Retrieves the [handler][`Call`] for the given target and leaves the
/// associated voice channel, if connected.
///
/// This will _not_ drop the handler, and will preserve it and its settings.
/// If you do not need to reuse event handlers, configuration, or active tracks
/// in the underlying driver *consider calling [`remove`]* to release tasks,
/// threads, and memory.
///
/// This is a wrapper around [getting][`get`] a handler and calling
/// [`leave`] on it.
///
/// [`Call`]: Call
/// [`get`]: Songbird::get
/// [`leave`]: Call::leave
/// [`remove`]: Songbird::remove
#[inline]
pub async fn leave<G: Into<GuildId>>(&self, guild_id: G) -> JoinResult<()> {
self._leave(guild_id.into()).await
}
async fn _leave(&self, guild_id: GuildId) -> JoinResult<()> {
if let Some(call) = self.get(guild_id) {
let mut handler = call.lock().await;
handler.leave().await
} else {
Err(JoinError::NoCall)
}
}
/// Retrieves the [`Call`] for the given target and leaves the associated
/// voice channel, if connected.
///
/// The handler is then dropped, removing settings for the target.
///
/// An Err(...) value implies that the gateway could not be contacted,
/// and that leaving should be attempted again later (i.e., after reconnect).
///
/// [`Call`]: Call
#[inline]
pub async fn remove<G: Into<GuildId>>(&self, guild_id: G) -> JoinResult<()> {
self._remove(guild_id.into()).await
}
async fn _remove(&self, guild_id: GuildId) -> JoinResult<()> {
self.leave(guild_id).await?;
self.calls.remove(&guild_id);
Ok(())
}
}
impl<'a> IntoIterator for &'a Songbird {
type Item = <Iter<'a> as Iterator>::Item;
type IntoIter = Iter<'a>;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
#[cfg(feature = "twilight")]
impl Songbird {
/// Handle events received on the cluster.
///
/// When using twilight, you are required to call this with all inbound
/// (voice) events, *i.e.*, at least `VoiceStateUpdate`s and `VoiceServerUpdate`s.
///
/// Users *must* ensure that calls to this function happen on a **separate task**
/// to any calls to [`join`], [`join_gateway`]. The simplest way to ensure this is
/// to `tokio::spawn` any command invocation.
///
/// Returned futures generally require the inner [`Call`] to be updated via this function,
/// and will deadlock if event processing is not carried out on another spawned task.
///
/// [`join`]: Songbird::join
/// [`join_gateway`]: Songbird::join_gateway
/// [`Call`]: Call
pub async fn process(&self, event: &TwilightEvent) {
match event {
TwilightEvent::VoiceServerUpdate(v) => {
let guild_id = GuildId::from(v.guild_id);
let call = self.get(guild_id);
if let Some(call) = call {
let mut handler = call.lock().await;
if let Some(endpoint) = &v.endpoint {
handler.update_server(endpoint.clone(), v.token.clone());
}
}
},
TwilightEvent::VoiceStateUpdate(v) => {
if self
.client_data
.get()
.map_or(true, |data| v.0.user_id.into_nonzero() != data.user_id.0)
{
return;
}
let call = v.0.guild_id.map(GuildId::from).and_then(|id| self.get(id));
if let Some(call) = call {
let mut handler = call.lock().await;
handler.update_state(v.0.session_id.clone(), v.0.channel_id);
}
},
_ => {},
}
}
}
#[cfg(feature = "serenity")]
#[async_trait]
impl VoiceGatewayManager for Songbird {
async fn initialise(&self, shard_count: u32, user_id: SerenityUser) {
debug!(
"Initialising Songbird for Serenity: ID {:?}, {} Shards",
user_id, shard_count
);
self.initialise_client_data(shard_count as u64, user_id);
debug!("Songbird ({:?}) Initialised!", user_id);
}
async fn register_shard(&self, shard_id: u32, sender: Sender<ShardRunnerMessage>) {
debug!(
"Registering Serenity shard handle {} with Songbird",
shard_id
);
self.sharder.register_shard_handle(shard_id, sender);
debug!("Registered shard handle {}.", shard_id);
}
async fn deregister_shard(&self, shard_id: u32) {
debug!(
"Deregistering Serenity shard handle {} with Songbird",
shard_id
);
self.sharder.deregister_shard_handle(shard_id);
debug!("Deregistered shard handle {}.", shard_id);
}
async fn server_update(&self, guild_id: SerenityGuild, endpoint: &Option<String>, token: &str) {
if let Some(call) = self.get(guild_id) {
let mut handler = call.lock().await;
if let Some(endpoint) = endpoint {
handler.update_server(endpoint.clone(), token.to_string());
}
}
}
async fn state_update(&self, guild_id: SerenityGuild, voice_state: &VoiceState) {
if self.client_data.get().map_or(true, |data| {
voice_state.user_id.get() != data.user_id.0.get()
}) {
return;
}
if let Some(call) = self.get(guild_id) {
let mut handler = call.lock().await;
handler.update_state(voice_state.session_id.clone(), voice_state.channel_id);
}
}
}
type DashMapIter<'a> = dashmap::iter::Iter<'a, GuildId, Arc<Mutex<Call>>>;
type InnerIter<'a> = std::iter::Map<
DashMapIter<'a>,
fn(<DashMapIter<'a> as Iterator>::Item) -> (GuildId, Arc<Mutex<Call>>),
>;
/// An iterator over all [`Call`]s currently stored in the manager instance.
pub struct Iter<'a> {
inner: InnerIter<'a>,
}
impl<'a> Iterator for Iter<'a> {
type Item = (GuildId, Arc<Mutex<Call>>);
fn next(&mut self) -> Option<Self::Item> {
self.inner.next()
}
fn size_hint(&self) -> (usize, Option<usize>) {
self.inner.size_hint()
}
fn count(self) -> usize {
self.inner.count()
}
fn fold<B, F>(self, init: B, f: F) -> B
where
Self: Sized,
F: FnMut(B, Self::Item) -> B,
{
self.inner.fold(init, f)
}
}
#[inline]
fn shard_id(guild_id: u64, shard_count: u64) -> u64 {
(guild_id >> 22) % shard_count
}