matrix-sdk-base 0.16.0

// Copyright 2025 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use matrix_sdk_common::deserialized_responses::TimelineEvent;
use matrix_sdk_crypto::RoomEventDecryptionResult;
use ruma::{RoomId, events::AnySyncTimelineEvent, serde::Raw};

use super::{Context, e2ee::E2EE, verification};
use crate::{
    Result, Room,
    latest_event::{LatestEvent, PossibleLatestEvent, is_suitable_for_latest_event},
};

/// Decrypt any [`Room::latest_encrypted_events`] for a particular set of
/// [`Room`]s.
///
/// If we can decrypt them, change [`Room::latest_event`] to reflect what we
/// found, and remove any older encrypted events from
/// [`Room::latest_encrypted_events`].
pub async fn decrypt_from_rooms(
    context: &mut Context,
    rooms: Vec<Room>,
    e2ee: E2EE<'_>,
) -> Result<()> {
    // All functions used by this one expect an `OlmMachine`. Return if there is
    // none.
    if e2ee.olm_machine.is_none() {
        return Ok(());
    }

    for room in rooms {
        // Try to find a message we can decrypt and is suitable for using as the latest
        // event. If we found one, set it as the latest and delete any older
        // encrypted events
        if let Some((found, found_index)) = find_suitable_and_decrypt(&room, &e2ee).await {
            room.on_latest_event_decrypted(
                found,
                found_index,
                &mut context.state_changes,
                &mut context.room_info_notable_updates,
            );
        }
    }

    Ok(())
}

async fn find_suitable_and_decrypt(
    room: &Room,
    e2ee: &E2EE<'_>,
) -> Option<(Box<LatestEvent>, usize)> {
    let enc_events = room.latest_encrypted_events();
    let power_levels = room.power_levels().await.ok();
    let power_levels_info = Some(room.own_user_id()).zip(power_levels.as_ref());

    // Walk backwards through the encrypted events, looking for one we can decrypt
    for (i, event) in enc_events.iter().enumerate().rev() {
        // Size of the `decrypt_sync_room_event` future should not impact this
        // async fn since it is likely that there aren't even any encrypted
        // events when calling it.
        let decrypt_sync_room_event =
            Box::pin(decrypt_sync_room_event(event, e2ee, room.room_id()));

        if let Ok(decrypted) = decrypt_sync_room_event.await {
            // We found an event we can decrypt
            if let Ok(any_sync_event) = decrypted.raw().deserialize() {
                // We can deserialize it to find its type
                match is_suitable_for_latest_event(&any_sync_event, power_levels_info) {
                    PossibleLatestEvent::YesRoomMessage(_)
                    | PossibleLatestEvent::YesPoll(_)
                    | PossibleLatestEvent::YesCallInvite(_)
                    | PossibleLatestEvent::YesRtcNotification(_)
                    | PossibleLatestEvent::YesSticker(_)
                    | PossibleLatestEvent::YesKnockedStateEvent(_) => {
                        return Some((Box::new(LatestEvent::new(decrypted)), i));
                    }
                    _ => (),
                }
            }
        }
    }

    None
}

/// Attempt to decrypt the given raw event into a [`TimelineEvent`].
///
/// In the case of a decryption error, returns a [`TimelineEvent`]
/// representing the decryption error; in the case of problems with our
/// application, returns `Err`.
///
/// # Panics
///
/// Panics if there is no [`OlmMachine`] in [`E2EE`].
async fn decrypt_sync_room_event(
    event: &Raw<AnySyncTimelineEvent>,
    e2ee: &E2EE<'_>,
    room_id: &RoomId,
) -> Result<TimelineEvent> {
    let event = match e2ee
        .olm_machine
        .expect("An `OlmMachine` is expected")
        .try_decrypt_room_event(event.cast_ref_unchecked(), room_id, e2ee.decryption_settings)
        .await?
    {
        RoomEventDecryptionResult::Decrypted(decrypted) => {
            // We're fine not setting the push actions for the latest event.

            // TODO: we should use `TimelineEvent::to_decrypted`
            // but this whole code is about to get soon removed by
            // https://github.com/matrix-org/matrix-rust-sdk/pull/5624.
            let event = TimelineEvent::from_decrypted(decrypted, None);

            if let Ok(sync_timeline_event) = event.raw().deserialize() {
                verification::process_if_relevant(&sync_timeline_event, e2ee.clone(), room_id)
                    .await?;
            }

            event
        }

        RoomEventDecryptionResult::UnableToDecrypt(utd_info) => {
            // TODO: we should use `TimelineEvent::to_utd`
            // but this whole code is about to get soon removed by
            // https://github.com/matrix-org/matrix-rust-sdk/pull/5624.
            TimelineEvent::from_utd(event.clone(), utd_info)
        }
    };

    Ok(event)
}

#[cfg(test)]
mod tests {
    use matrix_sdk_test::{
        JoinedRoomBuilder, SyncResponseBuilder, async_test, event_factory::EventFactory,
    };
    use ruma::{event_id, events::room::member::MembershipState, room_id, user_id};

    use super::{Context, E2EE, decrypt_from_rooms};
    use crate::{room::RoomInfoNotableUpdateReasons, test_utils::logged_in_base_client};

    #[async_test]
    async fn test_when_there_are_no_latest_encrypted_events_decrypting_them_does_nothing() {
        // Given a room
        let user_id = user_id!("@u:u.to");
        let room_id = room_id!("!r:u.to");

        let client = logged_in_base_client(Some(user_id)).await;

        let mut sync_builder = SyncResponseBuilder::new();

        let response = sync_builder
            .add_joined_room(
                JoinedRoomBuilder::new(room_id).add_timeline_event(
                    EventFactory::new()
                        .member(user_id)
                        .display_name("Alice")
                        .membership(MembershipState::Join)
                        .event_id(event_id!("$1")),
                ),
            )
            .build_sync_response();
        client.receive_sync_response(response).await.unwrap();

        let room = client.get_room(room_id).expect("Just-created room not found!");

        // Sanity: it has no latest_encrypted_events or latest_event
        assert!(room.latest_encrypted_events().is_empty());
        assert!(room.latest_event().is_none());

        // When I tell it to do some decryption
        let mut context = Context::default();

        decrypt_from_rooms(
            &mut context,
            vec![room.clone()],
            E2EE::new(
                client.olm_machine().await.as_ref(),
                &client.decryption_settings,
                client.handle_verification_events,
            ),
        )
        .await
        .unwrap();

        // Then nothing changed
        assert!(room.latest_encrypted_events().is_empty());
        assert!(room.latest_event().is_none());
        assert!(context.state_changes.room_infos.is_empty());
        assert!(
            !context
                .room_info_notable_updates
                .get(room_id)
                .copied()
                .unwrap_or_default()
                .contains(RoomInfoNotableUpdateReasons::LATEST_EVENT)
        );
    }
}