refactor(quark): port message_edit, message_fetch, voice_join

This commit is contained in:
Paul Makles
2024-04-07 16:47:46 +01:00
parent aded2e3239
commit aca1fe6dff
11 changed files with 214 additions and 96 deletions

1
Cargo.lock generated
View File

@@ -3669,6 +3669,7 @@ dependencies = [
"env_logger", "env_logger",
"futures", "futures",
"impl_ops", "impl_ops",
"iso8601-timestamp 0.2.11",
"lettre", "lettre",
"linkify 0.6.0", "linkify 0.6.0",
"log", "log",

View File

@@ -3,9 +3,12 @@ use std::collections::HashSet;
use indexmap::{IndexMap, IndexSet}; use indexmap::{IndexMap, IndexSet};
use iso8601_timestamp::Timestamp; use iso8601_timestamp::Timestamp;
use revolt_config::config; use revolt_config::config;
use revolt_models::v0::{ use revolt_models::{
self, DataMessageSend, Embed, MessageAuthor, MessageSort, MessageWebhook, PushNotification, v0::{
ReplyIntent, SendableEmbed, RE_MENTION, self, DataMessageSend, Embed, MessageAuthor, MessageSort, MessageWebhook, PushNotification,
ReplyIntent, SendableEmbed, Text, RE_MENTION,
},
validator::Validate,
}; };
use revolt_permissions::{ChannelPermission, PermissionValue}; use revolt_permissions::{ChannelPermission, PermissionValue};
use revolt_result::Result; use revolt_result::Result;
@@ -155,6 +158,7 @@ auto_derived!(
} }
/// Message Filter /// Message Filter
#[derive(Default)]
pub struct MessageFilter { pub struct MessageFilter {
/// Parent channel ID /// Parent channel ID
pub channel: Option<String>, pub channel: Option<String>,
@@ -441,6 +445,33 @@ impl Message {
Ok(()) Ok(())
} }
/// Create text embed from sendable embed
pub async fn create_embed(&self, db: &Database, embed: SendableEmbed) -> Result<Embed> {
embed.validate().map_err(|error| {
create_error!(FailedValidation {
error: error.to_string()
})
})?;
let media = if let Some(id) = embed.media {
Some(
db.find_and_use_attachment(&id, "attachments", "message", &self.id)
.await?,
)
} else {
None
};
Ok(Embed::Text(Text {
icon_url: embed.icon_url,
url: embed.url,
title: embed.title,
description: embed.description,
media: media.map(|m| m.into()),
colour: embed.colour,
}))
}
/// Update message data /// Update message data
pub async fn update(&mut self, db: &Database, partial: PartialMessage) -> Result<()> { pub async fn update(&mut self, db: &Database, partial: PartialMessage) -> Result<()> {
self.apply_options(partial.clone()); self.apply_options(partial.clone());

View File

@@ -268,6 +268,12 @@ auto_derived!(
/// Whether to not send a leave message /// Whether to not send a leave message
pub leave_silently: Option<bool>, pub leave_silently: Option<bool>,
} }
/// Voice server token response
pub struct LegacyCreateVoiceUserResponse {
/// Token for authenticating with the voice server
token: String,
}
); );
impl Channel { impl Channel {

View File

@@ -8,9 +8,12 @@ use revolt_config::config;
#[cfg(feature = "validator")] #[cfg(feature = "validator")]
use validator::Validate; use validator::Validate;
#[cfg(feature = "rocket")]
use rocket::{FromForm, FromFormField};
use iso8601_timestamp::Timestamp; use iso8601_timestamp::Timestamp;
use super::{Embed, File, MessageWebhook, User, Webhook, RE_COLOUR}; use super::{Embed, File, Member, MessageWebhook, User, Webhook, RE_COLOUR};
pub static RE_MENTION: Lazy<Regex> = pub static RE_MENTION: Lazy<Regex> =
Lazy::new(|| Regex::new(r"<@([0-9A-HJKMNP-TV-Z]{26})>").unwrap()); Lazy::new(|| Regex::new(r"<@([0-9A-HJKMNP-TV-Z]{26})>").unwrap());
@@ -66,6 +69,24 @@ auto_derived_partial!(
); );
auto_derived!( auto_derived!(
/// Bulk Message Response
#[serde(untagged)]
pub enum BulkMessageResponse {
JustMessages(
/// List of messages
Vec<Message>,
),
MessagesAndUsers {
/// List of messages
messages: Vec<Message>,
/// List of users
users: Vec<User>,
/// List of members
#[serde(skip_serializing_if = "Option::is_none")]
members: Option<Vec<Member>>,
},
}
/// System Event /// System Event
#[serde(tag = "type")] #[serde(tag = "type")]
pub enum SystemMessage { pub enum SystemMessage {
@@ -136,6 +157,7 @@ auto_derived!(
/// ///
/// Sort used for retrieving messages /// Sort used for retrieving messages
#[derive(Default)] #[derive(Default)]
#[cfg_attr(feature = "rocket", derive(FromFormField))]
pub enum MessageSort { pub enum MessageSort {
/// Sort by the most relevant messages /// Sort by the most relevant messages
#[default] #[default]
@@ -221,6 +243,71 @@ auto_derived!(
pub interactions: Option<Interactions>, pub interactions: Option<Interactions>,
} }
/// Options for querying messages
#[cfg_attr(feature = "validator", derive(Validate))]
#[cfg_attr(feature = "rocket", derive(FromForm))]
pub struct OptionsQueryMessages {
/// Maximum number of messages to fetch
///
/// For fetching nearby messages, this is \`(limit + 1)\`.
#[validate(range(min = 1, max = 100))]
pub limit: Option<i64>,
/// Message id before which messages should be fetched
#[validate(length(min = 26, max = 26))]
pub before: Option<String>,
/// Message id after which messages should be fetched
#[validate(length(min = 26, max = 26))]
pub after: Option<String>,
/// Message sort direction
pub sort: Option<MessageSort>,
/// Message id to search around
///
/// Specifying 'nearby' ignores 'before', 'after' and 'sort'.
/// It will also take half of limit rounded as the limits to each side.
/// It also fetches the message ID specified.
#[validate(length(min = 26, max = 26))]
pub nearby: Option<String>,
/// Whether to include user (and member, if server channel) objects
pub include_users: Option<bool>,
}
/// Options for searching for messages
pub struct OptionsMessageSearch {
/// Full-text search query
///
/// See [MongoDB documentation](https://docs.mongodb.com/manual/text-search/#-text-operator) for more information.
#[validate(length(min = 1, max = 64))]
pub query: String,
/// Maximum number of messages to fetch
#[validate(range(min = 1, max = 100))]
pub limit: Option<i64>,
/// Message id before which messages should be fetched
#[validate(length(min = 26, max = 26))]
pub before: Option<String>,
/// Message id after which messages should be fetched
#[validate(length(min = 26, max = 26))]
pub after: Option<String>,
/// Message sort direction
///
/// By default, it will be sorted by latest.
#[serde(default = "MessageSort::default")]
pub sort: MessageSort,
/// Whether to include user (and member, if server channel) objects
pub include_users: Option<bool>,
}
/// Changes to make to message
#[cfg_attr(feature = "validator", derive(Validate))]
pub struct DataEditMessage {
/// New message content
#[cfg_attr(feature = "validator", validate(length(min = 1, max = 2000)))]
pub content: Option<String>,
/// Embeds to include in the message
#[cfg_attr(feature = "validator", validate(length(min = 0, max = 10)))]
pub embeds: Option<Vec<SendableEmbed>>,
}
/// Options for bulk deleting messages /// Options for bulk deleting messages
#[cfg_attr( #[cfg_attr(
feature = "validator", feature = "validator",

View File

@@ -36,6 +36,7 @@ nanoid = "0.4.0"
serde_json = "1.0.57" serde_json = "1.0.57"
serde = { version = "1.0.115", features = ["derive"] } serde = { version = "1.0.115", features = ["derive"] }
validator = { version = "0.16", features = ["derive"] } validator = { version = "0.16", features = ["derive"] }
iso8601-timestamp = { version = "0.2.11", features = [] }
# async # async
futures = "0.3.8" futures = "0.3.8"

View File

@@ -1,60 +1,53 @@
use revolt_quark::{ use iso8601_timestamp::Timestamp;
models::message::{PartialMessage, SendableEmbed}, use revolt_config::config;
models::{Message, User}, use revolt_database::{
perms, util::{permissions::DatabasePermissionQuery, reference::Reference},
types::january::Embed, Database, Message, PartialMessage, User,
Db, Error, Permission, Ref, Result, Timestamp,
}; };
use revolt_models::v0::{self, Embed};
use rocket::serde::json::Json; use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
use serde::{Deserialize, Serialize}; use revolt_result::{create_error, Result};
use rocket::{serde::json::Json, State};
use validator::Validate; use validator::Validate;
/// # Message Details
#[derive(Validate, Serialize, Deserialize, JsonSchema)]
pub struct DataEditMessage {
/// New message content
#[validate(length(min = 1, max = 2000))]
content: Option<String>,
/// Embeds to include in the message
#[validate(length(min = 0, max = 10))]
embeds: Option<Vec<SendableEmbed>>,
}
/// # Edit Message /// # Edit Message
/// ///
/// Edits a message that you've previously sent. /// Edits a message that you've previously sent.
#[openapi(tag = "Messaging")] #[openapi(tag = "Messaging")]
#[patch("/<target>/messages/<msg>", data = "<edit>")] #[patch("/<target>/messages/<msg>", data = "<edit>")]
pub async fn req( pub async fn edit(
db: &Db, db: &State<Database>,
user: User, user: User,
target: Ref, target: Reference,
msg: Ref, msg: Reference,
edit: Json<DataEditMessage>, edit: Json<v0::DataEditMessage>,
) -> Result<Json<Message>> { ) -> Result<Json<v0::Message>> {
let edit = edit.into_inner(); let edit = edit.into_inner();
edit.validate() edit.validate().map_err(|error| {
.map_err(|error| Error::FailedValidation { error })?; create_error!(FailedValidation {
error: error.to_string()
})
})?;
let config = config().await;
Message::validate_sum(
&edit.content,
edit.embeds.as_deref().unwrap_or_default(),
config.features.limits.default.message_length,
)?;
// Ensure we have permissions to send a message // Ensure we have permissions to send a message
let channel = target.as_channel(db).await?; let channel = target.as_channel(db).await?;
let mut permissions = perms(&user).channel(&channel); let mut query = DatabasePermissionQuery::new(db, &user).channel(&channel);
permissions let permissions = calculate_channel_permissions(&mut query).await;
.throw_permission_and_view_channel(db, Permission::SendMessage)
.await?;
let mut message = msg.as_message(db).await?; permissions.throw_if_lacking_channel_permission(ChannelPermission::SendMessage)?;
if message.channel != channel.id() {
return Err(Error::NotFound);
}
let mut message = msg.as_message_in_channel(db, &channel.id()).await?;
if message.author != user.id { if message.author != user.id {
return Err(Error::CannotEditMessage); return Err(create_error!(CannotEditMessage));
} }
Message::validate_sum(&edit.content, edit.embeds.as_deref().unwrap_or_default())?;
message.edited = Some(Timestamp::now_utc()); message.edited = Some(Timestamp::now_utc());
let mut partial = PartialMessage { let mut partial = PartialMessage {
edited: message.edited, edited: message.edited,
@@ -79,14 +72,12 @@ pub async fn req(
// 3. Replace if we are given new embeds // 3. Replace if we are given new embeds
if let Some(embeds) = edit.embeds { if let Some(embeds) = edit.embeds {
// Ensure we have permissions to send embeds // Ensure we have permissions to send embeds
permissions permissions.throw_if_lacking_channel_permission(ChannelPermission::SendEmbeds)?;
.throw_permission_and_view_channel(db, Permission::SendEmbeds)
.await?;
new_embeds.clear(); new_embeds.clear();
for embed in embeds { for embed in embeds {
new_embeds.push(embed.clone().into_embed(db, &message.id).await?); new_embeds.push(message.create_embed(db, embed).await?);
} }
} }
@@ -95,10 +86,7 @@ pub async fn req(
message.update(db, partial).await?; message.update(db, partial).await?;
// Queue up a task for processing embeds if the we have sufficient permissions // Queue up a task for processing embeds if the we have sufficient permissions
if permissions if permissions.has_channel_permission(ChannelPermission::SendEmbeds) {
.has_permission(db, Permission::SendEmbeds)
.await?
{
if let Some(content) = edit.content { if let Some(content) = edit.content {
revolt_quark::tasks::process_embeds::queue( revolt_quark::tasks::process_embeds::queue(
message.channel.to_string(), message.channel.to_string(),
@@ -109,5 +97,5 @@ pub async fn req(
} }
} }
Ok(Json(message)) Ok(Json(message.into()))
} }

View File

@@ -12,14 +12,13 @@ use rocket::{serde::json::Json, State};
/// Retrieves a message by its id. /// Retrieves a message by its id.
#[openapi(tag = "Messaging")] #[openapi(tag = "Messaging")]
#[get("/<target>/messages/<msg>")] #[get("/<target>/messages/<msg>")]
pub async fn req( pub async fn fetch(
db: &State<Database>, db: &State<Database>,
user: User, user: User,
target: Reference, target: Reference,
msg: Reference, msg: Reference,
) -> Result<Json<v0::Message>> { ) -> Result<Json<v0::Message>> {
let channel = target.as_channel(db).await?; let channel = target.as_channel(db).await?;
let mut query = DatabasePermissionQuery::new(db, &user).channel(&channel); let mut query = DatabasePermissionQuery::new(db, &user).channel(&channel);
calculate_channel_permissions(&mut query) calculate_channel_permissions(&mut query)
.await .await

View File

@@ -37,20 +37,20 @@ pub fn routes() -> (Vec<Route>, OpenApi) {
message_send::message_send, message_send::message_send,
message_query::req, message_query::req,
message_search::req, message_search::req,
message_fetch::req, message_fetch::fetch,
message_edit::req, message_edit::edit,
message_bulk_delete::bulk_delete_messages, message_bulk_delete::bulk_delete_messages,
message_delete::delete, message_delete::delete,
group_create::create_group, group_create::create_group,
group_add_member::add_member, group_add_member::add_member,
group_remove_member::remove_member, group_remove_member::remove_member,
voice_join::req, voice_join::call,
permissions_set::req, permissions_set::req,
permissions_set_default::req, permissions_set_default::req,
message_react::react_message, message_react::react_message,
message_unreact::unreact_message, message_unreact::unreact_message,
message_clear_reactions::clear_reactions, message_clear_reactions::clear_reactions,
webhook_create::req, webhook_create::create_webhook,
webhook_fetch_all::req, webhook_fetch_all::fetch_webhooks,
] ]
} }

View File

@@ -1,40 +1,37 @@
use revolt_quark::{ use revolt_config::config;
models::{Channel, User}, use revolt_database::{
perms, util::{permissions::DatabasePermissionQuery, reference::Reference},
variables::delta::{USE_VOSO, VOSO_MANAGE_TOKEN, VOSO_URL}, Channel, Database, User,
Db, Error, Permission, Ref, Result,
}; };
use revolt_models::v0;
use rocket::serde::json::Json; use revolt_permissions::{calculate_channel_permissions, ChannelPermission};
use serde::{Deserialize, Serialize}; use revolt_result::{create_error, Result};
use rocket::{serde::json::Json, State};
/// # Voice Server Token Response
#[derive(Serialize, Deserialize, JsonSchema)]
pub struct CreateVoiceUserResponse {
/// Token for authenticating with the voice server
token: String,
}
/// # Join Call /// # Join Call
/// ///
/// Asks the voice server for a token to join the call. /// Asks the voice server for a token to join the call.
#[openapi(tag = "Voice")] #[openapi(tag = "Voice")]
#[post("/<target>/join_call")] #[post("/<target>/join_call")]
pub async fn req(db: &Db, user: User, target: Ref) -> Result<Json<CreateVoiceUserResponse>> { pub async fn call(
db: &State<Database>,
user: User,
target: Reference,
) -> Result<Json<v0::LegacyCreateVoiceUserResponse>> {
let channel = target.as_channel(db).await?; let channel = target.as_channel(db).await?;
let mut permissions = perms(&user).channel(&channel); let mut query = DatabasePermissionQuery::new(db, &user).channel(&channel);
calculate_channel_permissions(&mut query)
.await
.throw_if_lacking_channel_permission(ChannelPermission::Connect)?;
permissions let config = config().await;
.throw_permission_and_view_channel(db, Permission::Connect) if config.api.security.voso_legacy_token.is_empty() {
.await?; return Err(create_error!(VosoUnavailable));
if !*USE_VOSO {
return Err(Error::VosoUnavailable);
} }
match channel { match channel {
Channel::SavedMessages { .. } | Channel::TextChannel { .. } => { Channel::SavedMessages { .. } | Channel::TextChannel { .. } => {
return Err(Error::CannotJoinCall) return Err(create_error!(CannotJoinCall))
} }
_ => {} _ => {}
} }
@@ -44,33 +41,41 @@ pub async fn req(db: &Db, user: User, target: Ref) -> Result<Json<CreateVoiceUse
// - If not, create it. // - If not, create it.
let client = reqwest::Client::new(); let client = reqwest::Client::new();
let result = client let result = client
.get(&format!("{}/room/{}", *VOSO_URL, channel.id())) .get(&format!(
"{}/room/{}",
config.hosts.voso_legacy,
channel.id()
))
.header( .header(
reqwest::header::AUTHORIZATION, reqwest::header::AUTHORIZATION,
VOSO_MANAGE_TOKEN.to_string(), config.api.security.voso_legacy_token.clone(),
) )
.send() .send()
.await; .await;
match result { match result {
Err(_) => return Err(Error::VosoUnavailable), Err(_) => return Err(create_error!(VosoUnavailable)),
Ok(result) => match result.status() { Ok(result) => match result.status() {
reqwest::StatusCode::OK => (), reqwest::StatusCode::OK => (),
reqwest::StatusCode::NOT_FOUND => { reqwest::StatusCode::NOT_FOUND => {
if (client if (client
.post(&format!("{}/room/{}", *VOSO_URL, channel.id())) .post(&format!(
"{}/room/{}",
config.hosts.voso_legacy,
channel.id()
))
.header( .header(
reqwest::header::AUTHORIZATION, reqwest::header::AUTHORIZATION,
VOSO_MANAGE_TOKEN.to_string(), config.api.security.voso_legacy_token.clone(),
) )
.send() .send()
.await) .await)
.is_err() .is_err()
{ {
return Err(Error::VosoUnavailable); return Err(create_error!(VosoUnavailable));
} }
} }
_ => return Err(Error::VosoUnavailable), _ => return Err(create_error!(VosoUnavailable)),
}, },
} }
@@ -78,13 +83,13 @@ pub async fn req(db: &Db, user: User, target: Ref) -> Result<Json<CreateVoiceUse
if let Ok(response) = client if let Ok(response) = client
.post(&format!( .post(&format!(
"{}/room/{}/user/{}", "{}/room/{}/user/{}",
*VOSO_URL, config.hosts.voso_legacy,
channel.id(), channel.id(),
user.id user.id
)) ))
.header( .header(
reqwest::header::AUTHORIZATION, reqwest::header::AUTHORIZATION,
VOSO_MANAGE_TOKEN.to_string(), config.api.security.voso_legacy_token,
) )
.send() .send()
.await .await
@@ -92,9 +97,9 @@ pub async fn req(db: &Db, user: User, target: Ref) -> Result<Json<CreateVoiceUse
response response
.json() .json()
.await .await
.map_err(|_| Error::InvalidOperation) .map_err(|_| create_error!(InvalidOperation))
.map(Json) .map(Json)
} else { } else {
Err(Error::VosoUnavailable) Err(create_error!(VosoUnavailable))
} }
} }

View File

@@ -16,7 +16,7 @@ use validator::Validate;
/// Creates a webhook which 3rd party platforms can use to send messages /// Creates a webhook which 3rd party platforms can use to send messages
#[openapi(tag = "Webhooks")] #[openapi(tag = "Webhooks")]
#[post("/<target>/webhooks", data = "<data>")] #[post("/<target>/webhooks", data = "<data>")]
pub async fn req( pub async fn create_webhook(
db: &State<Database>, db: &State<Database>,
user: User, user: User,
target: Reference, target: Reference,

View File

@@ -12,7 +12,7 @@ use rocket::{serde::json::Json, State};
/// Gets all webhooks inside the channel /// Gets all webhooks inside the channel
#[openapi(tag = "Webhooks")] #[openapi(tag = "Webhooks")]
#[get("/<channel_id>/webhooks")] #[get("/<channel_id>/webhooks")]
pub async fn req( pub async fn fetch_webhooks(
db: &State<Database>, db: &State<Database>,
user: User, user: User,
channel_id: Reference, channel_id: Reference,