palpo-core 0.0.2

Core library used by the palpo crates.
Documentation 
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

//! Endpoints to request more history from another homeserver.
//! `GET /_matrix/federation/*/backfill/{room_id}`
//!
//! Get more history from another homeserver.
//! `/v1/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1backfillroomid

use reqwest::Url;
use salvo::prelude::*;
use serde::{Deserialize, Serialize};

use crate::sending::{SendRequest, SendResult};
use crate::serde::RawJsonValue;
use crate::{OwnedEventId, OwnedRoomId, OwnedServerName, UnixMillis};

// const METADATA: Metadata = metadata! {
//     method: GET,
//     rate_limited: false,
//     authentication: ServerSignatures,
//     history: {
//         1.0 => "/_matrix/federation/v1/backfill/:room_id",
//     }
// };

pub fn backfill_request(origin: &str, args: BackfillReqArgs) -> SendResult<SendRequest> {
    let url = Url::parse(&format!(
        "{origin}/_matrix/federation/v1/backfill/{}&limit={}&{}",
        &args.room_id,
        args.limit,
        args.v.iter().map(|v| format!("v={v}")).collect::<Vec<_>>().join("&")
    ))?;
    Ok(crate::sending::get(url))
}

/// Request type for the `get_backfill` endpoint.
#[derive(ToParameters, Deserialize, Debug)]
pub struct BackfillReqArgs {
    /// The room ID to backfill.
    #[salvo(parameter(parameter_in = Path))]
    pub room_id: OwnedRoomId,

    /// The event IDs to backfill from.
    #[salvo(parameter(parameter_in = Query))]
    pub v: Vec<OwnedEventId>,

    /// The maximum number of PDUs to retrieve, including the given events.
    #[salvo(parameter(parameter_in = Query))]
    pub limit: usize,
}

/// Response type for the `get_backfill` endpoint.
#[derive(ToSchema, Serialize, Deserialize, Debug)]

pub struct BackfillResBody {
    /// The `server_name` of the homeserver sending this transaction.
    pub origin: OwnedServerName,

    /// POSIX timestamp in milliseconds on originating homeserver when this transaction
    /// started.
    pub origin_server_ts: UnixMillis,

    /// List of persistent updates to rooms.
    #[salvo(schema(value_type = Vec<Object>))]
    pub pdus: Vec<Box<RawJsonValue>>,
}
impl BackfillResBody {
    /// Creates a new `Response` with:
    /// * the `server_name` of the homeserver.
    /// * the timestamp in milliseconds of when this transaction started.
    /// * the list of persistent updates to rooms.
    pub fn new(origin: OwnedServerName, origin_server_ts: UnixMillis, pdus: Vec<Box<RawJsonValue>>) -> Self {
        Self {
            origin,
            origin_server_ts,
            pdus,
        }
    }
}