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 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
use gtk::{
glib,
glib::{clone, closure_local},
prelude::*,
subclass::prelude::*,
};
use matrix_sdk::{ComposerDraft, ComposerDraftType};
use matrix_sdk_ui::timeline::{Message, RepliedToInfo};
use ruma::{
events::room::message::{MessageFormat, MessageType},
OwnedEventId, RoomOrAliasId, UserId,
};
use sourceview::prelude::*;
use tracing::{error, warn};
use super::{MessageBufferChunk, MessageBufferParser};
use crate::{
components::{AtRoom, Pill, PillSource},
prelude::*,
session::model::{EventKey, Member, Room},
spawn, spawn_tokio,
utils::matrix::{find_at_room, find_html_mentions, AT_ROOM},
};
// The duration in seconds we wait for before saving a change.
const SAVING_TIMEOUT: u32 = 3;
/// The start tag to represent a mention in a serialized draft.
const MENTION_START_TAG: &str = "<org.gnome.fractal.mention>";
/// The end tag to represent a mention in a serialized draft.
const MENTION_END_TAG: &str = "</org.gnome.fractal.mention>";
mod imp {
use std::{cell::RefCell, marker::PhantomData};
use futures_util::lock::Mutex;
use glib::subclass::Signal;
use once_cell::sync::Lazy;
use super::*;
#[derive(Debug, Default, glib::Properties)]
#[properties(wrapper_type = super::ComposerState)]
pub struct ComposerState {
/// The room associated with this state.
#[property(get, construct_only, nullable)]
pub room: glib::WeakRef<Room>,
/// The buffer of this state.
#[property(get)]
pub buffer: sourceview::Buffer,
/// The relation of this state.
pub related_to: RefCell<Option<RelationInfo>>,
/// Whether this state has a relation.
#[property(get = Self::has_relation)]
pub has_relation: PhantomData<bool>,
/// The widgets of this state.
///
/// These are the widgets inserted in the composer.
pub widgets: RefCell<Vec<(gtk::Widget, gtk::TextChildAnchor)>>,
/// The current view attached to this state.
pub view: glib::WeakRef<sourceview::View>,
/// The draft that was saved in the store.
pub saved_draft: RefCell<Option<ComposerDraft>>,
/// The signal handler for the current draft saving timeout.
draft_timeout: RefCell<Option<glib::SourceId>>,
/// The lock to prevent multiple draft saving operations at the same
/// time.
draft_lock: Mutex<()>,
}
#[glib::object_subclass]
impl ObjectSubclass for ComposerState {
const NAME: &'static str = "ContentComposerState";
type Type = super::ComposerState;
}
#[glib::derived_properties]
impl ObjectImpl for ComposerState {
fn signals() -> &'static [Signal] {
static SIGNALS: Lazy<Vec<Signal>> =
Lazy::new(|| vec![Signal::builder("related-to-changed").build()]);
SIGNALS.as_ref()
}
fn constructed(&self) {
self.parent_constructed();
crate::utils::sourceview::setup_style_scheme(&self.buffer);
// Markdown highlighting.
let md_lang = sourceview::LanguageManager::default().language("markdown");
self.buffer.set_language(md_lang.as_ref());
self.buffer.connect_changed(clone!(
#[weak(rename_to = imp)]
self,
move |_| {
imp.update_widgets();
imp.trigger_draft_saving();
}
));
}
}
impl ComposerState {
/// Whether this state has a relation.
fn has_relation(&self) -> bool {
self.related_to.borrow().is_some()
}
/// Update the list of widgets present in the composer.
pub(super) fn update_widgets(&self) {
self.widgets
.borrow_mut()
.retain(|(_w, anchor)| !anchor.is_deleted());
}
/// Get the draft for the current state.
///
/// Returns `None` if the draft would be empty.
fn draft(&self) -> Option<ComposerDraft> {
let obj = self.obj();
let draft_type = self
.related_to
.borrow()
.as_ref()
.map(|r| r.as_draft_type())
.unwrap_or(ComposerDraftType::NewMessage);
let (start, end) = self.buffer.bounds();
let body_len = end.offset() as usize;
let mut plain_text = String::with_capacity(body_len);
let split_message = MessageBufferParser::new(&obj, start, end);
for chunk in split_message {
match chunk {
MessageBufferChunk::Text(text) => {
plain_text.push_str(&text);
}
MessageBufferChunk::Mention(source) => {
plain_text.push_str(MENTION_START_TAG);
if let Some(user) = source.downcast_ref::<Member>() {
plain_text.push_str(user.user_id().as_ref());
} else if let Some(room) = source.downcast_ref::<Room>() {
plain_text.push_str(
room.aliases()
.alias()
.as_ref()
.map(AsRef::as_ref)
.unwrap_or_else(|| room.room_id().as_ref()),
);
} else if source.is::<AtRoom>() {
plain_text.push_str(AT_ROOM);
} else {
unreachable!()
};
plain_text.push_str(MENTION_END_TAG);
}
}
}
if draft_type == ComposerDraftType::NewMessage && plain_text.trim().is_empty() {
None
} else {
Some(ComposerDraft {
plain_text,
html_text: None,
draft_type,
})
}
}
/// Trigger the timeout for saving the current draft.
pub(super) fn trigger_draft_saving(&self) {
if self.draft_timeout.borrow().is_some() {
return;
}
let draft = self.draft();
if *self.saved_draft.borrow() == draft {
return;
}
let timeout = glib::timeout_add_seconds_local_once(
SAVING_TIMEOUT,
clone!(
#[weak(rename_to = imp)]
self,
move || {
imp.draft_timeout.take();
let obj = imp.obj().clone();
spawn!(glib::Priority::DEFAULT_IDLE, async move {
obj.imp().save_draft().await;
});
}
),
);
self.draft_timeout.replace(Some(timeout));
}
/// Save the current draft.
async fn save_draft(&self) {
let Some(room) = self.room.upgrade() else {
return;
};
let Some(_lock) = self.draft_lock.try_lock() else {
// The previous saving operation is still ongoing, try saving again later.
self.trigger_draft_saving();
return;
};
let draft = self.draft();
if *self.saved_draft.borrow() == draft {
// Nothing to do.
return;
}
let matrix_room = room.matrix_room().clone();
let draft_clone = draft.clone();
let handle = spawn_tokio!(async move {
if let Some(draft) = draft_clone {
matrix_room.save_composer_draft(draft).await
} else {
matrix_room.clear_composer_draft().await
}
});
match handle.await.unwrap() {
Ok(()) => {
self.saved_draft.replace(draft);
}
Err(error) => {
error!("Could not save composer draft: {error}");
}
}
}
/// Add the given widget at the position of the given iter to this
/// state.
pub(super) fn add_widget(&self, widget: impl IsA<gtk::Widget>, iter: &mut gtk::TextIter) {
let widget = widget.upcast();
let anchor = match iter.child_anchor() {
Some(anchor) => anchor,
None => self.buffer.create_child_anchor(iter),
};
if let Some(view) = self.view.upgrade() {
view.add_child_at_anchor(&widget, &anchor);
}
self.widgets.borrow_mut().push((widget, anchor));
}
/// Restore the state from the persisted draft.
pub(super) async fn restore_draft(&self) {
let Some(room) = self.room.upgrade() else {
return;
};
let matrix_room = room.matrix_room().clone();
let handle = spawn_tokio!(async move { matrix_room.load_composer_draft().await });
match handle.await.unwrap() {
Ok(Some(draft)) => self.restore_from_draft(draft).await,
Ok(None) => {}
Err(error) => {
error!("Could not restore draft: {error}");
}
}
}
/// Restore the state from the given draft.
async fn restore_from_draft(&self, draft: ComposerDraft) {
let Some(room) = self.room.upgrade() else {
return;
};
// Restore the relation.
self.restore_related_to_from_draft(draft.draft_type.clone())
.await;
// Make sure we start from an empty state.
self.buffer.set_text("");
self.widgets.borrow_mut().clear();
// Fill the buffer while inserting mentions.
let text = &draft.plain_text;
let mut end_iter = self.buffer.end_iter();
let mut pos = 0;
while let Some(rel_start) = text[pos..].find(MENTION_START_TAG) {
let start = pos + rel_start;
let content_start = start + MENTION_START_TAG.len();
let Some(rel_content_end) = text[content_start..].find(MENTION_END_TAG) else {
// Abort parsing.
error!("Could not find end tag for mention in serialized draft");
break;
};
let content_end = content_start + rel_content_end;
if start != pos {
self.buffer.insert(&mut end_iter, &text[pos..start]);
}
match DraftMention::new(&room, &text[content_start..content_end]) {
DraftMention::Source(source) => {
self.add_widget(source.to_pill(), &mut end_iter);
}
DraftMention::Text(s) => {
self.buffer.insert(&mut end_iter, s);
}
}
pos = content_end + MENTION_END_TAG.len();
}
if pos != text.len() {
self.buffer.insert(&mut end_iter, &text[pos..]);
}
self.saved_draft.replace(Some(draft));
}
/// Restore the relation from the given draft content.
async fn restore_related_to_from_draft(&self, draft_type: ComposerDraftType) {
let Some(room) = self.room.upgrade() else {
return;
};
let related_to = match draft_type {
ComposerDraftType::NewMessage => None,
ComposerDraftType::Reply { event_id } => {
let matrix_timeline = room.timeline().matrix_timeline();
let handle = spawn_tokio!(async move {
matrix_timeline
.replied_to_info_from_event_id(&event_id)
.await
});
match handle.await.unwrap() {
Ok(info) => Some(RelationInfo::Reply(info)),
Err(error) => {
warn!("Could not fetch replied-to event content of draft: {error}");
None
}
}
}
ComposerDraftType::Edit { event_id } => Some(RelationInfo::Edit(event_id)),
};
self.related_to.replace(related_to);
let obj = self.obj();
obj.emit_by_name::<()>("related-to-changed", &[]);
obj.notify_has_relation();
}
}
}
glib::wrapper! {
/// The composer state for a room.
///
/// This allows to save and restore the composer state between room changes.
/// It keeps track of the related event and restores the state of the composer's `GtkSourceView`.
pub struct ComposerState(ObjectSubclass<imp::ComposerState>);
}
impl ComposerState {
/// Create a new empty `ComposerState` for the given room.
pub fn new(room: Option<&Room>) -> Self {
let obj = glib::Object::builder::<Self>()
.property("room", room)
.build();
let imp = obj.imp();
spawn!(clone!(
#[weak]
imp,
async move {
imp.restore_draft().await;
}
));
obj
}
/// Attach this state to the given view.
pub fn attach_to_view(&self, view: Option<&sourceview::View>) {
let imp = self.imp();
imp.view.set(view);
if let Some(view) = view {
view.set_buffer(Some(&imp.buffer));
imp.update_widgets();
for (widget, anchor) in &*imp.widgets.borrow() {
view.add_child_at_anchor(widget, anchor);
}
}
}
/// Clear this state.
pub fn clear(&self) {
self.set_related_to(None);
let imp = self.imp();
imp.buffer.set_text("");
imp.widgets.borrow_mut().clear();
}
/// The relation to send with the current message.
pub fn related_to(&self) -> Option<RelationInfo> {
self.imp().related_to.borrow().clone()
}
/// Set the relation to send with the current message.
pub fn set_related_to(&self, related_to: Option<RelationInfo>) {
let imp = self.imp();
let had_relation = self.has_relation();
if imp
.related_to
.borrow()
.as_ref()
.is_some_and(|r| matches!(r, RelationInfo::Edit(_)))
{
// The user aborted the edit or the edit is done, clean up the entry.
imp.buffer.set_text("");
}
imp.related_to.replace(related_to);
if self.has_relation() != had_relation {
self.notify_has_relation();
}
self.emit_by_name::<()>("related-to-changed", &[]);
self.imp().trigger_draft_saving();
}
/// Update the buffer for the given edit source.
pub fn set_edit_source(&self, event_id: OwnedEventId, message: &Message) {
let Some(room) = self.room() else {
return;
};
// We don't support editing non-text messages.
let (text, formatted) = match message.msgtype() {
MessageType::Emote(emote) => (format!("/me {}", emote.body), emote.formatted.clone()),
MessageType::Text(text) => (text.body.clone(), text.formatted.clone()),
_ => return,
};
self.set_related_to(Some(RelationInfo::Edit(event_id)));
// Try to detect rich mentions.
let mut mentions = if let Some(html) =
formatted.and_then(|f| (f.format == MessageFormat::Html).then_some(f.body))
{
let mentions = find_html_mentions(&html, &room);
let mut pos = 0;
// This is looking for the mention link's inner text in the Markdown
// so it is not super reliable: if there is other text that matches
// a user's display name in the string it might be replaced instead
// of the actual mention.
// Short of an HTML to Markdown converter, it won't be a simple task
// to locate mentions in Markdown.
mentions
.into_iter()
.filter_map(|(pill, s)| {
text[pos..].find(s.as_ref()).map(|index| {
let start = pos + index;
let end = start + s.len();
pos = end;
DetectedMention { pill, start, end }
})
})
.collect::<Vec<_>>()
} else {
Vec::new()
};
// Try to detect `@room` mentions.
let can_contain_at_room = message.mentions().map(|m| m.room).unwrap_or(true);
if room.permissions().can_notify_room() && can_contain_at_room {
if let Some(start) = find_at_room(&text) {
let pill = room.at_room().to_pill();
let end = start + AT_ROOM.len();
mentions.push(DetectedMention { pill, start, end });
// Make sure the list is sorted.
mentions.sort_by(|lhs, rhs| lhs.start.cmp(&rhs.start));
}
}
let buffer = self.buffer();
if mentions.is_empty() {
buffer.set_text(&text);
} else {
// Place the pills instead of the text at the appropriate places in
// the GtkSourceView.
buffer.set_text("");
let mut pos = 0;
let mut iter = buffer.iter_at_offset(0);
for DetectedMention { pill, start, end } in mentions {
if pos != start {
buffer.insert(&mut iter, &text[pos..start]);
}
self.add_widget(pill, &mut iter);
pos = end;
}
if pos != text.len() {
buffer.insert(&mut iter, &text[pos..])
}
}
self.imp().trigger_draft_saving();
}
/// Add the given widget at the position of the given iter to this state.
pub fn add_widget(&self, widget: impl IsA<gtk::Widget>, iter: &mut gtk::TextIter) {
self.imp().add_widget(widget, iter);
}
/// Get the widget at the given anchor, if any.
pub fn widget_at_anchor(&self, anchor: >k::TextChildAnchor) -> Option<gtk::Widget> {
self.imp()
.widgets
.borrow()
.iter()
.find(|(_, a)| a == anchor)
.map(|(w, _)| w.clone())
}
/// Connect to the signal emitted when the relation changed.
pub fn connect_related_to_changed<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> glib::SignalHandlerId {
self.connect_closure(
"related-to-changed",
true,
closure_local!(move |obj: Self| {
f(&obj);
}),
)
}
}
/// The possible relations to send with a message.
#[derive(Debug, Clone)]
pub enum RelationInfo {
/// Send a reply with the given replied to info.
Reply(RepliedToInfo),
/// Send an edit to the event with the given ID.
Edit(OwnedEventId),
}
impl RelationInfo {
/// The unique key of the related event.
pub fn key(&self) -> EventKey {
match self {
RelationInfo::Reply(info) => EventKey::EventId(info.event_id().to_owned()),
RelationInfo::Edit(event_id) => EventKey::EventId(event_id.clone()),
}
}
/// Get this `RelationInfo` as a draft type.
pub fn as_draft_type(&self) -> ComposerDraftType {
match self {
Self::Reply(info) => ComposerDraftType::Reply {
event_id: info.event_id().to_owned(),
},
Self::Edit(event_id) => ComposerDraftType::Edit {
event_id: event_id.clone(),
},
}
}
}
/// A mention that was serialized in a draft.
///
/// If we managed to restore the mention, this is a `PillSource`, otherwise it's
/// the text of the mention.
enum DraftMention<'a> {
/// The source of the mention.
Source(PillSource),
/// The text of the mention.
Text(&'a str),
}
impl<'a> DraftMention<'a> {
/// Construct a `MentionContent` from the given string in the given room.
fn new(room: &Room, s: &'a str) -> Self {
if s == AT_ROOM {
Self::Source(room.at_room().upcast())
} else if s.starts_with('@') {
// This is a user mention.
match UserId::parse(s) {
Ok(user_id) => {
let member = Member::new(room, user_id);
member.update();
Self::Source(member.upcast())
}
Err(error) => {
error!("Could not parse user ID `{s}` from serialized mention: {error}");
Self::Text(s)
}
}
} else {
// It should be a room mention.
let Some(session) = room.session() else {
return Self::Text(s);
};
let room_list = session.room_list();
match RoomOrAliasId::parse(s) {
Ok(identifier) => match room_list.get_by_identifier(&identifier) {
Some(room) => Self::Source(room.upcast()),
None => {
warn!("Could not find room `{s}` from serialized mention");
Self::Text(s)
}
},
Err(error) => {
error!(
"Could not parse room identifier `{s}` from serialized mention: {error}"
);
Self::Text(s)
}
}
}
}
}
/// A mention that was detected in a message.
struct DetectedMention {
/// The pill to represent the mention.
pill: Pill,
/// The start of the mention in the text.
start: usize,
/// The end of the mention in the text.
end: usize,
}