liburlx 0.2.2

A memory-safe URL transfer library — idiomatic Rust reimplementation of libcurl
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
//! RTSP protocol handler.
//!
//! Implements the Real-Time Streaming Protocol (RFC 2326) for streaming
//! media control. RTSP is syntactically similar to HTTP/1.x but uses
//! `RTSP/1.0` version strings and requires a `CSeq` header on every
//! request/response.

use std::collections::HashMap;
use std::fmt::Write as _;

use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt};
use tokio::net::TcpStream;

use crate::error::Error;
use crate::protocol::http::response::Response;

/// Maximum size of a single RTSP header line.
const MAX_HEADER_LINE_SIZE: usize = 100 * 1024;

/// Maximum total response header section size.
const MAX_HEADER_SIZE: usize = 300 * 1024;

/// RTSP request method types matching curl's `CURL_RTSPREQ_*` values.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u32)]
pub enum RtspRequest {
    /// No request type set.
    None = 0,
    /// OPTIONS request.
    Options = 1,
    /// DESCRIBE request.
    Describe = 2,
    /// ANNOUNCE request.
    Announce = 3,
    /// SETUP request.
    Setup = 4,
    /// PLAY request.
    Play = 5,
    /// PAUSE request.
    Pause = 6,
    /// TEARDOWN request.
    Teardown = 7,
    /// `GET_PARAMETER` request.
    GetParameter = 8,
    /// `SET_PARAMETER` request.
    SetParameter = 9,
    /// RECORD request.
    Record = 10,
    /// RECEIVE (interleaved RTP data).
    Receive = 11,
}

impl RtspRequest {
    /// Convert from a numeric value (curl RTSPREQ enum).
    #[must_use]
    pub const fn from_long(v: u32) -> Option<Self> {
        match v {
            0 => Some(Self::None),
            1 => Some(Self::Options),
            2 => Some(Self::Describe),
            3 => Some(Self::Announce),
            4 => Some(Self::Setup),
            5 => Some(Self::Play),
            6 => Some(Self::Pause),
            7 => Some(Self::Teardown),
            8 => Some(Self::GetParameter),
            9 => Some(Self::SetParameter),
            10 => Some(Self::Record),
            11 => Some(Self::Receive),
            _ => Option::None,
        }
    }

    /// Get the RTSP method string.
    #[must_use]
    pub const fn method_str(self) -> &'static str {
        match self {
            Self::None | Self::Options => "OPTIONS",
            Self::Describe => "DESCRIBE",
            Self::Announce => "ANNOUNCE",
            Self::Setup => "SETUP",
            Self::Play => "PLAY",
            Self::Pause => "PAUSE",
            Self::Teardown => "TEARDOWN",
            Self::GetParameter => "GET_PARAMETER",
            Self::SetParameter => "SET_PARAMETER",
            Self::Record => "RECORD",
            Self::Receive => "RECEIVE",
        }
    }
}

/// Persistent RTSP session state across `perform()` calls.
pub struct RtspSession {
    /// The TCP stream to the RTSP server.
    stream: TcpStream,
    /// Client `CSeq` counter (incremented per request).
    pub client_cseq: u32,
    /// Server `CSeq` counter (from last response).
    pub server_cseq: u32,
    /// Last received `CSeq` from server response.
    pub cseq_recv: u32,
    /// Session ID extracted from response `Session:` header.
    pub session_id: Option<String>,
}

impl RtspSession {
    /// Set the client `CSeq` counter.
    pub const fn set_client_cseq(&mut self, cseq: u32) {
        self.client_cseq = cseq;
    }

    /// Get the session ID.
    pub fn session_id(&self) -> Option<&str> {
        self.session_id.as_deref()
    }

    /// Get the client `CSeq` counter.
    pub const fn client_cseq(&self) -> u32 {
        self.client_cseq
    }

    /// Get the server `CSeq` counter.
    pub const fn server_cseq(&self) -> u32 {
        self.server_cseq
    }

    /// Get the last received `CSeq`.
    pub const fn cseq_recv(&self) -> u32 {
        self.cseq_recv
    }
}

