mas_handlers/activity_tracker/
bound.rs

1// Copyright 2024, 2025 New Vector Ltd.
2// Copyright 2023, 2024 The Matrix.org Foundation C.I.C.
3//
4// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
5// Please see LICENSE files in the repository root for full details.
6
7use std::net::IpAddr;
8
9use mas_data_model::{BrowserSession, Clock, CompatSession, Session};
10
11use crate::activity_tracker::ActivityTracker;
12
13/// An activity tracker with an IP address bound to it.
14#[derive(Clone)]
15pub struct Bound {
16    tracker: ActivityTracker,
17    ip: Option<IpAddr>,
18}
19
20impl Bound {
21    /// Create a new bound activity tracker.
22    #[must_use]
23    pub fn new(tracker: ActivityTracker, ip: Option<IpAddr>) -> Self {
24        Self { tracker, ip }
25    }
26
27    /// Get the IP address bound to this activity tracker.
28    #[must_use]
29    pub fn ip(&self) -> Option<IpAddr> {
30        self.ip
31    }
32
33    /// Record activity in an OAuth 2.0 session.
34    pub async fn record_oauth2_session(&self, clock: &dyn Clock, session: &Session) {
35        self.tracker
36            .record_oauth2_session(clock, session, self.ip)
37            .await;
38    }
39
40    /// Record activity in a compatibility session.
41    pub async fn record_compat_session(&self, clock: &dyn Clock, session: &CompatSession) {
42        self.tracker
43            .record_compat_session(clock, session, self.ip)
44            .await;
45    }
46
47    /// Record activity in a browser session.
48    pub async fn record_browser_session(&self, clock: &dyn Clock, session: &BrowserSession) {
49        self.tracker
50            .record_browser_session(clock, session, self.ip)
51            .await;
52    }
53}