macltok

public

Star0

Watch0

92 commits 3 branches 0 tags 0 releases3.0 MiB

use std::{
    collections::{HashMap, VecDeque},
    sync::Arc,
};

use futures_util::future::{join_all, try_join};
use matrix_sdk::{
    Client, Room, RoomState, deserialized_responses::TimelineEvent as SdkTimelineEvent,
    room::MessagesOptions,
};
use ruma::{OwnedEventId, OwnedRoomId, OwnedUserId, UInt, push::Action};
use serde_json::Value;
use tokio::sync::{Mutex, broadcast::error::RecvError};

use crate::{
    Error, ErrorKind, Event, EventContext, EventContextCloseReason, EventContextCommand,
    EventContextPage, EventContextSession, Sender, TimelineEvent, TimelineItem,
    engine::MediaService,
    normalise::{
        MediaRegistration, MediaScope, apply_profiles, member_sender, normalise_context,
        normalise_observed, resolve_replies,
    },
    transport::EventSender,
};

const MAX_CONTEXT_LIMIT: u16 = 50;
/// a consumer that never closes its jump views still holds at most this many
const MAX_SESSIONS: usize = 32;

/// open event contexts, oldest first, each owning the media its pages registered
pub(crate) struct Sessions {
    open: Mutex<VecDeque<Session>>,
    events: EventSender,
}

struct Session {
    id: String,
    room_id: OwnedRoomId,
    scope: MediaScope,
}

impl Session {
    /// media ids carry the session, so two owners of one event never share an entry
    fn media_prefix(scope: &MediaScope) -> String {
        format!("{}#", scope.nonce())
    }
}

impl Sessions {
    pub(crate) fn new(events: EventSender) -> Self {
        Self {
            open: Mutex::default(),
            events,
        }
    }

    async fn open(
        &self,
        media: &MediaService,
        room_id: OwnedRoomId,
        scope: MediaScope,
        registrations: Vec<MediaRegistration>,
    ) -> String {
        let id = format!("context-{}", scope.nonce());
        let mut evicted = Vec::new();
        {
            let mut open = self.open.lock().await;
            media.register(&scope, registrations).await;
            open.push_back(Session {
                id: id.clone(),
                room_id,
                scope,
            });
            while open.len() > MAX_SESSIONS {
                if let Some(oldest) = open.pop_front() {
                    media.release(&oldest.scope).await;
                    evicted.push(oldest.id);
                }
            }
        }
        self.announce(evicted, EventContextCloseReason::Evicted)
            .await;
        id
    }

    /// the room and the media prefix the session's pages use
    async fn find(&self, id: &str) -> Result<(OwnedRoomId, String), Error> {
        let open = self.open.lock().await;
        let session = open
            .iter()
            .find(|session| session.id == id)
            .ok_or_else(not_open)?;
        Ok((
            session.room_id.clone(),
            Session::media_prefix(&session.scope),
        ))
    }

    /// under the lock, so a page that lands after its close registers nothing
    async fn register(
        &self,
        media: &MediaService,
        id: &str,
        registrations: Vec<MediaRegistration>,
    ) -> Result<(), Error> {
        let open = self.open.lock().await;
        let session = open
            .iter()
            .find(|session| session.id == id)
            .ok_or_else(not_open)?;
        media.register(&session.scope, registrations).await;
        Ok(())
    }

    async fn close(&self, media: &MediaService, id: &str) -> Result<(), Error> {
        let mut open = self.open.lock().await;
        let index = open
            .iter()
            .position(|session| session.id == id)
            .ok_or_else(not_open)?;
        if let Some(session) = open.remove(index) {
            media.release(&session.scope).await;
        }
        Ok(())
    }

    async fn close_left(&self, media: &MediaService, client: &Client) {
        let mut closed = Vec::new();
        {
            let mut open = self.open.lock().await;
            let mut kept = VecDeque::with_capacity(open.len());
            for session in open.drain(..) {
                let left = client
                    .get_room(&session.room_id)
                    .is_none_or(|room| matches!(room.state(), RoomState::Left | RoomState::Banned));
                if left {
                    media.release(&session.scope).await;
                    closed.push(session.id);
                } else {
                    kept.push_back(session);
                }
            }
            *open = kept;
        }
        self.announce(closed, EventContextCloseReason::RoomLeft)
            .await;
    }