/// Send an RTSP request and read the response.
///
/// # Errors
///
/// Returns errors for write failures and response parsing errors.
#[allow(clippy::too_many_arguments)]
pub async fn request<S>(
    stream: &mut S,
    method: &str,
    url: &str,
    custom_headers: &[(String, String)],
    body: Option<&[u8]>,
    cseq: u32,
) -> Result<Response, Error>
where
    S: AsyncRead + AsyncWrite + Unpin,
{
    let mut req = format!("{method} {url} RTSP/1.0\r\n");

    let has_cseq = custom_headers.iter().any(|(k, _)| k.eq_ignore_ascii_case("cseq"));
    if !has_cseq {
        let _ = write!(req, "CSeq: {cseq}\r\n");
    }

    for (key, value) in custom_headers {
        let _ = write!(req, "{key}: {value}\r\n");
    }

    if let Some(data) = body {
        if !data.is_empty()
            && !custom_headers.iter().any(|(k, _)| k.eq_ignore_ascii_case("content-length"))
        {
            let _ = write!(req, "Content-Length: {}\r\n", data.len());
        }
    }

    req.push_str("\r\n");

    stream
        .write_all(req.as_bytes())
        .await
        .map_err(|e| Error::Http(format!("RTSP write error: {e}")))?;

    if let Some(data) = body {
        if !data.is_empty() {
            stream
                .write_all(data)
                .await
                .map_err(|e| Error::Http(format!("RTSP body write error: {e}")))?;
        }
    }

    stream.flush().await.map_err(|e| Error::Http(format!("RTSP flush error: {e}")))?;

    read_response(stream, url).await
}

/// Perform an RTSP transfer using a persistent session.
///
/// # Errors
///
/// Returns errors for connection failures, protocol errors, `CSeq`
/// mismatches, and session ID mismatches.
#[allow(clippy::too_many_arguments, clippy::too_many_lines)]
pub async fn perform_with_session(
    url: &crate::url::Url,
    headers: &[(String, String)],
    body: Option<&[u8]>,
    verbose: bool,
    session: &mut Option<RtspSession>,
    rtsp_request_type: RtspRequest,
    rtsp_stream_uri: Option<&str>,
    rtsp_transport: Option<&str>,
    rtsp_session_id_override: Option<&str>,
    rtsp_headers: &[(String, String)],
) -> Result<Response, Error> {
    let (host, port) = url.host_and_port()?;

    if rtsp_request_type == RtspRequest::Setup && rtsp_transport.is_none() {
        return Err(Error::Transfer {
            code: 43,
            message: "SETUP requires CURLOPT_RTSP_TRANSPORT".to_string(),
        });
    }

    if session.is_none() {
        if verbose {
            #[allow(clippy::print_stderr)]
            {
                eprintln!("* Trying {host}:{port}...");
            }
        }

        let addr = format!("{host}:{port}");
        let tcp = TcpStream::connect(&addr).await.map_err(Error::Connect)?;

        if verbose {
            #[allow(clippy::print_stderr)]
            {
                eprintln!("* Connected to {host} ({host}) port {port}");
            }
        }

        *session = Some(RtspSession {
            stream: tcp,
            client_cseq: 1,
            server_cseq: 0,
            cseq_recv: 0,
            session_id: None,
        });
    }

    let sess =
        session.as_mut().ok_or_else(|| Error::Http("RTSP session not initialized".to_string()))?;

    let stream_uri = rtsp_stream_uri.unwrap_or_else(|| url.as_str());

    let mut all_headers: Vec<(String, String)> = Vec::new();

    if rtsp_request_type == RtspRequest::Setup {
        if let Some(transport) = rtsp_transport {
            all_headers.push(("Transport".to_string(), transport.to_string()));
        }
    }

    // Add Session header if we have a session ID
    let session_id_to_send =
        rtsp_session_id_override.map(ToString::to_string).or_else(|| sess.session_id.clone());
    if let Some(ref sid) = session_id_to_send {
        all_headers.push(("Session".to_string(), sid.clone()));
    }

    if rtsp_request_type == RtspRequest::Describe {
        all_headers.push(("Accept".to_string(), "application/sdp".to_string()));
    }

    if body.is_some_and(|b| !b.is_empty()) {
        let has_content_type = headers.iter().any(|(k, _)| k.eq_ignore_ascii_case("content-type"))
            || rtsp_headers.iter().any(|(k, _)| k.eq_ignore_ascii_case("content-type"));
        if !has_content_type {
            match rtsp_request_type {
                RtspRequest::Announce => {
                    all_headers.push(("Content-Type".to_string(), "application/sdp".to_string()));
                }
                RtspRequest::GetParameter | RtspRequest::SetParameter => {
                    all_headers.push(("Content-Type".to_string(), "text/parameters".to_string()));
                }
                _ => {}
            }
        }
    }

    for (k, v) in rtsp_headers {
        all_headers.push((k.clone(), v.clone()));
    }

    for (k, v) in headers {
        all_headers.push((k.clone(), v.clone()));
    }

    let cseq = sess.client_cseq;

    if rtsp_request_type == RtspRequest::Receive {
        let resp = Response::new(200, HashMap::new(), Vec::new(), stream_uri.to_string());
        return Ok(resp);
    }

    let response = request(
        &mut sess.stream,
        rtsp_request_type.method_str(),
        stream_uri,
        &all_headers,
        body,
        cseq,
    )
    .await?;

    sess.client_cseq = cseq + 1;

    if let Some(session_hdr) = response.header("session") {
        let session_id = session_hdr.split(';').next().unwrap_or(session_hdr).trim().to_string();
        sess.session_id = Some(session_id);
    }

    if let Some(cseq_hdr) = response.header("cseq") {
        if let Ok(resp_cseq) = cseq_hdr.trim().parse::<u32>() {
            sess.cseq_recv = resp_cseq;
            sess.server_cseq = resp_cseq;

            if resp_cseq != cseq {
                return Err(Error::RtspCseqError(format!("expected CSeq {cseq}, got {resp_cseq}")));
            }
        }
    } else {
        return Err(Error::RtspCseqError("no CSeq in server response".to_string()));
    }

    if let Some(ref sent_session) = session_id_to_send {
        if let Some(session_hdr) = response.header("session") {
            let resp_session = session_hdr.split(';').next().unwrap_or(session_hdr).trim();
            if !sent_session.is_empty() && resp_session != sent_session.as_str() {
                return Err(Error::RtspSessionError(format!(
                    "expected session '{sent_session}', got '{resp_session}'"
                )));
            }
        }
    }

    if verbose {
        #[allow(clippy::print_stderr)]
        {
            eprintln!("* Connection #0 to host {host} left intact");
        }
    }

    Ok(response)
}

