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::{
10    BrowserSession, Clock, CompatSession, Session, personal::session::PersonalSession,
11};
12
13use crate::activity_tracker::ActivityTracker;
14
15/// An activity tracker with an IP address bound to it.
16#[derive(Clone)]
17pub struct Bound {
18    tracker: ActivityTracker,
19    ip: Option<IpAddr>,
20}
21
22impl Bound {
23    /// Create a new bound activity tracker.
24    #[must_use]
25    pub fn new(tracker: ActivityTracker, ip: Option<IpAddr>) -> Self {
26        Self { tracker, ip }
27    }
28
29    /// Get the IP address bound to this activity tracker.
30    #[must_use]
31    pub fn ip(&self) -> Option<IpAddr> {
32        self.ip
33    }
34
35    /// Record activity in an OAuth 2.0 session.
36    pub async fn record_oauth2_session(&self, clock: &dyn Clock, session: &Session) {
37        self.tracker
38            .record_oauth2_session(clock, session, self.ip)
39            .await;
40    }
41
42    /// Record activity in a personal session.
43    pub async fn record_personal_session(&self, clock: &dyn Clock, session: &PersonalSession) {
44        self.tracker
45            .record_personal_session(clock, session, self.ip)
46            .await;
47    }
48
49    /// Record activity in a compatibility session.
50    pub async fn record_compat_session(&self, clock: &dyn Clock, session: &CompatSession) {
51        self.tracker
52            .record_compat_session(clock, session, self.ip)
53            .await;
54    }
55
56    /// Record activity in a browser session.
57    pub async fn record_browser_session(&self, clock: &dyn Clock, session: &BrowserSession) {
58        self.tracker
59            .record_browser_session(clock, session, self.ip)
60            .await;
61    }
62}