    async fn announce(&self, ids: Vec<String>, reason: EventContextCloseReason) {
        for context_id in ids {
            let event = Event::EventContextClosed {
                context_id,
                reason: reason.clone(),
            };
            if self.events.send(event).await.is_err() {
                return;
            }
        }
    }

    /// the media service is cleared beside this, so nothing is released one by one
    pub(crate) async fn clear(&self) {
        self.open.lock().await.clear();
    }
}

fn not_open() -> Error {
    Error::new(
        ErrorKind::EventContextNotOpen,
        "event context is closed or was never opened",
    )
}

/// leaving a room closes its event contexts
pub(super) async fn close_on_leave(
    client: Client,
    media: Arc<MediaService>,
    sessions: Arc<Sessions>,
) {
    let mut info = client.room_info_notable_update_receiver();
    loop {
        match info.recv().await {
            Ok(_) | Err(RecvError::Lagged(_)) => sessions.close_left(&media, &client).await,
            Err(RecvError::Closed) => return,
        }
    }
}

pub(crate) async fn execute(
    client: Client,
    media: Arc<MediaService>,
    sessions: Arc<Sessions>,
    command: EventContextCommand,
) -> Result<crate::CommandOutput, Error> {
    let current_user_id = client.user_id().map(ToOwned::to_owned);
    let room = |room_id: &OwnedRoomId| client.get_room(room_id).ok_or_else(Error::room_unknown);
    let (context_id, token, limit, backwards) = match command {
        EventContextCommand::Fetch {
            room_id,
            event_id,
            before_limit,
            after_limit,
        } => {
            let scope = media.context_scope();
            let (context, registrations, _) = capture_in(
                room(&room_id)?,
                current_user_id,
                event_id,
                before_limit,
                after_limit,
                &Session::media_prefix(&scope),
            )
            .await?;
            let context_id = sessions.open(&media, room_id, scope, registrations).await;
            return Ok(crate::CommandOutput::EventContext(EventContextSession {
                context_id,
                context,
            }));
        }
        EventContextCommand::Close { context_id } => {
            sessions.close(&media, &context_id).await?;
            return Ok(crate::CommandOutput::Done);
        }
        EventContextCommand::Before {
            context_id,
            token,
            limit,
        } => (context_id, token, limit, true),
        EventContextCommand::After {
            context_id,
            token,
            limit,
        } => (context_id, token, limit, false),
    };
    if limit == 0 {
        return Err(Error::new(
            ErrorKind::Invalid,
            "context page limit must be at least 1",
        ));
    }
    validate_limit(limit)?;
    if token.is_empty() {
        return Err(Error::new(
            ErrorKind::Invalid,
            "context pagination token is empty",
        ));
    }
    let (room_id, media_prefix) = sessions.find(&context_id).await?;
    let room = room(&room_id)?;
    let side = fetch_side(&room, Some(&token), limit, backwards).await?;
    let mut page = Assembly::new(
        &room,
        current_user_id.as_deref(),
        &side.values,
        &side.highlights,
        None,
        &media_prefix,
    )
    .await;
    let events = page.take(0..side.values.len());
    sessions.register(&media, &context_id, page.media).await?;
    Ok(crate::CommandOutput::EventContextPage(EventContextPage {
        events,
        next_token: side.token,
    }))
}

pub(crate) async fn capture(
    room: Room,
    current_user_id: Option<OwnedUserId>,
    event_id: OwnedEventId,
    before_limit: u16,
    after_limit: u16,
) -> Result<(EventContext, Vec<MediaRegistration>, Vec<Value>), Error> {
    capture_in(
        room,
        current_user_id,
        event_id,
        before_limit,
        after_limit,
        "",
    )
    .await
}