/// Perform an RTSP transfer (simple, non-session mode for CLI).
///
/// # Errors
///
/// Returns errors for connection or protocol failures.
pub async fn perform(
    url: &crate::url::Url,
    method: &str,
    headers: &[(String, String)],
    body: Option<&[u8]>,
    verbose: bool,
) -> Result<Response, Error> {
    let (host, port) = url.host_and_port()?;

    if verbose {
        #[allow(clippy::print_stderr)]
        {
            eprintln!("* Trying {host}:{port}...");
        }
    }

    let addr = format!("{host}:{port}");
    let mut tcp = TcpStream::connect(&addr).await.map_err(Error::Connect)?;

    if verbose {
        #[allow(clippy::print_stderr)]
        {
            eprintln!("* Connected to {host} ({host}) port {port}");
        }
    }

    let rtsp_method = if method == "GET" || method == "HEAD" || method == "POST" || method == "PUT"
    {
        "OPTIONS"
    } else {
        method
    };

    let url_str = url.to_full_string();
    let response = request(&mut tcp, rtsp_method, &url_str, headers, body, 1).await?;

    if verbose {
        #[allow(clippy::print_stderr)]
        {
            eprintln!("* Connection #0 to host {host} left intact");
        }
    }

    Ok(response)
}

async fn read_header_bytes<S>(stream: &mut S) -> Result<Vec<u8>, Error>
where
    S: AsyncRead + Unpin,
{
    let mut buf = Vec::with_capacity(4096);
    let mut total: usize = 0;
    let mut byte = [0u8; 1];

    loop {
        let n = stream
            .read(&mut byte)
            .await
            .map_err(|e| Error::Http(format!("RTSP read error: {e}")))?;
        if n == 0 {
            if buf.is_empty() {
                return Err(Error::Http("RTSP connection closed before response".to_string()));
            }
            break;
        }

        buf.push(byte[0]);
        total += 1;

        if total > MAX_HEADER_SIZE {
            return Err(Error::Transfer {
                code: 56,
                message: "RTSP response headers too large".to_string(),
            });
        }

        let len = buf.len();
        if (len >= 4 && buf[len - 4..] == *b"\r\n\r\n") || (len >= 2 && buf[len - 2..] == *b"\n\n")
        {
            break;
        }
    }

    Ok(buf)
}