async fn capture_in(
    room: Room,
    current_user_id: Option<OwnedUserId>,
    event_id: OwnedEventId,
    before_limit: u16,
    after_limit: u16,
    media_prefix: &str,
) -> Result<(EventContext, Vec<MediaRegistration>, Vec<Value>), Error> {
    validate_limit(before_limit)?;
    validate_limit(after_limit)?;
    let raw = room
        .event_with_context(&event_id, false, UInt::from(0_u16), None)
        .await
        .map_err(|source| {
            let error = Error::from_sdk("fetching event context failed", source);
            if error
                .server
                .as_ref()
                .is_some_and(|server| server.status == 404)
            {
                Error::new(ErrorKind::EventNotFound, "event was not found")
            } else {
                error
            }
        })?;
    let (target, target_highlight) = raw
        .event
        .as_ref()
        .and_then(raw_event)
        .ok_or_else(|| Error::new(ErrorKind::EventNotFound, "event was not found"))?;
    let (before, after) = try_join(
        fetch_side(&room, raw.prev_batch_token.as_deref(), before_limit, true),
        fetch_side(&room, raw.next_batch_token.as_deref(), after_limit, false),
    )
    .await?;
    let target_index = before.values.len();
    let mut values = before.values;
    values.push(target);
    values.extend(after.values);
    let mut highlights = before.highlights;
    highlights.push(target_highlight);
    highlights.extend(after.highlights);
    let mut page = Assembly::new(
        &room,
        current_user_id.as_deref(),
        &values,
        &highlights,
        Some(target_index),
        media_prefix,
    )
    .await;
    let events_before = page.take(0..target_index);
    let event = page
        .take(target_index..target_index + 1)
        .pop()
        .ok_or_else(|| Error::new(ErrorKind::EventNotFound, "event could not be read"))?;
    let events_after = page.take(target_index + 1..values.len());
    Ok((
        EventContext {
            events_before,
            event,
            events_after,
            start_token: before.token,
            end_token: after.token,
        },
        page.media,
        values,
    ))
}

struct Side {
    /// in timeline order
    values: Vec<Value>,
    /// beside `values`, from the push actions the sdk worked out as it fetched
    highlights: Vec<bool>,
    token: Option<String>,
}

fn raw_event(event: &SdkTimelineEvent) -> Option<(Value, bool)> {
    let value = serde_json::from_str(event.raw().json().get()).ok()?;
    let highlight = event
        .push_actions()
        .is_some_and(|actions| actions.iter().any(Action::is_highlight));
    Some((value, highlight))
}

async fn fetch_side(
    room: &Room,
    token: Option<&str>,
    limit: u16,
    backwards: bool,
) -> Result<Side, Error> {
    let Some(token) = token else {
        return Ok(Side {
            values: Vec::new(),
            highlights: Vec::new(),
            token: None,
        });
    };
    if limit == 0 {
        return Ok(Side {
            values: Vec::new(),
            highlights: Vec::new(),
            token: Some(token.to_owned()),
        });
    }
    let mut options = if backwards {
        MessagesOptions::backward()
    } else {
        MessagesOptions::forward()
    };
    options = options.from(token);
    options.limit = UInt::from(limit);
    let messages = room
        .messages(options)
        .await
        .map_err(|source| Error::from_sdk("fetching event context events failed", source))?;
    let mut events: Vec<_> = messages.chunk.iter().filter_map(raw_event).collect();
    if backwards {
        events.reverse();
    }
    let (values, highlights) = events.into_iter().unzip();
    Ok(Side {
        values,
        highlights,
        token: messages.end,
    })
}

/// a search hit as event context would show it, `values` its original and then its latest edit
pub(crate) async fn preview(
    room: &Room,
    current_user_id: Option<&ruma::UserId>,
    values: &[Value],
    highlight: bool,
) -> Option<(TimelineEvent, Vec<MediaRegistration>)> {
    let mut page = Assembly::new(
        room,
        current_user_id,
        values,
        &vec![highlight; values.len()],
        Some(0),
    )
    .await;
    match page.take(0..1).pop()? {
        TimelineItem::Event(event) => Some((*event, page.media)),
        _ => None,
    }
}

/// a window of raw events normalised together, so relations inside it land on their targets
struct Assembly {
    items: Vec<(usize, TimelineItem)>,
    media: Vec<MediaRegistration>,
}

impl Assembly {
    async fn new(
        room: &Room,
        current_user_id: Option<&ruma::UserId>,
        values: &[Value],
        highlights: &[bool],
        keep: Option<usize>,
        media_prefix: &str,
    ) -> Self {
        let page = normalise_context(values, keep, current_user_id, room.room_id(), media_prefix);
        let mut items = page.items;
        for (index, item) in &mut items {
            if let TimelineItem::Event(event) = item {
                event.highlight = highlights[*index];
            }
        }
        let mut media = page.media;
        let mut targets: HashMap<OwnedEventId, TimelineEvent> = HashMap::new();
        let mut missing = Vec::new();
        for (_, item) in &items {
            if let TimelineItem::Event(event) = item
                && let Some(event_id) = &event.event_id
            {
                targets.insert(event_id.clone(), (**event).clone());
            }
        }
        for event in events(&mut items) {
            if let Some(reply) = &event.reply_to
                && !targets.contains_key(&reply.event_id)
                && !missing.contains(&reply.event_id)
            {
                missing.push(reply.event_id.clone());
            }
        }
        let fetched = join_all(
            missing
                .into_iter()
                .map(|event_id| fetch_reply(room, current_user_id, event_id, media_prefix)),
        )
        .await;
        for (event, registrations) in fetched.into_iter().flatten() {
            media.extend(registrations);
            if let Some(event_id) = event.event_id.clone() {
                targets.insert(event_id, event);
            }
        }
        let profiles = profiles(
            room,
            items
                .iter()
                .filter_map(|(_, item)| match item {
                    TimelineItem::Event(event) => Some(&event.sender.user_id),
                    _ => None,
                })
                .chain(targets.values().map(|event| &event.sender.user_id)),
        )
        .await;
        apply_profiles(targets.values_mut(), &profiles);
        apply_profiles(events(&mut items), &profiles);
        resolve_replies(events(&mut items), &targets);
        Self { items, media }
    }

    /// the items that came from raw events in `range`
    fn take(&mut self, range: std::ops::Range<usize>) -> Vec<TimelineItem> {
        let (taken, kept) = std::mem::take(&mut self.items)
            .into_iter()
            .partition(|(index, _)| range.contains(index));
        self.items = kept;
        taken.into_iter().map(|(_, item)| item).collect()
    }
}

fn events(items: &mut [(usize, TimelineItem)]) -> impl Iterator<Item = &mut TimelineEvent> {
    items.iter_mut().filter_map(|(_, item)| match item {
        TimelineItem::Event(event) => Some(&mut **event),
        _ => None,
    })
}

async fn fetch_reply(
    room: &Room,
    current_user_id: Option<&ruma::UserId>,
    event_id: OwnedEventId,
    media_prefix: &str,
) -> Option<(TimelineEvent, Vec<MediaRegistration>)> {
    let event = room
        .load_or_fetch_event(&event_id, None)
        .await
        .inspect_err(|error| tracing::debug!(%event_id, %error, "fetching a reply target failed"))
        .ok()?;
    let value: Value = serde_json::from_str(event.raw().json().get()).ok()?;
    let identity = format!("{media_prefix}{}\n{event_id}", room.room_id());
    match normalise_observed(&value, current_user_id, &identity)? {
        (TimelineItem::Event(event), media) => Some((*event, media)),
        _ => None,
    }
}

/// under lazy-loaded members a sender may be unknown locally, and `get_member` fetches the
/// member list once for the room when it is
async fn profiles<'a>(
    room: &Room,
    user_ids: impl Iterator<Item = &'a OwnedUserId>,
) -> HashMap<OwnedUserId, Sender> {
    let mut unique: Vec<&OwnedUserId> = user_ids.collect();
    unique.sort();
    unique.dedup();
    join_all(
        unique.into_iter().map(|user_id| async move {
            Some((user_id.clone(), member_sender(room, user_id).await?))
        }),
    )
    .await
    .into_iter()
    .flatten()
    .collect()
}

fn validate_limit(limit: u16) -> Result<(), Error> {
    if limit > MAX_CONTEXT_LIMIT {
        Err(Error::new(ErrorKind::Invalid, "context limit exceeds 50"))
    } else {
        Ok(())
    }
}