async fn read_response<S>(stream: &mut S, url: &str) -> Result<Response, Error>
where
    S: AsyncRead + Unpin,
{
    let header_buf = read_header_bytes(stream).await?;
    let raw_headers = header_buf.clone();

    let header_str =
        String::from_utf8_lossy(&header_buf[..header_buf.len().saturating_sub(2)]).to_string();
    let mut lines = header_str.lines();

    let status_line = lines.next().ok_or_else(|| Error::Http("RTSP empty response".to_string()))?;
    let (status_code, _reason) = parse_status_line(status_line)?;

    let mut headers = HashMap::new();
    let mut headers_ordered = Vec::new();
    let mut header_original_names = HashMap::new();

    parse_header_lines(lines, &mut headers, &mut headers_ordered, &mut header_original_names)?;

    let body = read_content_body(stream, &headers).await?;

    let mut response =
        Response::with_raw_headers(status_code, headers, body, url.to_string(), raw_headers);
    response.set_header_original_names(header_original_names);
    response.set_headers_ordered(headers_ordered);

    Ok(response)
}

fn parse_header_lines<'a>(
    lines: impl Iterator<Item = &'a str>,
    headers: &mut HashMap<String, String>,
    headers_ordered: &mut Vec<(String, String)>,
    header_original_names: &mut HashMap<String, String>,
) -> Result<(), Error> {
    let mut current_line = String::new();

    for line in lines {
        if line.is_empty() {
            break;
        }

        if line.starts_with(' ') || line.starts_with('\t') {
            current_line.push(' ');
            current_line.push_str(line.trim());
            continue;
        }

        if !current_line.is_empty() {
            if current_line.len() > MAX_HEADER_LINE_SIZE {
                return Err(Error::Transfer {
                    code: 100,
                    message: "RTSP header line too large".to_string(),
                });
            }
            insert_header(&current_line, headers, headers_ordered, header_original_names);
        }

        current_line = line.to_string();
    }

    if !current_line.is_empty() {
        insert_header(&current_line, headers, headers_ordered, header_original_names);
    }

    Ok(())
}

async fn read_content_body<S>(
    stream: &mut S,
    headers: &HashMap<String, String>,
) -> Result<Vec<u8>, Error>
where
    S: AsyncRead + Unpin,
{
    if let Some(cl_str) = headers.get("content-length") {
        let content_length = cl_str
            .trim()
            .parse::<usize>()
            .map_err(|_| Error::Http(format!("RTSP invalid Content-Length: {cl_str}")))?;
        let mut body_buf = vec![0u8; content_length];
        let _n = stream
            .read_exact(&mut body_buf)
            .await
            .map_err(|e| Error::Http(format!("RTSP body read error: {e}")))?;
        Ok(body_buf)
    } else {
        Ok(Vec::new())
    }
}

fn parse_status_line(line: &str) -> Result<(u16, String), Error> {
    let parts: Vec<&str> = line.splitn(3, ' ').collect();
    if parts.len() < 2 {
        return Err(Error::Transfer {
            code: 8,
            message: format!("Weird RTSP server reply: {line}"),
        });
    }

    let version = parts[0];
    if !version.starts_with("RTSP/") {
        return Err(Error::Transfer {
            code: 8,
            message: format!("Weird RTSP server reply: {line}"),
        });
    }

    let ver = &version[5..];
    if ver != "1.0" {
        return Err(Error::Transfer {
            code: 8,
            message: format!("Unsupported RTSP version: {version}"),
        });
    }

    let status_code = parts[1].parse::<u16>().map_err(|_| Error::Transfer {
        code: 8,
        message: format!("RTSP invalid status code: {}", parts[1]),
    })?;

    let reason = if parts.len() > 2 { parts[2].to_string() } else { String::new() };

    Ok((status_code, reason))
}