1	use std::{
2	collections::{HashMap, VecDeque},
3	sync::Arc,
4	};
5
6	use futures_util::future::{join_all, try_join};
7	use matrix_sdk::{
8	Client, Room, RoomState, deserialized_responses::TimelineEvent as SdkTimelineEvent,
9	room::MessagesOptions,
10	};
11	use ruma::{OwnedEventId, OwnedRoomId, OwnedUserId, UInt, push::Action};
12	use serde_json::Value;
13	use tokio::sync::{Mutex, broadcast::error::RecvError};
14
15	use crate::{
16	Error, ErrorKind, Event, EventContext, EventContextCloseReason, EventContextCommand,
17	EventContextPage, EventContextSession, Sender, TimelineEvent, TimelineItem,
18	engine::MediaService,
19	normalise::{
20	MediaRegistration, MediaScope, apply_profiles, member_sender, normalise_context,
21	normalise_observed, resolve_replies,
22	},
23	transport::EventSender,
24	};
25
26	const MAX_CONTEXT_LIMIT: u16 = 50;
27	/// a consumer that never closes its jump views still holds at most this many
28	const MAX_SESSIONS: usize = 32;
29
30	/// open event contexts, oldest first, each owning the media its pages registered
31	pub(crate) struct Sessions {
32	open: Mutex<VecDeque<Session>>,
33	events: EventSender,
34	}
35
36	struct Session {
37	id: String,
38	room_id: OwnedRoomId,
39	scope: MediaScope,
40	}
41
42	impl Session {
43	/// media ids carry the session, so two owners of one event never share an entry
44	fn media_prefix(scope: &MediaScope) -> String {
45	format!("{}#", scope.nonce())
46	}
47	}
48
49	impl Sessions {
50	pub(crate) fn new(events: EventSender) -> Self {
51	Self {
52	open: Mutex::default(),
53	events,
54	}
55	}
56
57	async fn open(
58	&self,
59	media: &MediaService,
60	room_id: OwnedRoomId,
61	scope: MediaScope,
62	registrations: Vec<MediaRegistration>,
63	) -> String {
64	let id = format!("context-{}", scope.nonce());
65	let mut evicted = Vec::new();
66	{
67	let mut open = self.open.lock().await;
68	media.register(&scope, registrations).await;
69	open.push_back(Session {
70	id: id.clone(),
71	room_id,
72	scope,
73	});
74	while open.len() > MAX_SESSIONS {
75	if let Some(oldest) = open.pop_front() {
76	media.release(&oldest.scope).await;
77	evicted.push(oldest.id);
78	}
79	}
80	}
81	self.announce(evicted, EventContextCloseReason::Evicted)
82	.await;
83	id
84	}
85
86	/// the room and the media prefix the session's pages use
87	async fn find(&self, id: &str) -> Result<(OwnedRoomId, String), Error> {
88	let open = self.open.lock().await;
89	let session = open
90	.iter()
91	.find(\|session\| session.id == id)
92	.ok_or_else(not_open)?;
93	Ok((
94	session.room_id.clone(),
95	Session::media_prefix(&session.scope),
96	))
97	}
98
99	/// under the lock, so a page that lands after its close registers nothing
100	async fn register(
101	&self,
102	media: &MediaService,
103	id: &str,
104	registrations: Vec<MediaRegistration>,
105	) -> Result<(), Error> {
106	let open = self.open.lock().await;
107	let session = open
108	.iter()
109	.find(\|session\| session.id == id)
110	.ok_or_else(not_open)?;
111	media.register(&session.scope, registrations).await;
112	Ok(())
113	}
114
115	async fn close(&self, media: &MediaService, id: &str) -> Result<(), Error> {
116	let mut open = self.open.lock().await;
117	let index = open
118	.iter()
119	.position(\|session\| session.id == id)
120	.ok_or_else(not_open)?;
121	if let Some(session) = open.remove(index) {
122	media.release(&session.scope).await;
123	}
124	Ok(())
125	}
126
127	async fn close_left(&self, media: &MediaService, client: &Client) {
128	let mut closed = Vec::new();
129	{
130	let mut open = self.open.lock().await;
131	let mut kept = VecDeque::with_capacity(open.len());
132	for session in open.drain(..) {
133	let left = client
134	.get_room(&session.room_id)
135	.is_none_or(\|room\| matches!(room.state(), RoomState::Left \| RoomState::Banned));
136	if left {
137	media.release(&session.scope).await;
138	closed.push(session.id);
139	} else {
140	kept.push_back(session);
141	}
142	}
143	*open = kept;
144	}
145	self.announce(closed, EventContextCloseReason::RoomLeft)
146	.await;
147	}
148
149	async fn announce(&self, ids: Vec<String>, reason: EventContextCloseReason) {
150	for context_id in ids {
151	let event = Event::EventContextClosed {
152	context_id,
153	reason: reason.clone(),
154	};
155	if self.events.send(event).await.is_err() {
156	return;
157	}
158	}
159	}
160
161	/// the media service is cleared beside this, so nothing is released one by one
162	pub(crate) async fn clear(&self) {
163	self.open.lock().await.clear();
164	}
165	}
166
167	fn not_open() -> Error {
168	Error::new(
169	ErrorKind::EventContextNotOpen,
170	"event context is closed or was never opened",
171	)
172	}
173
174	/// leaving a room closes its event contexts
175	pub(super) async fn close_on_leave(
176	client: Client,
177	media: Arc<MediaService>,
178	sessions: Arc<Sessions>,
179	) {
180	let mut info = client.room_info_notable_update_receiver();
181	loop {
182	match info.recv().await {
183	Ok(_) \| Err(RecvError::Lagged(_)) => sessions.close_left(&media, &client).await,
184	Err(RecvError::Closed) => return,
185	}
186	}
187	}
188
189	pub(crate) async fn execute(
190	client: Client,
191	media: Arc<MediaService>,
192	sessions: Arc<Sessions>,
193	command: EventContextCommand,
194	) -> Result<crate::CommandOutput, Error> {
195	let current_user_id = client.user_id().map(ToOwned::to_owned);
196	let room = \|room_id: &OwnedRoomId\| client.get_room(room_id).ok_or_else(Error::room_unknown);
197	let (context_id, token, limit, backwards) = match command {
198	EventContextCommand::Fetch {
199	room_id,
200	event_id,
201	before_limit,
202	after_limit,
203	} => {
204	let scope = media.context_scope();
205	let (context, registrations, _) = capture_in(
206	room(&room_id)?,
207	current_user_id,
208	event_id,
209	before_limit,
210	after_limit,
211	&Session::media_prefix(&scope),
212	)
213	.await?;
214	let context_id = sessions.open(&media, room_id, scope, registrations).await;
215	return Ok(crate::CommandOutput::EventContext(EventContextSession {
216	context_id,
217	context,
218	}));
219	}
220	EventContextCommand::Close { context_id } => {
221	sessions.close(&media, &context_id).await?;
222	return Ok(crate::CommandOutput::Done);
223	}
224	EventContextCommand::Before {
225	context_id,
226	token,
227	limit,
228	} => (context_id, token, limit, true),
229	EventContextCommand::After {
230	context_id,
231	token,
232	limit,
233	} => (context_id, token, limit, false),
234	};
235	if limit == 0 {
236	return Err(Error::new(
237	ErrorKind::Invalid,
238	"context page limit must be at least 1",
239	));
240	}
241	validate_limit(limit)?;
242	if token.is_empty() {
243	return Err(Error::new(
244	ErrorKind::Invalid,
245	"context pagination token is empty",
246	));
247	}
248	let (room_id, media_prefix) = sessions.find(&context_id).await?;
249	let room = room(&room_id)?;
250	let side = fetch_side(&room, Some(&token), limit, backwards).await?;
251	let mut page = Assembly::new(
252	&room,
253	current_user_id.as_deref(),
254	&side.values,
255	&side.highlights,
256	None,
257	&media_prefix,
258	)
259	.await;
260	let events = page.take(0..side.values.len());
261	sessions.register(&media, &context_id, page.media).await?;
262	Ok(crate::CommandOutput::EventContextPage(EventContextPage {
263	events,
264	next_token: side.token,
265	}))
266	}
267
268	pub(crate) async fn capture(
269	room: Room,
270	current_user_id: Option<OwnedUserId>,
271	event_id: OwnedEventId,
272	before_limit: u16,
273	after_limit: u16,
274	) -> Result<(EventContext, Vec<MediaRegistration>, Vec<Value>), Error> {
275	capture_in(
276	room,
277	current_user_id,
278	event_id,
279	before_limit,
280	after_limit,
281	"",
282	)
283	.await
284	}
285
286	async fn capture_in(
287	room: Room,
288	current_user_id: Option<OwnedUserId>,
289	event_id: OwnedEventId,
290	before_limit: u16,
291	after_limit: u16,
292	media_prefix: &str,
293	) -> Result<(EventContext, Vec<MediaRegistration>, Vec<Value>), Error> {
294	validate_limit(before_limit)?;
295	validate_limit(after_limit)?;
296	let raw = room
297	.event_with_context(&event_id, false, UInt::from(0_u16), None)
298	.await
299	.map_err(\|source\| {
300	let error = Error::from_sdk("fetching event context failed", source);
301	if error
302	.server
303	.as_ref()
304	.is_some_and(\|server\| server.status == 404)
305	{
306	Error::new(ErrorKind::EventNotFound, "event was not found")
307	} else {
308	error
309	}
310	})?;
311	let (target, target_highlight) = raw
312	.event
313	.as_ref()
314	.and_then(raw_event)
315	.ok_or_else(\|\| Error::new(ErrorKind::EventNotFound, "event was not found"))?;
316	let (before, after) = try_join(
317	fetch_side(&room, raw.prev_batch_token.as_deref(), before_limit, true),
318	fetch_side(&room, raw.next_batch_token.as_deref(), after_limit, false),
319	)
320	.await?;
321	let target_index = before.values.len();
322	let mut values = before.values;
323	values.push(target);
324	values.extend(after.values);
325	let mut highlights = before.highlights;
326	highlights.push(target_highlight);
327	highlights.extend(after.highlights);
328	let mut page = Assembly::new(
329	&room,
330	current_user_id.as_deref(),
331	&values,
332	&highlights,
333	Some(target_index),
334	media_prefix,
335	)
336	.await;
337	let events_before = page.take(0..target_index);
338	let event = page
339	.take(target_index..target_index + 1)
340	.pop()
341	.ok_or_else(\|\| Error::new(ErrorKind::EventNotFound, "event could not be read"))?;
342	let events_after = page.take(target_index + 1..values.len());
343	Ok((
344	EventContext {
345	events_before,
346	event,
347	events_after,
348	start_token: before.token,
349	end_token: after.token,
350	},
351	page.media,
352	values,
353	))
354	}
355
356	struct Side {
357	/// in timeline order
358	values: Vec<Value>,
359	/// beside `values`, from the push actions the sdk worked out as it fetched
360	highlights: Vec<bool>,
361	token: Option<String>,
362	}
363
364	fn raw_event(event: &SdkTimelineEvent) -> Option<(Value, bool)> {
365	let value = serde_json::from_str(event.raw().json().get()).ok()?;
366	let highlight = event
367	.push_actions()
368	.is_some_and(\|actions\| actions.iter().any(Action::is_highlight));
369	Some((value, highlight))
370	}
371
372	async fn fetch_side(
373	room: &Room,
374	token: Option<&str>,
375	limit: u16,
376	backwards: bool,
377	) -> Result<Side, Error> {
378	let Some(token) = token else {
379	return Ok(Side {
380	values: Vec::new(),
381	highlights: Vec::new(),
382	token: None,
383	});
384	};
385	if limit == 0 {
386	return Ok(Side {
387	values: Vec::new(),
388	highlights: Vec::new(),
389	token: Some(token.to_owned()),
390	});
391	}
392	let mut options = if backwards {
393	MessagesOptions::backward()
394	} else {
395	MessagesOptions::forward()
396	};
397	options = options.from(token);
398	options.limit = UInt::from(limit);
399	let messages = room
400	.messages(options)
401	.await
402	.map_err(\|source\| Error::from_sdk("fetching event context events failed", source))?;
403	let mut events: Vec<_> = messages.chunk.iter().filter_map(raw_event).collect();
404	if backwards {
405	events.reverse();
406	}
407	let (values, highlights) = events.into_iter().unzip();
408	Ok(Side {
409	values,
410	highlights,
411	token: messages.end,
412	})
413	}
414
415	/// a search hit as event context would show it, `values` its original and then its latest edit
416	pub(crate) async fn preview(
417	room: &Room,
418	current_user_id: Option<&ruma::UserId>,
419	values: &[Value],
420	highlight: bool,
421	) -> Option<(TimelineEvent, Vec<MediaRegistration>)> {
422	let mut page = Assembly::new(
423	room,
424	current_user_id,
425	values,
426	&vec![highlight; values.len()],
427	Some(0),
428	)
429	.await;
430	match page.take(0..1).pop()? {
431	TimelineItem::Event(event) => Some((*event, page.media)),
432	_ => None,
433	}
434	}
435
436	/// a window of raw events normalised together, so relations inside it land on their targets
437	struct Assembly {
438	items: Vec<(usize, TimelineItem)>,
439	media: Vec<MediaRegistration>,
440	}
441
442	impl Assembly {
443	async fn new(
444	room: &Room,
445	current_user_id: Option<&ruma::UserId>,
446	values: &[Value],
447	highlights: &[bool],
448	keep: Option<usize>,
449	media_prefix: &str,
450	) -> Self {
451	let page = normalise_context(values, keep, current_user_id, room.room_id(), media_prefix);
452	let mut items = page.items;
453	for (index, item) in &mut items {
454	if let TimelineItem::Event(event) = item {
455	event.highlight = highlights[*index];
456	}
457	}
458	let mut media = page.media;
459	let mut targets: HashMap<OwnedEventId, TimelineEvent> = HashMap::new();
460	let mut missing = Vec::new();
461	for (_, item) in &items {
462	if let TimelineItem::Event(event) = item
463	&& let Some(event_id) = &event.event_id
464	{
465	targets.insert(event_id.clone(), (**event).clone());
466	}
467	}
468	for event in events(&mut items) {
469	if let Some(reply) = &event.reply_to
470	&& !targets.contains_key(&reply.event_id)
471	&& !missing.contains(&reply.event_id)
472	{
473	missing.push(reply.event_id.clone());
474	}
475	}
476	let fetched = join_all(
477	missing
478	.into_iter()
479	.map(\|event_id\| fetch_reply(room, current_user_id, event_id, media_prefix)),
480	)
481	.await;
482	for (event, registrations) in fetched.into_iter().flatten() {
483	media.extend(registrations);
484	if let Some(event_id) = event.event_id.clone() {
485	targets.insert(event_id, event);
486	}
487	}
488	let profiles = profiles(
489	room,
490	items
491	.iter()
492	.filter_map(\|(_, item)\| match item {
493	TimelineItem::Event(event) => Some(&event.sender.user_id),
494	_ => None,
495	})
496	.chain(targets.values().map(\|event\| &event.sender.user_id)),
497	)
498	.await;
499	apply_profiles(targets.values_mut(), &profiles);
500	apply_profiles(events(&mut items), &profiles);
501	resolve_replies(events(&mut items), &targets);
502	Self { items, media }
503	}
504
505	/// the items that came from raw events in `range`
506	fn take(&mut self, range: std::ops::Range<usize>) -> Vec<TimelineItem> {
507	let (taken, kept) = std::mem::take(&mut self.items)
508	.into_iter()
509	.partition(\|(index, _)\| range.contains(index));
510	self.items = kept;
511	taken.into_iter().map(\|(_, item)\| item).collect()
512	}
513	}
514
515	fn events(items: &mut [(usize, TimelineItem)]) -> impl Iterator<Item = &mut TimelineEvent> {
516	items.iter_mut().filter_map(\|(_, item)\| match item {
517	TimelineItem::Event(event) => Some(&mut **event),
518	_ => None,
519	})
520	}
521
522	async fn fetch_reply(
523	room: &Room,
524	current_user_id: Option<&ruma::UserId>,
525	event_id: OwnedEventId,
526	media_prefix: &str,
527	) -> Option<(TimelineEvent, Vec<MediaRegistration>)> {
528	let event = room
529	.load_or_fetch_event(&event_id, None)
530	.await
531	.inspect_err(\|error\| tracing::debug!(%event_id, %error, "fetching a reply target failed"))
532	.ok()?;
533	let value: Value = serde_json::from_str(event.raw().json().get()).ok()?;
534	let identity = format!("{media_prefix}{}\n{event_id}", room.room_id());
535	match normalise_observed(&value, current_user_id, &identity)? {
536	(TimelineItem::Event(event), media) => Some((*event, media)),
537	_ => None,
538	}
539	}
540
541	/// under lazy-loaded members a sender may be unknown locally, and `get_member` fetches the
542	/// member list once for the room when it is
543	async fn profiles<'a>(
544	room: &Room,
545	user_ids: impl Iterator<Item = &'a OwnedUserId>,
546	) -> HashMap<OwnedUserId, Sender> {
547	let mut unique: Vec<&OwnedUserId> = user_ids.collect();
548	unique.sort();
549	unique.dedup();
550	join_all(
551	unique.into_iter().map(\|user_id\| async move {
552	Some((user_id.clone(), member_sender(room, user_id).await?))
553	}),
554	)
555	.await
556	.into_iter()
557	.flatten()
558	.collect()
559	}
560
561	fn validate_limit(limit: u16) -> Result<(), Error> {
562	if limit > MAX_CONTEXT_LIMIT {
563	Err(Error::new(ErrorKind::Invalid, "context limit exceeds 50"))
564	} else {
565	Ok(())
566	}
567	}