fn insert_header(
    line: &str,
    headers: &mut HashMap<String, String>,
    headers_ordered: &mut Vec<(String, String)>,
    header_original_names: &mut HashMap<String, String>,
) {
    if let Some((key, value)) = line.split_once(':') {
        let key_trimmed = key.trim();
        let value_trimmed = value.trim();
        let key_lower = key_trimmed.to_ascii_lowercase();

        let _old = headers.insert(key_lower.clone(), value_trimmed.to_string());
        headers_ordered.push((key_trimmed.to_string(), value_trimmed.to_string()));
        let _old = header_original_names.insert(key_lower, key_trimmed.to_string());
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::*;

    #[test]
    fn parse_status_line_ok() {
        let (code, reason) = parse_status_line("RTSP/1.0 200 OK").unwrap();
        assert_eq!(code, 200);
        assert_eq!(reason, "OK");
    }

    #[test]
    fn parse_status_line_bad_version() {
        let err = parse_status_line("RTSP/1.1234567 200 OK").unwrap_err();
        assert!(err.to_string().contains("Unsupported RTSP version"));
    }

    #[test]
    fn parse_status_line_not_rtsp() {
        let err = parse_status_line("HTTP/1.1 200 OK").unwrap_err();
        assert!(err.to_string().contains("Weird RTSP server reply"));
    }

    #[test]
    fn rtsp_request_from_long() {
        assert_eq!(RtspRequest::from_long(0), Some(RtspRequest::None));
        assert_eq!(RtspRequest::from_long(1), Some(RtspRequest::Options));
        assert_eq!(RtspRequest::from_long(4), Some(RtspRequest::Setup));
        assert_eq!(RtspRequest::from_long(11), Some(RtspRequest::Receive));
        assert_eq!(RtspRequest::from_long(99), Option::None);
    }

    #[test]
    fn rtsp_request_method_str() {
        assert_eq!(RtspRequest::Options.method_str(), "OPTIONS");
        assert_eq!(RtspRequest::Describe.method_str(), "DESCRIBE");
        assert_eq!(RtspRequest::Setup.method_str(), "SETUP");
        assert_eq!(RtspRequest::GetParameter.method_str(), "GET_PARAMETER");
    }

    #[tokio::test]
    async fn request_and_response() {
        let response_data = b"RTSP/1.0 200 OK\r\nCSeq: 1\r\nPublic: DESCRIBE, OPTIONS\r\n\r\n";
        let (mut client, mut server) = tokio::io::duplex(4096);
        let _handle = tokio::spawn(async move {
            let mut buf = vec![0u8; 4096];
            let _n = server.read(&mut buf).await.unwrap();
            server.write_all(response_data).await.unwrap();
            server.flush().await.unwrap();
        });

        let headers: Vec<(String, String)> = vec![];
        let resp = request(&mut client, "OPTIONS", "rtsp://localhost/test", &headers, None, 1)
            .await
            .unwrap();
        assert_eq!(resp.status(), 200);
    }

    #[tokio::test]
    async fn response_with_body() {
        let response_data = b"RTSP/1.0 200 OK\r\nCSeq: 2\r\nContent-Length: 11\r\n\r\nhello world";
        let (mut client, mut server) = tokio::io::duplex(4096);
        let _handle = tokio::spawn(async move {
            let mut buf = vec![0u8; 4096];
            let _n = server.read(&mut buf).await.unwrap();
            server.write_all(response_data).await.unwrap();
            server.flush().await.unwrap();
        });

        let headers: Vec<(String, String)> = vec![];
        let resp = request(&mut client, "DESCRIBE", "rtsp://localhost/test", &headers, None, 2)
            .await
            .unwrap();
        assert_eq!(resp.status(), 200);
        assert_eq!(resp.body(), b"hello world");
    }
}